Sales order inbound APIs
A sales order functions as the seller’s official confirmation of the customer’s purchase. A sales order is an agreement outlining the goods or services to be delivered to the customer, confirming the terms of the sale.
- Transform Name:
- STD_MSDynamics_Business_Central_SalesOrder_IB
The following are the MS Dynamics Business Central ERP attributes that are mapped with the Canonical attributes and their output path.
| MS Dynamics Field Input Element | Mapped Canonical Path | Target Output Element | Mapping Rules | |
|---|---|---|---|---|
| @odata.context | Not mapped | Not mapped | – | |
| @odata.etag | Not mapped | Not mapped | – | |
| id | Not mapped | Not mapped | – | |
| number | data/messageBody/canonicalPurchaseOrderItemDetails/transactionReferenceIdentifierList
|
b2btransactionIdentifierValue | where b2bTransactionIdentifierType = PURCHASEORDER | |
| externalDocumentNumber | data/messageBody/canonicalPurchaseOrderItemDetails/transactionReferenceIdentifierList
|
b2btransactionIdentifierValue | where b2bTransactionIdentifierType = PURCHASEORDER | |
| orderDate | data/messageBody/canonicalPurchaseOrderHeader/transactionReferenceIdentifierList
|
transactionDate | where b2bTransactionIdentifierType = PURCHASEORDER | |
| postingDate | Not mapped | Not mapped | – | |
| customerId | Not mapped | Not mapped | Not mapped | |
| customerNumber | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/mpcCompanyLocationIdentifierList
|
companyIdentifierValue | where companyIdentifierType = COMPANYID | |
| customerName | Not mapped | Not mapped | – | |
| billToName | Required. data.messageBody/canonicalPurchaseOrderHeader/billToLocationInformation/companyLocationContactInformation
|
businessName | – | |
| billToCustomerId | Not mapped | Not mapped | Not mapped | |
| billToCustomerNumber | data/messageBody/canonicalPurchaseOrderHeader/billToBusinessInformation/mpcCompanyLocationIdentifierList
|
companyIdentifierValue | where companyIdentifierType = COMPANYID | |
| shipToName | Required. data/messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation
|
businessName | – | |
| shipToContact | data.messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation/companyLocationContactInformation/contactName
|
– | ||
| sellToAddressLine1 | Not mapped | Not mapped | – | |
| sellToAddressLine2 | Not mapped | Not mapped | – | |
| sellToCity | Not mapped | Not mapped | – | |
| sellToCountry | Not mapped | Not mapped | – | |
| sellToState | Not mapped | Not mapped | – | |
| sellToPostCode | Not mapped | Not mapped | – | |
| billToAddressLine1 | Required. data/messageBody/canonicalPurchaseOrderHeader/billToBusinessInformation/address |
billToAddressLine1 | – | |
| billToAddressLine2 | data/messageBody/canonicalPurchaseOrderHeader/billToBusinessInformation/address
|
billToAddressLine2 | – | |
| billToCity | Required. data/messageBody/canonicalPurchaseOrderHeader/billToBusinessInformation/address |
billToCity | – | |
| billToCountry | Required.data/messageBody/canonicalPurchaseOrderHeader/billToBusinessInformation/address
|
billToCountry | – | |
| billToState | Required.data/messageBody/canonicalPurchaseOrderHeader/billToBusinessInformation/address
|
billToState | – | |
| billToPostCode | data/messageBody/canonicalPurchaseOrderHeader/billToBusinessInformation/address
|
billToPostCode | – | |
| shipToAddressLine1 | data/messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation/address
|
shipToAddressLine1 | – | |
| shipToAddressLine2 | data/messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation/address
|
shipToAddressLine2 | – | |
| shipToCity | data/messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation/address
|
shipToCity | – | |
| shipToCountry | data/messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation/address
|
shipToCountry | – | |
| shipToState | data/messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation/address
|
shipToState | – | |
| shipToPostCode | data/messageBody/canonicalPurchaseOrderHeader/shipToLocationInformation/address
|
shipToPostCode | – | |
| shortcutDimension1Code | Not mapped | Not mapped | – | |
| shortcutDimension2Code | Not mapped | Not mapped | – | |
| currencyID | Not mapped | Not mapped | – | |
| currencyCode | data/messageBody/canonicalPurchaseOrderHeader/mpcCurrency
|
currencycode | – | |
| pricesIncludeTax | Not mapped | Not mapped | – | |
| paymentTermsId | Not mapped | Not mapped | – | |
| shipmentMethodId | Not mapped | Not mapped | – | |
| salesperson | Not mapped | Not mapped | – | |
| partialShipping | Not mapped | Not mapped | – | |
| requestedDeliveryDate | data/messageBody/canonicalPurchaseOrderHeader/mpcDates
data/messageBody/canonicalPurchaseOrderItemDetails/deliverySchedule
|
dateValue scheduleDateTime |
Where dateType = DELIVERYREQUSETED | |
| discountAmount | data/messageBody/canonicalPurchaseOrderHeader/creditsAndCharges |
creditChargeAmount | creditChargeType= DISCOUNT | |
| discountAppliedBeforeTax | Not mapped | Not mapped | – | |
| totalAmountExcludingTax | Not mapped | Not mapped | – | |
| totalTaxAmount | Not mapped | Not mapped | – | |
| totalAmountIncludingTax | Not mapped | Not mapped | – | |
| fullyShipped | Not mapped | Not mapped | – | |
| status | Not mapped | Not mapped | – | |
| lastModifiedDateTime | Not mapped | Not mapped | – | |
| phoneNumber | Not mapped | Not mapped | – | |
| Not mapped | Not mapped | – | ||
| customer | – | |||
| @odata.etag | Not mapped | Not mapped | – | |
| id | Not mapped | Not mapped | – | |
| number | Not mapped | Not mapped | – | |
| displayName | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/address
|
businessName | – | |
| type | Not mapped | Not mapped | – | |
| addressLine1 | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/address
|
address1 | – | |
| addressLine2 | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/address
|
address2 | – | |
| city | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/address
|
city | – | |
| state | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/address
|
state | – | |
| country | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/address
|
country | – | |
| postalCode | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/address
|
postalCode | – | |
| phoneNumber | data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/companyLocationContactInformation
|
contactPhone | – | |
data/messageBody/canonicalPurchaseOrderHeader/customerBusinessInformation/companyLocationContactInformation
|
contactEmail | – | ||
| website | Not mapped | Not mapped | – | |
| salespersonCode | Not mapped | Not mapped | – | |
| balanceDue | Not mapped | Not mapped | – | |
| creditLimit | Not mapped | Not mapped | – | |
| taxLiable | Not mapped | Not mapped | – | |
| taxAreaId | Not mapped | Not mapped | – | |
| taxAreaDisplayName | Not mapped | Not mapped | – | |
| taxRegistrationNumber | Not mapped | Not mapped | – | |
| currencyId | Not mapped | Not mapped | – | |
| currencyCode | Not mapped | Not mapped | – | |
| paymentTermsId | Not mapped | Not mapped | – | |
| shipmentMethodId | Not mapped | Not mapped | – | |
| paymentMethodId | Not mapped | Not mapped | – | |
| blocked | Not mapped | Not mapped | – | |
| lastModifiedDateTime | Not mapped | Not mapped | – | |
| dimensionValue | Not mapped | Not mapped | – | |
| currency | Not mapped | Not mapped | – | |
| paymentTerm | – | |||
| @odata.etag | Not mapped | Not mapped | – | |
| id | Not mapped | Not mapped | – | |
| code | data/messageBody/canonicalPurchaseOrderHeader/termsOfPayment
|
description | – | |
| displayName | Not mapped | Not mapped | – | |
| dueDateCalculation | Not mapped | Not mapped | – | |
| discountDateCalculation | Not mapped | Not mapped | – | |
| discountPercent | data/messageBody/canonicalPurchaseOrderHeader/termsOfPayment
|
termsOfPaymentPercent | – | |
| calculateDiscountOnCreditMemos | Not mapped | Not mapped | – | |
| lastModifiedDateTime | Not mapped | Not mapped | – | |
| shipmentMethod | – | |||
| dimensionSetLines | – | |||
| @odata.etag | Not mapped | Not mapped | – | |
| id | Not mapped | Not mapped | – | |
| code | Not mapped | Not mapped | – | |
| consolidationCode | Not mapped | Not mapped | – | |
| parentId | Not mapped | Not mapped | – | |
| parentType | Not mapped | Not mapped | – | |
| displayName | Not mapped | Not mapped | – | |
| valueId | Not mapped | Not mapped | – | |
| valueCode | Not mapped | Not mapped | – | |
| valueConsolidationCode | Not mapped | Not mapped | – | |
| valueDisplayName | Not mapped | Not mapped | – | |
| salesOrderLines | – | |||
| @odata.etag | Not mapped | Not mapped | – | |
| id | Not mapped | Not mapped | – | |
| documentId | Not mapped | Not mapped | – | |
| sequence | data/messageBody/canonicalPurchaseOrderItemDetails
|
lineItemNumber | – | |
| itemId | Not mapped | Not mapped | – | |
| accountId | Not mapped | Not mapped | – | |
| lineType | Not mapped | Item | Hard Code to Item | |
| lineObjectNumber | data/messageBody/canonicalPurchaseOrderItemDetails/productCodesIdentifiers
|
productCodeValue | where productCodeType=CUSTOMER | |
| description | data/messageBody/canonicalPurchaseOrderItemDetails/productItemInformation
|
productName | – | |
| description2 | Not mapped | Not mapped | – | |
| unitOfMeasureId | Not mapped | Not mapped | – | |
| unitOfMeasureCode | data/messageBody/canonicalPurchaseOrderItemDetails/itemQuantity
|
unitOfMeasure | Only Each and Case are allowed | |
| quantity | data/messageBody/canonicalPurchaseOrderItemDetails/itemQuantity
data/messageBody/canonicalPurchaseOrderItemDetails/deliverySchedule
|
quantityValue scheduledQuantity |
where quantity Type = ITEM | |
| unitPrice | data/messageBody/canonicalPurchaseOrderItemDetails/orderPricing |
pricingAmount | where pricingType=NET | |
| discountAmount | data/messageBody/canonicalPurchaseOrderItemDetails/creditsAndCharges
|
creditChargeAmount | creditChargeType= DISCOUNT | |
| discountPercent | data/messageBody/canonicalPurchaseOrderItemDetails/creditsAndCharges
|
creditChargePercentRate | creditChargeType= DISCOUNT | |
| discountAppliedBeforeTax | Not mapped | Not mapped | – | |
| amountExcludingTax | Not mapped | Not mapped | – | |
| taxCode | Not mapped | Not mapped | – | |
| taxPercent | Not mapped | Not mapped | – | |
| totalTaxAmount | Not mapped | Not mapped | – | |
| amountIncludingTax | Not mapped | Not mapped | – | |
| invoiceDiscountAllocation | Not mapped | Not mapped | – | |
| netAmount | data/messageBody/canonicalPurchaseOrderItemDetails/orderPricing
|
pricingAmount | where pricingType=NET | |
| netTaxAmount | Not mapped | Not mapped | – | |
| netAmountIncludingTax | Not mapped | Not mapped | – | |
| shipmentDate | Not mapped | Not mapped | – | |
| shippedQuantity | Not mapped | Not mapped | – | |
| invoicedQuantity | Not mapped | Not mapped | – | |
| invoiceQuantity | Not mapped | Not mapped | – | |
| shipQuantity | Not mapped | Not mapped | – | |
| itemVariantId | Not mapped | Not mapped | – | |
| locationId | Not mapped | Not mapped | – | |
| vendor | – | |||
| @odata.context | Not mapped | Not mapped | – | |
| id | data/messageBody/canonicalPurchaseOrderHeader/supplierBusinessInformation/mpcCompanyIdentiferList
|
companyIdentiferValue | where companyIdentifierType = COMPANYID | |
| systemVersion | Not mapped | Not mapped | – | |
| timestamp | Not mapped | Not mapped | – | |
| name | data/messageBody/canonicalPurchaseOrderHeader/supplierBusinessInformation
|
businessName | – | |
| displayName | Not mapped | Not mapped | – | |
| businessProfileId | Not mapped | Not mapped | – | |
| systemCreatedAt | Not mapped | Not mapped | – | |
| systemCreatedBy | Not mapped | Not mapped | – | |
| systemModifiedAt | Not mapped | Not mapped | – | |
| systemModifiedBy | Not mapped | Not mapped | – | |
