Create Payment

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
notesstringRequired

Optional: Payment notes - max 2000 chars - “Payment for March services”

amountstringRequired

Required: Payment amount - numeric min:0.01 - 250.00

customer_idstringRequired

Required: Customer ID - must exist in customers table - “{{customer_id}}

payment_datestringRequired

Required: Date payment was received - date format - “2026-03-05”

payment_typestringRequired

Optional: Payment type - standard|deposit - “standard”

work_order_idstringRequired

Optional: Associated work order ID - must exist in work_orders - “{{work_order_id}}

payment_methodstringRequired

Required: Payment method - cash|check|credit_card|ach|external - “check”

reference_numberstringRequired

Optional: Reference/check number - max 100 chars - “CHK-12345”

allocations[0][amount]stringRequired

Required with allocations: Amount to allocate - numeric min:0.01 - 250.00

allocations[0][invoice_id]stringRequired

Required with allocations: Invoice to allocate to - must exist in invoices - “{{invoice_id}}

Response

Successful response