AMCS Group RouteVisitJob API
The RouteVisitJob API from AMCS Group — 3 operation(s) for routevisitjob.
Work with this as data
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amcs-group-routevisitjob-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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 Specification
openapi: 3.2.0
info:
title: Core AccessGroup Route Visit Job API
version: core
servers:
- url: https://rstapi-sbx-svc-core.amcsplatform.com/erp/api/integrator/erp
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: RouteVisitJob
paths:
/transport/routeVisitJobs/changes:
get:
tags:
- RouteVisitJob
summary: Retrieve changes
description: '| Property | Description |
| ------------------------------------- | ----------------------------------------------------------------------------- |
| GUID| The GUID associated to the route visit job.|
| ActionListItem| The GUID and description associated to the action type.|
| RelatedRouteVisitGuid| The GUID related to the route visit.|
| MaterialListItem| The GUID and description associated to the material.|
| Quantity| The Quantity associated to the route visit job.|
| Weight| The Weight associated to the route visit job.|
| JobTimeStamp| The JobTimeStamp associated to the route visit job.|
| QuantityNotPlannedListItem| The GUID and description associated to the quantity not planned.|
| QuantityPlanned| The quantity planned associated to the route visit job.|
| DeferredRevenueAccountingPeriodListItem | The GUID and description associated to the deferred revenue accounting period.|'
operationId: RouteVisitJob_GetChanges
parameters:
- name: since
in: query
schema:
type: string
- name: cursor
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceChanges_ApiIntegratorRouteVisitJobResource'
/transport/routeVisitJobs/{guid}:
get:
tags:
- RouteVisitJob
summary: Find with GUID
description: '| Property | Description |
| ------------------------------------- | ----------------------------------------------------------------------------- |
| GUID| The GUID associated to the route visit job.|
| ActionListItem| The GUID and description associated to the action type.|
| RelatedRouteVisitGuid| The GUID related to the route visit.|
| MaterialListItem| The GUID and description associated to the material.|
| Quantity| The Quantity associated to the route visit job.|
| Weight| The Weight associated to the route visit job.|
| JobTimeStamp| The JobTimeStamp associated to the route visit job.|
| QuantityNotPlannedListItem| The GUID and description associated to the quantity not planned.|
| QuantityPlanned| The quantity planned associated to the route visit job.|
| DeferredRevenueAccountingPeriodListItem | The GUID and description associated to the deferred revenue accounting period.|'
operationId: RouteVisitJob_Get
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultEntity_ApiIntegratorRouteVisitJobResource'
put:
tags:
- RouteVisitJob
summary: Partial update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the route visit job.| No |
| RelatedRouteVisitGuid| The GUID related to the route visit.| Yes |
| MaterialListItem| The GUID and description associated to the material.| No |
| ContainerTypeListItem| The GUID and description associated to the container type.| No |
| Quantity| The Quantity associated to the route visit job.| No |
| Weight| The Weight associated to the route visit job.| No |
| JobTimeStamp| The JobTimeStamp associated to the route visit job.| No |
| QuantityNotPlannedListItem| The GUID and description associated to the quantity not planned.| No |
| QuantityPlanned| The quantity planned associated to the route visit job.| No |
| DeferredRevenueAccountingPeriodListItem | The GUID and description associated to the deferred revenue accounting period. | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If the DeferredRevenueAccountingPeriodListItem.Guid belongs to a closed accounting period | Accounting period is closed for this RouteVisitJob |
| If an update is made to a RouteVisitJob that is already exported | A record that is already included in GL export cannot be edited |'
operationId: RouteVisitJob_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorRouteVisitJobResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/transport/routeVisitJobs:
get:
tags:
- RouteVisitJob
summary: Find with Filters
description: '| Property | Description |
| ------------------------------------- | ----------------------------------------------------------------------------- |
| GUID| The GUID associated to the route visit job.|
| ActionListItem| The GUID and description associated to the action type.|
| RelatedRouteVisitGuid| The GUID related to the route visit.|
| MaterialListItem| The GUID and description associated to the material.|
| Quantity| The Quantity associated to the route visit job.|
| Weight| The Weight associated to the route visit job.|
| JobTimeStamp| The JobTimeStamp associated to the route visit job.|
| QuantityNotPlannedListItem| The GUID and description associated to the quantity not planned.|
| QuantityPlanned| The quantity planned associated to the route visit job.|
| DeferredRevenueAccountingPeriodListItem | The GUID and description associated to the deferred revenue accounting period.|'
operationId: RouteVisitJob_GetCollection
parameters:
- name: filter
in: query
schema:
type: string
- name: max
in: query
schema:
type: integer
format: int32
- name: page
in: query
schema:
type: integer
format: int32
- name: includeCount
in: query
schema:
type: boolean
- name: udf
in: query
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceResultCollection_ApiIntegratorRouteVisitJobResource'
post:
tags:
- RouteVisitJob
summary: Create or update
description: '| Property | Description | Required |
| ------------------------------------- | ----------------------------------------------------------------------------- | -------- |
| GUID| The GUID associated to the route visit job.| No |
| RelatedRouteVisitGuid| The GUID related to the route visit.| Yes |
| MaterialListItem| The GUID and description associated to the material.| No |
| ContainerTypeListItem| The GUID and description associated to the container type.| No |
| Quantity| The Quantity associated to the route visit job.| No |
| Weight| The Weight associated to the route visit job.| No |
| JobTimeStamp| The JobTimeStamp associated to the route visit job.| No |
| QuantityNotPlannedListItem| The GUID and description associated to the quantity not planned.| No |
| QuantityPlanned| The quantity planned associated to the route visit job.| No |
| DeferredRevenueAccountingPeriodListItem | The GUID and description associated to the deferred revenue accounting period. | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| If the DeferredRevenueAccountingPeriodListItem.Guid belongs to a closed accounting period | Accounting period is closed for this RouteVisitJob |'
operationId: RouteVisitJob_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorRouteVisitJobResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceResultEntityExtra:
type: object
properties:
expand:
type: object
additionalProperties:
type: object
additionalProperties:
type: object
include:
type: object
additionalProperties:
type: array
items:
type: object
additionalProperties:
type: object
ApiResourceResultCollection_ApiIntegratorRouteVisitJobResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorRouteVisitJobResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorRouteVisitJobResource:
type: object
properties:
MaterialListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ContainerTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
Quantity:
type: number
format: double
Weight:
type: number
format: double
JobTimeStamp:
type: string
format: zonedDateTime
example:
DateTime: '2000-01-01'
TimeZone: Europe/London
QuantityNotPlannedListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
QuantityPlanned:
type: number
format: double
DeferredRevenueAccountingPeriodListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
RelatedRouteVisitGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultEntity_ApiIntegratorRouteVisitJobResource:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorRouteVisitJobResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceChanges_ApiIntegratorRouteVisitJobResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorRouteVisitJobResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiResourceResultEntityLinks:
type: object
properties:
self:
type: string
associations:
type: array
items:
type: string
expand:
type: array
items:
type: string
operations:
type: array
items:
type: string
ApiResourceErrors:
type: object
properties:
errors:
type: string