Read
2 min
To read Sales Orders, please use the below parameters.
Supported “where” Filters
Field Name | Data Type | Description |
|---|---|---|
dateCreated | Long | This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates. |
internalId | String | Internal ID of the Sales Order. Multiple values can be passed in a comma-separated string. |
lastModifiedDate | Long | This will filter on an exact match (equal). Use the “additionalFilter” option for a range of dates. |
subsidiary | String | Internal ID of Subsidiary (Primary). Do Not Use this in additonalFilter. Multiple IDs can be passed in a comma-separated string Ex: 1,2 |
additonalFilter | String | construct the additional filter with a combination of the above fields using ‘+and+’ separator and pass it as a single string. Make sure to wrap the whole string using EncodingUtil.urlEncode |
tranDate | Long | Transaction date of the record. Use the “additionalFilter” option for a range of dates. |
customer | String | To filter the records based on the Customer. Multiple IDs can be passed in a comma-separated string Ex: 6,7 |
Example
{
action=readSalesOrder,
timestamp=1657005610951,
validRequest=true,
version=1.0,
responseJSON={
"currentPageRecords": null,
"totalRecords": 2,
"totalPages": 1,
"searchId": "WEBSERVICES_5333445_SB1_070520228517698711005783525_4375fd99",
"pageIndex": 1,
"errors": [
],
"customParamters": {
"where": {
"value": null,
"keyValueMap": {
"internalId": "61126,61127"
}
}
},
"status": "200""salesOrders": [
{
"tranId": "12320000000000153",
"tranDate": 1608796800,
"total": 82.6,
"terms": null,
"taxTotal": 12.6,
"subTotal": 70.0,
"subsidiary": {
"type": null,
"name": "Parent Company",
"internalId": "1",
"externalId": null
},
"status": "Pending Approval",
"startDate": null,
"shippingCost": null,
"shippingAddress": null,
"shipAddressList": null,
"salesRep": {
"type": null,
"name": "Navaneeth.D",
"internalId": "4",
"externalId": null
},
"salesforceID": null,
"salesEffectiveDate": 1608796800,
"otherRefNum": null,
"nullFieldList": null,
"memo": "Memo testinhg345",
"location": null,
"lastModifiedDate": 1634561084,
"itemList": {
"replaceAll": null,
"item": [
{
"unitsDisplay": null,
"taxRate1": "18.0",
"taxCode": {
"type": null,
"name": "VAT_IN:GST 18",
"internalId": "36",
"externalId": null
},
"tax1Amt": 12.6,
"shipMethod": null,
"shipGroup": null,
"serialNumbers": null,
"revRecStartDate": null,
"revRecSchedule": null,
"revRecEndDate": null,
"rate": "70.00",
"quantityRemaining": null,
"quantityReceived": null,
"quantityBilled": 0.0,
"quantity": 1.0,
"price": {
"type": null,
"name": "Base Price",
"internalId": "1",
"externalId": null
},
"poNum": null,
"orderLine": null,
"onHand": null,
"location": {
"type": null,
"name": "Hyderabad",
"internalId": "6",
"externalId": null
},
"line": 1,
"jobName": null,
"itemReceive": null,
"itemName": null,
"itemIsFulfilled": null,
"item": {
"type": null,
"name": "Apple",
"internalId": "444",
"externalId": null
},
"grossAmt": 82.6,
"expectedReceiptDate": null,
"description": "sales",
"department": null,
"customFieldList": {
"customField": [
{
"valueLookup": null,
"value": "false",
"scriptId": "custcol_checkbox",
"internalId": "443",
"fieldType": null
},
{
"valueLookup": null,
"value": "1",
"scriptId": "custcol_gh_line_no",
"internalId": "175",
"fieldType": null
},
{
"valueLookup": null,
"value": "12320000000000153_80009",
"scriptId": "custcol_gh_so_line_id",
"internalId": "200",
"fieldType": null
}
]
},
"createPo": null,
"costEstimateType": null,
"costEstimate": null,
"classification": null,
"amount": 70.0
}
]
},
"internalId": "61126",
"handlingCost": null,
"externalId": null,
"exchangeRate": 1.0,
"entity": {
"type": null,
"name": "CUST541AT Test Customer Deposits",
"internalId": "35144",
"externalId": null
},
"endDate": null,
"discountTotal": null,
"discountRate": null,
"discountItem": null,
"department": null,
"customForm": null,
"customFieldList": {
"customField": [
{
"valueLookup": null,
"value": " - ",
"scriptId": "custbody_breadwinner_pc_internal_id",
"internalId": "588",
"fieldType": null
},
{
"valueLookup": null,
"value": "false",
"scriptId": "custbody_checkbox",
"internalId": "272",
"fieldType": null
},
{
"valueLookup": null,
"value": "false",
"scriptId": "custbody_edoc_gen_trans_pdf",
"internalId": "925",
"fieldType": null
},
{
"valueLookup": null,
"value": "false",
"scriptId": "custbody_ei_ds_txn_identifier",
"internalId": "932",
"fieldType": null
}
]
},
"currencyRecord": {
"type": null,
"name": "INR",
"internalId": "1",
"externalId": null
},
"currencyName": "INR",
"createdFrom": null,
"createdDate": 1608797225,
"classification": null,
"billingAddress": null,
"billAddressList": null
},
{
"tranId": "12320000000000154",
"tranDate": 1608796800,
"total": 77.37,
"terms": null,
"taxTotal": 11.8,
"subTotal": 65.57,
"subsidiary": {
"type": null,
"name": "Parent Company",
"internalId": "1",
"externalId": null
},
"status": "Pending Approval",
"startDate": null,
"shippingCost": null,
"shippingAddress": null,
"shipAddressList": null,
"salesRep": {
"type": null,
"name": "Navaneeth.D",
"internalId": "4",
"externalId": null
},
"salesforceID": null,
"salesEffectiveDate": 1608796800,
"otherRefNum": null,
"nullFieldList": null,
"memo": "Memo testinhg345",
"location": null,
"lastModifiedDate": 1634561084,
"itemList": {
"replaceAll": null,
"item": [
{
"unitsDisplay": null,
"taxRate1": "18.0",
"taxCode": {
"type": null,
"name": "VAT_IN:GST 18",
"internalId": "36",
"externalId": null
},
"tax1Amt": 11.8,
"shipMethod": null,
"shipGroup": null,
"serialNumbers": null,
"revRecStartDate": null,
"revRecSchedule": null,
"revRecEndDate": null,
"rate": "65.56766557",
"quantityRemaining": null,
"quantityReceived": null,
"quantityBilled": 0.0,
"quantity": 1.0,
"price": {
"type": null,
"name": "Base Price",
"internalId": "1",
"externalId": null
},
"poNum": null,
"orderLine": null,
"onHand": null,
"location": null,
"line": 1,
"jobName": null,
"itemReceive": null,
"itemName": null,
"itemIsFulfilled": null,
"item": {
"type": null,
"name": "Bag",
"internalId": "34",
"externalId": null
},
"grossAmt": 77.37,
"expectedReceiptDate": null,
"description": "Blue color Bag<br>Made of Leather",
"department": null,
"customFieldList": {
"customField": [
{
"valueLookup": null,
"value": "false",
"scriptId": "custcol_checkbox",
"internalId": "443",
"fieldType": null
},
{
"valueLookup": null,
"value": "1",
"scriptId": "custcol_gh_line_no",
"internalId": "175",
"fieldType": null
},
{
"valueLookup": null,
"value": "12320000000000154_80014",
"scriptId": "custcol_gh_so_line_id",
"internalId": "200",
"fieldType": null
}
]
},
"createPo": "_dropShipment",
"costEstimateType": null,
"costEstimate": null,
"classification": null,
"amount": 65.57
}
]
},
"internalId": "61127",
"handlingCost": null,
"externalId": null,
"exchangeRate": 1.0,
"entity": {
"type": null,
"name": "CUST541AT Test Customer Deposits",
"internalId": "35144",
"externalId": null
},
"endDate": null,
"discountTotal": null,
"discountRate": null,
"discountItem": null,
"department": null,
"customForm": null,
"customFieldList": {
"customField": [
{
"valueLookup": null,
"value": " - ",
"scriptId": "custbody_breadwinner_pc_internal_id",
"internalId": "588",
"fieldType": null
},
{
"valueLookup": null,
"value": "false",
"scriptId": "custbody_checkbox",
"internalId": "272",
"fieldType": null
},
{
"valueLookup": null,
"value": "false",
"scriptId": "custbody_edoc_gen_trans_pdf",
"internalId": "925",
"fieldType": null
},
{
"valueLookup": null,
"value": "false",
"scriptId": "custbody_ei_ds_txn_identifier",
"internalId": "932",
"fieldType": null
}
]
},
"currencyRecord": {
"type": null,
"name": "INR",
"internalId": "1",
"externalId": null
},
"currencyName": "INR",
"createdFrom": null,
"createdDate": 1608797290,
"classification": null,
"billingAddress": null,
"billAddressList": null
}
],
},
}