AMCS Group Supplier API
The Supplier API from AMCS Group — 3 operation(s) for supplier.
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-supplier-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 Supplier 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: Supplier
paths:
/directory/suppliers/changes:
get:
tags:
- Supplier
summary: Retrieve changes
description: '| Property | Description |
| -------------- | ------------------------------------------------------------ |
| GUID | The GUID associated to the supplier. |
| ApAccountCode | The account code used for accounts payable associated to the supplier. |
| BankDetails | The object where bank details are specified. |
| BankDetails.AccountName | The account name associated to the bank details. |
| BankDetails.AccountNo | The account number associated to the bank details. |
| BankDetails.Address.Address1 | The address1 associated to the bank details. |
| BankDetails.Address.Address2 | The address2 associated to the bank details. |
| BankDetails.Address.Address3 | The address3 associated to the bank details. |
| BankDetails.Address.Address4 | The address4 associated to the bank details. |
| BankDetails.Address.Address5 | The address5 associated to the bank details. |
| BankDetails.Address.Postcode | The postcode associated to the bank details. |
| BankDetails.BankName | The bank name associated to the bank details. |
| BankDetails.BIC | The Bank Identifier Code associated to the bank details. |
| BankDetails.IBAN | The International Bank Account Number associated to the bank details. |
| BankDetails.SortCode | The sort code associated to the bank details. |
| BankDetails.DirectDebitRunConfigListItem | The GUID and name of the direct debit run config associated to the bank details. |
| CompanyOutletListItem | The GUID and name of the company outlet associated to the supplier. |
| CurrencyListItem | The GUID and name of the currency associated to the supplier. |
| Description | The description associated to the supplier. |
| IsTransportSupplier | Is this a transport supplier? |
| PaymentTermListItem | The GUID and name of the payment term associated to the supplier. |
| PaymentTypeListItem | The GUID and name of the payment type associated to the supplier. |
'
operationId: Supplier_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_ApiIntegratorSupplierAccountResource'
/directory/suppliers/{guid}:
get:
tags:
- Supplier
summary: Find with GUID
description: '| Property | Description |
| -------------- | ------------------------------------------------------------ |
| GUID | The GUID associated to the supplier. |
| ApAccountCode | The account code used for accounts payable associated to the supplier. |
| BankDetails | The object where bank details are specified. |
| BankDetails.AccountName | The account name associated to the bank details. |
| BankDetails.AccountNo | The account number associated to the bank details. |
| BankDetails.Address.Address1 | The address1 associated to the bank details. |
| BankDetails.Address.Address2 | The address2 associated to the bank details. |
| BankDetails.Address.Address3 | The address3 associated to the bank details. |
| BankDetails.Address.Address4 | The address4 associated to the bank details. |
| BankDetails.Address.Address5 | The address5 associated to the bank details. |
| BankDetails.Address.Postcode | The postcode associated to the bank details. |
| BankDetails.BankName | The bank name associated to the bank details. |
| BankDetails.BIC | The Bank Identifier Code associated to the bank details. |
| BankDetails.IBAN | The International Bank Account Number associated to the bank details. |
| BankDetails.SortCode | The sort code associated to the bank details. |
| BankDetails.DirectDebitRunConfigListItem | The GUID and name of the direct debit run config associated to the bank details. |
| CompanyOutletListItem | The GUID and name of the company outlet associated to the supplier. |
| CurrencyListItem | The GUID and name of the currency associated to the supplier. |
| Description | The description associated to the supplier. |
| IsTransportSupplier | Is this a transport supplier? |
| PaymentTermListItem | The GUID and name of the payment term associated to the supplier. |
| PaymentTypeListItem | The GUID and name of the payment type associated to the supplier. |
'
operationId: Supplier_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_ApiIntegratorSupplierAccountResource'
put:
tags:
- Supplier
summary: Partial update
description: '| Property | Description | Required |
| -------------- | ------------------------------------------------------------ | -------- |
| GUID | The GUID associated to the supplier. | No |
| ApAccountCode | The account code used for accounts payable associated to the supplier. | Yes |
| BankDetails | The object where bank details are specified. | No |
| BankDetails.AccountName | The account name associated to the bank details. | Yes |
| BankDetails.AccountNo | The account number associated to the bank details. | Yes |
| BankDetails.Address.Address1 | The address1 associated to the bank details. | No |
| BankDetails.Address.Address2 | The address2 associated to the bank details. | No |
| BankDetails.Address.Address3 | The address3 associated to the bank details. | No |
| BankDetails.Address.Address4 | The address4 associated to the bank details. | No |
| BankDetails.Address.Address5 | The address5 associated to the bank details. | No |
| BankDetails.Address.Postcode | The postcode associated to the bank details. | No |
| BankDetails.BankName | The bank name associated to the bank details. | Yes |
| BankDetails.BIC | The Bank Identifier Code associated to the bank details. | No |
| BankDetails.IBAN | The International Bank Account Number associated to the bank details. | No |
| BankDetails.SortCode | The sort code associated to the bank details. | No |
| BankDetails.DirectDebitRunConfigListItem | The GUID and name of the direct debit run config associated to the bank details. | Yes |
| CompanyOutletListItem | The GUID and name of the company outlet associated to the supplier. | No |
| CurrencyListItem | The GUID and name of the currency associated to the supplier. | Yes |
| Description | The description associated to the supplier. | Yes |
| IsTransportSupplier | Is this a transport supplier? | No |
| PaymentTermListItem | The GUID and name of the payment term associated to the supplier. | No |
| PaymentTypeListItem | The GUID and name of the payment type associated to the supplier. | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| CompanyOutlet not found with value CompanyOutletListItem.Guid | Failed to retrieve CompanyOutlet with GUID of {value of CompanyOutletListItem.Guid} |
| PaymentType not found with value PaymentTypeListItem.Guid | Failed to retrieve PaymentType with GUID of {value of PaymentTypeListItem.Guid} |
| PaymentTerm not found with value PaymentTermListItem.Guid | Failed to retrieve PaymentTerm with GUID of {value of PaymentTermListItem.Guid} |
| Currency not found with value CurrencyListItem.Guid | Failed to retrieve Currency with GUID of {value of CurrencyListItem.Guid} |
| DirectDebitRunConfig not found with value BankDetails.DirectDebitRunConfigListItem.Guid | Failed to retrieve DirectDebitRunConfig with GUID of {value of BankDetails.DirectDebitRunConfigListItem.Guid} |
| When APAccountCode is not unique | The ApAccountCode must be unique per supplier |
| Description not unique per supplier | The description must be unique per supplier |
| When Description is null/empty/more than 60 chars | Supplier/Haulier Description: Must have a value. Must be no more than 100 characters long |
| When APAccountCode is null/empty/more than 20 chars | APAccountCode: Must have a value. Must be no more than 20 characters long |'
operationId: SupplierAccount_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorSupplierAccountResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/directory/suppliers:
get:
tags:
- Supplier
summary: Find with Filters
description: '| Property | Description |
| -------------- | ------------------------------------------------------------ |
| GUID | The GUID associated to the supplier. |
| ApAccountCode | The account code used for accounts payable associated to the supplier. |
| BankDetails | The object where bank details are specified. |
| BankDetails.AccountName | The account name associated to the bank details. |
| BankDetails.AccountNo | The account number associated to the bank details. |
| BankDetails.Address.Address1 | The address1 associated to the bank details. |
| BankDetails.Address.Address2 | The address2 associated to the bank details. |
| BankDetails.Address.Address3 | The address3 associated to the bank details. |
| BankDetails.Address.Address4 | The address4 associated to the bank details. |
| BankDetails.Address.Address5 | The address5 associated to the bank details. |
| BankDetails.Address.Postcode | The postcode associated to the bank details. |
| BankDetails.BankName | The bank name associated to the bank details. |
| BankDetails.BIC | The Bank Identifier Code associated to the bank details. |
| BankDetails.IBAN | The International Bank Account Number associated to the bank details. |
| BankDetails.SortCode | The sort code associated to the bank details. |
| BankDetails.DirectDebitRunConfigListItem | The GUID and name of the direct debit run config associated to the bank details. |
| CompanyOutletListItem | The GUID and name of the company outlet associated to the supplier. |
| CurrencyListItem | The GUID and name of the currency associated to the supplier. |
| Description | The description associated to the supplier. |
| IsTransportSupplier | Is this a transport supplier? |
| PaymentTermListItem | The GUID and name of the payment term associated to the supplier. |
| PaymentTypeListItem | The GUID and name of the payment type associated to the supplier. |
'
operationId: Supplier_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_ApiIntegratorSupplierAccountResource'
post:
tags:
- Supplier
summary: Create or update
description: '| Property | Description | Required |
| -------------- | ------------------------------------------------------------ | -------- |
| GUID | The GUID associated to the supplier. | No |
| ApAccountCode | The account code used for accounts payable associated to the supplier. | Yes |
| BankDetails | The object where bank details are specified. | No |
| BankDetails.AccountName | The account name associated to the bank details. | Yes |
| BankDetails.AccountNo | The account number associated to the bank details. | Yes |
| BankDetails.Address.Address1 | The address1 associated to the bank details. | No |
| BankDetails.Address.Address2 | The address2 associated to the bank details. | No |
| BankDetails.Address.Address3 | The address3 associated to the bank details. | No |
| BankDetails.Address.Address4 | The address4 associated to the bank details. | No |
| BankDetails.Address.Address5 | The address5 associated to the bank details. | No |
| BankDetails.Address.Postcode | The postcode associated to the bank details. | No |
| BankDetails.BankName | The bank name associated to the bank details. | Yes |
| BankDetails.BIC | The Bank Identifier Code associated to the bank details. | No |
| BankDetails.IBAN | The International Bank Account Number associated to the bank details. | No |
| BankDetails.SortCode | The sort code associated to the bank details. | No |
| BankDetails.DirectDebitRunConfigListItem | The GUID and name of the direct debit run config associated to the bank details. | Yes |
| CompanyOutletListItem | The GUID and name of the company outlet associated to the supplier. | No |
| CurrencyListItem | The GUID and name of the currency associated to the supplier. | Yes |
| Description | The description associated to the supplier. | Yes |
| IsTransportSupplier | Is this a transport supplier? | No |
| PaymentTermListItem | The GUID and name of the payment term associated to the supplier. | No |
| PaymentTypeListItem | The GUID and name of the payment type associated to the supplier. | No |
**Extra validations**
| Condition | Error message |
| --------- | ------------- |
| CompanyOutlet not found with value CompanyOutletListItem.Guid | Failed to retrieve CompanyOutlet with GUID of {value of CompanyOutletListItem.Guid} |
| PaymentType not found with value PaymentTypeListItem.Guid | Failed to retrieve PaymentType with GUID of {value of PaymentTypeListItem.Guid} |
| PaymentTerm not found with value PaymentTermListItem.Guid | Failed to retrieve PaymentTerm with GUID of {value of PaymentTermListItem.Guid} |
| Currency not found with value CurrencyListItem.Guid | Failed to retrieve Currency with GUID of {value of CurrencyListItem.Guid} |
| DirectDebitRunConfig not found with value BankDetails.DirectDebitRunConfigListItem.Guid | Failed to retrieve DirectDebitRunConfig with GUID of {value of BankDetails.DirectDebitRunConfigListItem.Guid} |
| When APAccountCode is not unique | The ApAccountCode must be unique per supplier |
| When Description is null/empty/more than 60 chars | Supplier/Haulier Description: Must have a value. Must be no more than 100 characters long |
| When APAccountCode is null/empty/more than 20 chars | APAccountCode: Must have a value. Must be no more than 20 characters long |'
operationId: SupplierAccount_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorSupplierAccountResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
components:
schemas:
ApiIntegratorSupplierAccountBankDetailsAddressResource:
type: object
properties:
Address1:
type: string
Address2:
type: string
Address3:
type: string
Address4:
type: string
Address5:
type: string
Postcode:
type: string
ApiResourceId:
type: object
properties:
resource:
type: string
format: uuid
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiIntegratorSupplierAccountResource:
type: object
properties:
CompanyOutletListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ApAccountCode:
type: string
Description:
type: string
IsTransportSupplier:
type: boolean
PaymentTypeListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
PaymentTermListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
CurrencyListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
BankDetails:
$ref: '#/components/schemas/ApiIntegratorSupplierAccountBankDetailsResource'
GUID:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
isSuccess:
type: boolean
ApiResourceResultCollection_ApiIntegratorSupplierAccountResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorSupplierAccountResource'
extra:
$ref: '#/components/schemas/ApiResourceResultCollectionExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
ApiResourceChanges_ApiIntegratorSupplierAccountResource:
type: object
properties:
resource:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorSupplierAccountResource'
extra:
$ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
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
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiIntegratorSupplierAccountBankDetailsResource:
type: object
properties:
BankName:
type: string
AccountName:
type: string
AccountNo:
type: string
SortCode:
type: string
BIC:
type: string
IBAN:
type: string
Address:
$ref: '#/components/schemas/ApiIntegratorSupplierAccountBankDetailsAddressResource'
DirectDebitRunConfigListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ApiResourceResultEntity_ApiIntegratorSupplierAccountResource:
type: object
properties:
resource:
$ref: '#/components/schemas/ApiIntegratorSupplierAccountResource'
links:
$ref: '#/components/schemas/ApiResourceResultEntityLinks'
extra:
$ref: '#/components/schemas/ApiResourceResultEntityExtra'
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
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
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