Add Bill Payment
POST/api/bills/:id/payments
Records a payment against a landed-cost bill and recalculates the bill's paid status. The payment is pushed to the connected accounting provider (Xero / QuickBooks Online).
Fields:
- payment_date (optional, date, defaults to today)
- payment_type_id (required, an existing payment type)
- amount (required, numeric, must be greater than 0)
- external_reference (optional, string, max 255)
- currency_id (optional; defaults to the bill's currency)
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.