cityworks 2.2.0 → 2.2.2

package/dist/case_financial.d.ts

@@ -30,8 +30,8 @@ export declare class CaseFinancial {
      * Make a Payment. Adds a payment to the case fee(s) specified.
      *
      * @category Case Payments
-     * @param {Array<Array<string>>} payments - The Case Object ID for the case to which to add the fee
-     * @param {Array<number>} caseFees - Fees this payment should be applied to. Array of CaFeeIds values.
+     * @param {Array<Array<string>>} payments - A collection of Payments to add: [Payment Tender Type, Amount, Comment, Date Received, Reference String] (All as strings)
+     * @param {Array<number>} caseFees - The Ca Fee IDs to which to apply the payment.
      * @param {stringName:string,AddressLine1?:string,AddressLine2?:string,AddressLine3?:string,CityName?:string,CommentText?:string,Email?:string,FaxNumber?:string,PhoneHome?:string,PhoneMobile?:string,PhoneWork?:string,PhoneWorkExt?:string,StateCode?:string,WebSiteUrl?:string,ZipCode?:string,CountryCode?:string} payerInfo - Payer info for the payment being made.
      * @return {Object} Returns Promise that represents an object describing the newly-added payment.
      */
@@ -155,6 +155,28 @@ export declare class CaseFinancial {
      * @return {Object} Returns Promise that represents a collection of Case Payments.
      */
     getPayments(caObjectId: number): Promise<unknown>;
+    /**
+     * Get Receipts by Case ObjectId
+     *
+     * @category Case Payments
+     * @param {number} caObjectId - The Case Object ID for the case to get the payment receipts for
+     * @return {Object} Returns Promise that represents a collection of Case Receipts.
+     */
+    getReceipts(caObjectId: number): Promise<unknown>;
+    /**
+     * @hidden
+     */
+    static downloadUrls(): {
+        receipt: string;
+    };
+    /**
+     * Download a Receipt by Receipt Id or Receipt Name.
+     *
+     * @category Case Payments
+     * @param {string | number} receipt - The Receipt Name or Receipt ID for the receipt to download
+     * @return {Object} Returns Promise that represents the downloaded Receipt PDF and Filename.
+     */
+    downloadReceipt(receipt: string | number): Promise<unknown>;
     /**
      * Gets the instruments from the case specified by the CaObectId.
      *