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