The invoice object contains information such as their currency, invoiceNumber, issueDate, etc.

{
  id: "00000000-0000-0000-0000-00000000",
  remoteId: "361",
  customerId: "593409c0-0ee3-4de2-92ef-48f69c0935e5",
  invoiceNumber: "1117",
  issueDate: "2023-10-10",
  dueDate: "2023-10-10",
  paidOnDate: null,
  memo: null,
  companyId: null,
  currency: "USD",
  exchangeRate: 1,
  totalDiscount: null,
  subTotal: null,
  invoiceStatus: null,
  totalTaxAmount: null,
  totalAmount: 100,
  balance: 100,
  trackingCategories: [],
  lineItems: [
  {
    totalAmount: 100,
    accountingItemId: "5009dc24-ffcd-460c-a2c9-71e61814b80c",
    remoteId: "1"
  },
  {
  	totalAmount: 100
  }
  ],
  purchaseOrders: [],
  remoteCreatedAt: "2023-11-19T17:00:17.000Z",
  remoteUpdatedAt: "2023-11-19T17:00:17.000Z",
  remoteDeleted: false,
  createdAt: "2024-02-22T11:17:53.264Z",
  updatedAt: "2024-02-22T13:54:03.445Z"
}

Properties

idString

The Alloy-generated unique ID

remoteIdString

The ID of the object in the third-party application.

customerIdString

The ID of the customer associated with the invoice.

invoiceNumberString

A unique number or code assigned to the invoice for easy reference.

issueDateDate

The date when the invoice was generated and sent to the customer. Format: YYYY-MM-DD

dueDateDate

The date by which the payment for the invoice is expected. Format: YYYY-MM-DD

paidOnDateDate

The date when the invoice was settled or paid by the customer. Format: YYYY-MM-DD

memoString

Any supplementary notes, comments, or details related to the invoice.

companyIdString

ID of the company the invoice belongs to.

currencyEnum

The type of currency in which the invoice amount is presented. Possible values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL

exchangeRateNumber

The conversion rate used if the invoice involves transactions in foreign currency.

totalDiscountString

Aggregate reductions or markdowns applied to the invoice.

subTotalNumber

The amount before any taxes, discounts, or additional fees are accounted for.

invoiceStatusString

The current state of the invoice. Possible values: PAID, DRAFT, SUBMITTED, PARTIALLY_PAID, OPEN, VOID

totalTaxAmountNumber

Overall amount of taxes charged on the invoice.

totalAmountNumber

The complete sum due, after considering all charges, taxes, and discounts.

balanceNumber

The outstanding amount remaining to be paid, after any partial payments or credits.

trackingCategoriesString[]

An array of tracking category IDs.

lineItemsInvoiceLineItem[]

Detailed breakdown of all the goods or services billed in the invoice, including descriptions, quantities, and prices.

purchaseOrdersString[]

An array of purchase order IDs.

remoteCreatedAtDateTime

The exact date and time when the item was first added or created in the third-party application.

remoteUpdatedAtDateTime

The latest date and time when any modifications or updates were made to the item's details in the third-party application.

remoteDeletedBoolean

Flag to indicate that the record has been deleted in the third-party application.

createdAtDateTime

Date and time the record has been synced into the data cache.

updatedAtDateTime

Date and time the record has been updated in the data cache.

Invoice Line Item

{
remoteId: "1",
description: "Line Item",
unitPrice: 2,
quantity: 10,
totalAmount: 20,
currency: null,
exchangeRate: null,
accountingItemId: null,
accountId: "00000000-0000-0000-0000-00000000",
trackingCategoryId: null,
trackingCategoryIds: [],
companyId: null
}

Properties

remoteIdString

The ID of the object in the third-party application.

descriptionString

A concise overview or detail of the specific good or service listed in the line item.

unitPriceNumber

The cost assigned per individual unit of the good or service.

quantityNumber

The number of units of the particular good or service being invoiced.

totalAmountNumber

The cumulative sum for the line item, typically calculated as unitPrice * quantity.

currencyEnum

The type of currency in which the line item's amount is presented. Possible values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UYW, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWL

exchangeRateNumber

The conversion rate employed if the line item includes a foreign currency transaction.

accountingItemIdString

The ID of the item associated with the invoice line item.

accountIdString

The ID of the account associated with the invoice line item.

trackingCategoryIdString

The ID of the tracking category associated with the invoice line item.

trackingCategoryIdsString[]

An array of tracking category IDs associated with the invoice line item.

companyIdString

ID of the company the invoice line item belongs to.