InvoiceHistoryModel

An Invoice represents a bill sent from one company to another. The Lockstep Platform tracks changes to
each Invoice so that you can observe the changes over time. You can view the InvoiceHistory list to
monitor and observe the changes of this Invoice and track the dates when changes occurred.

Methods

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.

invoiceHistoryId

uuid

The unique ID number of this invoice history entry.

invoiceId

uuid

The unique ID of the Invoice represented by this history entry. This ID was automatically assigned
by Lockstep to the Invoice record when it was added to the Lockstep platform.

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

companyId

uuid

The ID number of the company that created this invoice.

customerId

uuid

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

erpKey

string, nullable, 0-100 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.

purchaseOrderCode

string, nullable, 0-100 characters

The purchase order code as it exists in the user's ERP or accounting system.

referenceCode

string, nullable, 0-100 characters

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.

salespersonCode

string, nullable, 0-50 characters

A code identifying the salesperson responsible for writing this invoice.

salespersonName

string, nullable, 0-50 characters

A string identifying the salesperson responsible for writing this invoice.

invoiceTypeCode

string, nullable, 0-50 characters

A code identifying the type of this invoice.

invoiceStatusCode

string, nullable, 0-50 characters

A code identifying the status of this invoice.

termsCode

string, nullable, 0-50 characters

A code identifying the terms given to the purchaser.

specialTerms

string, nullable, 0-200 characters

If the customer negotiated any special terms different from the standard terms above, describe them here.

currencyCode

string, nullable, 0-3 characters

The three-character ISO 4217 currency code used for this invoice. This will be validated by the /api/v1/currencies data set

totalAmount

double, nullable

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

salesTaxAmount

double, nullable

The total sales (or transactional) tax calculated for this invoice.

discountAmount

double, nullable

The total discounts given by the seller to the buyer on this invoice.

outstandingBalanceAmount

double, nullable

The remaining balance value of this invoice.

invoiceDate

date, nullable

The reporting date for this invoice.

discountDate

date, nullable

The date when discounts were adjusted for this invoice.

postedDate

date, nullable

The date when this invoice posted to the company's general ledger.

invoiceClosedDate

date, nullable

The date when the invoice was closed and finalized after completion of all payments and delivery of all products and
services.

paymentDueDate

date, nullable

The date when the remaining outstanding balance is due.

importedDate

date-time, nullable

The date and time when this record was imported from the user's ERP or accounting system.

primaryOriginAddressId

uuid, nullable

The ID number of the invoice's origination address

primaryBillToAddressId

uuid, nullable

The ID number of the invoice's bill-to address

primaryShipToAddressId

uuid, nullable

The ID number of the invoice's ship-to address

created

date-time, nullable, read-only

The date on which this invoice record was created.

createdUserId

uuid, nullable, read-only

The ID number of the user who created this invoice.

modified

date-time, nullable, read-only

The date on which this invoice record was last modified.

modifiedUserId

uuid, nullable, read-only

The ID number of the user who most recently modified this invoice.


Did this page help you?