Add payment

POST

/invoices/payments/

Records a payment against an invoice and returns its ID.

Request

Body Params application/jsonRequired

Example

{
    "invoice": "INV-1001",
    "paid_amount": 0,
    "payment_method": null,
    "reference": "Payment for INV-1001",
    "external_id": "PAY-EXT-1001",
    "paid_date": "2024-07-20"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://app.fieldinsight.com/public-api//invoices/payments/' \
--header 'Content-Type: application/json' \
--data '{
    "invoice": "INV-1001",
    "paid_amount": 0,
    "payment_method": null,
    "reference": "Payment for INV-1001",
    "external_id": "PAY-EXT-1001",
    "paid_date": "2024-07-20"
}'

Responses

🟢200OK

application/json

Successful response.

Bodyapplication/json

Example

{
    "id": 1801,
    "number": 1,
    "external_id": "PAY-1001"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🟠422Parameter Error

🟠429

Modified at 2026-10-30 03:40:11

Get payments

Upsert Payment Method