Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-receipt-batch-entries-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Vista Purchase Order v2 Direct Receipt Batch Entries API
description: For assistance, please visit our Customer Support page.
contact:
name: Customer Support
version: '2'
x-logo:
url: https://cdn.brandfolder.io/IH4HLZST/at/pwwq8z7wf64v8jxbtrgnpwqr/TrimbleR-Horiz-RGB-Blue.png
altText: Trimble logo
servers:
- url: https://{apiHost}/connect/v1/
description: App Xchange API (choose region)
variables:
apiHost:
default: api.xchange.trimble.com
description: Regional API hostname. Application keys and subscriber codes are environment-specific.
enum:
- api.xchange.trimble.com
- api-ap-au.xchange.trimble.com
security:
- {}
tags:
- name: Receipt Batch Entries
paths:
/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache:
get:
tags:
- Receipt Batch Entries
summary: Gets all Receipt Batch Entries objects from the cache
description: 'Represents data found in Vista™ PO Receipts program.
Vista view: PORB'
operationId: GET/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache
parameters:
- $ref: '#/components/parameters/subscriber_code'
- $ref: '#/components/parameters/X-Application-Key'
- $ref: '#/components/parameters/limit_continuation'
- $ref: '#/components/parameters/modifiedUTCSince'
- $ref: '#/components/parameters/continuationToken'
responses:
'200':
description: Success
content:
application/json:
schema:
required:
- limit
- data
- next
- continuationToken
type: object
properties:
limit:
type: integer
data:
type: array
items:
$ref: '#/components/schemas/data_receipt_bat_entries_withKeys'
next:
type: string
continuationToken:
type: string
'400':
$ref: '#/components/responses/errorResponse'
'401':
$ref: '#/components/responses/unauth'
'403':
$ref: '#/components/responses/forbidden'
x-operation-id-source: normalized
x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache
/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/search:
post:
tags:
- Receipt Batch Entries
summary: Search through Receipt Batch Entries objects in the data cache
description: 'Represents data found in Vista™ PO Receipts program.
Vista view: PORB'
operationId: POST/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/search/search
parameters:
- $ref: '#/components/parameters/subscriber_code'
- $ref: '#/components/parameters/X-Application-Key'
requestBody:
content:
application/json:
schema:
type: object
properties:
modifiedUtcAfter:
maxLength: 28
minLength: 28
type: string
description: '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.'
format: date-time
modifiedUtcBefore:
maxLength: 28
minLength: 28
type: string
description: '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.'
format: date-time
continuationToken:
type: string
description: 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.
filters:
type: array
items:
oneOf:
- required:
- propertyName
- value
- operator
type: object
properties:
propertyName:
type: string
description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter. E.g. 'PONumber' or 'Sender.LastName'.
value:
type: integer
description: You must match the JSON type value to the propertyName JSON type. There is no type coercion.
operator:
enum:
- Equal
- GreaterThan
- GreaterThanOrEqual
- LessThan
- LessThanOrEqual
- NotEqual
type: string
additionalProperties: false
description: ''
- required:
- propertyName
- value
- operator
type: object
properties:
propertyName:
type: string
description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter. E.g. 'PONumber' or 'Sender.LastName'.
value:
type: string
description: You must match the JSON type value to the propertyName JSON type. There is no type coercion.
operator:
enum:
- Equal
- GreaterThan
- GreaterThanOrEqual
- LessThan
- LessThanOrEqual
- NotEqual
- Like
- EndsWith
- StartsWith
- Contains
type: string
additionalProperties: false
description: ''
- required:
- propertyName
- value
- operator
type: object
properties:
propertyName:
type: string
description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter. E.g. 'PONumber' or 'Sender.LastName'.
value:
type: boolean
description: You must match the JSON type value to the propertyName JSON type. There is no type coercion.
operator:
enum:
- Equal
- NotEqual
type: string
additionalProperties: false
description: ''
- required:
- propertyName
- value
- operator
type: object
properties:
propertyName:
type: string
description: Name of the property to apply the filter on. Nested properties are supported with a dot (.) delimiter. E.g. 'PONumber' or 'Sender.LastName'.
value:
type: array
items:
oneOf:
- type: string
- type: number
description: ' This oneOf option is to be used for null values for all data types. You must match the JSON type value to the propertyName JSON type. There is no type coercion.'
operator:
enum:
- In
type: string
additionalProperties: false
description: ''
description: All provided filters are combined with AND conditions. E.g. filter1 AND filter2 AND filter3. Not providing a filter will result in an unfiltered result. Filtering can be performed on nested object properties but can not be performed on array item properties. 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.
additionalProperties: false
responses:
'200':
description: Success
content:
application/json:
schema:
required:
- count
- data
type: object
properties:
count:
type: integer
data:
type: array
items:
$ref: '#/components/schemas/data_receipt_bat_entries_withKeys'
continuationToken:
type: string
description: 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.
'400':
$ref: '#/components/responses/errorResponse'
'401':
$ref: '#/components/responses/unauth'
'403':
$ref: '#/components/responses/forbidden'
x-operation-id-source: normalized
x-operation-id-original: POST /direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/search/search
/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/{ryvitId_value}:
get:
tags:
- Receipt Batch Entries
summary: Gets one Receipt Batch Entries object from the cache
description: 'Represents data found in Vista™ PO Receipts program.
Vista view: PORB'
operationId: GET/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/{ryvitId_value}
parameters:
- $ref: '#/components/parameters/subscriber_code'
- $ref: '#/components/parameters/X-Application-Key'
- name: ryvitId_value
in: path
description: The code of the data object you want to get.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/data_receipt_bat_entries_withKeys'
'401':
$ref: '#/components/responses/unauth'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
x-operation-id-source: normalized
x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/{ryvitId_value}
/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/__ryvitId/{ryvitId_value}:
get:
tags:
- Receipt Batch Entries
summary: Gets one Receipt Batch Entries object from the cache
description: 'Represents data found in Vista™ PO Receipts program.
Vista view: PORB'
operationId: GET/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/__ryvitId/{ryvitId_value}
parameters:
- $ref: '#/components/parameters/subscriber_code'
- $ref: '#/components/parameters/X-Application-Key'
- name: ryvitId_value
in: path
description: The code of the data object you want to get.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/data_receipt_bat_entries_withKeys'
'401':
$ref: '#/components/responses/unauth'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
x-operation-id-source: normalized
x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/__ryvitId/{ryvitId_value}
/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/keyid/{KeyID}:
get:
tags:
- Receipt Batch Entries
summary: Gets one Receipt Batch Entries object from the cache
description: 'Represents data found in Vista™ PO Receipts program.
Vista view: PORB'
operationId: GET/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/keyid/{KeyID}
parameters:
- $ref: '#/components/parameters/subscriber_code'
- $ref: '#/components/parameters/X-Application-Key'
- name: KeyID
in: path
description: The KeyID portion of the key used to identify the object.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/data_receipt_bat_entries_withKeys'
'401':
$ref: '#/components/responses/unauth'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
x-operation-id-source: normalized
x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/keyid/{KeyID}
/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/natural/{Co}/{Mth}/{BatchId}/{BatchSeq}:
get:
tags:
- Receipt Batch Entries
summary: Gets one Receipt Batch Entries object from the cache
description: 'Represents data found in Vista™ PO Receipts program.
Vista view: PORB'
operationId: GET/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/natural/{Co,Mth,BatchId,BatchSeq}
parameters:
- $ref: '#/components/parameters/subscriber_code'
- $ref: '#/components/parameters/X-Application-Key'
- name: Co
in: path
description: The Co portion of the key used to identify the object.
required: true
schema:
type: string
- name: Mth
in: path
description: The Mth portion of the key used to identify the object.
required: true
schema:
type: string
- name: BatchId
in: path
description: The BatchId portion of the key used to identify the object.
required: true
schema:
type: string
- name: BatchSeq
in: path
description: The BatchSeq portion of the key used to identify the object.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/data_receipt_bat_entries_withKeys'
'401':
$ref: '#/components/responses/unauth'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
x-operation-id-source: normalized
x-operation-id-original: GET /direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/cache/natural/{Co,Mth,BatchId,BatchSeq}
/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/actions/add:
post:
tags:
- Receipt Batch Entries
summary: Executes the Add action for the Receipt Batch Entries data object
description: Adds a new PO Receipt Batch Entry to an existing PO Receipt Batch
operationId: POST/direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/actions/add
parameters:
- $ref: '#/components/parameters/subscriber_code'
- $ref: '#/components/parameters/X-Application-Key'
requestBody:
content:
application/json:
schema:
required:
- Co
- Mth
- BatchId
- PO
- POItem
- POItemLine
type: object
properties:
Co:
maximum: 255
minimum: 1
type: integer
description: Company. Key to po/receipt_batches(Co, Mth, BatchId).
Mth:
pattern: ^([0-9]{4})-(1[0-2]|0[1-9])-01$
type: string
description: 'Key to po/receipt_batches(Co, Mth, BatchId). Format: YYYY-MM-01.'
format: date
BatchId:
type: integer
description: Key to po/receipt_batches(Co, Mth, BatchId).
PO:
maxLength: 30
type: string
description: Key to po/po_headers(POCo, PO)
POItem:
type: integer
description: Key to po/po_items(POCo, PO, POItem)
POItemLine:
type: integer
description: Key to po/po_distributions(POCo, PO, POItem, POItemLine)
RecvdDate:
type: string
description: 'Format: YYY-MM-DD. Optional. If omitted, it will be defaulted to the current date.'
format: date
RecvdBy:
maxLength: 10
type:
- string
- 'null'
description: Person placing the order. Optional. If omitted, null will be defaulted.
Description:
maxLength: 30
type:
- string
- 'null'
description: Optional. If omitted, null will be defaulted.
Receiver#:
maxLength: 20
type:
- string
- 'null'
description: Receiver Number. Optional. If omitted, null will be defaulted.
RecvdUnits:
pattern: ^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$
type: string
description: Received Units. Optional. If omitted, 0 will be defaulted. If the UM for this PO Item is LS, you should omit this value or provide 0. Any value you provide will be ignored.
BOUnits:
pattern: ^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$
type: string
description: Backorder Units. Optional. If omitted, 0 will be defaulted. If the UM for this PO Item is LS, you should omit this value or provide 0. Any value you provide will be ignored.
RecvdCost:
pattern: ^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
type: string
description: Received Costs. Optional. If omitted, 0 will be defaulted. If the UM for this PO Item is not LS, you should omit this value or provide 0. Any value you provide will be ignored.
BOCost:
pattern: ^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
type: string
description: Backorder Costs. Optional. If omitted, 0 will be defaulted. If the UM for this PO Item is not LS, you should omit this value or provide 0. Any value you provide will be ignored.
Notes:
type:
- string
- 'null'
description: Optional. If not provided, null will be defaulted.
__custom_fields:
type: object
description: Add a property to this object for each user defined field to be set. Property name set to the user defined field name.
additionalProperties: false
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
id:
type: string
operation:
type: string
status:
type: string
'400':
$ref: '#/components/responses/errorResponse'
'401':
$ref: '#/components/responses/unauth'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/notFound'
x-$.result for Successful:
description: Object returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Successful"
content:
application/json:
schema:
required:
- Co
- Mth
- BatchId
- BatchSeq
- KeyID
type: object
properties:
Co:
type: integer
Mth:
type: string
BatchId:
type: integer
BatchSeq:
type: integer
KeyID:
type: integer
x-$.result for Failed:
description: Object returned at $.result from GET /direct/actions/{action_key_value} when $.status = "Failed"
content:
application/json:
schema:
required:
- code
- errors
type: object
properties:
code:
type: string
description: Well known codes listed in the examples properties. You must not fail to accept the error response if other codes are found as codes will be added over time.
user_defined_code:
type: string
description: When Code is User Defined, then this value provides details specific to this api.
errors:
minItems: 1
type: array
items:
required:
- text
type: object
properties:
text:
type: string
source:
type: array
items:
type: string
description: Array of a json path strings to the property(s) related to this error. (eg. $.Taxes.Amount)
details:
type: object
description: Properties will be added to this object to provide details specific to the error.
x-operation-id-source: normalized
x-operation-id-original: POST /direct/subscribers/{subscriber_code}/vista/po/2/data/receipt_bat_entries/actions/add
components:
parameters:
X-Application-Key:
name: X-Application-Key
in: header
description: Used to authorize access to the Direct API.
required: true
schema:
type: string
continuationToken:
name: continuationToken
in: query
description: A URL Encoded continuationToken value from a previous GET response. When provided, the next set of results for the original GET will be returned.
schema:
type: string
subscriber_code:
name: subscriber_code
in: path
description: The code of the subscriber that you are making this request for.
required: true
schema:
type: string
modifiedUTCSince:
name: modifiedUTCSince
in: query
description: A string specifies a datetime against which to filter the results. When specified the result will be ordered oldest __modifiedUTC to newest. Example 2019-12-11T20:16:58.3419275Z. Optional. If unspecified, all cached objects will be returned.
schema:
type: string
limit_continuation:
name: limit
in: query
description: Limits the number of records returned by the API, up to a maximum of 1,000. The API may return less than the limit even when more records exist. Always examine the 'next' and 'continuationToken' properties to determine if more records are available.
schema:
type: integer
responses:
errorResponse:
description: Describes issues with the request.
content:
application/json:
schema:
$ref: '#/components/schemas/errorSchema'
unauth:
description: You have not provided a proper X-Application-Key in the header of this request.
notFound:
description: The object with the given ID was not found OR a subscriber with the given URL was not found.
forbidden:
description: The X-Application-Key provided is valid but the key does not have access to this resource.
schemas:
data_receipt_bat_entries:
required:
- Co
- Mth
- BatchId
- BatchSeq
- BatchTransType
- PO
- POItem
- RecvdDate
- UnitCost
- RecvdUnits
- RecvdCost
- BOUnits
- BOCost
- InvdFlag
- KeyID
type: object
properties:
Co:
type: integer
description: ''
Mth:
type: string
description: ''
BatchId:
type: integer
description: ''
BatchSeq:
type: integer
description: ''
BatchTransType:
maxLength: 1
type: string
description: ''
POTrans:
type:
- integer
- 'null'
description: ''
PO:
maxLength: 30
type: string
description: ''
POItem:
type: integer
description: ''
RecvdDate:
type: string
description: ''
RecvdBy:
maxLength: 10
type:
- string
- 'null'
description: ''
Description:
maxLength: 30
type:
- string
- 'null'
description: ''
UnitCost:
pattern: ^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$
type: string
description: ''
ECM:
maxLength: 1
type:
- string
- 'null'
description: ''
RecvdUnits:
pattern: ^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$
type: string
description: ''
RecvdCost:
pattern: ^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
type: string
description: ''
BOUnits:
pattern: ^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$
type: string
description: ''
BOCost:
pattern: ^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
type: string
description: ''
OldPO:
maxLength: 30
type:
- string
- 'null'
description: ''
OldPOItem:
type:
- integer
- 'null'
description: ''
OldRecvdDate:
type:
- string
- 'null'
description: ''
OldRecvdBy:
maxLength: 10
type:
- string
- 'null'
description: ''
OldDesc:
maxLength: 30
type:
- string
- 'null'
description: ''
OldUnitCost:
pattern: ^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$
type:
- string
- 'null'
description: ''
OldECM:
maxLength: 1
type:
- string
- 'null'
description: ''
OldRecvdUnits:
pattern: ^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$
type:
- string
- 'null'
description: ''
OldRecvdCost:
pattern: ^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
type:
- string
- 'null'
description: ''
OldBOUnits:
pattern: ^[-+]?[0-9]{1,9}(?:.[0-9]{0,3})?$
type:
- string
- 'null'
description: ''
OldBOCost:
pattern: ^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$
type:
- string
- 'null'
description: ''
Receiver#:
maxLength: 20
type:
- string
- 'null'
description: ''
OldReceiver#:
maxLength: 20
type:
- string
- 'null'
description: ''
InvdFlag:
enum:
- Y
- N
type: string
description: ''
OldInvdFlag:
enum:
- Y
- N
- null
type:
- string
- 'null'
description: ''
Notes:
type:
- string
- 'null'
description: ''
UniqueAttchID:
maxLength: 36
minLength: 36
pattern: '[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}'
type:
- string
- 'null'
description: ''
KeyID:
type: integer
description: ''
APMth:
type:
- string
- 'null'
description: ''
APTrans:
type:
- integer
- 'null'
description: ''
APLine:
type:
- integer
- 'null'
description: ''
UIMth:
type:
- string
- 'null'
description: ''
UISeq:
type:
- integer
- 'null'
description: ''
UILine:
type:
- integer
- 'null'
description: ''
OldPOItemLine:
type:
- integer
- 'null'
description: ''
POItemLine:
type:
- integer
- 'null'
description: ''
__custom_fields:
type: object
description: This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.
errorSchema:
type: object
properties:
error:
type: object
properties:
message:
type: string
details:
type: array
items:
type: object
properties:
target:
title: Describes which field in the request has an issue.
type: string
message:
title: The error message describing the issue.
type: string
data_receipt_bat_entries_withKeys:
allOf:
- type: object
properties:
__ryvitKeys:
type: array
items:
type: string
description: Array of key paths that can be used to retrieve this object.
example:
- keyid/{KeyID}
__modifiedUTC:
type: string
description: UTC timestamp of when this object was last modified in the cache.
example: '2020-01-01T13:01:01.1234567Z'
- $ref: '#/components/schemas/data_receipt_bat_entries'