An order entry document contains information about sales transactions.
Returns a collection with a key, ID, and link for each order entry document. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
OK
Bad Request
{- "ia::result": [
- {
- "key": "453",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "href": "/objects/order-entry/document::Sales%20Invoice/453"
}, - {
- "key": "442",
- "id": "Sales Order-SO0023",
- "href": "/objects/order-entry/document::Sales%20Order/442"
}, - {
- "key": "446",
- "id": "Sales Order-SO0024",
- "href": "/objects/order-entry/document::Sales%20Order/446"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Returns detailed information for a specified order entry document.
key required | string System-assigned key for the order entry document. |
OK
Bad Request
{- "ia::result": {
- "key": "453",
- "documentNumber": "SUBINV#0182#doc",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "sourceDocument": {
- "id": "Sales Order-SO0026",
- "key": "451",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "state": "pending",
- "transactionDate": "2023-03-29",
- "audit": {
- "createdDateTime": "2023-11-10T18:36:30Z",
- "createdBy": "1",
- "modifiedBy": "1",
- "modifiedDateTime": "2023-11-10T18:36:32Z"
}, - "dueDate": "2024-10-28",
- "documentType": "Sales Invoice",
- "txnDefinition": {
- "id": "Sales Invoice",
- "key": "188",
- "href": "/objects/order-entry-txn-definition::Sales%20Invoice/188"
}, - "contacts": {
- "primary": {
- "key": "304",
- "id": "Power Aerospace Materials(C1)"
}, - "shipTo": {
- "key": "304",
- "id": "Power Aerospace Materials(C1)"
}, - "billTo": {
- "key": "304",
- "id": "Power Aerospace Materials(C1)"
}
}, - "isPrinted": false,
- "isBackordered": false,
- "subTotal": "750.44",
- "total": "742.54",
- "txnCurrency": "USD",
- "exchangeRate": {
- "date": "2023-03-29",
- "rate": "1"
}, - "subtotalInTxnCurrency": "750.55",
- "totalInTxnCurrency": "742.5",
- "baseCurrency": "USD",
- "isSystemGeneratedDocument": false,
- "postingDate": "2023-03-29",
- "paymentStatus": "open",
- "customer": {
- "key": "1",
- "id": "1",
- "href": "/objects/accounts-receivable/customer/1"
}, - "lines": [
- {
- "id": "790",
- "key": "790",
- "documentHeader": {
- "key": "453",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document::Sales%20Invoice/453"
}, - "documentType": "Sales Invoice",
- "lineNumber": 0,
- "dimensions": {
- "item": {
- "key": "1",
- "id": "1--PC Computer",
- "name": "PC Computer",
- "href": "/objects/inventory-control/item/1"
}, - "warehouse": {
- "id": "1",
- "key": "1",
- "href": "/objects/inventory-control/warehouse/1"
}, - "location": {
- "id": "1",
- "key": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1--Power Aerospace Materials",
- "name": "Power Aerospace Materials",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "item": {
- "key": "1",
- "id": "1--PC Computer",
- "href": "/objects/inventory-control/item/1"
}, - "unit": "Each",
- "quantity": "1",
- "quantityConverted": "0",
- "retailPrice": "750",
- "price": "742.5",
- "audit": {
- "createdDateTime": "2023-03-29T00:00:00Z",
- "modifiedDateTime": "2023-11-10T18:36:30Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "status": "active",
- "costMethod": "standard",
- "unitQuantity": "1",
- "multiplier": 1,
- "unitPrice": "750",
- "txnCurrency": "USD",
- "baseCurrency": "USD",
- "priceInTxnCurrency": "750",
- "conversionType": "quantity",
- "allowDropship": false,
- "allowBuyToOrder": false,
- "quantityRemaining": "1",
- "trackingDetail": [ ],
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}
], - "history": [
- {
- "id": "382",
- "key": "382",
- "convertedTo": {
- "key": "453",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document::Sales%20Invoice/453"
}, - "convertedFrom": {
- "id": "Sales Order-SO0026",
- "key": "451",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "orderEntryDocument": {
- "key": "451",
- "id": "Sales Order-SO0026",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "href": "/objects/order-entry/document-history/382"
}, - {
- "id": "380",
- "key": "380",
- "convertedTo": {
- "key": "451",
- "id": "Sales Order-SO0026",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "orderEntryDocument": {
- "key": "451",
- "id": "Sales Order-SO0026",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "href": "/objects/order-entry/document-history/380"
}
], - "subtotals": [
- {
- "id": "1204",
- "key": "1204",
- "description": "Sales Discount",
- "absoluteValue": "0",
- "total": "0",
- "isValueEditable": false,
- "isPercentEditable": true,
- "dimensions": {
- "location": {
- "key": "1",
- "id": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1--Power Aerospace Materials",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "txnAbsoluteValue": "0",
- "txnTotal": "0",
- "documentLine": {
- "id": "790",
- "key": "790",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}, - "audit": {
- "createdDateTime": "2023-11-10T18:36:31Z",
- "modifiedDateTime": "2023-11-10T18:36:31Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/order-entry/document-subtotal/1204"
}, - {
- "id": "1205",
- "key": "1205",
- "description": "Discounted Totals",
- "absoluteValue": "7.5",
- "percentValue": "1",
- "total": "7.5",
- "isValueEditable": false,
- "isPercentEditable": true,
- "dimensions": {
- "location": {
- "key": "1",
- "id": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1--Power Aerospace Materials",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "txnAbsoluteValue": "7.5",
- "txnTotal": "-7.5",
- "documentLine": {
- "id": "790",
- "key": "790",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}, - "audit": {
- "createdDateTime": "2023-11-10T18:36:31Z",
- "modifiedDateTime": "2023-11-10T18:36:31Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/order-entry/document-subtotal/1205"
}, - {
- "id": "1206",
- "key": "1206",
- "description": "Sales Tax",
- "absoluteValue": "0",
- "total": "0",
- "isValueEditable": false,
- "isPercentEditable": true,
- "dimensions": {
- "location": {
- "key": "1",
- "id": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "txnAbsoluteValue": "0",
- "txnTotal": "0",
- "documentLine": {
- "id": "790",
- "key": "790",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}, - "audit": {
- "createdDateTime": "2023-11-10T18:36:31Z",
- "modifiedDateTime": "2023-11-10T18:36:31Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/order-entry/document-subtotal/1206"
}
], - "href": "/objects/order-entry/document::Sales%20Invoice/453"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns a collection with a key, ID, and link for each order entry document with the specified name. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.
documentName required | string Document name |
OK
Bad Request
{- "ia::result": [
- {
- "key": "171",
- "id": "Sales Invoice-SUBINV#0147#doc",
- "href": "/objects/order-entry/document::Sales%20Invoice/171"
}, - {
- "key": "172",
- "id": "Sales Invoice-SUBINV#0148#doc",
- "href": "/objects/order-entry/document::Sales%20Invoice/172"
}, - {
- "key": "155",
- "id": "Sales Invoice-SUBINV#0144#doc",
- "href": "/objects/order-entry/document::Sales%20Invoice/155"
}
], - "ia::meta": {
- "totalCount": 3,
- "start": 1,
- "pageSize": 100
}
}
Creates a new order entry document.
documentName required | string Document name |
transactionDate required | string <date> Date on the Order Entry document. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentNumber | string Document number for the Order Entry document. If the transaction definition does not have a numbering sequence configured, provide a number to identify the transaction. Example: "SI-O122" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Default: "draft" State of the Order Entry document. Example: "draft" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
baseCurrency | string Base currency for the transaction. Example: "USD" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
txnCurrency | string Currency used for the transaction. Example: "USD" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Exchange rate details used to calculate the base amount. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dueDate | string <date> Due date for the Order Entry document. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
postingDate | string <date> The date on which Order Entry document posts to the General Ledger. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
referenceNumber | string Reference number for the Order Entry document. Example: "SALES-100" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notes | string Notes about the Order Entry document. Example: "Fast order" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
memo | string Text printed on the Order Entry document. Example: "Lowry solutions" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contractID | string Sales contract ID associated with the transaction. Example: "CN100123" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contractDescription | string Sales contract description. Example: "Sales & Service" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoiceDate | string <date> Original invoice date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerPONumber | string Customer PO number associated with the transaction. Example: "ABOTT-1001" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trackingNumber | string User-provided tracking reference number. Example: "TK-1002" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipByDate | string <date> The ship-by date for the order. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shippedDate | string <date> The date that the order was shipped. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serviceDeliveryDate | string <date> The date on which the service is delivered. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cancelAfterDate | string <date> Indicates the date after which the order can be canceled. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
doNotShipBeforeDate | string <date> Do not ship before this date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
doNotShipAfterDate | string <date> Do not ship after this date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestedShippingDate | string <date> The date the customer requests the goods to arrive on their premises. The default is the due date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Contacts associated with the Order Entry document. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Shipping method for the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Transaction definition that is associated with this transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parent/Source document | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Customer associated with the Order Entry document. Example: "IBN" | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Contract associated with the Order Entry document. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The associated tax solution for the transaction. Tax solutions are available for different countries, for example Australia GST or South Africa VAT. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Lines of the Order Entry document. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Lines of the Order Entry document subtotal. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Lines of the Order Entry document history. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array |
Created
Bad Request
{- "customer": {
- "id": "1"
}, - "state": "submitted",
- "transactionDate": "2023-11-01",
- "dueDate": "2024-12-12",
- "txnCurrency": "USD",
- "baseCurrency": "USD",
- "lines": [
- {
- "dimensions": {
- "item": {
- "id": "1"
}, - "warehouse": {
- "id": "1"
}, - "location": {
- "id": "1"
}
}, - "unit": "Each",
- "unitQuantity": "1",
- "unitPrice": "650"
}
]
}
{- "ia::result": {
- "key": "13977",
- "id": "Sales Invoice-SUBINV#0193#doc",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document::Sales%20Invoice/469"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified order entry document.
key required | string System-assigned key for the order entry document. |
documentName required | string Document name |
OK
Bad Request
{- "ia::result": {
- "key": "453",
- "documentNumber": "SUBINV#0182#doc",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "sourceDocument": {
- "id": "Sales Order-SO0026",
- "key": "451",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales Order/451"
}, - "state": "pending",
- "transactionDate": "2023-03-29",
- "audit": {
- "createdDateTime": "2023-11-10T18:36:30Z",
- "createdBy": "1",
- "modifiedBy": "1",
- "modifiedDateTime": "2023-11-10T18:36:32Z"
}, - "dueDate": "2024-10-28",
- "documentType": "Sales Invoice",
- "txnDefinition": {
- "id": "Sales Invoice",
- "key": "188",
- "href": "/objects/order-entry-txn-definition::Sales%20Invoice/188"
}, - "contacts": {
- "primary": {
- "key": "304",
- "id": "Power Aerospace Materials(C1)"
}, - "shipTo": {
- "key": "304",
- "id": "Power Aerospace Materials(C1)"
}, - "billTo": {
- "key": "304",
- "id": "Power Aerospace Materials(C1)"
}
}, - "isPrinted": false,
- "isBackordered": false,
- "subTotal": "750.66",
- "total": "742.54",
- "txnCurrency": "USD",
- "exchangeRate": {
- "date": "2023-03-29",
- "rate": "1"
}, - "subtotalInTxnCurrency": "750.55",
- "totalInTxnCurrency": "742.5",
- "baseCurrency": "USD",
- "isSystemGeneratedDocument": false,
- "postingDate": "2023-03-29",
- "paymentStatus": "open",
- "customer": {
- "key": "1",
- "id": "1",
- "href": "/objects/accounts-receivable/customer/1"
}, - "lines": [
- {
- "id": "790",
- "key": "790",
- "documentHeader": {
- "key": "453",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document::Sales%20Invoice/453"
}, - "documentType": "Sales Invoice",
- "lineNumber": 0,
- "dimensions": {
- "item": {
- "key": "1",
- "id": "1--PC Computer",
- "name": "PC Computer",
- "href": "/objects/inventory-control/item/1"
}, - "warehouse": {
- "id": "1",
- "key": "1",
- "href": "/objects/inventory-control/warehouse/1"
}, - "location": {
- "id": "1",
- "key": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1--Power Aerospace Materials",
- "name": "Power Aerospace Materials",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "item": {
- "key": "1",
- "id": "1--PC Computer",
- "href": "/objects/inventory-control/item/1"
}, - "unit": "Each",
- "quantity": "1",
- "quantityConverted": "0",
- "retailPrice": "750",
- "price": "742.5",
- "audit": {
- "createdDateTime": "2023-03-29T00:00:00Z",
- "modifiedDateTime": "2023-11-10T18:36:30Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "status": "active",
- "costMethod": "standard",
- "unitQuantity": "1",
- "multiplier": 1,
- "unitPrice": "750",
- "txnCurrency": "USD",
- "baseCurrency": "USD",
- "priceInTxnCurrency": "750",
- "conversionType": "quantity",
- "allowDropship": false,
- "allowBuyToOrder": false,
- "quantityRemaining": "1",
- "trackingDetail": [ ],
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}
], - "history": [
- {
- "id": "382",
- "key": "382",
- "convertedTo": {
- "key": "453",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document::Sales%20Invoice/453"
}, - "convertedFrom": {
- "id": "Sales Order-SO0026",
- "key": "451",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "orderEntryDocument": {
- "key": "451",
- "id": "Sales Order-SO0026",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "href": "/objects/order-entry/document-history/382"
}, - {
- "id": "380",
- "key": "380",
- "convertedTo": {
- "key": "451",
- "id": "Sales Order-SO0026",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "orderEntryDocument": {
- "key": "451",
- "id": "Sales Order-SO0026",
- "documentType": "Sales Order",
- "href": "/objects/order-entry/document::Sales%20Order/451"
}, - "href": "/objects/order-entry/document-history/380"
}
], - "subtotals": [
- {
- "id": "1204",
- "key": "1204",
- "description": "Sales Discount",
- "absoluteValue": "0",
- "total": "0",
- "isValueEditable": false,
- "isPercentEditable": true,
- "dimensions": {
- "location": {
- "key": "1",
- "id": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1--Power Aerospace Materials",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "txnAbsoluteValue": "0",
- "txnTotal": "0",
- "documentLine": {
- "id": "790",
- "key": "790",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}, - "audit": {
- "createdDateTime": "2023-11-10T18:36:31Z",
- "modifiedDateTime": "2023-11-10T18:36:31Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/order-entry/document-subtotal/1204"
}, - {
- "id": "1205",
- "key": "1205",
- "description": "Discounted Totals",
- "absoluteValue": "7.5",
- "percentValue": "1",
- "total": "7.5",
- "isValueEditable": false,
- "isPercentEditable": true,
- "dimensions": {
- "location": {
- "key": "1",
- "id": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1--Power Aerospace Materials",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "txnAbsoluteValue": "7.5",
- "txnTotal": "7.5",
- "documentLine": {
- "id": "790",
- "key": "790",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}, - "audit": {
- "createdDateTime": "2023-11-10T18:36:31Z",
- "modifiedDateTime": "2023-11-10T18:36:31Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/order-entry/document-subtotal/1205"
}, - {
- "id": "1206",
- "key": "1206",
- "description": "Sales Tax",
- "absoluteValue": "0",
- "total": "0",
- "isValueEditable": false,
- "isPercentEditable": true,
- "dimensions": {
- "location": {
- "key": "1",
- "id": "1",
- "href": "/objects/company-config/location/1"
}, - "customer": {
- "key": "1",
- "id": "1",
- "href": "/objects/accounts-receivable/customer/1"
}
}, - "txnAbsoluteValue": "0",
- "txnTotal": "0",
- "documentLine": {
- "id": "790",
- "key": "790",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document-line::Sales%20Invoice/790"
}, - "audit": {
- "createdDateTime": "2023-11-10T18:36:31Z",
- "modifiedDateTime": "2023-11-10T18:36:31Z",
- "createdBy": "1",
- "modifiedBy": "1"
}, - "href": "/objects/order-entry/document-subtotal/1206"
}
], - "href": "/objects/order-entry/document::Sales%20Invoice/453"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing order entry document by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the order entry document. |
documentName required | string Document name |
documentNumber | string Document number for the Order Entry document. If the transaction definition does not have a numbering sequence configured, provide a number to identify the transaction. Example: "SI-O122" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
state | string Default: "draft" State of the Order Entry document. Example: "draft" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
baseCurrency | string Base currency for the transaction. Example: "USD" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
txnCurrency | string Currency used for the transaction. Example: "USD" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Exchange rate details used to calculate the base amount. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transactionDate | string <date> Date on the Order Entry document. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dueDate | string <date> Due date for the Order Entry document. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
postingDate | string <date> The date on which Order Entry document posts to the General Ledger. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
referenceNumber | string Reference number for the Order Entry document. Example: "SALES-100" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notes | string Notes about the Order Entry document. Example: "Fast order" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
memo | string Text printed on the Order Entry document. Example: "Lowry solutions" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contractID | string Sales contract ID associated with the transaction. Example: "CN100123" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
contractDescription | string Sales contract description. Example: "Sales & Service" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoiceDate | string <date> Original invoice date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customerPONumber | string Customer PO number associated with the transaction. Example: "ABOTT-1001" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
trackingNumber | string User-provided tracking reference number. Example: "TK-1002" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipByDate | string <date> The ship-by date for the order. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shippedDate | string <date> The date that the order was shipped. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
serviceDeliveryDate | string <date> The date on which the service is delivered. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cancelAfterDate | string <date> Indicates the date after which the order can be canceled. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
doNotShipBeforeDate | string <date> Do not ship before this date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
doNotShipAfterDate | string <date> Do not ship after this date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
requestedShippingDate | string <date> The date the customer requests the goods to arrive on their premises. The default is the due date. Example: "2023-04-04" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Contacts associated with the Order Entry document. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Shipping method for the order. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Transaction definition that is associated with this transaction. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Parent/Source document | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Customer associated with the Order Entry document. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Contract associated with the Order Entry document. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object Accounts Receivable (AR) term, which determines the expiration date for quotes and the due date for invoices. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
object The associated tax solution for the transaction. Tax solutions are available for different countries, for example Australia GST or South Africa VAT. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Lines of the Order Entry document. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Lines of the Order Entry document subtotal. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array of objects Lines of the Order Entry document history. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array |
OK
Bad Request
{- "referenceNumber": "1012",
- "lines": [
- {
- "dimensions": {
- "item": {
- "key": "15"
}, - "warehouse": {
- "key": "4"
}, - "location": {
- "key": "6"
}
}, - "item": {
- "key": "15"
}, - "unit": "10 Pack"
}, - {
- "key": "22",
- "unitQuantity": "9",
- "price": "750"
}, - {
- "key": "59",
- "ia::operation": "delete"
}
]
}
{- "ia::result": {
- "key": "52",
- "id": "Sales Invoice-SUBINV#0182#doc",
- "documentType": "Sales Invoice",
- "href": "/objects/order-entry/document::Sales%20Invoice/52"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an order entry document.
key required | string System-assigned key for the order entry document. |
documentName required | string Document name |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "order-entry/document" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}