TransactionModel

Represents detailed transaction information which represents either Invoices, Credit Memos or Payments
within the group account.

Required Fields

groupKey

uuid

Group account transaction is associated with.

transactionId

uuid

The unique ID of the transaction record.

daysPastDue

int32

The amount of days past the due date the transaction is left un-closed.

transactionAmount

double

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

baseCurrencyTransactionAmount

double

The total value of this transaction, inclusive or all taxes and line items in the group's base currency.

transactionDetailCount

int32

The count of items associated to the transaction.

Examples:

  • Number of payments for an invoice.
  • Number of invoices a payment or credit memo is applied to.

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.

transactionCustomerId

uuid

The customer associated with this transaction

Optional Fields

baseCurrencyCode

string, nullable, 0-3 characters

The base currency code of the group.

referenceNumber

string, nullable

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

transactionStatus

string, nullable

The status of the transaction record.

Recognized Invoice status codes are:

  • Open - Represents an invoice that is considered open and needs more work to complete
  • Closed - Represents an invoice that is considered closed and resolved

Recognized Payment status codes are:

  • Open - Represents an payment that includes some unassigned amount that has not yet been applied to an invoice
  • Closed - Represents an payment where UnappliedAmount will be zero

transactionType

string, nullable

The type of the transaction 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 record was reported.

dueDate

date-time, nullable

The date when a transaction record is due for payment or completion.

currencyCode

string, nullable, 0-3 characters

The currency code of the transaction.

outstandingAmount

double, nullable

The remaining balance of this transaction.

baseCurrencyOutstandingAmount

double, nullable

The remaining balance of this transaction in the group's base currency.

transactionCustomerName

string, nullable

The name of the customer associated with this transaction

serviceFabricStatus

string, nullable

Specific payment transactions have a status with Service Fabric.

Recognized values are:

  • PENDING
  • PAID
  • PAID_OFFLINE
  • PARTIALLY
  • PARTIALLY_REFUNDED