PaymentSyncModel

The PaymentSyncModel represents information coming into Lockstep from an external financial system or other
enterprise resource planning system. To import data from an external system, convert your original data into
the PaymentSyncModel format and call the Upload Sync File API.
This API retrieves all of the data you uploaded in a compressed ZIP file and imports it into the Lockstep
platform.

Once imported, this record will be available in the Lockstep API as a PaymentModel.

For more information on writing your own connector, see Connector Data.

Required Fields

erpKey

string

This is the primary key of the Payment record. For this field, you should use whatever the payment's unique
identifying number is in the originating system. Search for a unique, non-changing number within the
originating financial system for this record.

Example: If you store your payment records in a database, whatever the primary key for the payment table is
in the database should be the "ErpKey".

For more information, see Identity Columns.

companyErpKey

string

The original primary key or unique ID of the company to which this payment belongs. This value should
match the Company ErpKey field on the
CompanySyncModel.

paymentType

string

The type of payment, AR Payment or AP Payment.

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

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.

paymentDate

date-time

The date when this payment was received. This typically is the date when an accounting employee recorded
that they received notification that the payment had occurred, whether they were notified by email, postal
mail, or financial transaction notification.

postDate

date-time

The date when a payment was posted to a ledger. This date is often determined by a company's accounting
practices and may be different than the date when the payment was received. This date may be affected by
issues such as temporary holds on funds transferred, bank holidays, or other actions.

paymentAmount

double

Total amount of this payment.

unappliedAmount

double

Unapplied balance of this payment. If this amount is nonzero, the field IsOpen will be true.

Optional Fields

tenderType

string, nullable

Cash, check, credit card, wire transfer.

Recognized TenderType values are:

  • Cash - A cash payment or other direct transfer.
  • Check - A check payment.
  • Credit Card - A payment made via a credit card.
  • Wire Transfer - A payment made via wire transfer from another financial institution.
  • Other - A payment made via another method not listed above.

memoText

string, nullable

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

currencyCode

string, nullable

The ISO 4217 currency code for this payment.

For a list of ISO 4217 currency codes, see Query Currencies.

created

date-time, nullable

If known, the date when this record was created according to the originating financial system
in which this record is maintained. If the originating financial system does not maintain a
created-date, leave this field null.

modified

date-time, nullable

If known, the date when this record was most recently modified according to the originating
financial system in which this record is maintained. If the originating financial system does
not maintain a most-recently-modified-date, leave this field null.

referenceCode

string, nullable

A reference code for the payment for the given financial or ERP system. This can be any value that the
originating system uses to designate the payment, such as a confirmation number or tracking number, that
is different from the ErpKey value.

isVoided

boolean, nullable

True if this payment was voided.

inDispute

boolean, nullable

True if this payment is in dispute.


Did this page help you?