Record payment for purchase order

POST/api/v1/purchase-orders/{id}/payments

Link a bank transaction to a purchase order as a payment.

Operation ID: record_order_payment_api_v1_purchase_orders__id__payments_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

idstring · uuidrequired

Request body

Schema: OrderPaymentRequest

transaction_idstringrequired: UUID of the bank transaction representing the payment.
amountintegerrequired: Payment amount in cents. Must be > 0.
paid_onstring · date-time: Override payment date (ISO 8601). Defaults to the transaction datetime if omitted.

Responses

201Successful Response

Schema: SuccessEnvelope_OrderPaymentResponse_

successboolean
messagestring
codestring
dataOrderPaymentResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/purchase-orders/{id}/payments

bash

curl -X POST 'https://api.ondayzero.com/api/v1/purchase-orders/{id}/payments' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "transaction_id": "string",
  "amount": 0
}'