AMCS Group Charge API
The Charge API from AMCS Group — 3 operation(s) for charge.
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:amcs-group-charge-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 Specification
openapi: 3.2.0
info:
title: AMCS Platform REST Charge API
description: '
# Overview
## Who Should Read this Document
This document contains a technical description of the AMCS Platform REST API. It is intended for:
· System integrators
· Customer IT team looking to integrate AMCS Platform with another system
· Third parties looking to integrate their system with AMCS Platform
## Document Scope
This document introduces the technical aspects of the AMCS Platform REST API. The purpose of this document is to provide readers with detail on how to:
· Access the REST API
· Make calls to the API to retrieve, append and update resources
· Retrieve the incremental changes to a collection
· Find more detail on the end points that are available from an environment. ## Summary
AMCS Platform REST API is designed to support the integration of AMCS Platform with other systems. With care and additional infrastructure, the REST API can be used to build functionality on top of Platform but that is not it’s primary purpose. The ‘changes since’ process provides the main means of performing an initial synchronisation of the AMCS Platform and another system, and then keeping them synchronised. Methods are also provided to create and update resources. # Integration Patterns and Tools
The AMCS Platform provides a number of tools that can be used to connect systems. Care should be taken to match the right tooling to the intended pattern of integration. · When an extract-based approach is needed, use BI reporting. · When derived values are require, use the data mart. · When business processes on different systems need to be integrated by synchronising the data on each through an event style interface, use the REST API. An integration using the REST API will need to take full responsibility for all aspects of the integration including:
· Pulling change events from AMCS Platform
· Filtering the changed resources for the ones that are of interest
· Pulling additional resources from the REST API in order the retrieve all the properties needed by the destination
· Mashing resources to create the complete view required
· Translating that into the form required by the destination
· Validating this to ensure it meet the entry rules of the destination
· Pushing the result to the destination
In the early stages of designing the interface care should be taken to ensure that the need for caching/staging has been considered. The changes since functionality is effectively a means of pulling create/change events from platform. The only filters available enable retrieval of related resources to build a view external to AMCS Platform
# Basics
The AMCS REST API provides a RESTful interface that allows access to the primary business resources of the AMCS platform. The interface follows general HATEOAS compliance principles. ## Quick start
A quickstart walkthrough based on node.js and covering authentication and getting a page of customers can be found here. ## Interface definitions
Swagger documentation for the end points available on an environment can be found at:
Before 8.5: https://{environment domain name}/swagger/ui/index
From 8.5: https://{environment domain name}/erp/api/swagger/ui/index
## HTTP Interface
The following HTTP RESTful methods are provided as part of this API:
· GET: Provides read access to retrieve details of one or more resources. · POST: Creates or updates a single resource or a set of resources. · PUT: Updates a single resource or a set of resources. Note:
· DELETE methods are currently not provided as part of the API. The REST API URIs begin with
https://{environment domain name}/erp/api/integrator/erp
For example:
https://prod.amcs-at-mycompany.com/erp/api/integrator/erp
This should be used as the base of the URI.'
version: latest
servers:
- url: https://ete-p5-tst-svc-core.amcsplatform.com/erp/api/integrator/erp
tags:
- name: Charge
paths:
/accounting/charges/changes:
get:
tags:
- Charge
summary: Retrieve changes
description: '| Property| Description |
| --------------------------------- |-------------------------------------------------------------------------------- |
| GUID| The Guid associated to the contact. Filterable |
| RelatedSiteOrderGuid| The related site order Guid. Filterable |
| RelatedJobGuid| The related Job Guid. Filterable |
| RelatedLiftEventGuid| The related Lift event Guid. Filterable |
| RelatedPriceGuid| The related Price Guid. Filterable |
| RelatedRouteVisitGuid| The related Route visit Guid. Filterable |
| RelatedRouteVisitJobGuid| The related Route visit job Guid. Filterable |
| RelatedWeighingInGuid| The related Weighing In Guid. Filterable |
| RelatedWeighingOutGuid| The related Weighing Out Guid. Filterable |
| RelatedPONumberGuid| The related PO Number Guid. Filterable |
| RelatedPriceModifierGuid| The related Price modifier Guid.Filterable |
| RelatedInvoiceGuid| The related Invoice Guid.Filterable |
| RelatedDepartmentGuid| The related Department Guid.Filterable |
| RelatedServiceGuid| The related Service Guid.Filterable |
| PONumber| The related PO Number. |
| Amount.IsEstimate | Is the Amount an Estimation. |
| Amount.Price| The price of the Amount. |
| Amount.PriceExVat | The Price not including the Vat. |
| Amount.Rate| The Rate of the Amount. |
| DoNotInvoice| If the charge has not been invoiced or not. |
| DoNotInvoiceReasonListItem | The Guid and Description associated to the Reason. |
| ActionListItem | The Guid and Description associated to the Action. |
| ActionGuidFilter | Used to filter the action guid associated to the charge. |
| ChargeDateTime | The date and time when the charge happened |
| ChargeStartDateFilter | Used to filter by the Start of ChargeDateTime |
| ChargeEndDateFilter | Used to filter by the End of ChargeDateTime |'
operationId: Charge_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_ApiIntegratorChargeResource'
/accounting/charges/{guid}:
get:
tags:
- Charge
summary: Find with GUID
description: '| Property| Description |
| --------------------------------- |-------------------------------------------------------------------------------- |
| GUID| The Guid associated to the contact. Filterable |
| RelatedSiteOrderGuid| The related site order Guid. Filterable |
| RelatedJobGuid| The related Job Guid. Filterable |
| RelatedLiftEventGuid| The related Lift event Guid. Filterable |
| RelatedPriceGuid| The related Price Guid. Filterable |
| RelatedRouteVisitGuid| The related Route visit Guid. Filterable |
| RelatedRouteVisitJobGuid| The related Route visit job Guid. Filterable |
| RelatedWeighingInGuid| The related Weighing In Guid. Filterable |
| RelatedWeighingOutGuid| The related Weighing Out Guid. Filterable |
| RelatedPONumberGuid| The related PO Number Guid. Filterable |
| RelatedPriceModifierGuid| The related Price modifier Guid.Filterable |
| RelatedInvoiceGuid| The related Invoice Guid.Filterable |
| RelatedDepartmentGuid| The related Department Guid.Filterable |
| RelatedServiceGuid| The related Service Guid.Filterable |
| PONumber| The related PO Number. |
| Amount.IsEstimate | Is the Amount an Estimation. |
| Amount.Price| The price of the Amount. |
| Amount.PriceExVat | The Price not including the Vat. |
| Amount.Rate| The Rate of the Amount. |
| DoNotInvoice| If the charge has not been invoiced or not. |
| DoNotInvoiceReasonListItem | The Guid and Description associated to the Reason. |
| ActionListItem | The Guid and Description associated to the Action. |
| ActionGuidFilter | Used to filter the action guid associated to the charge. |
| ChargeDateTime | The date and time when the charge happened |
| ChargeStartDateFilter | Used to filter by the Start of ChargeDateTime |
| ChargeEndDateFilter | Used to filter by the End of ChargeDateTime |'
operationId: Charge_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_ApiIntegratorChargeResource'
put:
tags:
- Charge
summary: Partial update
description: '| Property| Description | Required |
| --------------------------------- |--------------------------------------------------------------------- | -------- |
| GUID| The Guid associated to the contact. | Yes |
| RelatedSiteOrderGuid| The related site order Guid. | Yes |
| RelatedJobGuid| The related Job Guid. | No |
| RelatedLiftEventGuid| The related Lift event Guid. | No |
| RelatedPriceGuid| The related Price Guid. | No |
| RelatedRouteVisitGuid| The related Route visit Guid. | No |
| RelatedRouteVisitJobGuid| The related Route visit job Guid. | No |
| RelatedWeighingInGuid| The related Weighing In Guid. | No |
| RelatedWeighingOutGuid| The related Weighing Out Guid. | No |
| RelatedPONumberGuid| The related PO Number Guid. | No |
| RelatedPriceModifierGuid| The related Price modifier Guid. | No |
| RelatedInvoiceGuid| The related Invoice Guid. | No |
| RelatedDepartmentGuid| The related Department Guid. | No |
| RelatedServiceGuid| The related Service Guid. | No |
| PONumber| The related PO Number. | No |
| Amount.IsEstimate | Is the Amount an Estimation. | Yes |
| Amount.Price| The price of the Amount. | Yes |
| Amount.PriceExVat | The Price not including the Vat. | Yes |
| Amount.Rate| The Rate of the Amount. | Yes |
| DoNotInvoice| If the charge can be invoiced or not. | No |
| DoNotInvoiceReasonListItem | The Guid and Description associated to the reason for DoNotInvoice. | No |
| ActionListItem | The Guid and Description associated to the Action. | No |
| ActionGuidFilter | Used to filter the action guid associated to the charge. | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| RelatedSiteOrderGuid is being edited | RelatedSiteOrderGuid is a read-only property. |
| RelatedJobGuid is being edited | RelatedJobGuid is a read-only property. |
| RelatedLiftEventGuid is being edited | RelatedLiftEventGuid is a read-only property. |
| RelatedPriceGuid is being edited | RelatedPriceGuid is a read-only property. |
| RelatedRouteVisitGuid is being edited | RelatedRouteVisitGuid is a read-only property. |
| RelatedRouteVisitJobGuid is being edited | RelatedRouteVisitJobGuid is a read-only property. |
| RelatedWeighingInGuid is being edited | RelatedWeighingInGuid is a read-only property. |
| RelatedWeighingOutGuid is being edited | RelatedWeighingOutGuid is a read-only property. |
| RelatedPriceModifierGuid is being edited | RelatedPriceModifierGuid is a read-only property. |
| RelatedInvoiceGuid is being edited | RelatedInvoiceGuid is a read-only property. |
| RelatedDepartmentGuid is being edited | RelatedDepartmentGuid is a read-only property. |
| RelatedServiceGuid is being edited | RelatedServiceGuid is a read-only property. |
| ActionListItem.Guid is being edited | ActionListItem.Guid is a read-only property. |
| Amount.IsEstimate is being edited | Amount.IsEstimate is a read-only property. |
| Amount.Price is being edited | Amount.Price is a read-only property. |
| Amount.PriceExVat is being edited | Amount.PriceExVat is a read-only property. |
| Amount.Rate is being edited | Amount.Rate is a read-only property. |
| Amount was set null | Amount field is not editable and cannot be null |
| DoNotInvoiceReasonListItem is not in one of the following reason categories: DoNotInvoice | DoNotInvoiceReasonListItem must be in one of the following reason categories: DoNotInvoice. |
| DoNotInvoice was set to true and DoNotInvoiceReasonListItem was null | Charge with DoNotInvoiceReasonListItem cannot be null if DoNotInvoice is true. |
| DoNotInvoiceReasonListItem value was provided and DoNotInvoice was set to false | Charge with DoNotInvoice cannot be set if DoNotInvoiceReasonListItem has a value. |
| RelatedPONumberGuid supplied belongs to a deleted PONumber | Failed to save/update Charge because the supplied PONumber is not valid. The update has been rejected.'
operationId: Charge_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorChargeResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/accounting/charges:
get:
tags:
- Charge
summary: Find with Filters
description: '| Property| Description |
| --------------------------------- |-------------------------------------------------------------------------------- |
| GUID| The Guid associated to the contact. Filterable |
| RelatedSiteOrderGuid| The related site order Guid. Filterable |
| RelatedJobGuid| The related Job Guid. Filterable |
| RelatedLiftEventGuid| The related Lift event Guid. Filterable |
| RelatedPriceGuid| The related Price Guid. Filterable |
| RelatedRouteVisitGuid| The related Route visit Guid. Filterable |
| RelatedRouteVisitJobGuid| The related Route visit job Guid. Filterable |
| RelatedWeighingInGuid| The related Weighing In Guid. Filterable |
| RelatedWeighingOutGuid| The related Weighing Out Guid. Filterable |
| RelatedPONumberGuid| The related PO Number Guid. Filterable |
| RelatedPriceModifierGuid| The related Price modifier Guid.Filterable |
| RelatedInvoiceGuid| The related Invoice Guid.Filterable |
| RelatedDepartmentGuid| The related Department Guid.Filterable |
| RelatedServiceGuid| The related Service Guid.Filterable |
| PONumber| The related PO Number. |
| Amount.IsEstimate | Is the Amount an Estimation. |
| Amount.Price| The price of the Amount. |
| Amount.PriceExVat | The Price not including the Vat. |
| Amount.Rate| The Rate of the Amount. |
| DoNotInvoice| If the charge has not been invoiced or not. |
| DoNotInvoiceReasonListItem | The Guid and Description associated to the Reason. |
| ActionListItem | The Guid and Description associated to the Action. |
| ActionGuidFilter | Used to filter the action guid associated to the charge. |
| ChargeDateTime | The date and time when the charge happened |
| ChargeStartDateFilter | Used to filter by the Start of ChargeDateTime |
| ChargeEndDateFilter | Used to filter by the End of ChargeDateTime |'
operationId: Charge_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_ApiIntegratorChargeResource'
components:
schemas:
ApiResourceResultCollectionExtra:
type: object
properties:
count:
type: integer
format: int32
ApiIntegratorChargeAmountResource:
type: object
properties:
IsEstimate:
type: boolean
Price:
type: number
format: double
PriceExVat:
type: number
format: double
Rate:
type: number
format: double
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
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
ApiIntegratorChargeResource:
type: object
properties:
RelatedSiteOrderGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedJobGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedLiftEventGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedPriceGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedRouteVisitGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedRouteVisitJobGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedWeighingInGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedWeighingOutGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedPONumberGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedPriceModifierGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedInvoiceGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedDepartmentGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedServiceGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ActionListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
PONumber:
type: string
Amount:
$ref: '#/components/schemas/ApiIntegratorChargeAmountResource'
DoNotInvoice:
type: boolean
DoNotInvoiceReasonListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ActionGuidFilter:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ChargeDateTime:
type: string
format: dateTime
example: '2000-01-01 00:00:00.000'
ChargeStartDateFilter:
type: string
format: dateTime
example: '2000-01-01 00:00:00.000'
ChargeEndDateFilter:
type: string
format: dateTime
example: '2000-01-01 00:00:00.000'
RelatedOneOffActionGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
RelatedDefaultActionGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceResultEntity_ApiIntegratorChargeResource:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorChargeResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceChanges_ApiIntegratorChargeResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorChargeResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceResultUpdatesExtra:
type: object
properties:
until:
type: string
cursor:
type: string
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiResourceResultCollection_ApiIntegratorChargeResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorChargeResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'