AMCS Group AccountCustomer API
The AccountCustomer API from AMCS Group — 3 operation(s) for accountcustomer.
The AccountCustomer API from AMCS Group — 3 operation(s) for accountcustomer.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amcs-group-accountcustomer-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Core AccessGroup Account Customer 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: AccountCustomer
paths:
/accounting/accountCustomers/changes:
get:
tags:
- AccountCustomer
summary: Retrieve changes
description: "| Property | Description |\n| ------------------------- | ------------------------------------------------------------------------ |\n| GUID | The GUID associated to the customer. |\n| Name | The customer's name. |\n| Reference | An alternative name used for the customer. |\n| FederalId | The customer's local authority / government / tax reference. |\n| IsInternal | Whether the customer is an internal customer. |\n| ARAccountCode | Used to filter customers on the accounts receivable code. |\n| APAccountCode | Used to filter customers on the accounts payable code. |\n| Notes| Notes of customer. |\n| AMICENumber| AMICE Number of customer. |\n| CoCNumber| CoC Number of customer. |\n| HasRedLight | Red light indicator passed to driver to indicate the mood of the end customer.|\n| CombineChargesRebates | Rebate are included on the invoice, otherwise a separate bill is generated for rebates. |\n| ExternalVehicleValidation | The customer uses their own vehicles and the weighbridge will need to validate the vehicle registrations against a list held on the AMCS Platform. |\n| TicketsRequiredWithInvoice | Tickets are required with invoice. |\n| RctCustomer | In the Republic of Ireland the customer is a contractor liable for Relevent Contractors Tax. |\n| ProofOfServiceRequired | Customers need to sign tickets. |\n| ExcludeFromStatementRun | Excludes them from the batch statement run. |\n| ReceiveServiceUpdatesByEmail | Customer receives service updates by email. |\n| ReceiveServiceUpdatesByText | Customer receives service updates by text. |\n| ReceiveMarketingUpdatesByEmail | Customer receives marketing updates by email. |\n| ReceiveMarketingUpdatesByText | Customer receives marketing updates by text. |\n| CompanyListItem | The GUID and name of the company this customer is associated to. |\n| CustomerStateListItem | The GUID and status of the customer (eg. Active, Suspended, etc.). |\n| CustomerStateChangeReasonListItem | The GUID and reason of the latest state change. | \n| CustomerTypeListItem | The GUID and type of customer (eg. Residential, Commerical, Municipal). |\n| CustomerCategoryListItem | The GUID and category of the customer (various values). |\n| CustomerGroupListItem | The GUID and group of the customer (various values). |\n| VisitStatusListItem | The GUID and description of the visit status of the customer |\n| CurrencyListItem | The GUID and currency of the customer (various values). |\n| CustomerTemplateListItem| The GUID and customer template of the customer (various values). |\n| BusinessTypeListItem | The GUID and business type of the customer (various values). |\n| AutoArAccountCode| The object allowing for creation of an ArAccountCode, depending on system configuration. |\n| AutoArAccountCode.CompanyOutletGuid | The GUID of the company outlet used for creation of an ArAccountCode, depending on system configuration. |\n| RelatedUserSalesRepGuid | The GUID of the related sales rep. | \n| RelatedUserCreditControllerGuid | The GUID of the related credit controller. | \n| RelatedMasterAccountGuid | The GUID of the related master account. | \n| RelatedBillToCustomerGuid | The GUID of the related customer where the bills must be send to. | \n| RelatedLocationHQGuid| The GUID associated to the HQ location of the customer. | \n| BankDetails| The object where bank details are specified. |\n| BankDetails.BankName | The bank name of the direct debit. |\n| BankDetails.AccountName | The account name of the direct debit. |\n| BankDetails.AccountNo | The account number of the direct debit. |\n| BankDetails.SortCode | The sort code of the direct debit. |\n| BankDetails.BIC | The Bank Identifier Code of the direct debit. |\n| BankDetails.IBAN | The International Bank Account Number of the direct debit. |\n| BankDetails.NationalBankCode | The National Bank Code of the direct debit. |\n| BankDetails.DirectDebitRunConfigListItem | The GUID and description of the direct debit run configuration. |\n| BankDetails.DirectDebitAccountTypeListItem | The GUID and description of the direct debit account type. |\n| BankDetails.Address | The object where bank address details are specified. |\n| BankDetails.Address.Address1 | The Address1 of the bank. |\n| BankDetails.Address.Address2 | The Address2 of the bank. |\n| BankDetails.Address.Address3 | The Address3 of the bank. |\n| BankDetails.Address.Address4 | The Address4 of the bank. |\n| BankDetails.Address.Address5 | The Address5 of the bank. |\n| BankDetails.Address.Postcode | The Postcode of the bank. |\n| Contract| The object allowing for creation of the contract. |\n| Contract.StartDate | The start date of the contract in ISO format (YYYY-MM-DD). |\n| Contract.ApprovedDate | The approved date of the contract in ISO format (YYYY-MM-DD). |\n| Contract.CreditLimit | The maximum credit limit stipulated on this contract. |\n| Contract.BalanceMigrated | The balance which has been migrated. |\n| Contract.InvoiceCycleId | The Id of the invoice cycle this contract will be invoice under (there may be cycles done monthly, daily, weekly, etc.) |\n| Contract.VATExemptNumber | If the contract is exempt from VAT, this is the associated confirmation number. |\n| Contract.VATExemptionExpiryDate | If the contract is exempt from VAT this is date this status is no longer valid in ISO format (YYYY-MM-DD). |\n| Contract.VATRegistrationNumber | If the contract is registered with VAT, this is the relevant number. |\n| Contract.RollUpInvoiceBySite | Whether the roll up of invoice are done by site. |\n| Contract.RollUpInvoiceByService | Whether the roll up of invoice are done by service. |\n| Contract.IsInvoiceCollated | Whether the invoice are collated.|\n| Contract.DepartmentListItem | The GUID and name of the department this contract is associated to. |\n| Contract.ContractStatusListItem | The GUID and status of the contract (eg. Approved, Pending, Un-Approved). |\n| Contract.PaymentTypeListItem | The GUID and description of how payments for invoices under the contract will be paid (eg. Cash, Credit Card, etc.). |\n| Contract.PaymentTermListItem | The GUID and description of the payment terms invoices under the contract are to the paid to (eg. Immediately, 30 Days Net, etc.). |\n| Contract.InvoiceFrequencyTermListItem | The GUID and description of the invoice frequency term (eg. Quarterly, Immediate, etc.). |\n| Contract.InvoiceDocumentDeliveryMethods[]| The array of document delivery types associated to the Contract.|\n| Contract.InvoiceDocumentDeliveryMethods[0].DocumentDeliveryType| The GUID and description of the document delivery type associated to the InvoiceDocumentDeliveryMethods. |\n| Balance| The object which allows creation of Customer Balance.|\n| Balance.OutstandingAmount | The Outstanding Amount on the customers account.| \n| Balance.UnallocatedAmount | The Unallocated Amount on the customers account.| \n| Balance.UnconfirmedBalance | The Unconfirmed Balance Amount on the customers account.| \n| Balance.LedgerBalance | The Ledger Balance Amount on the customers account.| \n| TradingNames.Guid | The TradingNames Guid on the customers account. | \n| TradingNames.Description | The TradingNames Description on the customers account.| \n| TradingNames.TradingNameTypeListItem.Guid | The Guid associated to the TradingNameTypeListItem on the customers account. | \n| TradingNames.TradingNameTypeListItem.Description | The Description associated to the TradingNameTypeListItem on the customers account. | \n| TradingNames.IsDeleted | Is the TradingName Deleted. | \n| TradingNames.IsForAllSites | IsForAllSites set for the TradingNames. | \n| PaymentProviderSettings[0].Name | The Name of the Payment Provider Settings. |\n| PaymentProviderSettings[0].Value | The Value of the Payment Provider Settings. |\n| PaymentProviderSettings[0].PaymentProviderListItem | The Guid and Description associated to the PaymentProviderListItem of the Payment Provider Settings. |\n| PaymentProviderSettings[0].IsDeleted | Is the PaymentProviderSettings deleted. |\n| PaymentProviderSettings[0].Guid | The Guid of the Payment Provider Settings. |\n| CreditCards[0].Forename | The Forename of the credit card holder. | \n| CreditCards[0].Surname | The Surname of the credit card holder. | \n| CreditCards[0].Postcode | The Postcode associated to the credit card. | \n| CreditCards[0].Province | The Province associated to the credit card. | \n| CreditCards[0].DateCreated | The DateCreated associated to the credit card. | \n| CreditCards[0].MaskedCreditCardNumber | The MaskedCreditCardNumber associated to the credit card. | \n| CreditCards[0].Address1 | The Address1 associated to the credit card. | \n| CreditCards[0].City | The City associated to the credit card. | \n| CreditCards[0].RelatedContactGuid | The RelatedContactGuid associated to the credit card. | \n| CreditCards[0].Country | The Country associated to the credit card. | \n| CreditCards[0].CreditCardExpiryDate | The CreditCardExpiryDate associated to the credit card. | \n| CreditCards[0].Currency | The Currency associated to the credit card. | \n| CreditCards[0].ExternalVaultCardReference | The ExternalVaultCardReference associated to the credit card. | \n| CreditCards[0].ExternalVaultReference | The ExternalVaultReference associated to the credit card. | \n| CreditCards[0].IsACH | Is the payment an ACH payment. | \n| CreditCards[0].Deleted | Is the CreditCard deleted. |\n| CreditCards[0].IsRequestWithImmediateResponse | The IsRequestWithImmediateResponse associated to the credit card. | \n| CreditCards[0].PayerReference | The payer reference associated to the credit card. | \n| CreditCards[0].PaymentReference | The payment reference associated to the credit card. | \n| CreditCards[0].PaymentPointListItem | The Guid and Description associated to the PaymentPointListItem to the credit card. | \n| CreditCards[0].PaymentProviderListItem | The Guid and Description associated to the PaymentProviderListItem to the credit card. | \n| CreditCards[0].Guid | The Guid associated to the credit card. |\n| RelatedCustomerStateChangeRequests| The array of related customer state change requests|\n| RelatedCustomerStateChangeRequests[0].EffectiveDate| The effective date associated to the customer state change request|\n| RelatedCustomerStateChangeRequests[0].RelatedCustomerStateGuid| The related customer state guid associated to the customer state change request|\n| RelatedCustomerStateChangeRequests[0].RelatedChangeReasonGuid| The related customer change reason guid associated to the customer state change request|\n| RelatedBlobHashes| The array of related external documents to the account customer. |\n| RelatedBlobHashes[0].Hash| The hash of the external document blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted. |\n| RelatedReportBlobs| The array of related report documents to the account customer. |\n| RelatedReportBlobs[0].Guid| The Guid associated to the customer report. |\n| RelatedReportBlobs[0].Hash| The hash of the report document blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted. |\n| RelatedReportBlobs[0].DocumentDescription| The description associated to the customer report.|\n| RelatedReportBlobs[0].DocumentName| The document name associated to the customer report.|\n| RelatedReportBlobs[0].IsForAllSites| Whether the customer report is for all sites of related customer.|\n| RelatedReportBlobs[0].RelatedSites| The list of related customer report sites.|\n| RelatedReportBlobs[0].RelatedSites[0].Guid| The guid associated to the customer report site.|\n| RelatedReportBlobs[0].RelatedSites[0].RelatedSiteGuid| The related customer siteguid associated to the customer report site.|\n| RelatedReportBlobs[0].RelatedExcludedSites| The list of excluded related customer report sites.|\n| RelatedReportBlobs[0].RelatedExcludedSites[0].Guid| The guid associated to the customer report site.|\n| RelatedReportBlobs[0].RelatedExcludedSites[0].RelatedSiteGuid| The related customer siteguid associated to the customer report site.|\n| RelatedExternalVehicles| The array of related external vehicles associated to the account customer.|\n| RelatedExternalVehicles[0].RelatedExternalVehicleGuid| The related external vehicleguid associated to the account customer. |\n| RelatedExternalVehicles[0].IsForAllMaterials | Whether the related external vehicle is for all Materials. |\n| RelatedExternalVehicles[0].IsForAllSites | Whether the related external vehicle is for all Sites.|\n| RelatedExternalVehicles[0].ValidFrom | The valid from date of the related external vehicles in ISO format (YYYY-MM-DD).|\n| RelatedExternalVehicles[0].ValidTo | The valid to date of the related external vehicles in ISO format (YYYY-MM-DD).|\n| RelatedExternalVehicles[0].IsDeleted | Whether the related external vehicle is deleted.|\n| RelatedExternalVehicles[0].Guid | The Guid associated to the related external vehicle.|\n| CustomerBusinessType| The array of related customer business type associated to the account customer. |\n| CustomerBusinessType[0].Guid| The customer business type Guid associated to the account customer.|\n| CustomerBusinessType[0].BusinessTypeOptionListItem| The Guid and Description associated to the BusinessTypeOptionListItem to the customer business type.|\n| DefaultSicCodeListItem| The Guid and Description associated to the DefaultSicCodeListItem to the account customer.|\n| IsTaxExempt| Whether the account customer is tax exempt. |\n| TradingNameGuidFilter| Filter by the Guid of the Trading Name. |\n| TradingNameFilter| Filter by the Trading Name. |\n| RelatedExternalVehicleGuidFilter| Filter by the Guid of the Related External Vehicle. |"
operationId: AccountCustomer_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_ApiIntegratorAccountCustomerResource'
/accounting/accountCustomers/{guid}:
get:
tags:
- AccountCustomer
summary: Find with GUID
description: "| Property | Description |\n| ------------------------- | ------------------------------------------------------------------------ |\n| GUID | The GUID associated to the customer. |\n| Name | The customer's name. |\n| Reference | An alternative name used for the customer. |\n| FederalId | The customer's local authority / government / tax reference. |\n| IsInternal | Whether the customer is an internal customer. |\n| ARAccountCode | Used to filter customers on the accounts receivable code. |\n| APAccountCode | Used to filter customers on the accounts payable code. |\n| Notes| Notes of customer. |\n| AMICENumber| AMICE Number of customer. |\n| CoCNumber| CoC Number of customer. |\n| HasRedLight | Red light indicator passed to driver to indicate the mood of the end customer.|\n| CombineChargesRebates | Rebate are included on the invoice, otherwise a separate bill is generated for rebates. |\n| ExternalVehicleValidation | The customer uses their own vehicles and the weighbridge will need to validate the vehicle registrations against a list held on the AMCS Platform. |\n| TicketsRequiredWithInvoice | Tickets are required with invoice. |\n| RctCustomer | In the Republic of Ireland the customer is a contractor liable for Relevent Contractors Tax. |\n| ProofOfServiceRequired | Customers need to sign tickets. |\n| ExcludeFromStatementRun | Excludes them from the batch statement run. |\n| ReceiveServiceUpdatesByEmail | Customer receives service updates by email. |\n| ReceiveServiceUpdatesByText | Customer receives service updates by text. |\n| ReceiveMarketingUpdatesByEmail | Customer receives marketing updates by email. |\n| ReceiveMarketingUpdatesByText | Customer receives marketing updates by text. |\n| CompanyListItem | The GUID and name of the company this customer is associated to. |\n| CustomerStateListItem | The GUID and status of the customer (eg. Active, Suspended, etc.). |\n| CustomerStateChangeReasonListItem | The GUID and reason of the latest state change. | \n| CustomerTypeListItem | The GUID and type of customer (eg. Residential, Commerical, Municipal). |\n| CustomerCategoryListItem | The GUID and category of the customer (various values). |\n| CustomerGroupListItem | The GUID and group of the customer (various values). |\n| VisitStatusListItem | The GUID and description of the visit status of the customer |\n| CurrencyListItem | The GUID and currency of the customer (various values). |\n| CustomerTemplateListItem| The GUID and customer template of the customer (various values). |\n| BusinessTypeListItem | The GUID and business type of the customer (various values). |\n| AutoArAccountCode| The object allowing for creation of an ArAccountCode, depending on system configuration. |\n| AutoArAccountCode.CompanyOutletGuid | The GUID of the company outlet used for creation of an ArAccountCode, depending on system configuration. |\n| RelatedUserSalesRepGuid | The GUID of the related sales rep. | \n| RelatedUserCreditControllerGuid | The GUID of the related credit controller. | \n| RelatedMasterAccountGuid | The GUID of the related master account. | \n| RelatedBillToCustomerGuid | The GUID of the related customer where the bills must be send to. | \n| RelatedLocationHQGuid| The GUID associated to the HQ location of the customer. | \n| BankDetails| The object where bank details are specified. |\n| BankDetails.BankName | The bank name of the direct debit. |\n| BankDetails.AccountName | The account name of the direct debit. |\n| BankDetails.AccountNo | The account number of the direct debit. |\n| BankDetails.SortCode | The sort code of the direct debit. |\n| BankDetails.BIC | The Bank Identifier Code of the direct debit. |\n| BankDetails.IBAN | The International Bank Account Number of the direct debit. |\n| BankDetails.NationalBankCode | The National Bank Code of the direct debit. |\n| BankDetails.DirectDebitRunConfigListItem | The GUID and description of the direct debit run configuration. |\n| BankDetails.DirectDebitAccountTypeListItem | The GUID and description of the direct debit account type. |\n| BankDetails.Address | The object where bank address details are specified. |\n| BankDetails.Address.Address1 | The Address1 of the bank. |\n| BankDetails.Address.Address2 | The Address2 of the bank. |\n| BankDetails.Address.Address3 | The Address3 of the bank. |\n| BankDetails.Address.Address4 | The Address4 of the bank. |\n| BankDetails.Address.Address5 | The Address5 of the bank. |\n| BankDetails.Address.Postcode | The Postcode of the bank. |\n| Contract| The object allowing for creation of the contract. |\n| Contract.StartDate | The start date of the contract in ISO format (YYYY-MM-DD). |\n| Contract.ApprovedDate | The approved date of the contract in ISO format (YYYY-MM-DD). |\n| Contract.CreditLimit | The maximum credit limit stipulated on this contract. |\n| Contract.BalanceMigrated | The balance which has been migrated. |\n| Contract.InvoiceCycleId | The Id of the invoice cycle this contract will be invoice under (there may be cycles done monthly, daily, weekly, etc.) |\n| Contract.VATExemptNumber | If the contract is exempt from VAT, this is the associated confirmation number. |\n| Contract.VATExemptionExpiryDate | If the contract is exempt from VAT this is date this status is no longer valid in ISO format (YYYY-MM-DD). |\n| Contract.VATRegistrationNumber | If the contract is registered with VAT, this is the relevant number. |\n| Contract.RollUpInvoiceBySite | Whether the roll up of invoice are done by site. |\n| Contract.RollUpInvoiceByService | Whether the roll up of invoice are done by service. |\n| Contract.IsInvoiceCollated | Whether the invoice are collated.|\n| Contract.DepartmentListItem | The GUID and name of the department this contract is associated to. |\n| Contract.ContractStatusListItem | The GUID and status of the contract (eg. Approved, Pending, Un-Approved). |\n| Contract.PaymentTypeListItem | The GUID and description of how payments for invoices under the contract will be paid (eg. Cash, Credit Card, etc.). |\n| Contract.PaymentTermListItem | The GUID and description of the payment terms invoices under the contract are to the paid to (eg. Immediately, 30 Days Net, etc.). |\n| Contract.InvoiceFrequencyTermListItem | The GUID and description of the invoice frequency term (eg. Quarterly, Immediate, etc.). |\n| Contract.InvoiceDocumentDeliveryMethods[]| The array of document delivery types associated to the Contract.|\n| Contract.InvoiceDocumentDeliveryMethods[0].DocumentDeliveryType| The GUID and description of the document delivery type associated to the InvoiceDocumentDeliveryMethods. |\n| Balance| The object which allows creation of Customer Balance.|\n| Balance.OutstandingAmount | The Outstanding Amount on the customers account.| \n| Balance.UnallocatedAmount | The Unallocated Amount on the customers account.| \n| Balance.UnconfirmedBalance | The Unconfirmed Balance Amount on the customers account.| \n| Balance.LedgerBalance | The Ledger Balance Amount on the customers account.| \n| TradingNames.Guid | The TradingNames Guid on the customers account. | \n| TradingNames.Description | The TradingNames Description on the customers account.| \n| TradingNames.TradingNameTypeListItem.Guid | The Guid associated to the TradingNameTypeListItem on the customers account. | \n| TradingNames.TradingNameTypeListItem.Description | The Description associated to the TradingNameTypeListItem on the customers account. | \n| TradingNames.IsDeleted | Is the TradingName Deleted. | \n| TradingNames.IsForAllSites | IsForAllSites set for the TradingNames. | \n| PaymentProviderSettings[0].Name | The Name of the Payment Provider Settings. |\n| PaymentProviderSettings[0].Value | The Value of the Payment Provider Settings. |\n| PaymentProviderSettings[0].PaymentProviderListItem | The Guid and Description associated to the PaymentProviderListItem of the Payment Provider Settings. |\n| PaymentProviderSettings[0].IsDeleted | Is the PaymentProviderSettings deleted. |\n| PaymentProviderSettings[0].Guid | The Guid of the Payment Provider Settings. |\n| CreditCards[0].Forename | The Forename of the credit card holder. | \n| CreditCards[0].Surname | The Surname of the credit card holder. | \n| CreditCards[0].Postcode | The Postcode associated to the credit card. | \n| CreditCards[0].Province | The Province associated to the credit card. | \n| CreditCards[0].DateCreated | The DateCreated associated to the credit card. | \n| CreditCards[0].MaskedCreditCardNumber | The MaskedCreditCardNumber associated to the credit card. | \n| CreditCards[0].Address1 | The Address1 associated to the credit card. | \n| CreditCards[0].City | The City associated to the credit card. | \n| CreditCards[0].RelatedContactGuid | The RelatedContactGuid associated to the credit card. | \n| CreditCards[0].Country | The Country associated to the credit card. | \n| CreditCards[0].CreditCardExpiryDate | The CreditCardExpiryDate associated to the credit card. | \n| CreditCards[0].Currency | The Currency associated to the credit card. | \n| CreditCards[0].ExternalVaultCardReference | The ExternalVaultCardReference associated to the credit card. | \n| CreditCards[0].ExternalVaultReference | The ExternalVaultReference associated to the credit card. | \n| CreditCards[0].IsACH | Is the payment an ACH payment. | \n| CreditCards[0].Deleted | Is the CreditCard deleted. |\n| CreditCards[0].IsRequestWithImmediateResponse | The IsRequestWithImmediateResponse associated to the credit card. | \n| CreditCards[0].PayerReference | The payer reference associated to the credit card. | \n| CreditCards[0].PaymentReference | The payment reference associated to the credit card. | \n| CreditCards[0].PaymentPointListItem | The Guid and Description associated to the PaymentPointListItem to the credit card. | \n| CreditCards[0].PaymentProviderListItem | The Guid and Description associated to the PaymentProviderListItem to the credit card. | \n| CreditCards[0].Guid | The Guid associated to the credit card. |\n| RelatedCustomerStateChangeRequests| The array of related customer state change requests|\n| RelatedCustomerStateChangeRequests[0].EffectiveDate| The effective date associated to the customer state change request|\n| RelatedCustomerStateChangeRequests[0].RelatedCustomerStateGuid| The related customer state guid associated to the customer state change request|\n| RelatedCustomerStateChangeRequests[0].RelatedChangeReasonGuid| The related customer change reason guid associated to the customer state change request|\n| RelatedBlobHashes| The array of related external documents to the account customer. |\n| RelatedBlobHashes[0].Hash| The hash of the external document blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted. |\n| RelatedReportBlobs| The array of related report documents to the account customer. |\n| RelatedReportBlobs[0].Guid| The Guid associated to the customer report. |\n| RelatedReportBlobs[0].Hash| The hash of the report document blob to be used against the /blob endpoint. Files are provided as an octet stream which will need to be converted. |\n| RelatedReportBlobs[0].DocumentDescription| The description associated to the customer report.|\n| RelatedReportBlobs[0].DocumentName| The document name associated to the customer report.|\n| RelatedReportBlobs[0].IsForAllSites| Whether the customer report is for all sites of related customer.|\n| RelatedReportBlobs[0].RelatedSites| The list of related customer report sites.|\n| RelatedReportBlobs[0].RelatedSites[0].Guid| The guid associated to the customer report site.|\n| RelatedReportBlobs[0].RelatedSites[0].RelatedSiteGuid| The related customer siteguid associated to the customer report site.|\n| RelatedReportBlobs[0].RelatedExcludedSites| The list of excluded related customer report sites.|\n| RelatedReportBlobs[0].RelatedExcludedSites[0].Guid| The guid associated to the customer report site.|\n| RelatedReportBlobs[0].RelatedExcludedSites[0].RelatedSiteGuid| The related customer siteguid associated to the customer report site.|\n| RelatedExternalVehicles| The array of related external vehicles associated to the account customer.|\n| RelatedExternalVehicles[0].RelatedExternalVehicleGuid| The related external vehicleguid associated to the account customer. |\n| RelatedExternalVehicles[0].IsForAllMaterials | Whether the related external vehicle is for all Materials. |\n| RelatedExternalVehicles[0].IsForAllSites | Whether the related external vehicle is for all Sites.|\n| RelatedExternalVehicles[0].ValidFrom | The valid from date of the related external vehicles in ISO format (YYYY-MM-DD).|\n| RelatedExternalVehicles[0].ValidTo | The valid to date of the related external vehicles in ISO format (YYYY-MM-DD).|\n| RelatedExternalVehicles[0].IsDeleted | Whether the related external vehicle is deleted.|\n| RelatedExternalVehicles[0].Guid | The Guid associated to the related external vehicle.|\n| CustomerBusinessType| The array of related customer business type associated to the account customer. |\n| CustomerBusinessType[0].Guid| The customer business type Guid associated to the account customer.|\n| CustomerBusinessType[0].BusinessTypeOptionListItem| The Guid and Description associated to the BusinessTypeOptionListItem to the customer business type.|\n| DefaultSicCodeListItem| The Guid and Description associated to the DefaultSicCodeListItem to the account customer.|\n| IsTaxExempt| Whether the account customer is tax exempt. |\n| TradingNameGuidFilter| Filter by the Guid of the Trading Name. |\n| TradingNameFilter| Filter by the Trading Name. |\n| RelatedExternalVehicleGuidFilter| Filter by the Guid of the Related External Vehicle. |"
operationId: AccountCustomer_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_ApiIntegratorAccountCustomerResource'
put:
tags:
- AccountCustomer
summary: Partial update
description: "| Property | Description | Required |\n| ------------------------- | -------------------------------------------------------------------------- | -------- |\n| GUID | The GUID associated to the customer. | No |\n| Name | The customer's name. | No |\n| Reference | An alternative name used for the customer. | No |\n| FederalId | The customer's local authority / government / tax reference. | No |\n| IsInternal | Whether the customer is an internal customer. | No |\n| ARAccountCode | The account code used for accounts receivable. | No |\n| APAccountCode | The account code used for accounts payable. | No |\n| Notes| Notes of customer. | No |\n| AMICENumber| AMICE Number of customer. | No |\n| CoCNumber|
# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amcs-group/refs/heads/main/openapi/amcs-group-accountcustomer-api-openapi.yml