PaymentSummaryModel

Contains summary information for a Payment

Methods

The following API methods use this data model.

Required Fields

groupKey

uuid

The GroupKey uniquely identifies a single Lockstep 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.

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.

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.

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.

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.


Did this page help you?