CreditMemoAppliedModel

Credit Memos reflect credits granted to a customer for various reasons, such as discounts or refunds.
Credit Memos may be applied to Invoices as Payments. When a Credit Memo is applied as payment to an Invoice,
Lockstep creates a Credit Memo Application record to track the amount from the Credit Memo that was applied
as payment to the Invoice. You can examine Credit Memo Application records to track which Invoices were paid
using this Credit.

Methods

Fields

creditMemoAppliedId

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.

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.

invoiceId

uuid

The id of the invoice

creditMemoInvoiceId

uuid

The id of the credit memo invoice

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.

entryNumber

int32

Reference number for the applied credit memo.

applyToInvoiceDate

date-time

Date payment applied to credit memo.

creditMemoAppliedAmount

double

Amount applied to credit memo.

created

date-time, read-only

Date credit memo applied record was created.

createdUserId

uuid, read-only

The id of the user who created this applied credit memo.

modified

date-time, read-only

Date credit memo applied record was modified.

modifiedUserId

uuid, read-only

The id of the user who modified this applied credit memo.

appEnrollmentId

uuid, nullable, read-only

AppEnrollmentId for this record; used for mapping purposes.

attachments

AttachmentModel[], nullable, read-only

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

notes

NoteModel[], nullable, read-only

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

customFieldDefinitions

CustomFieldDefinitionModel[], nullable, read-only

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

customFieldValues

CustomFieldValueModel[], nullable, read-only

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


Did this page help you?