POST
/
invoices

Creates a one-off invoice.

Request

accountId
string
required

The ID of the account for which the invoice is being created.

billingPeriodStart
timestamp
required

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

billingPeriodEnd
timestamp
required

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

description
string

A description or note for the invoice. Also known as memo.

lineItems
List

A list of line items included in the invoice.

issueDate
string

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

autoIssue
boolean

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

Response

id
string
required

The Alguna ID of the invoice.

accountId
string
required

The Alguna ID of the account associated with the invoice.

status
string
required

The status of the invoice.

dueDate
string
required

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

issueDate
string
required

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

autoIssue
boolean
required

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

billingPeriodStart
string
required

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

billingPeriodEnd
string
required

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

billingPeriod
string
required

The formatted billing period for the invoice.

currency
string
required

The ISO 4217 currency in which the invoice is billed.

description
string
required

The description of the invoice.

lineItems
List
required

A list of line items included in the invoice.

subtotal
string
required

The subtotal amount of the invoice.

tax
string
required

The tax amount of the invoice.

total
string
required

The total amount of the invoice as a decimal String.

amountPaid
string
required

The amount paid for the invoice.

amountRemaining
string
required

The remaining amount to be paid for the invoice.

externalId
string
required

The external ID associated with the invoice.

externalProvider
string
required

The external provider associated with the invoice.

externalUrl
string
required

The external URL associated with the invoice.

purchaseOrderNumber
string

The purchase order number associated with the invoice.

createdAt
datetime
required

The date and time at which the invoice was created.

updatedAt
datetime
required

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