Skip to Main Content
Riverty Docs
    riverty logo Docs

    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

    • accountId
      string
      Max length: 100
      Specific reference for account related to customer
      billCycle
      string
      Bill cycle of the associated account.
      businessCode
      number
      Business Code
      array
      amountGrossDiscounts
      number
      Gross amount of discounts in Euro
      amountNetDiscounts
      number
      Net amount of discounts in Euro
      chargeMode
      number
      Charge Mode. Possible values : one-time, monthly, Usage-based, Per invoice if active, Per active license, Billing periods monthly
      currency
      string
      Currency.
      grossAmount
      number
      Gross amount of charge in Euro
      localisedDisplayValue
      string
      Localised display value of the charge.
      netAmount
      number
      Net amount of charge in Euro
      pricedEvent
      boolean
      Client sends in the charge with the order as it is dependent on situation, e.g. speeding ticket.
      salesOrganisation
      string
      Market or country.
      taxRateType
      string
      Enum:
      • TAXLESS
      • NORMAL
      • REDUCED
      Tax rate type: Possible values: NORMAL, TAXLESS, REDUCED
      validFromDate
      string
      Valid From Date of the Charge.
      validToDate
      string
      Valid to Date of the Charge.
      vatAmount
      number
      Amount of taxes in Euro
      vatPercent
      number
      Tax rate applied in %
      contractId
      required
      string
      Max length: 18
      Specific reference for contract
      contractName
      string
      Max length: 100
      Description of contract
      array
      customDataType
      required
      string
      Max length: 20
      Enum:
      • Accounting
      • Car
      • Charging
      • Tariff
      • UsedCarSales
      • CorrectingInvoice
      • Generic
      Type of the event: Possible Values 'Accounting' = Cost center, 'Car' = Vehicle Identification number, 'Tariff' = Tariff details
      object
      customerNumber
      string
      Max length: 100
      External customer reference
      array
      amount
      number
      Amount applicable for the discount .
      amountNeT
      number
      Net Amount applicable for the discount .
      campaignId
      string
      Campaign Id applicable on the product .
      discountName
      string
      Business name of the discount .
      discountType
      object
      id
      number
      Unique Identifier of the discount .
      percentage
      number
      Percentage discount applicable on the product .
      taxRate
      number
      Tax rate applicabe on the discount.
      voucherCode
      string
      Discount voucher code.
      externalAccountId
      string
      External AccountId.
      externalContractId
      string
      Max length: 40
      External Contract ID
      externalContractReference
      string
      External Contract Reference
      array
      invoiceReferences associated with the contract
      nextBillrunStartDate
      string
      Requested next bill run start date for contract. Format is 'YYYY-MM-DD'.
      array
      externalContractIds of options
      orderDate
      string
      Order date of contract. Format is 'YYYY-MM-DD'.
      orderReference
      string
      orderReference of the contract while creating the initial order
      productDescription
      string
      Max length: 100
      product description
      quantity
      integer
      Quantity of product as part of contract
      startDateBilling
      string
      Start date for billing of contract. Format is 'YYYY-MM-DD'.
      startDateRequested
      string
      Requested start date for contract. Format is 'YYYY-MM-DD'.
      status
      string
      Status of contract
      subcontractOf
      string
      externalContractId of the main contract
    • object
      Object that contains details for an error that was encountered when accessing a third party service
      action
      string
      External action to be triggered based on error code/message
      code
      string
      Code
      customerFacingMessage
      string
      Customer facing message
      description
      string
      Description
      fieldReference
      string
      Field reference
      source
      string
      Source of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPal
      title
      string
      Title
      type
      string
      Type or class
      code
      string
      Error code
      description
      string
      Error description
      title
      string
      Error title
      type
      string
      Error type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
    • object
      Object that contains details for an error that was encountered when accessing a third party service
      action
      string
      External action to be triggered based on error code/message
      code
      string
      Code
      customerFacingMessage
      string
      Customer facing message
      description
      string
      Description
      fieldReference
      string
      Field reference
      source
      string
      Source of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPal
      title
      string
      Title
      type
      string
      Type or class
      code
      string
      Error code
      description
      string
      Error description
      title
      string
      Error title
      type
      string
      Error type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
    • object
      Object that contains details for an error that was encountered when accessing a third party service
      action
      string
      External action to be triggered based on error code/message
      code
      string
      Code
      customerFacingMessage
      string
      Customer facing message
      description
      string
      Description
      fieldReference
      string
      Field reference
      source
      string
      Source of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPal
      title
      string
      Title
      type
      string
      Type or class
      code
      string
      Error code
      description
      string
      Error description
      title
      string
      Error title
      type
      string
      Error type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning
    • object
      Object that contains details for an error that was encountered when accessing a third party service
      action
      string
      External action to be triggered based on error code/message
      code
      string
      Code
      customerFacingMessage
      string
      Customer facing message
      description
      string
      Description
      fieldReference
      string
      Field reference
      source
      string
      Source of external error code, e.g. Internal ThirdPartyACI Third-PartyPayPal
      title
      string
      Title
      type
      string
      Type or class
      code
      string
      Error code
      description
      string
      Error description
      title
      string
      Error title
      type
      string
      Error type, e.g. InternalServiceError InternalValidationError InternalBusinessError ThirdPartyError Warning