Invoice

An invoice is a type of accounting record representing the billing sent from merchant to customer. This record acts primarily as a collection of other records, such as line items, taxes, discounts, and credits. An invoice is also sometimes referred to as an order.

  • currencyCode
    Type: string · Currencycode
    required
  • date
    Type: string · DateFormat: date
    required

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • externalSubtotal
    Type: number · Externalsubtotal
    required
  • externalTotal
    Type: number · Externaltotal
    required
  • status
    Type: string · InvoiceStatusenum
    required
    values
    • paid
    • voided
    • drafted
    • open
    • uncollectible
  • subtotal
    Type: number · Subtotal
    required
  • tax
    Type: number · Tax
    required
  • total
    Type: number · Total
    required
  • customFields
    Type: object · CustomFieldsnullable

    The additional fields related to an accounting record. Custom fields are used to attach custom metadata to the objects to ingest into the system. Custom fields can be any valid JSON object.

    • propertyName
      Type: anything
  • dueDate
    Type: string · DuedateFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • exchangeRates
    Type: array object[] | null · Exchangeratesnullable
    • currencyCode
      Type: string · Currencycode
      required
    • rate
      Type: number · Rate
      required
  • issuedDate
    Type: string · IssueddateFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • paidDate
    Type: string · PaiddateFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • uncollectibleDate
    Type: string · UncollectibledateFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21