PaymentSummaryModel

Contains summary information for a Payment

Required Fields

groupKey

uuid

The GroupKey uniquely identifies a single ADS Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

paymentId

uuid

The id of the payment

paymentAmount

double

Total amount of this payment.

unappliedAmount

double

Unapplied balance of this payment.

baseCurrencyPaymentAmount

double

The payment amount in the group's base currency.

baseCurrencyUnappliedAmount

double

The unapplied amount in the group's base currency.

supportsErpPdfRetrieval

boolean

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

modified

date-time

The modified date of the payment

Optional Fields

memoText

string, nullable

Memo or reference text (ex. memo field on a check).

referenceCode

string, nullable

Reference code for the payment for the given Erp system.

tenderType

string, nullable

The tender type of payment (Cash, Check, etc.)

paymentType

string, nullable

The type of payment, AR Payment or AP Payment.

paymentDate

date, nullable

The date of this payment.

currencyCode

string, nullable, 0-3 characters

The currency code of the payment.

baseCurrencyCode

string, nullable, 0-3 characters

The base currency code of the group.

invoiceCount

int32, nullable

The number of invoices associated to this payment.

totalPaymentsApplied

double, nullable

The number of payments applied to this payment.

invoiceList

string[], nullable

The reference codes of the invoices associated to this payment.

invoiceIdList

uuid[], nullable

The ids of the invoices associated to this payment.

paymentCompanyId

uuid, nullable

The id of the company for this payment.

paymentCompanyName

string, nullable

The name of the company for this payment.

Deprecated Fields

Deprecated fields are maintained for backwards compatibility with previous versions of the API. Deprecated fields may be removed in a future release of the API.

isOpen

boolean

True if this payment includes some unassigned amount that has not yet been applied to an invoice. If this
value is true, the field UnappliedAmount will be nonzero.

customerIds

uuid[], nullable

The ids of the customer for the associated invoices.

customerNames

string[], nullable

The names of the customer for the associated invoices.

companyIds

uuid[], nullable

The ids of the company for the associated invoices.

companyNames

string[], nullable

The names of the company for the associated invoices.