Add payment to invoice

POST /api/v1/invoices/{invoice_id}/payments

Link a bank transaction as payment against an invoice. Supports split payments (one transaction paying multiple invoices) and partial payments (multiple transactions paying one invoice).

Operation ID: create_invoice_payment_api_v1_invoices__invoice_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

invoice_id string · uuid required

Request body

Schema: InvoicePaymentRequest

transaction_id string required: UUID of the bank transaction representing the payment.
amount integer required: Payment amount in cents allocated to this invoice. Must be > 0 and <= the remaining unallocated amount on the transaction. Overpayments (exceeding the invoice balance) are permitted.
paid_on string · date-time: Override payment date (ISO 8601). Defaults to the transaction datetime if omitted.

Responses

201 Successful Response

Schema: InvoicePaymentResponse

id string required: Payment record UUID.
invoice_id string required: UUID of the invoice being paid.
transaction_id string required: UUID of the bank transaction.
amount integer required: Allocated payment amount in cents.
currency string: Currency (USD, CAD, AUD, EUR, or GBP).
paid_on string · date-time required: Effective payment date.
created_at string · date-time required: Record creation timestamp.
updated_at string · date-time required: Last update timestamp.
business_id string required: Business UUID.
transaction InvoicePaymentTransactionSummary: Linked bank transaction summary. Included when listing payments.

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields

loc array · string | integer required
msg string required
type string required
input object
ctx object

Code samples

POST /api/v1/invoices/{invoice_id}/payments

bash

curl -X POST 'https://api.ondayzero.com/api/v1/invoices/{invoice_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
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/invoices/{invoice_id}/payments', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "transaction_id": "string",
  "amount": 0
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "transaction_id": "string",
  "amount": 0
}

response = httpx.post("https://api.ondayzero.com/api/v1/invoices/{invoice_id}/payments", headers=headers, json=payload)
data = response.json()