Path
GET /businesses/{businessCode}/customers/{customerNumber}/contracts Request Parameters
businessCode
required
string
Business Code
customerNumber
required
string
External customer reference
onlyActive
string default: true
Use onlyActive=false to get all contracts for given Customer. Default value is true - so only active Contract are returned.
X-Request-ID
string
The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.
Responses
-
accountIdstringMax length: 100Specific reference for account related to customerbusinessCodenumberBusiness CodearrayamountGrossDiscountsnumberGross amount of discounts in EuroamountNetDiscountsnumberNet amount of discounts in EurochargeModenumberCharge Mode. Possible values : one-time, monthly, Usage-based, Per invoice if active, Per active license, Billing periods monthlycurrencystringCurrency.grossAmountnumberGross amount of charge in EurolocalisedDisplayValuestringLocalised display value of the charge.netAmountnumberNet amount of charge in EuropricedEventbooleanClient sends in the charge with the order as it is dependent on situation, e.g. speeding ticket.salesOrganisationstringMarket or country.taxRateTypestringEnum:
- TAXLESS
- NORMAL
- REDUCED
Tax rate type: Possible values: NORMAL, TAXLESS, REDUCEDvalidFromDatestringValid From Date of the Charge.validToDatestringValid to Date of the Charge.vatAmountnumberAmount of taxes in EurovatPercentnumberTax rate applied in %contractIdrequiredstringMax length: 18Specific reference for contractcontractNamestringMax length: 100Description of contractarraycustomDataTyperequiredstringMax length: 20Enum:- Accounting
- Car
- Charging
- Tariff
- UsedCarSales
- CorrectingInvoice
- Generic
Type of the event: Possible Values 'Accounting' = Cost center, 'Car' = Vehicle Identification number, 'Tariff' = Tariff detailsobjectcustomerNumberstringMax length: 100External customer referencearrayamountnumberAmount applicable for the discount .amountNeTnumberNet Amount applicable for the discount .campaignIdstringCampaign Id applicable on the product .discountNamestringBusiness name of the discount .discountTypeobjectidnumberUnique Identifier of the discount .percentagenumberPercentage discount applicable on the product .taxRatenumberTax rate applicabe on the discount.voucherCodestringDiscount voucher code.externalAccountIdstringExternal AccountId.externalContractIdstringMax length: 40External Contract IDexternalContractReferencestringExternal Contract ReferencearrayinvoiceReferences associated with the contractnextBillrunStartDatestringRequested next bill run start date for contract. Format is 'YYYY-MM-DD'.arrayexternalContractIds of optionsorderDatestringOrder date of contract. Format is 'YYYY-MM-DD'.orderReferencestringorderReference of the contract while creating the initial orderproductDescriptionstringMax length: 100product descriptionquantityintegerQuantity of product as part of contractstartDateBillingstringStart date for billing of contract. Format is 'YYYY-MM-DD'.startDateRequestedstringRequested start date for contract. Format is 'YYYY-MM-DD'.statusstringStatus of contractsubcontractOfstringexternalContractId of the main contract -
objectObject that contains details for an error that was encountered when accessing a third party serviceactionstringExternal action to be triggered based on error code/messagecodestringCodecustomerFacingMessagestringCustomer facing messagedescriptionstringDescriptionfieldReferencestringField referencesourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitletypestringType or classcodestringError codedescriptionstringError descriptiontitlestringError titletypestringError type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
-
objectObject that contains details for an error that was encountered when accessing a third party serviceactionstringExternal action to be triggered based on error code/messagecodestringCodecustomerFacingMessagestringCustomer facing messagedescriptionstringDescriptionfieldReferencestringField referencesourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitletypestringType or classcodestringError codedescriptionstringError descriptiontitlestringError titletypestringError type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
-
objectObject that contains details for an error that was encountered when accessing a third party serviceactionstringExternal action to be triggered based on error code/messagecodestringCodecustomerFacingMessagestringCustomer facing messagedescriptionstringDescriptionfieldReferencestringField referencesourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitletypestringType or classcodestringError codedescriptionstringError descriptiontitlestringError titletypestringError type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
-
objectObject that contains details for an error that was encountered when accessing a third party serviceactionstringExternal action to be triggered based on error code/messagecodestringCodecustomerFacingMessagestringCustomer facing messagedescriptionstringDescriptionfieldReferencestringField referencesourcestringSource of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPaltitlestringTitletypestringType or classcodestringError codedescriptionstringError descriptiontitlestringError titletypestringError type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning