InvoiceLineSyncModel

The InvoiceLineSyncModel 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 InvoiceLineSyncModel 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 an InvoiceLineModel.

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

Required Fields

erpKey

string

This is the primary key of the Invoice Line record. For this field, you should use whatever the contact'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 invoice line records in a database, whatever the primary key for the invoice
line table is in the database should be the "ErpKey".

For more information, see Identity Columns.

invoiceErpKey

string

The original primary key or unique ID of the invoice to which this line belongs. This value should
match the Invoice ErpKey field on the
InvoiceSyncModel.

lineNumber

string

The line number of this line, as defined in the originating ERP or accounting system. You can sort on this number to
get the original view of lines within the invoice.

Optional Fields

productCode

string, nullable

A code number identifying the product or service that is specified on this line.

description

string, nullable

Description of this invoice line.

unitMeasureCode

string, nullable

For lines measured in a unit other than "quantity", this code indicates the measurement system for the quantity field.
If the line is measured in quantity, this field is null.

unitPrice

double, nullable

The price of a single unit for this line.

quantity

double, nullable

The quantity of items for ths line.

quantityShipped

double, nullable

The number of items that have been shipped.

quantityReceived

double, nullable

The number of items that has been received.

totalAmount

double, nullable

The total amount for this line.

exemptionCode

string, nullable

If this line is tax exempt, this code indicates the reason for the exemption.

reportingDate

date-time, nullable

If null, the products specified on this line were delivered on the same date as all other lines.
If not null, this line was delivered or finalized on a different date than the overall invoice.

originAddressLine1

string, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressLine2

string, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressLine3

string, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressCity

string, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressRegion

string, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressPostalCode

string, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressCountry

string, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressLatitude

float, nullable

Origination address for this invoice line, if this line item was originated from a different address

originAddressLongitude

float, nullable

Origination address for this invoice line, if this line item was originated from a different address

billToAddressLine1

string, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressLine2

string, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressLine3

string, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressCity

string, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressRegion

string, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressPostalCode

string, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressCountry

string, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressLatitude

float, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

billToAddressLongitude

float, nullable

Billing address for this invoice line, if this line item is to be billed to a different address

shipToAddressLine1

string, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressLine2

string, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressLine3

string, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressCity

string, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressRegion

string, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressPostalCode

string, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressCountry

string, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressLatitude

float, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

shipToAddressLongitude

float, nullable

Shipping address for this invoice line, if this line item is to be shipped to a different address

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?