Skip to content
Developerhome
Product homepage
Sage Network API

InvoiceLineModel

  Less than to read

Represents a line in an invoice

Methods

The following API methods use this data model.

uuid, read-only

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

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

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Sage Network 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, read-only, min 1 characters

The ID number of the invoice this line belongs to.

created

date-time, read-only

The date on which this line was created.

createdUserId

uuid, read-only

The ID number of the user who created this line.

modified

date-time, read-only

The date on which this line was last modified.

modifiedUserId

uuid, read-only

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

appEnrollmentId

uuid, nullable, read-only

The AppEnrollmentId of the application that imported this record. For accounts with more than one financial system connected, this field identifies the originating financial system that produced this record. This value is null if this record was not loaded from an external ERP or financial system.

erpWriteStatus

ErpWriteStatuses, read-only

Possible statuses for a record that supports ERP write.

erpWriteStatusName

string, nullable, read-only

The name of the ErpWriteStatus for this Invoice

sourceModifiedDate

date-time, nullable, read-only

The date on which this record was last modified in source ERP.

Required Fields

unitPrice

double

The price of a single unit for this line.

Optional Fields

erpKey

string, nullable, max 100 characters

The unique ID of this record as it was known in its originating financial system, if it was different from the original LineNumber.

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.

lineNumber

string, nullable, max 100 characters

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.

productCode

string, nullable, max 100 characters

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

description

string, nullable, max 250 characters

Description of this invoice line.

unitMeasureCode

string, nullable, max 50 characters

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.

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, max 100 characters

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

reportingDate

date, 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.

overrideOriginAddressId

uuid, nullable

An optional ID number for the line’s origin address.

overrideBillToAddressId

uuid, nullable

An optional ID number for the line’s bill to address.

overrideShipToAddressId

uuid, nullable

An optional ID number for the line’s ship to address.

Included Collections

These fields are available when using Retrieve or Query API calls if you specify the associated Include parameter.

notes

NoteModel[], nullable, read-only

A collection of notes linked to this record. To retrieve this collection, specify Notes in the include parameter when retrieving data.

To create a note, use the Create Note endpoint with the TableKey to InvoiceLine and the ObjectKey set to the InvoiceLineId for this record. For more information on extensibility, see linking extensible metadata to objects.

attachments

AttachmentModel[], nullable, read-only

A collection of attachments linked to this record. To retrieve this collection, specify Attachments in the include parameter when retrieving data.

To create an attachment, use the Upload Attachment endpoint with the TableKey to InvoiceLine and the ObjectKey set to the InvoiceLineId for this record. For more information on extensibility, see linking extensible metadata to objects.