Invoices
Mark Invoice as Paid
PUT
Marks an invoice as paid without creating a payment through a payment provider. Use this when recording payments received outside of Alguna (e.g., bank transfers, cheques, or cash).
If you have a customer-facing invoice reference number instead of an Alguna invoice ID, use the Invoice Lookup endpoint first to resolve it.
Params
string
required
The Alguna ID of the invoice to mark as paid.
Request Body
All fields are optional. When omitted, sensible defaults are applied (full invoice amount, current date).string
The amount paid as a decimal string. Defaults to the full invoice total when omitted.
string
The date the payment was received. (RFC 3339 formatted timestamp). Defaults to the current date when omitted.
string
The source of the external payment. One of:
bank_transfer, cheque, payment_card, cash, other.string
A free-text note describing the payment (e.g., a bank reference or cheque number).
Response
Returns the full invoice object with its status updated topaid.
string
The Alguna ID of the invoice.
string
The Alguna ID of the account associated with the invoice.
string
The status of the invoice. Will be
paid after a successful call.string
The due date of the invoice. (RFC 3339 timestamp)
string
The date when the invoice was issued. (RFC 3339 timestamp)
string
The start date of the billing period for the invoice. (RFC 3339 timestamp)
string
The end date of the billing period for the invoice. (RFC 3339 timestamp)
string
The formatted billing period for the invoice.
string
The ISO 4217 currency in which the invoice is billed.
string
The description of the invoice.
string
The subtotal amount of the invoice as a decimal string.
string
The tax amount of the invoice as a decimal string.
string
The total amount of the invoice as a decimal string.
string
The amount that has been paid for the invoice as a decimal string.
string
The remaining amount to be paid for the invoice as a decimal string.
datetime
The date and time at which the invoice was created.
datetime
The date and time at which the invoice was last updated.