Creates a one-off invoice.
{
"accountId": "acct_340-spas",
"billingPeriodStart": "2023-11-01T00:00:00Z",
"billingPeriodEnd": "2009-11-30T23:59:59Z",
"description": "Invoice for November 2023",
"lineItems": [
{
"description": "Implementation fee",
"unitPrice": "2.00",
"quantity": "3.00"
}
],
"issueDate": "2023-12-01T00:00:00Z"
}
Request
The ID of the account for which the invoice is being created.
The start date of the billing period for the invoice. (RFC 3339 formatted
timestamp)
The end date of the billing period for the invoice. (RFC 3339 formatted
timestamp)
A description or note for the invoice. Also known as memo.
A list of line items included in the invoice.
Description of the line item.
Details of the unit price.
ID of the product associated with the line item.
The date when the invoice should be issued. (RFC 3339 timestamp)
Response
{
"id": "oQLSmmnn",
"accountId": "aBsZxlLh",
"status": "upcoming",
"dueDate": "2024-02-23T00:00:00Z",
"issueDate": "2024-01-24T16:37:44.958601Z",
"billingPeriodStart": "2024-01-01T00:00:00Z",
"billingPeriodEnd": "2024-01-31T23:59:59Z",
"billingPeriod": "Jan 1, 2024 - Jan 31, 2024",
"currency": "USD",
"description": "Invoice for period January 1, 2024 to January 31, 2024",
"lineItems": [
{
"id": "tlfAFLJI",
"description": "Platform subscription",
"billingPeriodStart": "2024-01-01T00:00:00Z",
"billingPeriodEnd": "2024-01-31T23:59:59Z",
"quantity": "1",
"unitPrice": "200",
"totalPrice": "200",
"isEditable": false,
"productId": "HyujZkkm"
},
{
"id": "vPcZvThU",
"description": "Monthly user seats",
"billingPeriodStart": "2024-01-01T00:00:00Z",
"billingPeriodEnd": "2024-01-31T23:59:59Z",
"quantity": "1",
"unitPrice": "500",
"totalPrice": "500",
"isEditable": false,
"productId": "GPAPMbiw"
}
],
"subtotal": "700",
"tax": "0",
"total": "700",
"amountPaid": "0",
"amountRemaining": "700",
"externalId": "80c84e7d-b265-4835-8ea0-e38a6c924ba4",
"externalProvider": "xero",
"externalUrl": "https://go.xero.com/",
"purchaseOrderNumber": null,
"createdAt": "2024-01-24T16:36:52.703596Z",
"updatedAt": "2024-01-26T19:00:40.957736Z"
}
The Alguna ID of the invoice.
The Alguna ID of the account associated with the invoice.
The status of the invoice.
The due date of the invoice. (RFC 3339 timestamp).
The date when the invoice was issued. (RFC 3339 timestamp)
The start date of the billing period for the invoice. (RFC 3339 timestamp)
The end date of the billing period for the invoice. (RFC 3339 timestamp)
The formatted billing period for the invoice.
The ISO 4217 currency in which the invoice is billed.
The description of the invoice.
A list of line items included in the invoice.
The Alguna ID of the line item.
Description of the line item.
The start date of the billing period for the line item. (RFC 3339
timestamp)
The end date of the billing period for the line item. (RFC 3339 timestamp)
The quantity of the line item.
The unit price of the line item.
The total price of the line item.
A boolean indicating whether the line item is editable (true or
false).
The Alguna ID of the product associated with the line item.
The subtotal amount of the invoice.
The tax amount of the invoice.
The total amount of the invoice as a decimal String.
The amount paid for the invoice.
The remaining amount to be paid for the invoice.
The external ID associated with the invoice.
The external provider associated with the invoice.
The external URL associated with the invoice.
The purchase order number associated with the invoice.
The date and time at which the invoice was created.
The date and time at which the invoice was last updated.
