Credit

A credit is a type of accounting record representing a financial transaction in which one party extends credit to another in lieu of payment. Credit records are applicable only when a payables balance is tracked for each customer in addition to transactional invoices and payments. Examples of credits include gift cards, customer success credits, unused time credits, and service credits.

  • amount
    Type: number
    required
  • currencyCode
    Type: string
    required
  • date
    Type: stringFormat: date
    required

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

  • type
    Type: enum
    required
    values
    ApplicationIssuanceAdjustment
  • customFields
    Type: nullable

    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.

    Properties: 1
  • description
    Type: stringnullable
  • endDate
    Type: stringFormat: datenullable

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

  • exchangeRates
    Type: array of ExchangeRatenullable
    Properties: 2
  • startDate
    Type: stringFormat: datenullable

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

Previous
CreateRecordsResponse
Next
CreditNote