CoreOf[Customer]

  • data
    Type: object · Customer
    required

    The record's payload, in its own transaction currency.

    • date
      Type: string · DateFormat: date
      required

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

    • 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.

    • email
      Type: string · Emailnullable
    • name
      Type: string · Namenullable
  • id
    Type: object · Id
    required

    The record's identity: its public type and external id.

    • dataType
      Type: string · DataTypeenum
      required

      A string representing the type of the T0 accounting record.

      values
      • Adjustment
      • Product
      • CardTransaction
      • FixedAsset
      • Contractor
    • externalId
      Type: string · Externalid
      required
    • platformDataType
      Type: string · Platformdatatypenullable
    • platformId
      Type: string · Platformidnullable
    • platformType
      Type: string · Platformtypenullable
  • expanded
    Type: object · Expandednullable

    Linked records requested through expand, keyed by link name. Each record is in its own type's public shape. Absent when expand was not requested.

    • propertyName
      Type: array object[] · Core[]

      Represents one of the T0 accounting records, alongside its links and identifiers.

      • data
        required

        Represents one of the T0 accounting records (e.g. a payment, dispute, credit, etc).

      • id
        Type: object · Id
        required
      • links
        Type: array object[] | null · Linksnullable
  • expanded_truncated
    Type: array string[] | null · Expanded Truncatednullable

    Names of expanded child links whose result was capped (at most 500 children per link per page are returned). Absent when nothing was truncated.

  • links
    Type: array object[] · Links

    Outbound links to other records. Follow one with GET /{segment}/{externalId}.

    • dataType
      Type: string · DataTypeenum
      required

      A string representing the type of the T0 accounting record.

      values
      • Adjustment
      • Product
      • CardTransaction
      • FixedAsset
      • Contractor
    • externalId
      Type: string · Externalid
      required
    • platformDataType
      Type: string · Platformdatatypenullable
    • platformId
      Type: string · Platformidnullable
    • platformType
      Type: string · Platformtypenullable