AMCS Group ServiceAgreement API
The ServiceAgreement API from AMCS Group — 4 operation(s) for serviceagreement.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup ServiceAgreement API
version: core
tags:
- name: ServiceAgreement
paths:
/productCatalogue/serviceAgreements/changes:
get:
tags:
- ServiceAgreement
summary: Retrieve changes
description: "| Property | Description |\r\n| -------------- | ------------------------------------------------------------ |\r\n| GUID| The GUID associated to the service agreement. |\r\n| Description| The description associated to the service agreement. | \r\n| StartDate| The start date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| EndDate| The end date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| ReviewDate| The review date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| RelatedCustomerGuid| The GUID of the customer associated to the service agreement. Filterable. | \r\n| EndReasonListItem| The GUID and name of the end reason associated to the service agreement. | \r\n| InvoiceFrequencyListItem| The GUID and name of the invoice frequency associated to the service agreement. | \r\n| InvoiceCycleListItem| The GUID and name of the Invoice cycle associated to the service agreement. | \r\n| OutletListItem| The GUID and name of the outlet associated to the service agreement. | \r\n| PaymentTypeListItem| The GUID and name of the payment type associated to the service agreement. | \r\n| PaymentTermListItem| The GUID and name of the payment term associated to the service agreement. |\r\n| DepartmentListItem| The GUID and name of the department associated to the service agreement. |\r\n| PrimaryServiceListItem| The GUID and name of the primary service associated to the service agreement. |\r\n| IsDeleted| Whether the service agreement is deleted. |\r\n| Prices| The list of prices associated to the service agreement. |\r\n| Prices[0].PriceGuid| The GUID associated to the price related to the service agreement. |\r\n| Prices[0].ActionListItem| The GUID and name of the action associated to the price. |\r\n| Prices[0].ServiceListItem| The GUID and name of the service associated to the price. |\r\n| Prices[0].UnitOfMeasureListItem| The GUID and name of the unit of measurement associated to the price. |\r\n| Prices[0].DefaultActionExternalDescription | The default action external description of the price. |\r\n| Prices[0].SalesCode| The sales code of the price. |\r\n| Prices[0].CostCode| The cost code of the price. OBSOLETE |\r\n| Prices[0].PurchaseCode| The purchase code of the price. OBSOLETE |\r\n| Prices[0].ContainerTypeListItem| The GUID and name of the container type associated to the price. |\r\n| Prices[0].MaterialListItem| The GUID and name of the material associated to the price. |\r\n| Prices[0].MaterialClassListItem| The GUID and name of the material class associated to the price. |\r\n| Prices[0].PricingBasisListItem| The GUID and name of the pricing basis associated to the price. |\r\n| Prices[0].DateDeleted| The date deleted of the price. |\r\n| Prices[0].IsDeleted| Whether the price is deleted. |\r\n| Prices[0].Amount| The amount object associated to the price. |\r\n| Prices[0].Amount.Price| The price associated to the amount. |\r\n| Prices[0].Amount.Offset| The offset associated to the amount. |\r\n| Prices[0].Amount.Percentage| The percentage associated to the amount. |\r\n| Prices[0].Amount.FloorPrice| The floor price associated to the amount. |\r\n| Prices[0].Amount.CeilingPrice| The ceiling price associated to the amount. |\r\n| Prices[0].Amount.MinimumCharge| The minimum charge associated to the amount. |\r\n| Prices[0].Amount.Allowance| The allowance associated to the amount. |\r\n| Prices[0].Amount.VATListItem| The GUID and name of the VAT associated to the amount. |\r\n| Prices[0].Amount.IsRebate| Whether the price is rebate. |\r\n| Prices[0].LatePaymentFeeDefinition | The late payment fee definition associated to the price. |\r\n| Prices[0].LatePaymentFeeDefinition.Description | The description associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.CustomerCategoryListItem | The GUID and description of the customer category associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.LatePaymentFeeTypeListItem | The GUID and description of the late payment fee type associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.ActionListItem | The GUID and description of the action associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.DefaultActionListItem | The GUID and description of the default action associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.RelatedPriceGuid | The GUID of the price associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.GraceDays | The GraceDays associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.FlatFeeAmount | The FlatFeeAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.PercentageFeeDecimalAmount | The PercentageFeeDecimalAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.PercentageFeeAmount | The PercentageFeeAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.MinimumCharge | The MinimumCharge associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.MaximumCharge | The MaximumCharge associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.IsDeleted | Whether the late payment fee definition is deleted. |\r\n| Prices[0].LatePaymentFeeDefinition.Guid | The Guid associated to the late payment fee definition. |\r\n| OrderCombinationGroups | The list of order combination groups associated to the service agreement. |\r\n| OrderCombinationGroups[0].Guid | The GUID associated to the order combination group. |\r\n| OrderCombinationGroups[0].InvoiceCycleListItem | The GUID and description of the invoice cycle associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsConcessionary | Whether the order combination group is concessionary. |\r\n| OrderCombinationGroups[0].IsRequiresPrePay | Whether the order combination group requires prepay. |\r\n| OrderCombinationGroups[0].Name | The name of the order combination group. |\r\n| OrderCombinationGroups[0].IsOutletLevelPricingUsed | Is outlet level pricing used. |\r\n| OrderCombinationGroups[0].AnnualContractCost | The cost of the annual contract. |\r\n| OrderCombinationGroups[0].AnnualContractValue | The value of the annual contract. |\r\n| OrderCombinationGroups[0].BillingUsagePolicyGuid | The GUID of the billing usage policy associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsUseReducedRateForAdditionalBin | Is reduced rate used for additional bin. |\r\n| OrderCombinationGroups[0].RefundableAdvanceDeposit | The refundable advance deposit. |\r\n| OrderCombinationGroups[0].StartDateDeferredDays | The start date deferred days. |\r\n| OrderCombinationGroups[0].ForceFullPayment| Whether the order combination group forces full payment. |\r\n| OrderCombinationGroups[0].UseOutletLevelPricing| Whether the order combination group uses outlet level pricing. |\r\n| OrderCombinationGroups[0].RelatedContractTermLengthGuid | The GUID of the contract term length associated to the order combination group. |\r\n| OrderCombinationGroups[0].SubscriptionTypeListItem | The GUID and description of the subscription type associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsDeleted | Whether the order combination group is deleted. |\r\n| RelatedOutlets | The list of related outlets associated to the service agreement. |\r\n| RelatedOutlets[0].Guid | The Guid associated to the related outlets. |\r\n| RelatedOutlets[0].CompanyOutletListItem | The Guid and description of the CompanyOutlet associated to the service agreement. |\r\n| RelatedOutlets[0].IsRelatedOutletDeleted | Is the service agreement deleted. |\r\n| RelatedCustomers | The list of related customers associated to the service agreement. |\r\n| RelatedCustomers[0].Guid | The Guid associated to the service agreement. |\r\n| RelatedCustomers[0].RelatedCustomerGuid | The related customer guid CompanyOutlet associated to the service agreement. |\r\n| RelatedCustomers[0].IsRelatedCustomerDeleted | Is the related customer deleted. |\r\n| RelatedCustomers[0].IsForAllSites | Is the related customer for all sites. |\r\n| RelatedCustomers[0].RelatedSites[] | The list of related sites associated to the service agreement. |\r\n| RelatedCustomers[0].RelatedSites[0].CustomerSiteGuid | The guid associated to the Customer site. |\r\n| RelatedCustomers[0].RelatedSites[0].RelatedSiteGuid | The RelatedSiteGuid associated to the site. |\r\n| RelatedCustomers[0].RelatedSites[0].IsRelatedSiteDeleted | Is the RelatedSite deleted. |\r\n| BillingUsagePolicies | The list of billing usage policies associated to the service agreement. |\r\n| BillingUsagePolicies[0].Guid | The GUID associated to the billing usage policy. |\r\n| BillingUsagePolicies[0].Description | The description of the billing usage policy. |\r\n| BillingUsagePolicies[0].AltWeightSourceForOutsideThreshold | Alternative weight source for outside threshold. |\r\n| BillingUsagePolicies[0].AltWeightSourceForZeroWeight | Alternative weight source for zero weight. |\r\n| BillingUsagePolicies[0].ApplyToWeightsOutsideThresholds | Whether to apply to weights outside thresholds. |\r\n| BillingUsagePolicies[0].ApplyToZeroWeights | Whether to apply to zero weights. |\r\n| BillingUsagePolicies[0].IsUseAccumulatedWeight | Whether to use accumulated weight. |\r\n| BillingUsagePolicies[0].IsUseActualLifts | Whether to use actual lifts. |\r\n| BillingUsagePolicies[0].IsUseExpectedLifts | Whether to use expected lifts. |\r\n| BillingUsagePolicies[0].FairUsageMonths | Number of fair usage months. |\r\n| BillingUsagePolicies[0].LiftsForAverage | Number of lifts to get average weight. |\r\n| BillingUsagePolicies[0].MonthlyLag | Number of monthly lag. |\r\n| BillingUsagePolicies[0].IsDeleted | Whether the billing usage policy is deleted. |\r\n| BillingUsagePolicies[0].Thresholds | The weight threshold associated to the billing usage policy. |\r\n| BillingUsagePolicies[0].Thresholds[0].Guid | The GUID associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].IsDeleted | Whether the billing usage policy weight threshold is deleted. |\r\n| BillingUsagePolicies[0].Thresholds[0].MinWeight | The minimum weight associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].MaxWeight | The maximum weight associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].ContainerTypeListItem | The GUID and description of the container type associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].MaterialListItem | The GUID and description of the material associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].UnitOfMeasurementListItem | The GUID and description of the unit of measurement associated to the billing usage policy weight threshold. |\r\n| PriceGuidFilter | Used to filter on the Guid in the Prices array. |\r\n| CompanyOutletListItemGuidFilter | Used to filter on the CompanyOutletListItem Guid in the RelatedOutlets array. |\r\n| RelatedCustomerGuidFilter | Used to filter on the GUID in the RelatedCustomers array. |\r\n| RelatedCustomersGuidFilter | Used to filter on the RelatedCustomerGuid in the RelatedCustomers array. |\r\n| RelatedSiteGuidFilter | Used to filter on the GUID in the RelatedSites array. |\r\n"
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 |\r\n| -------------- | ------------------------------------------------------------ |\r\n| GUID| The GUID associated to the service agreement. |\r\n| Description| The description associated to the service agreement. | \r\n| StartDate| The start date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| EndDate| The end date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| ReviewDate| The review date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| RelatedCustomerGuid| The GUID of the customer associated to the service agreement. Filterable. | \r\n| EndReasonListItem| The GUID and name of the end reason associated to the service agreement. | \r\n| InvoiceFrequencyListItem| The GUID and name of the invoice frequency associated to the service agreement. | \r\n| InvoiceCycleListItem| The GUID and name of the Invoice cycle associated to the service agreement. | \r\n| OutletListItem| The GUID and name of the outlet associated to the service agreement. | \r\n| PaymentTypeListItem| The GUID and name of the payment type associated to the service agreement. | \r\n| PaymentTermListItem| The GUID and name of the payment term associated to the service agreement. |\r\n| DepartmentListItem| The GUID and name of the department associated to the service agreement. |\r\n| PrimaryServiceListItem| The GUID and name of the primary service associated to the service agreement. |\r\n| IsDeleted| Whether the service agreement is deleted. |\r\n| Prices| The list of prices associated to the service agreement. |\r\n| Prices[0].PriceGuid| The GUID associated to the price related to the service agreement. |\r\n| Prices[0].ActionListItem| The GUID and name of the action associated to the price. |\r\n| Prices[0].ServiceListItem| The GUID and name of the service associated to the price. |\r\n| Prices[0].UnitOfMeasureListItem| The GUID and name of the unit of measurement associated to the price. |\r\n| Prices[0].DefaultActionExternalDescription | The default action external description of the price. |\r\n| Prices[0].SalesCode| The sales code of the price. |\r\n| Prices[0].CostCode| The cost code of the price. OBSOLETE |\r\n| Prices[0].PurchaseCode| The purchase code of the price. OBSOLETE |\r\n| Prices[0].ContainerTypeListItem| The GUID and name of the container type associated to the price. |\r\n| Prices[0].MaterialListItem| The GUID and name of the material associated to the price. |\r\n| Prices[0].MaterialClassListItem| The GUID and name of the material class associated to the price. |\r\n| Prices[0].PricingBasisListItem| The GUID and name of the pricing basis associated to the price. |\r\n| Prices[0].DateDeleted| The date deleted of the price. |\r\n| Prices[0].IsDeleted| Whether the price is deleted. |\r\n| Prices[0].Amount| The amount object associated to the price. |\r\n| Prices[0].Amount.Price| The price associated to the amount. |\r\n| Prices[0].Amount.Offset| The offset associated to the amount. |\r\n| Prices[0].Amount.Percentage| The percentage associated to the amount. |\r\n| Prices[0].Amount.FloorPrice| The floor price associated to the amount. |\r\n| Prices[0].Amount.CeilingPrice| The ceiling price associated to the amount. |\r\n| Prices[0].Amount.MinimumCharge| The minimum charge associated to the amount. |\r\n| Prices[0].Amount.Allowance| The allowance associated to the amount. |\r\n| Prices[0].Amount.VATListItem| The GUID and name of the VAT associated to the amount. |\r\n| Prices[0].Amount.IsRebate| Whether the price is rebate. |\r\n| Prices[0].LatePaymentFeeDefinition | The late payment fee definition associated to the price. |\r\n| Prices[0].LatePaymentFeeDefinition.Description | The description associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.CustomerCategoryListItem | The GUID and description of the customer category associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.LatePaymentFeeTypeListItem | The GUID and description of the late payment fee type associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.ActionListItem | The GUID and description of the action associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.DefaultActionListItem | The GUID and description of the default action associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.RelatedPriceGuid | The GUID of the price associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.GraceDays | The GraceDays associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.FlatFeeAmount | The FlatFeeAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.PercentageFeeDecimalAmount | The PercentageFeeDecimalAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.PercentageFeeAmount | The PercentageFeeAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.MinimumCharge | The MinimumCharge associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.MaximumCharge | The MaximumCharge associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.IsDeleted | Whether the late payment fee definition is deleted. |\r\n| Prices[0].LatePaymentFeeDefinition.Guid | The Guid associated to the late payment fee definition. |\r\n| OrderCombinationGroups | The list of order combination groups associated to the service agreement. |\r\n| OrderCombinationGroups[0].Guid | The GUID associated to the order combination group. |\r\n| OrderCombinationGroups[0].InvoiceCycleListItem | The GUID and description of the invoice cycle associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsConcessionary | Whether the order combination group is concessionary. |\r\n| OrderCombinationGroups[0].IsRequiresPrePay | Whether the order combination group requires prepay. |\r\n| OrderCombinationGroups[0].Name | The name of the order combination group. |\r\n| OrderCombinationGroups[0].IsOutletLevelPricingUsed | Is outlet level pricing used. |\r\n| OrderCombinationGroups[0].AnnualContractCost | The cost of the annual contract. |\r\n| OrderCombinationGroups[0].AnnualContractValue | The value of the annual contract. |\r\n| OrderCombinationGroups[0].BillingUsagePolicyGuid | The GUID of the billing usage policy associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsUseReducedRateForAdditionalBin | Is reduced rate used for additional bin. |\r\n| OrderCombinationGroups[0].RefundableAdvanceDeposit | The refundable advance deposit. |\r\n| OrderCombinationGroups[0].StartDateDeferredDays | The start date deferred days. |\r\n| OrderCombinationGroups[0].ForceFullPayment| Whether the order combination group forces full payment. |\r\n| OrderCombinationGroups[0].UseOutletLevelPricing| Whether the order combination group uses outlet level pricing. |\r\n| OrderCombinationGroups[0].RelatedContractTermLengthGuid | The GUID of the contract term length associated to the order combination group. |\r\n| OrderCombinationGroups[0].SubscriptionTypeListItem | The GUID and description of the subscription type associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsDeleted | Whether the order combination group is deleted. |\r\n| RelatedOutlets | The list of related outlets associated to the service agreement. |\r\n| RelatedOutlets[0].Guid | The Guid associated to the related outlets. |\r\n| RelatedOutlets[0].CompanyOutletListItem | The Guid and description of the CompanyOutlet associated to the service agreement. |\r\n| RelatedOutlets[0].IsRelatedOutletDeleted | Is the service agreement deleted. |\r\n| RelatedCustomers | The list of related customers associated to the service agreement. |\r\n| RelatedCustomers[0].Guid | The Guid associated to the service agreement. |\r\n| RelatedCustomers[0].RelatedCustomerGuid | The related customer guid CompanyOutlet associated to the service agreement. |\r\n| RelatedCustomers[0].IsRelatedCustomerDeleted | Is the related customer deleted. |\r\n| RelatedCustomers[0].IsForAllSites | Is the related customer for all sites. |\r\n| RelatedCustomers[0].RelatedSites[] | The list of related sites associated to the service agreement. |\r\n| RelatedCustomers[0].RelatedSites[0].CustomerSiteGuid | The guid associated to the Customer site. |\r\n| RelatedCustomers[0].RelatedSites[0].RelatedSiteGuid | The RelatedSiteGuid associated to the site. |\r\n| RelatedCustomers[0].RelatedSites[0].IsRelatedSiteDeleted | Is the RelatedSite deleted. |\r\n| BillingUsagePolicies | The list of billing usage policies associated to the service agreement. |\r\n| BillingUsagePolicies[0].Guid | The GUID associated to the billing usage policy. |\r\n| BillingUsagePolicies[0].Description | The description of the billing usage policy. |\r\n| BillingUsagePolicies[0].AltWeightSourceForOutsideThreshold | Alternative weight source for outside threshold. |\r\n| BillingUsagePolicies[0].AltWeightSourceForZeroWeight | Alternative weight source for zero weight. |\r\n| BillingUsagePolicies[0].ApplyToWeightsOutsideThresholds | Whether to apply to weights outside thresholds. |\r\n| BillingUsagePolicies[0].ApplyToZeroWeights | Whether to apply to zero weights. |\r\n| BillingUsagePolicies[0].IsUseAccumulatedWeight | Whether to use accumulated weight. |\r\n| BillingUsagePolicies[0].IsUseActualLifts | Whether to use actual lifts. |\r\n| BillingUsagePolicies[0].IsUseExpectedLifts | Whether to use expected lifts. |\r\n| BillingUsagePolicies[0].FairUsageMonths | Number of fair usage months. |\r\n| BillingUsagePolicies[0].LiftsForAverage | Number of lifts to get average weight. |\r\n| BillingUsagePolicies[0].MonthlyLag | Number of monthly lag. |\r\n| BillingUsagePolicies[0].IsDeleted | Whether the billing usage policy is deleted. |\r\n| BillingUsagePolicies[0].Thresholds | The weight threshold associated to the billing usage policy. |\r\n| BillingUsagePolicies[0].Thresholds[0].Guid | The GUID associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].IsDeleted | Whether the billing usage policy weight threshold is deleted. |\r\n| BillingUsagePolicies[0].Thresholds[0].MinWeight | The minimum weight associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].MaxWeight | The maximum weight associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].ContainerTypeListItem | The GUID and description of the container type associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].MaterialListItem | The GUID and description of the material associated to the billing usage policy weight threshold. |\r\n| BillingUsagePolicies[0].Thresholds[0].UnitOfMeasurementListItem | The GUID and description of the unit of measurement associated to the billing usage policy weight threshold. |\r\n| PriceGuidFilter | Used to filter on the Guid in the Prices array. |\r\n| CompanyOutletListItemGuidFilter | Used to filter on the CompanyOutletListItem Guid in the RelatedOutlets array. |\r\n| RelatedCustomerGuidFilter | Used to filter on the GUID in the RelatedCustomers array. |\r\n| RelatedCustomersGuidFilter | Used to filter on the RelatedCustomerGuid in the RelatedCustomers array. |\r\n| RelatedSiteGuidFilter | Used to filter on the GUID in the RelatedSites array. |\r\n"
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 |\r\n| -------------- | ------------------------------------------------------------ |\r\n| GUID| The GUID associated to the service agreement. |\r\n| Description| The description associated to the service agreement. | \r\n| StartDate| The start date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| EndDate| The end date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| ReviewDate| The review date associated to the service agreement in ISO format (YYYY-MM-DD). | \r\n| RelatedCustomerGuid| The GUID of the customer associated to the service agreement. Filterable. | \r\n| EndReasonListItem| The GUID and name of the end reason associated to the service agreement. | \r\n| InvoiceFrequencyListItem| The GUID and name of the invoice frequency associated to the service agreement. | \r\n| InvoiceCycleListItem| The GUID and name of the Invoice cycle associated to the service agreement. | \r\n| OutletListItem| The GUID and name of the outlet associated to the service agreement. | \r\n| PaymentTypeListItem| The GUID and name of the payment type associated to the service agreement. | \r\n| PaymentTermListItem| The GUID and name of the payment term associated to the service agreement. |\r\n| DepartmentListItem| The GUID and name of the department associated to the service agreement. |\r\n| PrimaryServiceListItem| The GUID and name of the primary service associated to the service agreement. |\r\n| IsDeleted| Whether the service agreement is deleted. |\r\n| Prices| The list of prices associated to the service agreement. |\r\n| Prices[0].PriceGuid| The GUID associated to the price related to the service agreement. |\r\n| Prices[0].ActionListItem| The GUID and name of the action associated to the price. |\r\n| Prices[0].ServiceListItem| The GUID and name of the service associated to the price. |\r\n| Prices[0].UnitOfMeasureListItem| The GUID and name of the unit of measurement associated to the price. |\r\n| Prices[0].DefaultActionExternalDescription | The default action external description of the price. |\r\n| Prices[0].SalesCode| The sales code of the price. |\r\n| Prices[0].CostCode| The cost code of the price. OBSOLETE |\r\n| Prices[0].PurchaseCode| The purchase code of the price. OBSOLETE |\r\n| Prices[0].ContainerTypeListItem| The GUID and name of the container type associated to the price. |\r\n| Prices[0].MaterialListItem| The GUID and name of the material associated to the price. |\r\n| Prices[0].MaterialClassListItem| The GUID and name of the material class associated to the price. |\r\n| Prices[0].PricingBasisListItem| The GUID and name of the pricing basis associated to the price. |\r\n| Prices[0].DateDeleted| The date deleted of the price. |\r\n| Prices[0].IsDeleted| Whether the price is deleted. |\r\n| Prices[0].Amount| The amount object associated to the price. |\r\n| Prices[0].Amount.Price| The price associated to the amount. |\r\n| Prices[0].Amount.Offset| The offset associated to the amount. |\r\n| Prices[0].Amount.Percentage| The percentage associated to the amount. |\r\n| Prices[0].Amount.FloorPrice| The floor price associated to the amount. |\r\n| Prices[0].Amount.CeilingPrice| The ceiling price associated to the amount. |\r\n| Prices[0].Amount.MinimumCharge| The minimum charge associated to the amount. |\r\n| Prices[0].Amount.Allowance| The allowance associated to the amount. |\r\n| Prices[0].Amount.VATListItem| The GUID and name of the VAT associated to the amount. |\r\n| Prices[0].Amount.IsRebate| Whether the price is rebate. |\r\n| Prices[0].LatePaymentFeeDefinition | The late payment fee definition associated to the price. |\r\n| Prices[0].LatePaymentFeeDefinition.Description | The description associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.CustomerCategoryListItem | The GUID and description of the customer category associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.LatePaymentFeeTypeListItem | The GUID and description of the late payment fee type associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.ActionListItem | The GUID and description of the action associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.DefaultActionListItem | The GUID and description of the default action associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.RelatedPriceGuid | The GUID of the price associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.GraceDays | The GraceDays associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.FlatFeeAmount | The FlatFeeAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.PercentageFeeDecimalAmount | The PercentageFeeDecimalAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.PercentageFeeAmount | The PercentageFeeAmount associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.MinimumCharge | The MinimumCharge associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.MaximumCharge | The MaximumCharge associated to the late payment fee definition. |\r\n| Prices[0].LatePaymentFeeDefinition.IsDeleted | Whether the late payment fee definition is deleted. |\r\n| Prices[0].LatePaymentFeeDefinition.Guid | The Guid associated to the late payment fee definition. |\r\n| OrderCombinationGroups | The list of order combination groups associated to the service agreement. |\r\n| OrderCombinationGroups[0].Guid | The GUID associated to the order combination group. |\r\n| OrderCombinationGroups[0].InvoiceCycleListItem | The GUID and description of the invoice cycle associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsConcessionary | Whether the order combination group is concessionary. |\r\n| OrderCombinationGroups[0].IsRequiresPrePay | Whether the order combination group requires prepay. |\r\n| OrderCombinationGroups[0].Name | The name of the order combination group. |\r\n| OrderCombinationGroups[0].IsOutletLevelPricingUsed | Is outlet level pricing used. |\r\n| OrderCombinationGroups[0].AnnualContractCost | The cost of the annual contract. |\r\n| OrderCombinationGroups[0].AnnualContractValue | The value of the annual contract. |\r\n| OrderCombinationGroups[0].BillingUsagePolicyGuid | The GUID of the billing usage policy associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsUseReducedRateForAdditionalBin | Is reduced rate used for additional bin. |\r\n| OrderCombinationGroups[0].RefundableAdvanceDeposit | The refundable advance deposit. |\r\n| OrderCombinationGroups[0].StartDateDeferredDays | The start date deferred days. |\r\n| OrderCombinationGroups[0].ForceFullPayment| Whether the order combination group forces full payment. |\r\n| OrderCombinationGroups[0].UseOutletLevelPricing| Whether the order combination group uses outlet level pricing. |\r\n| OrderCombinationGroups[0].RelatedContractTermLengthGuid | The GUID of the contract term length associated to the order combination group. |\r\n| OrderCombinationGroups[0].SubscriptionTypeListItem | The GUID and description of the subscription type associated to the order combination group. |\r\n| OrderCombinationGroups[0].IsDeleted | Whether the order combination group is deleted. |\r\n| RelatedOutlets | The list of related outlets associated to the service agreement. |\r\n| RelatedOutlets[0].Guid | The Guid associated to the related outlets. |\r\n| RelatedOutlets[0].CompanyOutletListItem | The Guid and description of the CompanyOutlet
# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-serviceagreement-api-openapi.yml