List

About List

List operation retrieve instances of an entity. The result contains objects that match the request, including all fields. The data can be paginated, filtered and sorted.

Entities

Following objects can be retrieved using List API:

To see the object fields and properties, review the API description.

Example

Request

<API_URL_EndPoint>/List/<Object Name>.json

data={
   "nested": true,
   "start" : 0,
   "max" : 999,
   "filters" : [{"field":"", "op":"", "value":""}],
   "sort" : [{"field":"", "asc":}]
}

Pagination

Use start and max for pagination. The max number of records returned for each query is 999.

On the first return of 999 records, to ask for the next "page", set the values as follows and repeat as needed.

Example:

"start" : 999,
"max" : 999

Generally, smaller batches are more easily managed. For example, retrieve "start": 0, "max": 100, then "start": 100, "max": 100.

Sorting

Any field can be used as the sort field.

• To sort ascending, pass the field name and "asc": 1
• To sort descending, pass the field name and "asc": 0

Filter

To narrow results, you can filter by one or more expressions. If more than one expression is specified, the result includes objects that match all the expressions. Each filter is composed of three elements: field, operator, and value.

You can filter any field within an object, with one of these date types:

• ID (Nested object's IDs are not filtered)
• Enum
• Date
• DateTime (except = and != operations):
  

  Format (createdTime, updatedTime) is YYYY-MM-DDThh:mm:ss.sss±hhmm (ISO 8601 format with time offset from UTC).

  Note: If your request does not match the DateTime format above the response will only contain records for the date provided, time filtering will be ignored.

• Name (only = operation supported, can filter by exact match). Available for most objects (vendor, customer, department, etc) and it is case insensitive.

Filter can use the following operators:

Request

​<API_URL_EndPoint>/List/SentPay.json

data={
  "nested" : true,
  "start" : 0,
  "max" : 999,
  "filters" : [{
    "field":"updatedTime", 
    "op":">", 
    "value":"2016-11-16T02:02:00.000+0000"
  },
  {
    "field":"updatedTime", 
    "op":"<=", 
    "value":"2016-12-13T20:32:27.000+0000"
  }],
  "sort" : [{
    "field":"createdTime", 
    "asc":1
  }]
}

Response

{
  "response_status" : 0,
  "response_message" : "Success",
  "response_data" : [{
    "entity" : "SentPay",
    "id" : "stp01AUXGYKCBGFMaqlc",
    "processDate" : "2016-11-28",
    "amount" : 1212.00,
    "status" : "2",
    "description" : "Inv #2342",
    "txnNumber" : "CPZNYFRECCXRWGBYMAMQ",
    "name" : "P12092701 - 0501023",
    "vendorId" : "00901JBDVPAPJQQRffhd",
    "isOnline" : false,
    "paymentType" : "0",
    "chartOfAccountId" : "0ca01OUABGVXJKGT53j6",
    "syncReference" : "432",
    "toPrintCheck" : false,
    "billPays" : [{
      "entity" : "BillPay",
      "id" : "blp01AUXGYKCBGFMaqlc",
      "billId" : "00n01EBFFYCOCATMbno7",
      "name" : "P12092701 - 0501023",
      "paymentStatus" : "2",
      "amount" : 1212.00,
      "description" : "Inv #2342",
      "processDate" : "2016-11-28",
      "createdTime" : "2016-11-27T18:30:49.000+0000",
      "updatedTime" : "2016-11-27T18:30:56.000+0000",
      "paymentType" : "1",
      "syncReference" : "432",
      "toPrintCheck" : false,
      "chartOfAccountId" : "0ca01OUABGVXJKGT53j6"
    }],
    "billCredits" : []
  }, 
  {
    "entity" : "SentPay",
    "id" : "stp01GLKWXANTNVPaxi2",
    "processDate" : "2016-11-29",
    "amount" : 608.00,
    "status" : "1",
    "description" : "Acct #234233-multiple invoices",
    "txnNumber" : "QQKRHUULUXRMWNYDNJJT",
    "name" : "P12102601 - 0509339",
    "vendorId" : "00901NILRMWHLVFXffha",
    "isOnline" : true,
    "paymentType" : "0",
    "chartOfAccountId" : "0ca01NBHJBSCARHW53j4",
    "syncReference" : null,
    "toPrintCheck" : false,
    "billPays" : [{
      "entity" : "BillPay",
      "id" : "blp01ECRHZRYLBNRax0c",
      "billId" : "00n01JIURQVADATRbuky",
      "name" : "P12102601 - 0509339",
      "paymentStatus" : "1",
      "amount" : 110.00,
      "description" : "Acct #234233-multiple invoices",
      "processDate" : "2016-11-29",
      "createdTime" : "2016-11-26T22:16:03.000+0000",
      "updatedTime" : "2016-11-26T22:16:03.000+0000",
      "paymentType" : "0",
      "syncReference" : null,
      "toPrintCheck" : false,
      "chartOfAccountId" : "0ca01NBHJBSCARHW53j4"
    }],
    "billCredits" : [{
      "entity" : "BillCredit",
      "id" : "bcr01CRJPQLYJBERXc6x",
      "billId" : "00n01JIURQVADATRbuky",
      "sentPayId" : "stp01GLKWXANTNVPaxi2",
      "vendorCreditId" : "vcr01AMXYXTLMCXB2hle",
      "amount" : 1.00
    }, 
    {
      "entity" : "BillCredit",
      "id" : "bcr01CGOCYJJMMEFJc6y",
      "billId" : "00n01IBQBTHVMZFKbukz",
      "sentPayId" : "stp01GLKWXANTNVPaxi2",
      "vendorCreditId" : "vcr01WRPJYWWCKOP2hlf",
      "amount" : 2.00
    }]
  }]
}

Parameters

The data fields use the following parameters.