AMCS Group CostAgreement API
The CostAgreement API from AMCS Group — 3 operation(s) for costagreement.
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-costagreement-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 Cost Agreement 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: CostAgreement
paths:
/productCatalogue/costAgreements/changes:
get:
tags:
- CostAgreement
summary: Retrieve changes
description: "| Property| Description|\n| ----------------------------------------------------------|-------------------------------------------------------------------------------------- |\n| GUID| The GUID associated to the cost agreement.|\n| Description| The description associated to the cost agreement.| \n| IsDefault| Is default cost agreement.| \n| AgreementNumber| The agreement number associated to the cost agreement.| \n| CostCentreListItem| The GUID and description of the cost centre associated to the cost agreement.| \n| CompanyOutletListItems| The list of company outlets associated to the cost agreement.| \n| CompanyOutletListItems[0].CompanyOutletListItem| The GUID and description of the company outlet associated to the cost agreement.| \n| RelatedSupplierGuid| Used to filter on the related supplier GUID.| \n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|\n| RelatedSupplierSiteGuids| The list of supplier site GUIDs associated to the cost agreement.| \n| RelatedLocationSourceGuid| Used to filter on the source location associated to the cost.|\n| RelatedLocationDestinationGuid| Used to filter on the destination location associated to the cost.|\n| RelatedCostGuidFilter| Used to filter on the related cost GUID.|\n| RelatedSupplierSiteGuids[0].RelatedSupplierSiteGuid| The GUID of the supplier site associated to the cost agreement.|\n| EndDate| The end date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| EndReasonListItem| The GUID and description of the end reason associated to the cost agreement.| \n| IsAutoRenewal| Is the cost agreement has auto renewal enabled.| \n| IsForAllSites| Is the cost agreement for all sites.| \n| PrimaryServiceListItem| The GUID and description of the end reason associated to the cost agreement.| \n| ReviewDate| The review date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| StartDate| The start date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| Costs| The list of costs associated to the cost agreement.|\n| Costs[0].GUID| The GUID associated to the cost.|\n| Costs[0].IsDeleted| Whether the cost is deleted.|\n| Costs[0].Description| The description associated to the cost.|\n| Costs[0].DefaultActionListItem| The GUID and description of the default action associated to the cost.|\n| Costs[0].ServiceFrequencyListItem| The GUID and description of the service frequency associated to the cost.|\n| Costs[0].ContainerTypeListItem| The GUID and description of the container type associated to the cost.|\n| Costs[0].RentTermListItem| The GUID and description of the rent term associated to the cost.|\n| Costs[0].MaterialListItem| The GUID and description of the material associated to the cost.|\n| Costs[0].RelatedLocationSourceGuid| The GUID related to the source location associated to the cost.|\n| Costs[0].RelatedLocationDestinationGuid| The GUID related to the destination location associated to the cost.|\n| Costs[0].EffectiveFrom| The date effective from date associated to the cost.|\n| Costs[0].Amount| The amount object associated to the cost.|\n| Costs[0].Amount.Cost| The cost value associated to the amount.|\n| Costs[0].Amount.MaximumCost| The maximum cost associated to the amount.|\n| Costs[0].Amount.MinimumCost| The minimum cost associated to the amount.|\n| Costs[0].Amount.Allowance| The allowance associated to the amount.|\n| Costs[0].Amount.VATListItem| The GUID and description of the VAT associated to the amount.|\n| Costs[0].Amount.TaxTemplateCollectionListItem| The GUID and description of the tax template collection associated to the amount.|\n| RelatedServiceAgreements| The list of service agreements related to the cost agreement.|\n| RelatedServiceAgreements[0].Guid| The Guid associated to the service agreement cost agreement.|\n| RelatedServiceAgreements[0].IsDeleted| Whether the service agreement cost agreement is deleted.|\n| RelatedServiceAgreements[0].RelatedServiceAgreementGuid| The Guid of the service agreement associated to the cost agreement.|\n| RelatedServiceAgreementGuidFilter | Used to filter on the related service agreement GUID.|\n"
operationId: CostAgreement_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_ApiIntegratorCostAgreementResource'
/productCatalogue/costAgreements/{guid}:
get:
tags:
- CostAgreement
summary: Find with GUID
description: "| Property| Description|\n| ----------------------------------------------------------|-------------------------------------------------------------------------------------- |\n| GUID| The GUID associated to the cost agreement.|\n| Description| The description associated to the cost agreement.| \n| IsDefault| Is default cost agreement.| \n| AgreementNumber| The agreement number associated to the cost agreement.| \n| CostCentreListItem| The GUID and description of the cost centre associated to the cost agreement.| \n| CompanyOutletListItems| The list of company outlets associated to the cost agreement.| \n| CompanyOutletListItems[0].CompanyOutletListItem| The GUID and description of the company outlet associated to the cost agreement.| \n| RelatedSupplierGuid| Used to filter on the related supplier GUID.| \n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|\n| RelatedSupplierSiteGuids| The list of supplier site GUIDs associated to the cost agreement.| \n| RelatedLocationSourceGuid| Used to filter on the source location associated to the cost.|\n| RelatedLocationDestinationGuid| Used to filter on the destination location associated to the cost.|\n| RelatedCostGuidFilter| Used to filter on the related cost GUID.|\n| RelatedSupplierSiteGuids[0].RelatedSupplierSiteGuid| The GUID of the supplier site associated to the cost agreement.|\n| EndDate| The end date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| EndReasonListItem| The GUID and description of the end reason associated to the cost agreement.| \n| IsAutoRenewal| Is the cost agreement has auto renewal enabled.| \n| IsForAllSites| Is the cost agreement for all sites.| \n| PrimaryServiceListItem| The GUID and description of the end reason associated to the cost agreement.| \n| ReviewDate| The review date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| StartDate| The start date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| Costs| The list of costs associated to the cost agreement.|\n| Costs[0].GUID| The GUID associated to the cost.|\n| Costs[0].IsDeleted| Whether the cost is deleted.|\n| Costs[0].Description| The description associated to the cost.|\n| Costs[0].DefaultActionListItem| The GUID and description of the default action associated to the cost.|\n| Costs[0].ServiceFrequencyListItem| The GUID and description of the service frequency associated to the cost.|\n| Costs[0].ContainerTypeListItem| The GUID and description of the container type associated to the cost.|\n| Costs[0].RentTermListItem| The GUID and description of the rent term associated to the cost.|\n| Costs[0].MaterialListItem| The GUID and description of the material associated to the cost.|\n| Costs[0].RelatedLocationSourceGuid| The GUID related to the source location associated to the cost.|\n| Costs[0].RelatedLocationDestinationGuid| The GUID related to the destination location associated to the cost.|\n| Costs[0].EffectiveFrom| The date effective from date associated to the cost.|\n| Costs[0].Amount| The amount object associated to the cost.|\n| Costs[0].Amount.Cost| The cost value associated to the amount.|\n| Costs[0].Amount.MaximumCost| The maximum cost associated to the amount.|\n| Costs[0].Amount.MinimumCost| The minimum cost associated to the amount.|\n| Costs[0].Amount.Allowance| The allowance associated to the amount.|\n| Costs[0].Amount.VATListItem| The GUID and description of the VAT associated to the amount.|\n| Costs[0].Amount.TaxTemplateCollectionListItem| The GUID and description of the tax template collection associated to the amount.|\n| RelatedServiceAgreements| The list of service agreements related to the cost agreement.|\n| RelatedServiceAgreements[0].Guid| The Guid associated to the service agreement cost agreement.|\n| RelatedServiceAgreements[0].IsDeleted| Whether the service agreement cost agreement is deleted.|\n| RelatedServiceAgreements[0].RelatedServiceAgreementGuid| The Guid of the service agreement associated to the cost agreement.|\n| RelatedServiceAgreementGuidFilter | Used to filter on the related service agreement GUID.|\n"
operationId: CostAgreement_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_ApiIntegratorCostAgreementResource'
put:
tags:
- CostAgreement
summary: Partial update
description: "| Property| Description| Required |\n| ----------------------------------------------------------|-------------------------------------------------------------------------------------- |----------|\n| GUID| The GUID associated to the cost agreement.| No |\n| Description| The description associated to the cost agreement.| Yes | \n| IsDefault| Is default cost agreement.| Yes | \n| AgreementNumber| The agreement number associated to the cost agreement.| Yes | \n| CostCentreListItem| The GUID and description of the cost centre associated to the cost agreement.| No | \n| CompanyOutletListItems| The list of company outlets associated to the cost agreement.| No | \n| CompanyOutletListItems[0].CompanyOutletListItem| The GUID and description of the company outlet associated to the cost agreement.| No |\n| RelatedSupplierGuid| The GUID and description of the supplier GUID associated to the cost agreement.| No | \n| RelatedSupplierSiteGuids| The list of supplier site GUIDs associated to the cost agreement.| Yes |\n| RelatedLocationSourceGuid| Used to filter on the source location associated to the cost.|No |\n| RelatedLocationDestinationGuid| Used to filter on the destination location associated to the cost.| No |\n| RelatedCostGuidFilter| Used to filter on the related cost GUID.| No |\n| RelatedSupplierSiteGuids[0].RelatedSupplierSiteGuid| The GUID of the supplier site associated to the cost agreement.| Yes |\n| EndDate| The end date associated to the cost agreement in ISO format (YYYY-MM-DD).| No | \n| EndReasonListItem| The GUID and description of the end reason associated to the cost agreement.| No | \n| IsAutoRenewal| Is the cost agreement has auto renewal enabled.| No | \n| IsForAllSites| Is the cost agreement for all sites.| No | \n| PrimaryServiceListItem| The GUID and description of the end reason associated to the cost agreement.| No | \n| ReviewDate| The review date associated to the cost agreement in ISO format (YYYY-MM-DD).| No | \n| StartDate| The start date associated to the cost agreement in ISO format (YYYY-MM-DD).| No | \n| Costs| The list of costs associated to the cost agreement.| No |\n| Costs[0].GUID| The GUID associated to the cost.| No |\n| Costs[0].IsDeleted| Whether the cost is deleted.|Yes |\n| Costs[0].Description| The description associated to the cost.| No |\n| Costs[0].DefaultActionListItem| The GUID and description of the default action associated to the cost.| No |\n| Costs[0].ServiceFrequencyListItem| The GUID and description of the service frequency associated to the cost.| No |\n| Costs[0].ContainerTypeListItem| The GUID and description of the container type associated to the cost.| No |\n| Costs[0].RentTermListItem| The GUID and description of the rent term associated to the cost.|No |\n| Costs[0].MaterialListItem| The GUID and description of the material associated to the cost.|No |\n| Costs[0].RelatedLocationSourceGuid| The GUID related to the source location associated to the cost.|No |\n| Costs[0].RelatedLocationDestinationGuid| The GUID related to the destination location associated to the cost.|No |\n| Costs[0].EffectiveFrom| The date effective from date associated to the cost.|No |\n| Costs[0].Amount| The amount object associated to the cost.|No |\n| Costs[0].Amount.Cost| The cost value associated to the amount.| No |\n| Costs[0].Amount.MaximumCost| The maximum cost associated to the amount.|No |\n| Costs[0].Amount.MinimumCost| The minimum cost associated to the amount.|No |\n| Costs[0].Amount.Allowance| The allowance associated to the amount.|No |\n| Costs[0].Amount.VATListItem| The GUID and description of the VAT associated to the amount.|No |\n| Costs[0].Amount.TaxTemplateCollectionListItem| The GUID and description of the tax template collection associated to the amount.|No |\n| RelatedServiceAgreements| The list of service agreements related to the cost agreement.|No |\n| RelatedServiceAgreements[0].Guid| The Guid associated to the service agreement cost agreement.|No |\n| RelatedServiceAgreements[0].IsDeleted| Whether the service agreement cost agreement is deleted.|Yes |\n| RelatedServiceAgreements[0].RelatedServiceAgreementGuid| The Guid of the service agreement associated to the cost agreement.|Yes |\n| RelatedServiceAgreementGuidFilter | Used to filter on the related service agreement GUID.|No |\n\n**Extra validations**\n\n| Condition | Error message |\n| --------- | ------------- |\n| If Costs[0].GUID is duplicated on another Cost | Failed to save. Entity already exists Guid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |\n| If all existing Costs[] items are not supplied | Failed to save. Cost with GUID of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was not supplied |\n| If Costs[0].GUID is not associated with the current cost agreement| Failed to save. Cost with Guid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx does not belong to CostAgreement |\n| If Costs[0] has a related field set that is not allowed given the cost agreement primary service and the costs action | Cost has the property RelatedSiteDestinationGuid with value of 355dbd83-abce-4797-a5b4-ac59632dc821 that is not supported. The given DefaultActionListItem: 4fd49204-7123-eb11-8d03-98e74393fee2 only allows the following fields: RelatedSupplierSiteDestinationGuid. | \n| If RelatedServiceAgreements.Guid is changed on update | RelatedServiceAgreements.Guid is a read-only property |\n| If RelatedServiceAgreements.RelatedServiceAgreementGuid is changed on update | RelatedServiceAgreements.RelatedServiceAgreementGuid is a read-only property |\n| If RelatedServiceAgreements.IsDeleted is changed on update | RelatedServiceAgreements.IsDeleted is a read-only property |\n| If we insert duplicate service agreement on cost agreement update | Failed to save. Serviceagreement already exists with Guid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |\n| If Costs.IsDeleted is changed on update | Costs.IsDeleted is a read-only property |"
operationId: CostAgreement_Update
parameters:
- name: guid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorCostAgreementResource'
required: true
x-bodyName: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
/productCatalogue/costAgreements:
get:
tags:
- CostAgreement
summary: Find with Filters
description: "| Property| Description|\n| ----------------------------------------------------------|-------------------------------------------------------------------------------------- |\n| GUID| The GUID associated to the cost agreement.|\n| Description| The description associated to the cost agreement.| \n| IsDefault| Is default cost agreement.| \n| AgreementNumber| The agreement number associated to the cost agreement.| \n| CostCentreListItem| The GUID and description of the cost centre associated to the cost agreement.| \n| CompanyOutletListItems| The list of company outlets associated to the cost agreement.| \n| CompanyOutletListItems[0].CompanyOutletListItem| The GUID and description of the company outlet associated to the cost agreement.| \n| RelatedSupplierGuid| Used to filter on the related supplier GUID.| \n| RelatedSupplierSiteGuid| Used to filter on the related supplier site GUID.|\n| RelatedSupplierSiteGuids| The list of supplier site GUIDs associated to the cost agreement.| \n| RelatedLocationSourceGuid| Used to filter on the source location associated to the cost.|\n| RelatedLocationDestinationGuid| Used to filter on the destination location associated to the cost.|\n| RelatedCostGuidFilter| Used to filter on the related cost GUID.|\n| RelatedSupplierSiteGuids[0].RelatedSupplierSiteGuid| The GUID of the supplier site associated to the cost agreement.|\n| EndDate| The end date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| EndReasonListItem| The GUID and description of the end reason associated to the cost agreement.| \n| IsAutoRenewal| Is the cost agreement has auto renewal enabled.| \n| IsForAllSites| Is the cost agreement for all sites.| \n| PrimaryServiceListItem| The GUID and description of the end reason associated to the cost agreement.| \n| ReviewDate| The review date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| StartDate| The start date associated to the cost agreement in ISO format (YYYY-MM-DD).| \n| Costs| The list of costs associated to the cost agreement.|\n| Costs[0].GUID| The GUID associated to the cost.|\n| Costs[0].IsDeleted| Whether the cost is deleted.|\n| Costs[0].Description| The description associated to the cost.|\n| Costs[0].DefaultActionListItem| The GUID and description of the default action associated to the cost.|\n| Costs[0].ServiceFrequencyListItem| The GUID and description of the service frequency associated to the cost.|\n| Costs[0].ContainerTypeListItem| The GUID and description of the container type associated to the cost.|\n| Costs[0].RentTermListItem| The GUID and description of the rent term associated to the cost.|\n| Costs[0].MaterialListItem| The GUID and description of the material associated to the cost.|\n| Costs[0].RelatedLocationSourceGuid| The GUID related to the source location associated to the cost.|\n| Costs[0].RelatedLocationDestinationGuid| The GUID related to the destination location associated to the cost.|\n| Costs[0].EffectiveFrom| The date effective from date associated to the cost.|\n| Costs[0].Amount| The amount object associated to the cost.|\n| Costs[0].Amount.Cost| The cost value associated to the amount.|\n| Costs[0].Amount.MaximumCost| The maximum cost associated to the amount.|\n| Costs[0].Amount.MinimumCost| The minimum cost associated to the amount.|\n| Costs[0].Amount.Allowance| The allowance associated to the amount.|\n| Costs[0].Amount.VATListItem| The GUID and description of the VAT associated to the amount.|\n| Costs[0].Amount.TaxTemplateCollectionListItem| The GUID and description of the tax template collection associated to the amount.|\n| RelatedServiceAgreements| The list of service agreements related to the cost agreement.|\n| RelatedServiceAgreements[0].Guid| The Guid associated to the service agreement cost agreement.|\n| RelatedServiceAgreements[0].IsDeleted| Whether the service agreement cost agreement is deleted.|\n| RelatedServiceAgreements[0].RelatedServiceAgreementGuid| The Guid of the service agreement associated to the cost agreement.|\n| RelatedServiceAgreementGuidFilter | Used to filter on the related service agreement GUID.|\n"
operationId: CostAgreement_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_ApiIntegratorCostAgreementResource'
post:
tags:
- CostAgreement
summary: Create or update
description: "| Property| Description| Required |\n| ----------------------------------------------------------|-------------------------------------------------------------------------------------- |----------|\n| GUID| The GUID associated to the cost agreement.| No |\n| Description| The description associated to the cost agreement.| Yes | \n| IsDefault| Is default cost agreement.| Yes | \n| AgreementNumber| The agreement number associated to the cost agreement.| Yes | \n| CostCentreListItem| The GUID and description of the cost centre associated to the cost agreement.| No | \n| CompanyOutletListItems| The list of company outlets associated to the cost agreement.| No | \n| CompanyOutletListItems[0].CompanyOutletListItem| The GUID and description of the company outlet associated to the cost agreement.| No |\n| RelatedSupplierGuid| The GUID and description of the supplier GUID associated to the cost agreement.| No | \n| RelatedSupplierSiteGuids| The list of supplier site GUIDs associated to the cost agreement.| Yes |\n| RelatedLocationSourceGuid| Used to filter on the source location associated to the cost.|No |\n| RelatedLocationDestinationGuid| Used to filter on the destination location associated to the cost.| No |\n| RelatedCostGuidFilter| Used to filter on the related cost GUID.| No |\n| RelatedSupplierSiteGuids[0].RelatedSupplierSiteGuid| The GUID of the supplier site associated to the cost agreement.| Yes |\n| EndDate| The end date associated to the cost agreement in ISO format (YYYY-MM-DD).| No | \n| EndReasonListItem| The GUID and description of the end reason associated to the cost agreement.| No | \n| IsAutoRenewal| Is the cost agreement has auto renewal enabled.| No | \n| IsForAllSites| Is the cost agreement for all sites.| No | \n| PrimaryServiceListItem| The GUID and description of the end reason associated to the cost agreement.| No | \n| ReviewDate| The review date associated to the cost agreement in ISO format (YYYY-MM-DD).| No | \n| StartDate| The start date associated to the cost agreement in ISO format (YYYY-MM-DD).| No | \n| Costs| The list of costs associated to the cost agreement.| No |\n| Costs[0].GUID| The GUID associated to the cost.| No |\n| Costs[0].IsDeleted| Whether the cost is deleted.|Yes |\n| Costs[0].Description| The description associated to the cost.| No |\n| Costs[0].DefaultActionListItem| The GUID and description of the default action associated to the cost.| No |\n| Costs[0].ServiceFrequencyListItem| The GUID and description of the service frequency associated to the cost.| No |\n| Costs[0].ContainerTypeListItem| The GUID and description of the container type associated to the cost.| No |\n| Costs[0].RentTermListItem| The GUID and description of the rent term associated to the cost.|No |\n| Costs[0].MaterialListItem| The GUID and description of the material associated to the cost.|No |\n| Costs[0].RelatedLocationSourceGuid| The GUID related to the source location associated to the cost.|No |\n| Costs[0].RelatedLocationDestinationGuid| The GUID related to the destination location associated to the cost.|No |\n| Costs[0].EffectiveFrom| The date effective from date associated to the cost.|No |\n| Costs[0].Amount| The amount object associated to the cost.|No |\n| Costs[0].Amount.Cost| The cost value associated to the amount.| No |\n| Costs[0].Amount.MaximumCost| The maximum cost associated to the amount.|No |\n| Costs[0].Amount.MinimumCost| The minimum cost associated to the amount.|No |\n| Costs[0].Amount.Allowance| The allowance associated to the amount.|No |\n| Costs[0].Amount.VATListItem| The GUID and description of the VAT associated to the amount.|No |\n| Costs[0].Amount.TaxTemplateCollectionListItem| The GUID and description of the tax template collection associated to the amount.|No |\n| RelatedServiceAgreements| The list of service agreements related to the cost agreement.|No |\n| RelatedServiceAgreements[0].Guid| The Guid associated to the service agreement cost agreement.|No |\n| RelatedServiceAgreements[0].IsDeleted| Whether the service agreement cost agreement is deleted.|Yes |\n| RelatedServiceAgreements[0].RelatedServiceAgreementGuid| The Guid of the service agreement associated to the cost agreement.|Yes |\n| RelatedServiceAgreementGuidFilter | Used to filter on the related service agreement GUID.|No | \n\n**Extra validations**\n\n| Condition | Error message |\n| --------- | ------------- |\n| If Costs[0].GUID is duplicated on another Cost | Failed to save. Entity already exists Guid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |\n| If all existing Costs[] items are not supplied | Failed to save. Cost with GUID of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx was not supplied |\n| If Costs[0].GUID is not associated with the current cost agreement| Failed to save. Cost with Guid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx does not belong to CostAgreement |\n| If Costs[0] has a related field set that is not allowed given the cost agreement primary service and the costs action | Cost has the property RelatedSiteDestinationGuid with value of 355dbd83-abce-4797-a5b4-ac59632dc821 that is not supported. The given DefaultActionListItem: 4fd49204-7123-eb11-8d03-98e74393fee2 only allows the following fields: RelatedSupplierSiteDestinationGuid. | \n| If RelatedServiceAgreements.Guid is not null on insert | Attempting to update service agreement when creating the cost agreement . Could not process the request. Provide service agreement without a Guid property to create new cost agreement rather than attempting an update |\n| If RelatedServiceAgreements.IsDeleted is TRUE | Could not process the request. RelatedServiceAgreements can not be deleted via the REST API |\n| If RelatedServiceAgreements.Guid is changed on update | RelatedServiceAgreements.Guid is a read-only property |\n| If RelatedServiceAgreements.RelatedServiceAgreementGuid is changed on update | RelatedServiceAgreements.RelatedServiceAgreementGuid is a read-only property |\n| If RelatedServiceAgreements.IsDeleted is changed on update | RelatedServiceAgreements.IsDeleted is a read-only property |\n| If we insert duplicate service agreement on cost agreement update | Failed to save. Serviceagreement already exists with Guid of xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |\n| If Costs.IsDeleted is changed on update | Costs.IsDeleted is a read-only property |\n| If Costs.IsDeleted is TRUE on insert | IsDeleted is TRUE. Could not process the request. Costs can not be deleted via the REST API |"
operationId: CostAgreement_Create
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiIntegratorCostAgreementResource'
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
ApiIntegratorCostAgreementAmountResource:
type: object
properties:
Cost:
type: number
format: double
MaximumCost:
type: number
format: double
MinimumCost:
type: number
format: double
Allowance:
type: number
format: double
VATListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
TaxTemplateCollectionListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ApiIntegratorCostAgreementServiceAgreementResource:
type: object
properties:
Guid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
IsDeleted:
type: boolean
RelatedServiceAgreementGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiIntegratorCostAgreementCompanyOutletResource:
type: object
properties:
CompanyOutletListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ApiIntegratorCostAgreementRelatedSupplierSiteResource:
type: object
properties:
RelatedSupplierSiteGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
ApiIntegratorCostAgreementResource:
type: object
properties:
Description:
type: string
IsDefault:
type: boolean
AgreementNumber:
type: string
CostCentreListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
RelatedSupplierGuid:
type: string
format: uuid
example: 00000000-0000-0000-0000-000000000000
EndDate:
type: string
format: localDate
example: '2000-01-01'
EndReasonListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
IsAutoRenewal:
type: boolean
IsForAllSites:
type: boolean
PrimaryServiceListItem:
$ref: '#/components/schemas/ApiIntegratorListItemResource'
ReviewDate:
type: string
format: localDate
example: '2000-01-01'
StartDate:
type: string
format: localDate
example: '2000-01-01'
CompanyOutletListItems:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorCostAgreementCompanyOutletResource'
RelatedSupplierSiteGuids:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorCostAgreementRelatedSupplierSiteResource'
RelatedServiceAgreements:
type: array
items:
$ref: '#/components/schemas/ApiIntegratorCostAgreementServiceAgreementResource'
Costs:
type: array
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-costagreement-api-openapi.yml