Docs
Record Payment
POST /Orders/{orderId}/payments
POST
/Orders/{orderId}/paymentsRecords money paid against the order and returns the payment id. The amount must be greater than zero; method is optional (ACH, Check, Card, Wire or Other). orderDocumentId optionally points at an invoice on this order; omit it on a reimbursement order, which has no vendor document. Payments count toward Paid when the order's status is derived.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| orderId | uuid | Required |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| orderDocumentId | uuid | Optional | |
| amount | number | Optional | |
| date | date-time | Optional | |
| method | string | Optional | |
| reference | string | Optional |
Response
Type: uuid