GET
/
invoices
/
:id

Params

id
string

The ID of the invoice to fetch.

Response

id
string

The Alguna ID of the invoice.

accountId
string

The Alguna ID of the account associated with the invoice.

status
string

The status of the invoice, e.g., “processing”.

dueDate
string

The due date of the invoice. (RFC 3339 timestamp)

issueDate
string

The date when the invoice was issued. (RFC 3339 timestamp)

autoIssue
boolean

A boolean indicating whether the invoice was automatically issued (true or false).

billingPeriodStart
string

The start date of the billing period for the invoice. (RFC 3339 timestamp)

billingPeriodEnd
string

The end date of the billing period for the invoice. (RFC 3339 timestamp)

billingPeriod
string

The formatted billing period for the invoice, representing the period from Jan 1, 2024, to Jan 31, 2024.

currency
string

The ISO 4217 currency in which the invoice is billed.

description
string

The description of the invoice, e.g., “Invoice for period January 1, 2024 to January 31, 2024”.

lineItems
List

A list of line items included in the invoice.

subtotal
string

The subtotal amount of the invoice as a decimal string.

tax
string

The tax amount of the invoice as a decimal string.

total
string

The total amount of the invoice as a decimal string.

amountPaid
string

The amount that has been paid for the invoice as a decimal string.

amountRemaining
string

The remaining amount to be paid for the invoice as a decimal string.

externalId
string

The external ID associated with the invoice, e.g., “80c84e7d-b265-4835-8ea0-e38a6c924ba4”.

externalProvider
string

The external provider associated with the invoice, e.g., “xero”.

externalUrl
string

The external URL associated with the invoice.

purchaseOrderNumber
string

The purchase order number associated with the invoice.

createdAt
datetime

The date and time at which the invoice was created.

updatedAt
datetime

The date and time at which the invoice was last updated.