CreditMemoAppliedSyncModel

The CreditMemoAppliedSyncModel 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 CreditMemoAppliedSyncModel 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 CreditMemoAppliedModel.

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

Required Fields

erpKey

string

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

Since Credit Memo Applications are often considered transactions, a typical value to look for will be
the transaction ID number, the payment confirmation number, or some other record of this payment.

For more information, see Identity Columns.

invoiceErpKey

string

This field indicates which Invoice had its balanced reduced by applying a credit memo. In this field,
identify the original primary key or unique ID of the Invoice which had its balanced reduced.

Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this
credit memo to reduce the balance of the invoice PO1000578. The InvoiceErpKey is PO1000578.

creditMemoInvoiceErpKey

string

This field indicates which Invoice is the original credit memo that was used to make this payment
application event. In this field, identify the original primary key or unique ID of the Invoice which
created the credit memo that was consumed in this event.

Example: Company ABC received a credit memo, CM000123 for $500. Company ABC then chooses to apply this
credit memo to reduce the balance of the invoice PO1000578. The CreditMemoInvoiceErpKey is CM000123.

entryNumber

int32

Reference number for the applied credit memo.

applyToInvoiceDate

date-time

The date on which this credit memo was applied to the Invoice.

creditMemoAppliedAmount

double

The amount of this credit memo that was applied to this Invoice.

Optional Fields

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.


Did this page help you?