Skip to main content
POST
Mark an invoice as paid
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

client_id
string
required

Unique ID of the client for which you want to retrieve or update details. Refer to Getting the Client ID section for detailed instructions.

invoice_id
string
required

The invoice's number as printed on the document, its identifier, or its ID.

Body

application/json
payment_method
enum<string>
required

How the payment was made.

Available options:
ACH,
Bank Transfer,
Cash,
Check,
Debit,
Credit Card
Example:

"Bank Transfer"

email
string<email>
required

Email of the acting user. Required when you authenticate with an API key.

Example:

"oliver@example.com"

amount
number<float>

Amount received, with at most 2 decimal places. Must be greater than 0 and no more than the invoice's balance. Defaults to the full remaining balance. A partial amount leaves the invoice generated; it becomes paid once the balance reaches 0.

Example:

1250.5

payment_date
string<date>

Date the payment was received in YYYY-MM-DD format. Defaults to today.

Example:

"2026-11-19"

notes
string

Notes saved with the payment, such as a bank reference.

Example:

"Wire ref 9001"

notify_client
boolean
default:false

Whether to email the invoice's recipients a payment confirmation.

Example:

false

Response

OK - Payment recorded

id
string<uuid>
number
string
Example:

"INV-2026-042"

status
enum<string>

paid once the balance reaches 0, otherwise generated.

Available options:
generated,
paid
Example:

"paid"

amount_paid
number<float>

Total of all payments recorded against the invoice.

Example:

2500

balance
number<float>

Amount still owed.

Example:

0

payment_transaction_id
string<uuid>

ID of the payment just recorded.