Payments

Record and manage payments for invoices and retainer invoices.

Create Payment

POST https://api.invoiless.com/v1/invoices/:id/payments

Record a payment for an invoice.

Example:

{
  "amount": 100.5,
  "method": "BankTransfer",
  "paidAt": "2024-01-15",
  "notes": "Payment received via bank transfer"
}

Path Parameters

Name	Type	Description	Required
id	string	Invoice id	Yes

Header Parameters

Name	Type	Description	Required
scope-id	string	Scope id	No

Body Parameters

Name	Type	Description	Required
amount	number	Payment amount (must be positive, max 2 decimal places). If not provided, the full invoice balance will be used	No
method	string	Payment method, possible values are Cash, Cheque, Card, BankTransfer, or Other	Yes
paidAt	date	Payment date	No, default is current date
notes	string	Payment notes (max 500 characters)	No
sendNotification	bool	Send payment notification email to customer	No, default is false

Get Payment

GET https://api.invoiless.com/v1/payments/:id

Retrieve a specific payment by ID.

Path Parameters

Name	Type	Description	Required
id	string	Payment id	Yes

Get Payments

GET https://api.invoiless.com/v1/invoices/:id/payments

Retrieve all payments for a specific invoice.

Path Parameters

Name	Type	Description	Required
id	string	Invoice id	Yes

List Payments

GET https://api.invoiless.com/v1/payments

Retrieve a paginated list of all payments.

Query Parameters

Name	Type	Description	Required
page	number	Page number	No, default is 1
limit	number	Page limit	No, default is 50
search	string	Search by invoice number, customer name, notes, or amount	No

Update Payment

PUT https://api.invoiless.com/v1/payments/:id

PATCH https://api.invoiless.com/v1/payments/:id

Update an existing payment. See PUT vs PATCH for details on the differences.

Path Parameters

Name	Type	Description	Required
id	string	Payment id	Yes

Body Parameters

Accepts the same parameters as Create Payment.

Delete Payment

DELETE https://api.invoiless.com/v1/payments/:id

Permanently delete a payment.

Path Parameters

Name	Type	Description	Required
id	string	Payment id	Yes