AMCS Group

AMCS Group ServiceAgreement API

The ServiceAgreement API from AMCS Group — 4 operation(s) for serviceagreement.

Documentation GitHub OpenAPI

Operations 4

GET /productCatalogue/serviceAgreements/changes Retrieve changes #

GET /productCatalogue/serviceAgreements/{guid} Find with GUID #

GET /productCatalogue/serviceAgreements Find with Filters #

POST /integrator/vip/serviceAgreements Create or update #

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-serviceagreement-api-openapi.yml

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.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/amcs-group-serviceagreement-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.

GitHub Google LinkedIn

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 Service Agreement API
  description: '![latest End points](/amcsrestapi/diagram/endpointslatest.svg)


    # Overview


    ## Who Should Read this Document


    This document contains a technical description of the AMCS Platform REST API.'
  version: latest
servers:
- url: https://ete-p5-tst-svc-core.amcsplatform.com/erp/api/integrator/erp
tags:
- name: ServiceAgreement
paths:
  /productCatalogue/serviceAgreements/changes:
    get:
      tags:
      - ServiceAgreement
      summary: Retrieve changes
      description: '| Property | Description |

        | -------------- | ------------------------------------------------------------ |

        | GUID| The GUID associated to the service agreement.'
      operationId: ServiceAgreement_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_ApiIntegratorServiceAgreementResource'
  /productCatalogue/serviceAgreements/{guid}:
    get:
      tags:
      - ServiceAgreement
      summary: Find with GUID
      description: '| Property | Description |

        | -------------- | ------------------------------------------------------------ |

        | GUID| The GUID associated to the service agreement.'
      operationId: ServiceAgreement_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_ApiIntegratorServiceAgreementResource'
  /productCatalogue/serviceAgreements:
    get:
      tags:
      - ServiceAgreement
      summary: Find with Filters
      description: '| Property | Description |

        | -------------- | ------------------------------------------------------------ |

        | GUID| The GUID associated to the service agreement.'
      operationId: ServiceAgreement_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_ApiIntegratorServiceAgreementResource'
  /integrator/vip/serviceAgreements:
    post:
      tags:
      - ServiceAgreement
      summary: Create or update
      operationId: ServiceAgreement_Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiIntegratorServiceAgreementSaveResource'
        required: true
        x-bodyName: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
components:
  schemas:
    ApiIntegratorServiceAgreementPriceAmountResource:
      type: object
      properties:
        Price:
          type: number
          format: double
        Offset:
          type: number
          format: double
        Percentage:
          type: number
          format: double
        FloorPrice:
          type: number
          format: double
        CeilingPrice:
          type: number
          format: double
        MinimumCharge:
          type: number
          format: double
        MaximumCharge:
          type: number
          format: double
        Allowance:
          type: number
          format: float
        VatListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        EffectiveFrom:
          type: string
          format: dateTime
          example: '2000-01-01 00:00:00.000'
        EffectiveTo:
          type: string
          format: dateTime
          example: '2000-01-01 00:00:00.000'
        TaxTemplateCollectionListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        IsRebate:
          type: boolean
    ApiIntegratorServiceAgreementRelatedCustomersResource:
      type: object
      properties:
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedCustomerGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        IsForAllSites:
          type: boolean
        IsRelatedCustomerDeleted:
          type: boolean
        RelatedSites:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementRelatedSitesResource'
    ApiResourceResultEntity_ApiIntegratorServiceAgreementResource:
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/ApiIntegratorServiceAgreementResource'
        links:
          $ref: '#/components/schemas/ApiResourceResultEntityLinks'
        extra:
          $ref: '#/components/schemas/ApiResourceResultEntityExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiIntegratorServiceAgreementResource:
      type: object
      properties:
        Description:
          type: string
        StartDate:
          type: string
          format: localDate
          example: '2000-01-01'
        EndDate:
          type: string
          format: localDate
          example: '2000-01-01'
        ReviewDate:
          type: string
          format: localDate
          example: '2000-01-01'
        RelatedCustomerGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        EndReasonListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        InvoiceFrequencyListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        InvoiceCycleListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        OutletListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        PaymentTypeListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        PaymentTermListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        DepartmentListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        PrimaryServiceListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        Prices:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementPriceResource'
        OrderCombinationGroups:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementOrderCombinationGroupsResource'
        RelatedOutlets:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementRelatedOutletsResource'
        RelatedCustomers:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementRelatedCustomersResource'
        BillingUsagePolicies:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementBillingUsagePolicyResource'
        IsDeleted:
          type: boolean
        PriceGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        CompanyOutletListItemGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedCustomerGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedCustomersGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedSiteGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        GUID:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiIntegratorServiceAgreementSaveResource:
      type: object
      properties:
        Description:
          type: string
        StartDate:
          type: string
          format: localDate
          example: '2000-01-01'
        EndDate:
          type: string
          format: localDate
          example: '2000-01-01'
        ReviewDate:
          type: string
          format: localDate
          example: '2000-01-01'
        RelatedCustomerGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        EndReasonListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        InvoiceFrequencyListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        InvoiceCycleListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        OutletListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        PaymentTypeListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        PaymentTermListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        DepartmentListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        PrimaryServiceListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        Prices:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementPriceResource'
        OrderCombinationGroups:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementOrderCombinationGroupsResource'
        RelatedOutlets:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementRelatedOutletsResource'
        RelatedCustomers:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementRelatedCustomersResource'
        BillingUsagePolicies:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementBillingUsagePolicyResource'
        IsDeleted:
          type: boolean
        PriceGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        CompanyOutletListItemGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedCustomerGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedCustomersGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedSiteGuidFilter:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        GUID:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceResultCollection_ApiIntegratorServiceAgreementResource:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    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
    ApiResourceResultUpdatesExtra:
      type: object
      properties:
        until:
          type: string
        cursor:
          type: string
    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
    ApiResourceChanges_ApiIntegratorServiceAgreementResource:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultUpdatesExtra'
        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
    ApiIntegratorServiceAgreementBillingUsagePolicyResource:
      type: object
      properties:
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        Thresholds:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorServiceAgreementBillingUsagePolicyWeightThresholdResource'
        IsDeleted:
          type: boolean
        AltWeightSourceForOutsideThreshold:
          type: integer
          format: int32
        AltWeightSourceForZeroWeight:
          type: integer
          format: int32
        ApplyToWeightsOutsideThresholds:
          type: boolean
        ApplyToZeroWeights:
          type: boolean
        Description:
          type: string
        IsUseAccumulatedWeight:
          type: boolean
        IsUseActualLifts:
          type: boolean
        IsUseExpectedLifts:
          type: boolean
        FairUsageMonths:
          type: integer
          format: int32
        LiftsForAverage:
          type: integer
          format: int32
        MonthlyLag:
          type: integer
          format: int32
    ApiResourceStatus:
      type: object
      properties:
        id:
          type: integer
          format: int32
        isSuccess:
          type: boolean
    ApiIntegratorServiceAgreementRelatedSitesResource:
      type: object
      properties:
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        RelatedSiteGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        IsRelatedSiteDeleted:
          type: boolean
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string
    ApiIntegratorServiceAgreementPriceResource:
      type: object
      properties:
        PriceGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        DefaultActionListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        CostCode:
          type: string
        PurchaseCode:
          type: string
        DateDeleted:
          type: string
          format: dateTime
          example: '2000-01-01 00:00:00.000'
        IsDeleted:
          type: boolean
        ContainerTypeListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        MaterialListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        Amount:
          $ref: '#/components/schemas/ApiIntegratorServiceAgreementPriceAmountResource'
        LatePaymentFeeDefinition:
          $ref: '#/components/schemas/ApiIntegratorServiceAgreementPriceLatePaymentFeeDefinitionResource'
    ApiIntegratorServiceAgreementRelatedOutletsResource:
      type: object
      properties:
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        CompanyOutletListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        IsRelatedOutletDeleted:
          type: boolean
    ApiIntegratorServiceAgreementPriceLatePaymentFeeDefinitionResource:
      type: object
      properties:
        Description:
          type: string
        CustomerCategoryListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        LatePaymentFeeTypeListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        ActionListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        DefaultActionListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        RelatedPriceGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        GraceDays:
          type: integer
          format: int32
        FlatFeeAmount:
          type: number
          format: double
        PercentageFeeDecimalAmount:
          type: number
          format: double
        PercentageFeeAmount:
          type: number
          format: double
        MinimumCharge:
          type: number
          format: double
        MaximumCharge:
          type: number
          format: double
        IsDeleted:
          type: boolean
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiIntegratorServiceAgreementBillingUsagePolicyWeightThresholdResource:
      type: object
      properties:
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        ContainerTypeListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        MaterialListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        UnitOfMeasurementListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        MinWeight:
          type: number
          format: double
        MaxWeight:
          type: number
          format: double
        IsDeleted:
          type: boolean
    ApiResourceId:
      type: object
      properties:
        resource:
          type: string
          format: uuid
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type: integer
          format: int32
    ApiIntegratorServiceAgreementOrderCombinationGroupsResource:
      type: object
      properties:
        Guid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        InvoiceCycleListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        IsConcessionary:
          type: boolean
        IsRequiresPrePay:
          type: boolean
        ForceFullPayment:
          type: boolean
        RelatedContractTermLengthGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        UseOutletLevelPricing:
          type: boolean
        Name:
          type: string
        IsOutletLevelPricingUsed:
          type: boolean
        AnnualContractCost:
          type: number
          format: double
        AnnualContractValue:
          type: number
          format: double
        BillingUsagePolicyGuid:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
        IsUseReducedRateForAdditionalBin:
          type: boolean
        RefundableAdvanceDeposit:
          type: number
          format: double
        StartDateDeferredDays:
          type: integer
          format: int32
        SubscriptionTypeListItem:
          $ref: '#/components/schemas/ApiIntegratorListItemResource'
        IsDeleted:
          type: boolean