Invoice

InvoiceObj:

Name
Data Type
Description

invoiceHeader

InvoiceHeader

Represents the invoice header.

invoiceItemLineArr

List<InvoiceItemLine>

Contains a list of invoice item lines.

IsBeingAutoCreated

bool

Indicates whether the invoice is being auto-created.

SimulatationFlag

bool

Indicates whether the invoice is in simulation mode.

invoiceHeader:

Name
Data Type
Description

Id

long

Invoice ID

InvoiceNumber

string

Invoice number

TxnId

string

Transaction ID

TxnNumber

long

Transaction number

StoreId

int

Store ID

StoreName

string

Store name

SaleStoreId

int

Sale store ID

SaleStoreName

string

Sale store name

StoreCode

string

Store code

SaleStoreCode

string

Sale store code

CustomerId

int

Customer ID

IntAccntId

string

Internal account ID

CustomerPO

string

Customer purchase order

AccntReceivableId

string

Account receivable ID

AccntReceivableName

string

Account receivable name

TypeId

int

Type ID

TxnDate

DateTime

Transaction date

CurrencyId

int

Currency ID

ExchangeRate

double

Exchange rate

RefNo

string

Reference number

Memo

string

Memo

BillToAddr

string

Billing address

BillToCity

string

Billing city

BillToState

string

Billing state

BillToStateAbbr

string

Billing state abbreviation

BillToCountry

string

Billing country

BillToCountryISO2

string

Billing country ISO2 code

BillToZpCode

string

Billing ZIP code

ShipToAddr

string

Shipping address

ShipToCity

string

Shipping city

ShipToState

string

Shipping state

ShipToStateAbbr

string

Shipping state abbreviation

ShipToCountry

string

Shipping country

ShipToCountryISO2

string

Shipping country ISO2 code

ShipToZpCode

string

Shipping ZIP code

DueDate

DateTime?

Due date

PaymentTermsId

int?

Payment terms ID

PaymentMethodTypeId

int?

Payment method type ID

PaymentTermsName

string

Payment terms name

CreateDttm

DateTime

Creation date and time

CreateSource

string

Creation source

ModifyDttm

DateTime?

Modification date and time

ModifySource

string

Modification source

StatusId

int

Status ID

StatusName

string

Status name

SalesRepId

string

Sales representative ID

CustomerServiceRepId

string

Customer service representative ID

SalesRepFullName

string

Sales representative full name

CustomerServiceRepFullName

string

Customer service representative full name

CustomerServiceRepEmail

string

Customer service representative email

SalesRepEmail

string

Sales representative email

FobId

int?

FOB ID

FobName

string

FOB name

ShipDate

DateTime

Shipping date

ShipMethodId

int?

Shipping method ID

ShipMethodName

string

Shipping method name

TotalAmount

double

Total amount

DiscountableAmount

double

Discountable amount

MaxDiscountAllowed

double

Maximum discount allowed

TotalTaxAmount

double

Total tax amount

AmountPaid

double

Amount paid

CreditApplied

double

Credit applied

DepositApplied

double

Deposit applied

DiscountApplied

double

Discount applied

AmountDue

double

Amount due

CustomerMessage

string

Customer message

CustomerTaxCodeId

int?

Customer tax code ID

CustomerGroupId

int?

Customer group ID

DiscountDate

DateTime?

Discount date

CustomerName

string

Customer name

CustomerFullName

string

Customer full name

CurrencyName

string

Currency name

CurrencyCode

string

Currency code

CurrencySymbol

string

Currency symbol

CarrierId

int?

Carrier ID

CarrierName

string

Carrier name

CarrierCode

string

Carrier code

ShippingTermsId

int?

Shipping terms ID

ShippingTermsName

string

Shipping terms name

ShipServiceId

int?

Shipping service ID

ShipServiceName

string

Shipping service name

ShipServiceCode

string

Shipping service code

ShippingTypeId

int?

Shipping type ID

ShippingTypeName

string

Shipping type name

ShippingNotes

string

Shipping notes

ShippingCost

double?

Shipping cost

ShippingTaxCodeId

int?

Shipping tax code ID

ShippingTaxCodeName

string

Shipping tax code name

ShippingAmount

double?

Shipping amount

AmountToPay

double

Amount to pay

DiscountToUse

double

Discount to use

DiscountAccntId

string

Discount account ID

DiscountAccntName

string

Discount account name

OldTxnDate

DateTime

Old transaction date

ShippingCostCredited

double?

Credited shipping cost

MatchedFlag

bool

Matched flag

TaxSummaryDataText

string

Tax summary data text

ReportingDataText

string

Reporting data text

OpeningBalanceFlag

bool

Opening balance flag

SoId

long?

Sales order ID

SoNumber

string

Sales order number

PortalAccountNumber

string

Portal account number

CounterNumber

string

Counter number

SysLockFlag

bool

System lock flag

UnPostTranFlag

bool

Unposted transaction flag

ItemIncomeAccountName

string

Item income account name

ItemIncomeAccountId

string

Item income account ID

EmailedFlag

bool

Emailed flag

LastEmailDttm

DateTime?

Last email date and time

ProjectClassId

int?

Project class ID

ProjectClassName

string

Project class name

ShippingTaxItems

List

List of shipping tax items

ThirdPartyRefNo

string

Third party reference number

ThirdPartySource

string

Third party source

ShipmentId

long?

Shipment ID

ShippingCostCarrier

double?

Carrier shipping cost

CustomerEmailMain

string

Customer main email

CustomerDefaultBillingEmail

string

Customer default billing email

CustomerDefaultShipmentEmail

string

Customer default shipment email

CustomerMainPhone

string

Customer main phone number

TrackingNumbers

string

Tracking numbers

ThirdPartyDisplayName

string

Third party display name

ThirdPartyIconUrl

string

Third party icon URL

ShippingTaxData

TaxData

Shipping tax data

ShippingTaxDataSerialized

string

Serialized shipping tax data

ShippingAccountNumber

string

Shipping account number

TaxCalcByAddress

bool

Tax calculation by address flag

TaxCalcByAddressDisable

bool

Disable tax calculation by address flag

TaxCalcType

string

Tax calculation type

ErrorOnTaxMismatch

bool

Error on tax mismatch flag

ThirdPartyTotalTaxAmount

double?

Third party total tax amount

ThirdPartyTotalAmount

double?

Third party total amount

NoTaxCompareFlag

bool

No tax compare flag

TotalQty

double

Total quantity

CustomerParentId

int?

Customer parent ID

SubTotalExclDiscount

double

Subtotal excluding discount

DiscountAmount

double

Discount amount

SubTotal

double

Subtotal

BillToAddr2

string

Billing address line 2

ShipToAddr2

string

Shipping address line 2

AutoCreateCarrierFlag

bool

Auto-create carrier flag

ReCalcTaxesFlag

bool

Recalculate taxes flag

ReCalcShippingTaxesFlag

bool

Recalculate shipping taxes flag

DocumentUrl

string

Document URL

ShipToFirstName

string

Shipping first name

ShipToLastName

string

Shipping last name

ShipToName

string

Shipping name

PaymentEmailSentFlag

bool

Payment email sent flag

PaymentEmailSentCount

int

Payment email sent count

LastPaymentEmailSentSource

string

Last payment email sent source

LastPaymentEmailSentDttm

DateTime?

Last payment email sent date and time

ShipToCompanyName

string

Shipping company name

ShipToPhoneNumber

string

Shipping phone number

ShipToEmail

string

Shipping email

ShipToAddrName

string

Shipping address name

BillToFirstName

string

Billing first name

BillToLastName

string

Billing last name

RiskAnalysis

string

Risk analysis

BillToName

string

Billing name

BillToCompanyName

string

Billing company name

BillToPhoneNumber

string

Billing phone number

BillToEmail

string

Billing email

BillToAddrName

string

Billing address name

TaxOperationCountryCode

string

Tax operation country code

FullPaymentDate

DateTime?

Full payment date

Tags

string

Tags

TotalPaidAmount

double

Total paid amount

CustomerEmailCC

string

Customer email CC

CustomerFirstName

string

Customer first name

CustomerLastName

string

Customer last name

SoToInvoice

bool

Sales order to invoice flag

UseDefaultSKUWhenError

bool

Use default SKU when error flag

ThirdPartyDefaultSKU

string

Third party default SKU

ExchangeRateFormula

string

Exchange rate formula

SoSubTypeId

int?

Sales order sub-type ID

LastOverdueEmailDttm

DateTime?

Last overdue email date and time

WaveNumbers

string

Wave numbers

BrandId

int?

Brand ID

BrandName

string

Brand name

BuyerId

int?

Buyer ID

BuyerName

string

Buyer name

MetaData

string

Metadata

ShipFromAddrName

string

Ship from address name

ShipFromFirstName

string

Ship from first name

ShipFromLastName

string

Ship from last name

ShipFromName

string

Ship from name

ShipFromCompanyName

string

Ship from company name

ShipFromAddr

string

Ship from address

ShipFromAddr2

string

Ship from address line 2

ShipFromCity

string

Ship from city

ShipFromState

string

Ship from state

ShipFromStateAbbr

string

Ship from state abbreviation

ShipFromZpCode

string

Ship from ZIP code

ShipFromCountry

string

Ship from country

ShipFromCountryISO2

string

Ship from country ISO2 code

ShipFromPhoneNumber

string

Ship from phone number

ShipFromEmail

string

Ship from email

DueDays

int?

Due days

DiscountDays

int?

Discount days

DiscountPercentage

double?

Discount percentage

SaleStoreAddrName

string

Sale store address name

SaleStoreFirstName

string

Sale store first name

SaleStoreLastName

string

Sale store last name

SaleStoreCompanyName

string

Sale store company name

SaleStoreAddr

string

Sale store address

SaleStoreAddr2

string

Sale store address line 2

SaleStoreCity

string

Sale store city

SaleStoreState

string

Sale store state

SaleStoreStateAbbr

string

Sale store state abbreviation

SaleStoreZpCode

string

Sale store ZIP code

SaleStoreCountry

string

Sale store country

SaleStoreCountryISO2

string

Sale store country ISO2 code

SaleStorePhoneNumber

string

Sale store phone number

SaleStoreEmail

string

Sale store email

UpdateEnable

bool

Update enable flag

AutoPaymentTotalAmount

string

Auto payment total amount

PaymentAmount

int

Payment amount

IsEdiFlag

bool

EDI flag

DueReminderEmailDate

DateTime?

Due reminder email date

DueReminderDays

string

Due reminder days

ThirdPartyInvoiceAlreadyExists

bool

Third party invoice already exists flag

ThirdPartyRefName

string

Third party reference name

ThirdPartyOrderDttm

DateTime?

Third party order date and time

ThirdPartyNotes

string

Third party notes

Sscc

string

SSCC

MasterBOLNumber

string

Master BOL number

BOLNumber

string

BOL number

MasterTrackingNumber

string

Master tracking number

TaxServiceRefNumber

string

Tax service reference number

TaxServiceHashCode

int

Tax service hash code

TaxServiceHashCodeOld

int

Old tax service hash code

EntityUseCode

string

Entity use code

NoTaxServiceRequestFlag

bool?

No tax service request flag

ShipmentRefNumber

string

Shipment reference number

ContainerRefNumber

string

Container reference number

MarkAsShipped

bool

Mark as shipped flag

TaxCalcCode

string

Tax calculation code

InvoiceBatchId

long?

Invoice batch ID

ShippingExpenseAccntId

string

Shipping expense account ID

ShippingExpenseAccntName

string

Shipping expense account name

CustomerTags

string

Customer tags

CustomerGroupName

string

Customer group name

CustomerParentName

string

Customer parent name

LinkedShippingBillId

long?

Linked shipping bill ID

IsShippingBillCreated

bool

Shipping bill created flag

CustomerAccountNumber

string

Customer account number

OrderTypeId

int?

Order type ID

DefaultBillingMethodTypeId

int?

Default billing method type ID

CustomerBillingMethodName

string

Customer billing method name

LastOverdueEmailSentDttm

DateTime?

Last overdue email sent date and time

JobScheduleRunFlag

bool

Job schedule run flag

JobScheduleReRunFlag

bool

Job schedule re-run flag

PackingSlipNumber

string

Packing slip number

DateOrder

DateTime?

Order date

DateToBeShipped

DateTime?

Date to be shipped

LadingQty

int?

Lading quantity

Weight

double?

Weight

WeightUomName

string

Weight unit of measure name

WeightUomCode

string

Weight unit of measure code

PaymentMethodTypeName

string

Payment method type name

PaymentMethodName

string

Payment method name

CardLast4Digit

string

Last 4 digits of the card

ChequeNo

string

Cheque number

PaymentRefNo

string

Payment reference number

PaymentRefNo2

string

Second payment reference number

EdiDocStatus

string

EDI document status

EdiDocRespMessage

string

EDI document response message

PaymentLinkCount

int

Payment link count

PermissionGroupId

int?

Permission group ID

DueReminderEmailSentDttm

DateTime?

Due reminder email sent date and time

RestrictDueInvoiceEmailFlag

bool

Restrict due invoice email flag

RestrictOverdueInvoiceEmailFlag

bool

Restrict overdue invoice email flag

IsFirstInvoice

bool

First invoice flag

ShipConfirmationEmailSent

bool

Ship confirmation email sent flag

ShipConfirmationEmailSentDttm

DateTime?

Ship confirmation email sent date and time

OrderTypeCode

string

Order type code

invoiceItemLine

Name
Data Type
Description

Id

long

Identifier for the invoice item line

TxnId

string

Transaction ID

TxnNumber

long

Transaction number

SoId

long?

Sales order ID

SoNumber

string

Sales order number

SoLineId

long?

Sales order line ID

InvoiceId

long

Invoice ID

ItemTypeId

int

Item type ID

ItemTypeName

string

Item type name

LineNumber

int

Line number

ItemId

long?

Item ID

ItemNumber

string

Item number

StatusId

int?

Status ID

Description

string

Description of the invoice item line

Qty

double?

Quantity

CreditQty

double?

Credit quantity

OldQty

double?

Previous quantity

QtyDecimalFlag

bool?

Flag indicating if quantity can have decimal values

BaseUomId

int?

Base unit of measure ID

SellUomId

int?

Selling unit of measure ID

UomFactor

double?

Conversion factor between base and selling units of measure

UnitPrice

double?

Unit price

Discount

double?

Discount

DiscountTypeId

int?

Discount type ID

EffectiveUnitPrice

double?

Effective unit price after discount

BaseUomName

string

Base unit of measure name

SellUomName

string

Selling unit of measure name

TotalAmount

double?

Total amount

TaxCodeId

int?

Tax code ID

TaxCodeName

string

Tax code name

TaxAmount

double?

Tax amount

IsTaxableFlag

bool

Flag indicating if the item is taxable

CreateDttm

DateTime

Creation date and time

CreateSource

string

Source of creation

ModifyDttm

DateTime?

Modification date and time

ModifySource

string

Source of modification

HasRestriction

bool?

Flag indicating if there is a restriction

RestrictionOverrideFlag

bool?

Flag indicating if restriction is overridden

RestrictionOverrideUser

string

User who overridden the restriction

RestrictionOverridePrice

double?

Overridden price for the restriction

DeleteFlag

bool

Flag indicating if the item is marked for deletion

EditState

bool

State indicating if the item is in edit mode

ProjectClassId

int?

Project class ID

ProjectClassName

string

Project class name

InventoryLocChangeList

List

List of inventory location changes

DiscountTypeName

string

Discount type name

TaxItems

List

List of tax items

ThirdPartyRefNo

string

Third-party reference number

ThirdPartySource

string

Third-party source

TaxData

TaxData

Tax data

TaxDataJson

string

Tax data in JSON format

IsoCode2

string

ISO country code (2 characters)

IsoCountryName

string

ISO country name

VASItemId

int?

Value-added service (VAS) item ID

VASItemName

string

VAS item name

VASItemCost

double?

VAS item cost

MetaData

string

Metadata associated with the item

ExternalItemNumber

string

External item number

ForceSalesTaxCode

bool

Flag indicating if sales tax code is forced

OldSellUomId

int?

Old selling unit of measure ID

OldUomFactor

double?

Old unit of measure factor

BaseQtyOrdered

double?

Base quantity ordered

BaseQtyShipped

double?

Base quantity shipped

OldBaseQtyShipped

double?

Old base quantity shipped

BaseQtyRemainingToShip

double?

Base quantity remaining to be shipped

BaseUomCode

string

Base unit of measure code

SellUomCode

string

Selling unit of measure code

ItemForceSalesTaxCodeId

int?

Item force sales tax code ID

ItemForceSalesTaxCodeName

string

Item force sales tax code name

DefaultSellUomId

long

Default selling unit of measure ID

MatchFlag

bool

Flag indicating if the item is matched

DiscountPerQty

double?

Discount per quantity

DiscountPercentage

double?

Discount percentage

CustomerItemNumber

string

Customer item number

Title

string

Title of the item

TrackingBySerialNumberFlag

bool

Flag indicating if the item is tracked by serial number

ItemUpc

string

Item UPC (Universal Product Code)

VASTaxableFlag

bool

Flag indicating if the VAS item is taxable

VASDiscountableFlag

bool

Flag indicating if the VAS item is discountable

VASItemCostTotal

double?

Total cost of VAS items

SellPkgQty

double?

Selling package quantity

TaxCategoryCode

string

Tax category code

HSCode

string

Harmonized System (HS) code

IsBomItemFlag

bool

Flag indicating if the item is a bill of materials (BOM) item

IsDropshipFlag

bool

Flag indicating if the item is drop-shipped

ReceiptId

long?

Receipt ID

ReceiptLineId

long?

Receipt line ID

ReceiptNumber

string

Receipt number

ReceiptQty

double?

Quantity received in the receipt

TaxStateMappingProfileId

int?

Tax state mapping profile ID

ThirdPartyRefNo2

string

Second third-party reference number

QtyRemainingToCredit

double

Quantity remaining to be credited

IsProducibleFlag

bool

Flag indicating if the item is producible

InventoryLocationChange:

Name
Data Type
Description

StoreId

int

Identifier for the store

StoreName

string

Name of the store

LocationId

long

Identifier for the location

LocationOnHand

double

Quantity on hand at the location

LocationName

string

Name of the location

RefLineId

long

Identifier for the reference line

ItemId

long

Identifier for the item

ItemNumber

string

Number of the item

DeltaQty

double

Change in quantity

DeltaBaseQty

double

Difference between new and old quantity

OpCodeId

int?

Identifier for the operation code

LpnId

long?

Identifier for the LPN (License Plate Number)

LpnNumber

string

Number of the LPN

UomFactor

double

Unit of measure factor

BaseUomId

int?

Identifier for the base unit of measure

EffectiveUomId

int?

Identifier for the effective unit of measure

BaseUomName

string

Name of the base unit of measure

EffectiveUomName

string

Name of the effective unit of measure

LotNumber

string

Lot number associated with the item

MfgDate

DateTime?

Manufacturing date of the item

ExpDate

DateTime?

Expiry date of the item

BatchNumber

string

Batch number associated with the item

AutoGenerateLpnFlag

bool

Flag indicating whether LPN should be generated

ItemQualityId

long

Identifier for the item quality

OrderTaxItem:

Name
Data Type
Description

Id

int

Identifier for the tax item

Name

string

Name of the tax item

TotalAmount

double

Total amount of the tax item

Rate

double

Rate of the tax item

RateType

string

Type of the tax rate

TaxData.TaxItem:

Name
Data Type
Description

itemId

int

Identifier for the item associated with tax

itemName

string

Name of the item associated with tax

itemAmount

double

Amount related to the item

lineAmount

double

Amount related to the line

itemRatePerc

double

Rate percentage of the item

Last updated