API referenceInvoices

Record a payment made outside InversePay

Settle an invoice paid by bank transfer, cash or cheque. **No ledger entry and no balance change.** The money went to the business's own account; we never held it, and crediting a wallet for it would claim funds that are not there. This settles the *invoice* and says nothing about the balance — which is the truth, and the reason this is not recorded as a charge. Partial payments are ordinary: send each one as it arrives and the invoice moves to `paid` when they add up. Overpayment is capped at the total by the reconcile rather than refused, because the money did arrive.

POST
/api/b/v1/invoices/{invoice_id}/payments

Settle an invoice paid by bank transfer, cash or cheque.

No ledger entry and no balance change. The money went to the business's own account; we never held it, and crediting a wallet for it would claim funds that are not there. This settles the invoice and says nothing about the balance — which is the truth, and the reason this is not recorded as a charge.

Partial payments are ordinary: send each one as it arrives and the invoice moves to paid when they add up. Overpayment is capped at the total by the reconcile rather than refused, because the money did arrive.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

Path Parameters

invoice_id*Invoice Id
Formatuuid
admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Money that reached the business outside InversePay.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/payments" \  -H "Content-Type: application/json" \  -d '{    "amount_minor": 450000  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "number": "string",  "customer_name": "string",  "customer_email": "string",  "currency": "string",  "subtotal_minor": 0,  "tax_minor": 0,  "total_minor": 0,  "paid_minor": 0,  "outstanding_minor": 0,  "state": "draft",  "due_date": "2019-08-24",  "notes": "string",  "sent_at": "2019-08-24T14:15:22Z",  "paid_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "payment_link_slug": "string",  "lines": [],  "reminders": []}