curl --request POST \
--url https://api.filexpress.app/api/external/v1/receivables/payments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"payment_method_id": "9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11",
"bank_id": "3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01",
"reference_number": "TRF-88231",
"payment_date": "2026-10-06",
"notes": "Cobro parcial",
"allocations": [
{
"sale_id": "9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11",
"amount": 300
}
]
}
'{
"status": true,
"data": {
"payments": [
{
"payment_id": "3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01",
"sale_id": "9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11",
"generation_code": "6F1E2D3C-8A4B-4C5D-9E6F-0A1B2C3D4E5F",
"amount": 300,
"pending_amount": 330,
"payment_status": "partial"
}
],
"total_applied": 300
}
}Register collection
Applies a collection per invoice (allocations) or spread from the oldest invoice to the newest; all or nothing. If bank_id is given, the deposit is registered (GET /treasury/banks); with petty_cash_id (cash only, mutually exclusive with bank_id) the collection goes into that petty cash fund. cost_center_id (optional) defaults to the document’s.
Required permission: receivables.payments
curl --request POST \
--url https://api.filexpress.app/api/external/v1/receivables/payments \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"payment_method_id": "9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11",
"bank_id": "3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01",
"reference_number": "TRF-88231",
"payment_date": "2026-10-06",
"notes": "Cobro parcial",
"allocations": [
{
"sale_id": "9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11",
"amount": 300
}
]
}
'{
"status": true,
"data": {
"payments": [
{
"payment_id": "3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01",
"sale_id": "9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11",
"generation_code": "6F1E2D3C-8A4B-4C5D-9E6F-0A1B2C3D4E5F",
"amount": 300,
"pending_amount": 330,
"payment_status": "partial"
}
],
"total_applied": 300
}
}Authorizations
Integration API Key (Integrations → New Integration).
Headers
Optional. Unique key per operation (max. 100 characters, valid for 24 h per integration). A retry with the same key and the same body returns the original response (header Idempotent-Replayed: true) without repeating the operation; with a different body, or while the first is still in progress, it returns 409.
100Body
Payment method (GET /payment-methods).
Payment date.
Bank (GET /treasury/banks).
Cost center of the payment (leaf and active; GET /accounting/cost-centers). If missing, that of the document. Only applied to income statement account lines when posting.
Reference (max. 255).
Notes (max. 500).
Required together with the third party (automatic mode).
Amount to distribute (automatic mode).
x > 0Customer (automatic mode, instead of allocations).
Petty cash that receives the collection (GET /treasury/petty-cashes). Only with cash method and without bank_id.
Amount per invoice (or use customer_id).
1 - 200 elementsShow child attributes
Show child attributes