GET
/
invoices
/
{id}
Get Invoice
curl --request GET \
  --url https://api.alguna.io/invoices/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
}

​
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., “upcoming”.
​
dueDate
string
The due date of the invoice. (RFC 3339 timestamp)
​
issueDate
string
The date when the invoice was issued. (RFC 3339 timestamp)
​
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.
{
  "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"
}