Read
2 min
To read Invoices, 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 Invoice. 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=readInvoice,
timestamp=1657006553277,
validRequest=true,
version=1.0,
responseJSON={
"currentPageRecords": null,
"totalRecords": 2,
"totalPages": 1,
"searchId": "WEBSERVICES_5333445_SB1_07052022850827757644992188_17adb3bb3",
"pageIndex": 1,
"errors": [
],
"customParamters": {
"where": {
"value": null,
"keyValueMap": {
"internalId": "94209,94308"
}
}
},
"status": "200""invoices": [
{
"undepFunds": null,
"tranId": "INV439",
"tranDate": 1642752000,
"total": 1.18,
"terms": null,
"taxTotal": 0.18,
"subTotal": 1.0,
"subsidiary": {
"type": null,
"name": "Atlanta",
"internalId": "20",
"externalId": null
},
"status": "Paid In Full",
"shippingCost": null,
"shippingAddress": null,
"salesRep": null,
"salesforceID": null,
"otherRefNum": null,
"nullFieldList": null,
"memo": "3",
"location": {
"type": null,
"name": "Testing",
"internalId": "14",
"externalId": null
},
"lastModifiedDate": 1645105569,
"itemList": {
"replaceAll": null,
"item": [
{
"unitsDisplay": null,
"taxRate1": "18.0",
"taxCode": {
"type": null,
"name": "VAT_IN:GST 18",
"internalId": "36",
"externalId": null
},
"tax1Amt": 0.18,
"shipMethod": null,
"shipGroup": null,
"serialNumbers": null,
"revRecStartDate": null,
"revRecSchedule": null,
"revRecEndDate": null,
"rate": "1.00",
"quantityRemaining": null,
"quantityReceived": null,
"quantityBilled": null,
"quantity": 1.0,
"price": null,
"poNum": null,
"orderLine": null,
"onHand": null,
"location": null,
"line": 1,
"jobName": null,
"itemReceive": null,
"itemName": null,
"itemIsFulfilled": null,
"item": {
"type": null,
"name": "Touch Pad Pro",
"internalId": "570",
"externalId": null
},
"grossAmt": 1.18,
"expectedReceiptDate": null,
"description": "linedesc",
"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
}
]
},
"createPo": null,
"costEstimateType": null,
"costEstimate": null,
"classification": null,
"amount": 1.0
}
]
},
"internalId": "94209",
"handlingCost": null,
"externalId": null,
"exchangeRate": 0.02,
"entity": {
"type": null,
"name": "CUST975AT Test Account62105",
"internalId": "72596",
"externalId": null
},
"dueDate": 1623567600,
"discountTotal": null,
"discountRate": null,
"discountItem": null,
"department": {
"type": null,
"name": "test",
"internalId": "3",
"externalId": 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": "SGD",
"internalId": "6",
"externalId": null
},
"currencyName": "SGD",
"createdFrom": null,
"createdDate": 1642770141,
"classification": {
"type": null,
"name": "Testing",
"internalId": "3",
"externalId": null
},
"billingAddress": {
"zip": "500081",
"state": "Telangana",
"internalId": "79380",
"country": "_india",
"city": "Hyderabad",
"attention": null,
"addrPhone": null,
"addressee": "Test Account62105",
"addr3": null,
"addr2": null,
"addr1": "Nehrunagar"
},
"account": {
"type": null,
"name": "Accounts Receivable",
"internalId": "122",
"externalId": null
}
},
{
"undepFunds": null,
"tranId": "INV440",
"tranDate": 1643011200,
"total": 1.18,
"terms": null,
"taxTotal": 0.18,
"subTotal": 1.0,
"subsidiary": {
"type": null,
"name": "Atlanta",
"internalId": "20",
"externalId": null
},
"status": "Pending Approval",
"shippingCost": null,
"shippingAddress": null,
"salesRep": null,
"salesforceID": null,
"otherRefNum": null,
"nullFieldList": null,
"memo": "3",
"location": {
"type": null,
"name": "Testing",
"internalId": "14",
"externalId": null
},
"lastModifiedDate": 1643008927,
"itemList": {
"replaceAll": null,
"item": [
{
"unitsDisplay": null,
"taxRate1": "18.0",
"taxCode": {
"type": null,
"name": "VAT_IN:GST 18",
"internalId": "36",
"externalId": null
},
"tax1Amt": 0.18,
"shipMethod": null,
"shipGroup": null,
"serialNumbers": null,
"revRecStartDate": null,
"revRecSchedule": null,
"revRecEndDate": null,
"rate": "1.00",
"quantityRemaining": null,
"quantityReceived": null,
"quantityBilled": null,
"quantity": 1.0,
"price": null,
"poNum": null,
"orderLine": null,
"onHand": null,
"location": null,
"line": 1,
"jobName": null,
"itemReceive": null,
"itemName": null,
"itemIsFulfilled": null,
"item": {
"type": null,
"name": "Touch Pad Pro",
"internalId": "570",
"externalId": null
},
"grossAmt": 1.18,
"expectedReceiptDate": null,
"description": "linedesc",
"department": null,
"customFieldList": {
"customField": [
{
"valueLookup": null,
"value": "false",
"scriptId": "custcol_checkbox",
"internalId": "443",
"fieldType": null
}
]
},
"createPo": null,
"costEstimateType": null,
"costEstimate": null,
"classification": null,
"amount": 1.0
}
]
},
"internalId": "94308",
"handlingCost": null,
"externalId": null,
"exchangeRate": 0.02,
"entity": {
"type": null,
"name": "CUST980AT Test Account62105",
"internalId": "72888",
"externalId": null
},
"dueDate": 1623567600,
"discountTotal": null,
"discountRate": null,
"discountItem": null,
"department": {
"type": null,
"name": "test",
"internalId": "3",
"externalId": 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": "SGD",
"internalId": "6",
"externalId": null
},
"currencyName": "SGD",
"createdFrom": null,
"createdDate": 1643008927,
"classification": {
"type": null,
"name": "Testing",
"internalId": "3",
"externalId": null
},
"billingAddress": {
"zip": "500081",
"state": "Telangana",
"internalId": "79672",
"country": "_india",
"city": "Hyderabad",
"attention": null,
"addrPhone": null,
"addressee": "Test Account62105",
"addr3": null,
"addr2": null,
"addr1": "Nehrunagar"
},
"account": {
"type": null,
"name": "Accounts Receivable",
"internalId": "122",
"externalId": null
}
}
],
},
}