Key

SalesDocumentKey

N/A

N/A

The sales document key object that uniquely identifies a sales document.

Type

SalesDocumentType

N/A

Automatically set, based on the type of sales document being created.

Identifies the type of sales document. This property is read-only.

Date

dateTime

N/A

If not provided, defaults to system date.

The date of the sales document.

FreightAmount

MoneyAmount

N/A

0

The total freight amount for the sales document.

MiscellaneousAmount

MoneyAmount

N/A

0

The total miscellaneous amount for the sales document.

TaxAmount

MoneyAmount

N/A

If not provided, defaults to the sum of all the tax detail lines.

The total tax amount for the sales document.

TradeDiscount

MoneyPercentChoice

N/A

If not provided, defaults from customer.

The type and amount of the trade discount for the sales document. The trade discount amount can be a money amount or a percent.

DiscountAmount

MoneyAmount

N/A

0

The type and amount of the discount (markdown) for the sales document. The discount (markdown) amount can be a money amount or a percent.

CustomerName

string

64

If not provided, defaults from customer.

The full name of the customer on the sales document.

CustomerPONumber

string

20

Empty

The customer's purchase order number for the sales document.

UPSZone

string

3

Empty

The UPS zone for the ship to address on the sales document.

MasterNumber

int

N/A

0

The master number of the sales document. The value 0 indicates master numbers are not being tracked.

CommissionAmount

MoneyAmount

N/A

0

The total commission amount for the sales document.

ExchangeRate

decimal

N/A

N/A

The exchange rate of the sales document. Set this value only for multi-currency transactions. If there is triangulation and both rates are fixed, this is the originating to Euro fixed rate. Otherwise this is the variable rate.

ExchangeDate

dateTime

N/A

N/A

The exchange date associated with the exchange rate provided.

RequestedShipDate

dateTime

N/A

If not provided, defaults to the date of the sales document.

The date on which the items should be shipped.

Comment

string

500

Empty

The comment text associated with the sales document.

TaxExemptNumber1

string

25

If not provided, defaults from customer.

The tax exempt number for the customer.

TaxExemptNumber2

string

25

If not provided, defaults from customer.

The tax exempt number for the customer.

TaxRegistrationNumber

string

25

If not provided, defaults from customer.

The tax registration number for the customer.

FreightTaxBasis

SalesTaxBasis

N/A

If not provided, set based on the Freight Tax Basis Behavior option specified.

A tax option which will determine whether the freight amount on the sales document is taxable and where the tax schedule defaults from. Taxable will tax freight charges. Nontaxable will not tax freight charges. Based On Customers will use the tax schedule assigned to the customer's shipping address for calculating taxes on freight charges.

MiscellaneousTaxBasis

SalesTaxBasis

N/A

If not provided, set based on the Miscellaneous Tax Basis Behavior option specified.

A tax option which will determine whether the miscellaneous amount on the sales document is taxable and where the tax schedule defaults from. Taxable will tax miscellaneous charges. Nontaxable will not tax miscellaneous charges. Based On Customers will use the tax schedule assigned to the customer's shipping address for calculating taxes on miscellaneous charges.

FreightTaxAmount

MoneyAmount

N/A

The sum of the freight tax detail lines.

The tax amount for the FreightAmount property on the sales document. This property is read-only.

MiscellaneousTaxAmount

MoneyAmount

N/A

The sum of the miscellaneous tax detail lines.

The tax amount for the MiscellaneousAmount property on the sales document. This property is read-only.

Note

string

N/A

0

The note text on a sales document.

TransactionState

SalesTransactionState

N/A

N/A

Indicates whether the sales document was retrieved from the open table or the history table. This property is read-only.

TaxScheduleKey

TaxScheduleKey

N/A

Empty

The tax schedule key object that uniquely identifies the sales tax schedule used for the sales document. This property is read-only.

FreightTaxScheduleKey

TaxScheduleKey

N/A

Empty

The tax schedule key object that uniquely identifies the freight tax schedule used for the sales document.

MiscellaneousTax
ScheduleKey

TaxScheduleKey

N/A

Empty

The tax schedule key object that uniquely identifies the miscellaneous tax schedule used for the sales document.

LineTotalAmount

MoneyAmount

N/A

The sum of all sales document lines.

The subtotal amount of the sales document. This property is read-only.

TotalAmount

MoneyAmount

N/A

The sum of (LineTotalAmount + FreightAmount + MiscellaneousAmount + TaxAmount - TradeDiscountAmount).

The total document amount. This property is read-only.

CreatedBy

string

N/A

Set to the user ID of the subscriber who created the document.

The user who created the sales document. This property is read-only.

CreatedDate

dateTime

N/A

Set to the system date.

The date the sales document was created.

ModifiedDate

dateTime

N/A

Set to the system date.

The date the sales document was last modified. The value is in Coordinated Universal Time (UTC).

LastModifiedDate

dateTime

N/A

Set to the system date.

The date the sales document was last modified. The value is in Coordinated Universal Time (UTC).

CommissionBasedOn

CommissionBasedOn

N/A

Sales

Options which determine how to calculate sales amounts for commission' calculations. When set to Sales, commissions will be calculated as a percentage of the sale amount. When set to DocumentTotal commissions will be calculated as a percentage of the document total, including the sale amount, freight, taxes, and miscellaneous charges. This property is read-only.

CommissionSaleAmount

MoneyAmount

N/A

N/A

The sale amount used to calculate the commission. This property is read only.

ActualShipDate

dateTime

N/A

N/A

The last date a line item on the sales document was shipped. This property is read-only.

FulfillDate

dateTime

N/A

N/A

The last date that a line item quantity on the sales document was fulfilled. This property is read only.

QuoteDate

dateTime

N/A

N/A

The date of the quote. This property is read-only.

AuditTrailCode

string

N/A

N/A

The internally-assigned audit trail code that gets assigned when the transaction is posted. This property is read-only.

IsIntrastatDocument

boolean

N/A

N/A

Identifies the intrastat state of the sales document. This property is read-only.

IsVoided

boolean

N/A

N/A

Indicates whether the document has been voided. True indicates the document has not been voided. False indicates it has not been voided. This property is read-only.

Reference

string

30

Empty

The transaction comments that will be posted in the general ledger for the sales document.

ShipCompleteOnly

boolean

N/A

N/A

Indicates whether the customer is willing to accept partial shipments. True means they are unwilling to accept partial shipments. False means they are willing to accept partial shipments. This property is read-only.

FrontOfficeIntegrationId

string

50

Empty

The ID of the document in the front office application from which the sales document originated. This property is read-only.

IntegrationSource

int

N/A

0

The integration source from with the sales document originated. This property is read-only.

IntegrationId

string

50

Empty

The ID of the document from which the sales document originated. This property is read-only.

InvoiceDate

dateTime

N/A

N/A

The invoice date used when type is not invoice. This property is read-only.

BackorderDate

dateTime

N/A

N/A

The backorder date used when type is not backorder. This property is read-only.

ReturnDate

dateTime

N/A

N/A

The return date used when type is not return. This property is read-only.

OriginalSalesDocument
Key

SalesDocumentKey

OriginalSalesDocument
Type

string

DocumentTypeKey

SalesDocumentTypeKey

N/A

If not provided, is set based on the Default Document Type ID Behavior option specified.

The document type key object that uniquely identifies the document type of the sales document.

ShippingMethodKey

ShippingMethodKey

N/A

If not provided, defaults from customer.

The shipping method key object that uniquely identifies the shipping method to use for the sales document.

WarehouseKey

WarehouseKey

N/A

If not provided set based on the Default Warehouse Behavior option specified.

The warehouse key object that uniquely identifies the default warehouse from which items will be shipped.

CustomerKey

CustomerKey

N/A

N/A

The customer key object that uniquely identifies the customer for the sales document.

SalesTerritoryKey

SalesTerritoryKey

N/A

Empty

The sales territory key object that uniquely identifies the sales territory for the sales document.

SalespersonKey

SalespersonKey

N/A

Empty

The salesperson key object that uniquely identifies the salesperson for the sales document.

BatchKey

BatchKey

N/A

If not provided, will be set according to the Batch creation Behavior option selected.

The batch key object that uniquely identifies the batch to use for the sales document.

BillToAddressKey

CustomerAddressKey

N/A

Empty

The customer address key object that uniquely identifies the bill to address for the sales document.

ShipToAddressKey

CustomerAddressKey

N/A

Empty

The customer address key object that uniquely identifies the ship to address for the sales document.

PaymentTermsKey

PaymentTermsKey

N/A

If not provided, defaults from customer.

The payment terms key object that uniquely identifies the payment terms to use for the sales document.

CurrencyKey

CurrencyKey

N/A

Empty

The currency key object that uniquely identifies the currency for the sales document.

CommentKey

CommentKey

N/A

Empty

The comment key object that uniquely identifies a comment for the sales document.

PriceLevelKey

PriceLevelKey

N/A

Empty

The price level key object that uniquely identifies the default price level for the sales document.

ShipToAddress

BusinessAddress

N/A

If nothing is supplied, the default will be supplied from the customer address key. If any one of the following are supplied, the remaining that are not supplied will default to blank:

BusinessAddress.Name Address.Line1 Address.Line2 Address.Line3 Address.City Address.State Address.PostalCode Address.Country BusinessAddress.ContactPerson Address.Phone1 Address.Phone2 Address.Phone3 Address.Fax

The address details of the ship to address on the sales document.

UserDefined

SalesUserDefined

N/A

N/A

The user defined data on the sales document.

Commissions

ArrayOfSalesCommission

N/A

N/A

The collection of sales commissions associated with the sales document.

ProcessHolds

ArrayOfSalesProcessHold

N/A

N/A

The collection of process holds associated with the dales document.

Taxes

ArrayOfSalesDocument
Tax

N/A

N/A

The collection of sales tax details associated with the sales document.

FreightTaxes

ArrayOfSalesDocument
Tax

N/A

N/A

The collection of freight tax details associated with the sales document.

MiscellaneousTaxes

ArrayOfSalesDocument
Tax

N/A

N/A

The collection of miscellaneous tax details associated with the sales document.

TrackingNumbers

ArrayOfSalesTracking
Number

N/A

N/A

The collection of tracking numbers associated with the sales document.