v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Release Retainage Batches

Search through Release Retainage Batches objects in the data cache

Represents Vista™ batches for "AP Release" source type batches.

Vista view: HQBC

post/direct/subscribers/{subscriber_code}/vista/ap/2/data/rel_retainage_batch/cache/search

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

modifiedUtcAfterstring date-time

Returns objects that were modified after the specified date (ISO 8601 format). Format: yyyy-MM-ddThh:mm:ss.fffffffZ. Example '2019-12-11T20:16:58.3419275Z'. If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.

modifiedUtcBeforestring date-time

Returns objects that were modified before the specified date (ISO 8601 format). Format: yyyy-MM-ddThh:mm:ss.fffffffZ. Example '2019-12-11T20:16:58.3419275Z'. If provided on the first call, the same value must be provided on all subsequent calls as you use the continuation token for the next result set.

continuationTokenstring

Supplying this token will result in retrieving the next chunk of data if the first request contained more than 100 (up to) records or greater than 1 megabyte in size. On your first call, you must omit or provide an empty string. On subsequent calls, provide the continuationToken from the previous result.

Response

Success

countinteger required

continuationTokenstring

Supply this token on the next request to get the next chunk of data. This will have a value if the result set contains more than 100 records or the set is greater than 1 megabyte.

Example response

{
  "data": [
    {
      "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
    }
  ]
}