Invoices

Add payment records to invoices

Creates payment records for the invoices in the Approved status in bulk. <br />Note: This method is available to users with the Invoice Admin role and with the InvoiceChangeToPaid feature flag enabled. <br />Example Request

             POST /invoices/Payments
             {
               "Payments": [
                 {
                   "InvoiceId": 96814318,
                   "PaymentDate": "2021-12-13T06:12:22.820Z",
                   "PaymentNumber": "456858",
                   "PaymentAmount": 756
                 },
                 {
                   "InvoiceId": 4988659,
                   "PaymentDate": "2021-12-13T06:12:22.820Z",
                   "PaymentNumber": "97027818",
                   "PaymentAmount": 1250.55
                 }  
               ]
             }
post/invoices/Payments

Request

Request body

Response

The payments are successfully added. <br/>Error codes: 503 - Request is invalid 1178 - Invoice cannot be paid before the invoice creation date 1178 - Invoice has already been paid 1178 - No invoice ID 1178 - Only approved invoices may be paid 1178 - Payment amount exceeds the actual invoice amount 1178 - Payment amount should be more than zero 1178 - Payment is not allowed for this subscriber 1178 - Payment number cannot exceed 100 characters

Changes

No recorded changes to this operation across all 1 revision of this API.