Invoice Object

The invoice data object

{
  "amountDue": 0.0,
  "amountDueInSmallestUnit": 0,
  "amountPaid": 0.0,
  "amountRemaining": 0.0,
  "contract": {
    <contract object>
  },
  "currency": "usd",
  "due": "2024-02-01T19:42:00.656805391Z",
  "invoiceNumber": "LAM-23423",
  "invoicePeriodStart": "2024-01-26T00:00:00Z",
  "invoicePeriodEnd": "2024-01-26T00:00:00Z", 
  "invoiceUrl": "https://customeros.ai/invoices/96d612a8-b086-4dae-9f10-a12796f30c55",
  "invoiceLineItems": [
    <invoiceLineItems object>
  ],
  "metadata": {
    <metadata object>
  },
  "note": "",
  "organization": {
    <organization object>
  },
  "paid": false,
  "subtotal": 0.0,
  "status": "DUE", 
  "taxDue": 0.0
}

amountDue

Float representing the total amount due for this invoice, including any applicable taxes.

amountPaid

Float representing the amount that has been paid against the invoice.

amountRemaining

Float representing the difference between the amountDue and amountPaid.

contract

The contract object

currency

Enum representing the three-letter ISO currency code, in lower case.

due

ISO 8601 timestamp representing the date payment for this invoice is due.

invoiceNumber

A unique, identifying string that appears on the invoice.

invoicePeriodStart

ISO 8601 timestamp of the first day in the invoice period.

invoicePeriodEnd

ISO 8601 timestamp of the last day in the invoice period.

invoiceUrl

A nullable string representing the URL for the hosted invoice page which allows customers to view and pay an invoice.

lineItems

The invoice line items object

metadata

The metadata object

note

A string representing any notes on the invoice. Can be an empty string.

organization

The organization object

paid

A boolean indicating if the invoice has been paid in full.

subtotal

A float representing the sum of all line items minus tax/VAT.

status

An enum representing the current status of the invoice. Valid values are:

• DRAFT
• DUE
• PAID
• VOID

tax

The invoice tax object

taxDue

A float respresenting the applicable tax rate multiplied by the subtotal