AnyCore

A record of any exposed type — the published Core plus optional expansion.

Returned by the type-agnostic point read, where the caller has said nothing about the type and the union IS the contract.

  • data
    required

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

    A tax is a type of accounting record representing a financial charge or levy imposed by a government on individuals, businesses, or other entities to fund public expenditures and government operations.

    • amount
      Type: number · Amount
      required
    • 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

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

    • description
      Type: string · Descriptionnullable
    • endDate
      Type: string · EnddateFormat: datenullable

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

    • exchangeRates
      Type: array object[] | null · Exchangeratesnullable
    • startDate
      Type: string · StartdateFormat: datenullable

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

  • id
    Type: object · Id
    required
    • 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[] | null · Linksnullable
    • 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