CreditMemoInvoiceModel

Contains information about a credit memo invoice

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.

creditMemoAppliedId

uuid

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

invoiceId

uuid

The id of the invoice

creditMemoInvoiceId

uuid

The id of the credit memo invoice

creditMemoAppliedAmount

double

Amount applied to credit memo.

baseCurrencyCreditMemoAppliedAmount

double

The amount applied to credit memo in the group's base currency.

Optional Fields

baseCurrencyCode

string, nullable, 0-3 characters

The base currency code of the group.

currencyCode

string, nullable, 0-3 characters

The currency code of the credit memo invoice.

applyToInvoiceDate

date, nullable

Date invoice applied to credit memo.

referenceCode

string, nullable

An additional reference code that is sometimes used to identify this invoice.
The meaning of this field is specific to the ERP or accounting system used by the user.

companyId

uuid, nullable

The ID number of the company that created this invoice.

customerId

uuid, nullable

The ID number of the counterparty for the invoice, for example, a customer or vendor.

invoiceStatusCode

string, nullable

A code identifying the status of this invoice.

totalAmount

double, nullable

The total value of this invoice, inclusive of all taxes and line items.

outstandingBalanceAmount

double, nullable

The remaining balance value of this invoice.

baseCurrencyTotalAmount

double, nullable

The total value of this invoice, inclusive of all taxes and line items in the group's base currency.

baseCurrencyOutstandingBalanceAmount

double, nullable

The remaining balance value of this invoice in the group's base currency.