Pay Invoice

POST /api/.../invoices/{id}/payments

Pay invoice.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the Invoice.
dto DtoAcqPaymentData Yes Define this parameter in the request body.
DtoAcqPaymentData
Property Type Nullable Description
InvoiceID Int No The unique id assigned to the Invoice.
InvoiceStatusID Int No The id assigned to the Invoice status.
PaymentStatusID Int No For invoice payment this value is 7
PayStatusDate Datetime No
CheckNumber String Yes Check Number
CheckDate DateTime Yes Check date
VchrDate Datetime Yes Voucher date
VchrNumber string Yes Voucher number
PayAmount Decimal Yes
PaymentType int Yes Options are 1 (Credit Card), 2 (Check), 3 (Voucher), 4, (Deposit Account)
Example
application/json, text/json 
  {
    "InvoiceID": 8919,
    "InvoiceStatusID": 1,
    "PaymentStatusID": 7,
    "PayStatusDate": "2021-04-15T00:04:37.634Z",
    "CheckNumber": "1234",
    "CheckDate": "2021-04-15T00:04:37.634Z",
    "VchrDate": "2021-04-15T00:04:37.634Z",
    "VchrNumber": "string",
    "PayAmount": 10,
    "PaymentType": 2
 }

Response Information

True is returned upon success.

Example
application/json, text/json 
true

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Invalid invoice ID.
400 Not all the line item segments are received. The operation will be canceled.