TransactionDetailModel

Represents transaction detail information associated to a transaction. This can either be Invoices which are paid with a
Credit Memo or Payment transaction, or Credit Memos or Payments used as payment for an Invoice transaction.

Methods

The following API methods use this data model.

Required Fields

groupKey

uuid

Group account transaction detail is associated with.

transactionDetailId

uuid

The unique ID of the transaction detail record.

transactionDetailAppliedId

uuid

The unique ID of the entity applying the transaction to the transaction detail record.

transactionId

uuid

The unique ID of the transaction record.

transactionInvoiceDate

date-time

The date of the invoice associated to the transaction detail record.

transactionAmount

double

The total value of this transaction detail, inclusive or all taxes and line items.

supportsErpPdfRetrieval

boolean

Specific transactions have support for pdf retrieval from their respective erp. When this flag is true, an additional
call to Invoices/{id}/pdf or Payments/{id}/pdf can be made to retrieve a pdf directly from the erp.

Optional Fields

referenceNumber

string, nullable

An additional reference number that is sometimes used to identify a transaction detail.
The meaning of this field is specific to the ERP or accounting system used by the user.

transactionType

string, nullable

The type of the transaction detail record.

Recognized Invoice types are:

  • AR Invoice - Represents an invoice sent by Company to the Customer
  • AP Invoice - Represents an invoice sent by Vendor to the Company
  • AR Credit Memo - Represents a credit memo generated by Company given to Customer
  • AP Credit Memo - Represents a credit memo generated by Vendor given to Company

Recognized PaymentType values are:

  • AR Payment - A payment made by a Customer to the Company
  • AP Payment - A payment made by the Company to a Vendor

transactionSubType

string, nullable

Additional type categorization of the transaction.

transactionDate

date-time, nullable

The date when a transaction detail record was reported.

outstandingAmount

double, nullable

The remaining balance of this transaction detail.