CreditNote

A credit note is a type of accounting record representing adjustments to an invoice issued by a merchant to a buyer, indicating that the seller is crediting back a certain amount to the buyer.

  • 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

  • issuedDate
    Type: string · IssueddateFormat: date
    required

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

  • status
    Type: string · CreditNoteStatusenum
    required
    values
    • Issued
    • Voided
  • 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
  • description
    Type: string · Descriptionnullable
  • exchangeRates
    Type: array object[] | null · Exchangeratesnullable
    • currencyCode
      Type: string · Currencycode
      required
    • rate
      Type: number · Rate
      required
  • externalSubtotal
    Type: number · Externalsubtotalnullable
  • externalTotal
    Type: number · Externaltotalnullable