Add payment
Record a payment against an invoice.
Endpoint
| Property | Value |
|---|---|
| URL | POST /invoice/payment/add-payment/{invoiceId} |
| Method | POST |
| Auth | R-Auth: <company-jwt> |
Example Request
curl --location '{{baseUrl}}/invoice/payment/add-payment/{{invoiceId}}?paidAmount=1800.00&paymentDate=2026-06-16T00:00:00' \
--header 'R-Auth: {{companyJwt}}' \
--request POST
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
invoiceId | UUID | Yes | Invoice ID from Search documents |
Query parameters
| Parameter | Type | Required | Format | Description |
|---|---|---|---|---|
paidAmount | number | Yes | Number | Amount being paid |
paymentDate | string | Yes | yyyy-MM-ddTHH:mm:ss | Date of payment |
Response
{
"paymentStatus": "PAID",
"paidAmount": 1800.0,
"totalAmount": 1800.0,
"remainingAmount": 0.0,
"paymentDate": "2026-06-16"
}
Response fields
| Field | Description |
|---|---|
paymentStatus | Payment status. Possible values: SENT (unpaid), PARTIAL_PAID, PAID |
paidAmount | Amount paid so far |
totalAmount | Total invoice amount |
remainingAmount | Remaining balance |
paymentDate | Date of payment |