Mark invoice as paid
Marks an issued one-off invoice as paid, for a payment made outside Aira. A paid invoice comes back as it is, so a retry is safe.
Authorizations
API Key Authentication.
Path Parameters
The unique identifier of the invoice to mark as paid.
Response
Schema representing an invoice. Monetary amounts are integers in cents.
The unique identifier of the invoice in our system.
A unique key that identifies the invoice for idempotent creation. Supplied by the caller for one-off invoices; generated by the billing engine for contract invoices.
The unique identifier of the customer this invoice bills.
The unique identifier of the customer payment account used as the billing account for this invoice.
The unique identifier of the contract that generated this invoice. Null for invoices not generated from a contract (e.g. one-off and imported invoices).
The number of the invoice within its contract, in the order that Aira created the contract's invoices: 1 for the first, 2 for the next, and so on. Every invoice gets its own number, including each invoice of a split across payment accounts and the replacement of a reopened invoice, and a number never changes and is never reused. Null for invoices without a contract.
x >= 1Snapshot of the legal entity issuing the invoice (the seller), captured at invoice creation.
Snapshot of the billed party (the legal entity behind the customer payment account), captured at invoice creation.
How the originating contract distributes charges across payment accounts: single bills a single payment account; percent_split divides the total between payment accounts by configured percentages; subsidiary_usage_split divides it according to each subsidiary's usage.
single, percent_split, subsidiary_usage_split When the invoice amounts were last computed by the billing engine. Null when the invoice has never been calculated.
Human-readable invoice number, built from the customer's invoice prefix plus a sequential counter.
"ACMEI-0042"
The date of the invoice. On a contract invoice it is the date of its billing act: the first day of the first billing cycle that the contract invoices for an activation invoice, and the last day of the billing cycle for a closing invoice. Its line items state the periods that it bills. On a one-off or imported invoice it is the date given when the invoice was created.
Free-form memo attached to the invoice. On contract invoices, it reads "Período a " with the period of the line item that bills most often, such as the month when a monthly fee is billed with an annual fee. When two line items bill equally often, it uses the earlier period. Null when absent.
Sum of the line item subtotals before adjustments, in cents.
Net amount of all adjustments applied to the invoice line items (discounts and allocation offsets), in cents. Negative when adjustments reduce the amount owed.
Final invoice amount, in cents: subtotalAmount + adjustmentAmount.
The discount portion of adjustmentAmount, in cents (sum of monetary discount adjustments only). Negative when discounts were applied.
Current status of the invoice lifecycle: open (accumulating charges, editable), in_review (flagged for manual review before issuing), issued (finalized and issued to the customer), synced (registered in the external ERP/payment provider), pending (a payment was initiated and awaits settlement), paid, overdue (unpaid past the due date), canceled, or failed (an issue/sync attempt failed and needs attention).
open, in_review, issued, synced, pending, paid, overdue, canceled, failed Whether the invoice contents are locked against edits. Derived from status: issued, synced, pending, paid, overdue, and canceled invoices are locked; open, in_review, and failed invoices are editable.
Reason for the most recent failure on the invoice (e.g. an ERP sync or payment issue). Null when the invoice has no active failure.
How the invoice originated: contract (generated by a contract billing cycle), one_off (created manually or through the API), or import (ingested from an external system).
contract, one_off, import Whether the invoice is issued automatically when its billing cycle closes, without manual review.
Outstanding amount due on the invoice, in cents. Null when not tracked.
Payment due date of the invoice. Null when no due date is set (e.g. before the invoice is issued).
Line item groups on the invoice. Each group gathers the line items generated from one plan instance (or created as a group on one-off invoices).
Line items that do not belong to any line item group (e.g. contract-level minimum commitments, additional charges, and ungrouped one-off items).
The values of the tenant's custom fields for invoices, keyed by the key of each custom field. The object is empty when the invoice holds no value. A user edits them in the billing app, in any status of the invoice, and no public route writes them.