Invoices

Add a payment to an invoice

Creates a payment record for the specified invoice in the Approved status. <br />Send this request GET/odata/invoices to get the invoice ID. <br />Learn how subscribers can mark invoices as paid in ServiceChannel University. <br />Example Request

            POST /invoices/{invoiceId}/Payment
            {
             "PaymentDate": "2021-06-10T07:40:47.881Z",
             "PaymentNumber": "25469833",
             "PaymentAmount": 850
            }
post/invoices/{invoiceId}/Payment

Request

Path parameters

invoiceIdinteger required

Unique numeric identifier of the invoice to add a payment to.

Request body

PaymentDatestring date-time

Date and time when the specified invoice is paid. Cannot be earlier than the invoice approval date.

PaymentNumberstring

Order number of payment for the invoice.

PaymentAmountnumber double

Amount you want to pay. Cannot exceed the invoice total amount. If it’s a credited invoice, a single payment is required with a minus before the payment amount.

Response

A payment record is added to the specified invoice.

Changes

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