PaymentModel

A Payment represents money sent from one company to another. A single payment may contain payments for
one or more invoices; it is also possible for payments to be made in advance of an invoice, for example,
as a deposit. The creator of the Payment is identified by the CustomerId field, and the recipient of
the Payment is identified by the CompanyId field. Most Payments are uniquely identified both by a
Lockstep Platform ID number and a customer ERP "key" that was generated by the system that originated
the Payment. Payments that have not been fully applied have a nonzero UnappliedAmount value, which
represents a deposit that has been paid and not yet applied to an Invoice.

Methods

Fields

groupKey

uuid, read-only

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, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

For the ID of this record in its originating financial system, see ErpKey.

companyId

uuid

The ID of the company to which this payment belongs.

erpKey

string, nullable, 0-255 characters

The unique ID of this record as it was known in its originating financial system.

If this company record was imported from a financial system, it will have the value ErpKey
set to the original primary key number of the record as it was known in the originating financial
system. If this record was not imported, this value will be null.

For more information, see Identity Columns.

paymentType

string, 1-20 characters

The type of payment, cash or check.

tenderType

string, 1-25 characters

Cash, check, credit card, wire transfer.

isOpen

boolean

Has the payment been fully applied?

memoText

string, nullable, 0-50 characters

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

paymentDate

date

The date of this payment.

postDate

date

Payment post date.

paymentAmount

double

Total amount of this payment.

unappliedAmount

double

Unapplied balance of this payment.

currencyCode

string, nullable, 0-3 characters

Currency of the payment. This will be validated by the /api/v1/currencies data set

referenceCode

string, nullable, 0-100 characters

Reference code for the payment for the given Erp system.

created

date-time, read-only

The date on which this record was created.

createdUserId

uuid, read-only

The ID of the user who created this payment.

modified

date-time, read-only

The date on which this record was last modified.

modifiedUserId

uuid, read-only

The ID of the user who last modified this payment.

appEnrollmentId

uuid, nullable, read-only

AppEnrollmentId for this record; used for mapping purposes.

isVoided

boolean

Is the payment voided?

inDispute

boolean

Is the payment in dispute?

applications

PaymentAppliedModel[], nullable, read-only

All applications this payment is associated with.
To retrieve this collection, specify Applications in the "Include" parameter for your query.

notes

NoteModel[], nullable, read-only

All notes attached to this payment.
To retrieve this collection, specify Notes in the "Include" parameter for your query.

attachments

AttachmentModel[], nullable, read-only

All attachments attached to this payment.
To retrieve this collection, specify Attachments in the "Include" parameter for your query.

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

All definitions attached to this payment.
To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.

customFieldValues

CustomFieldValueModel[], nullable, read-only

All values attached to this payment.
To retrieve this collection, specify CustomFieldValues in the "Include" parameter for your query.


Did this page help you?