Installments

Manage invoice payment installments.

Payment installments for invoices. Optional file - only needed if you manage installment-based payments.

Dependency: Requires Invoices to be uploaded first.

⚠️ Important: When uploading installments for an invoice, you must include ALL installments (1..n) for that invoice in the same file. Partial updates are not supported.

Endpoint

POST /full-csv-integration/upload-installments

Form Field: installmentsFile

Required Fields

Field	Type	Description	Validations
`erp_invoice_id`	String	Invoice ID in ERP	Must exist in Invoices
`sequence`	Integer	Installment sequence number	Integer, starting at 1. Must be contiguous (1, 2, 3…) — see the warning below
`due_date`	Date	Installment due date	`YYYY-MM-DD` recommended. Other formats are accepted; values that cannot be parsed are stored empty rather than raising an error
`amount`	Float	Installment amount	Decimal number

Optional Fields

Field	Type	Description	Default
`status`	String	Installment status. Accepts `pending`, `paid` or `partial`, matched case-insensitively. An unrecognised value is not an error: it becomes `pending` on create and keeps the current status on update. The default applies on create only	`pending`

⚠️ Non-contiguous sequences are dropped silently: if an invoice’s sequence values have a gap, every installment for that invoice is discarded and the upload still reports success. Check that each invoice’s installments run 1..n with no gaps before uploading.

Example CSV

erp_invoice_id,sequence,due_date,amount,status
INV001,1,2024-02-15,500000.00,paid
INV001,2,2024-03-15,500000.00,pending
INV002,1,2024-02-20,500000.00,pending