Responses

• 200
  businessCode

  number

  Business Code.

  contracts

  object

  accountId

  string

  Max length: 100

  Specific reference for account related to customer

  acount

  array

  Account on which the Contract belongs.

  accountDetails

  object

  accountAddress

  object

  careOf

  string

  Max length: 40

  Name of the intermediary responsible for transferring a mail item between the postal system and the final recipient, e.g. 'Jane c/o John'. This field is also to be used for company, authority and organisation names, e.g. 'Sportverein Blau-Weiss e.V.'

  companyName

  string

  Max length: 80

  Company Name to which invoice has to be billed.

  countryCode

  string

  Country code (encoded as 2-letter code according to ISO 3166-1 alpha-2)

  phone

  string

  Max length: 20

  Phone number of the account to which invoice has to be billed.

  postalCode

  string

  Max length: 10

  Postal code

  postalPlace

  string

  Max length: 40

  Postal place, e.g. city

  street

  string

  Max length: 60

  Name of street or packstation

  streetNumber

  string

  Max length: 10

  Street or packstation number

  addressDataFromDefault

  boolean

  Flag to be set false only when address data needs to be explicitly updated. When it is set to true, address will be inherited from default account of the customer.

  streetNumberAdditional

  string

  Max length: 10

  Additional street number

  accountCategory

  string

  Enum:

  • Standard
  • Reseller

  Account Category. Possible values are Standard, Reseller. Default value is Standard.

  currency

  string

  Currency in which account is billed.

  dataFromDefault

  boolean

  Flag to be set false only when basic account data needs to be explicitly updated. When it is set to true, basic data of account will be inherited from default account of the customer.

  email

  string

  Max length: 241

  Email address of the account to which invoice has to be billed.

  emailFromDefault

  boolean

  Flag to be set false only when email needs to be explicitly updated. When it is set to true,email will be inherited from default account of the customer.

  firstName

  string

  Max length: 40

  First name to which invoice has to be billed.

  identificationNumber

  string

  Max length: 20

  Identification nummber to which invoice has to be billed.

  lastName

  string

  Max length: 40

  Last name to which invoice has to be billed.

  ownerConsumption

  boolean

  If the account has the owner consumption status.

  paymentRegistration

  object

  Contains information about a registered payment

  bankAccount

  object

  Bank Account info is needed only in case of SEPA payment. EITHER PSP details OR bank account should be provided BUT NOT both.

  accountHolderName

  string

  Account Holder full name.

  iban

  string

  IBAN of the customer.

  isMandated

  boolean

  Customer's consent to perform SEPA.

  sepaMandateRef

  string

  SEPA Mandate Reference generated by Riverty's Subscription Management system.

  signatureDate

  string

  yyyy-MM-dd

  Date of the Signature when mandate was signed by the customer.

  id

  string

  Payment identification

  paymentDataFromDefault

  boolean

  Flag to be set false only when paymentRegistration data needs to be explicitly updated. When it is set to true,payment Resgistration will be inherited from default account of the customer.

  paymentMethodName

  string

  Enum:

  • AfterPayDirectDebit
  • AfterPayInstallmentsDirectDebit
  • AfterPayInstallmentsOpenInvoice
  • AfterPayOpenInvoice
  • AmazonPay
  • AmericanExpress
  • ApplePayExpressCheckout
  • ArvatoDirectDebitSepa
  • Bancontact
  • Blik
  • BlikCodeOnly
  • CashOnDelivery
  • DinersClub
  • Discover
  • Eps
  • Giftcard
  • Giropay
  • GooglePay
  • Ideal
  • InAppAmazon
  • InAppApple
  • InAppGoogle
  • InStoreOpenInvoice
  • InStorePickup
  • InStorePrepayment
  • Klarna
  • KlarnaDirectDebit
  • KlarnaInstallments
  • KlarnaOpenInvoice
  • KlarnaPayLater
  • KlarnaPayOverTime
  • LoyaltyCard
  • MasterCard
  • Multibanco
  • OpenInvoice
  • PayPal
  • PayPalExpressCheckout
  • PayU
  • PrePayment
  • Przelewy24
  • Sofort
  • Trustly
  • Visa
  • POSPayment

  Name of the payment method being used: * AfterPayDirectDebit * AfterPayInstallmentsDirectDebit * AfterPayInstallmentsOpenInvoice * AfterPayOpenInvoice * AmazonPay * AmericanExpress * ApplePayExpressCheckout * ArvatoDirectDebitSepa * Bancontact * Blik * BlikCodeOnly * CashOnDelivery * DinersClub * Discover * Eps * Giftcard * Giropay * GooglePay * Ideal * InAppAmazon * InAppApple * InAppGoogle * InStoreOpenInvoice * InStorePickup * InStorePrepayment * Klarna * KlarnaDirectDebit * KlarnaInstallments * KlarnaOpenInvoice * KlarnaPayLater * KlarnaPayOverTime * LoyaltyCard * MasterCard * Multibanco * OpenInvoice * PayPal * PayPalExpressCheckout * PayU * PrePayment * Przelewy24 * Sofort * Trustly * Visa * POSPayment

  pspCustomerId

  string

  PSP Customer identification

  pspPaymentMethodId

  string

  PSP Payment method Id

  salutation

  string

  Enum:

  • MR
  • MRS

  Salutation of the natural person: * MR = Mr * MRS = Mrs

  taxExemption

  string

  Enum:

  • Disabled
  • Enabled

  If there is any taxExemption for the account. Possible values are Disabled, Enabled. Default value is Disabled.

  taxIdentificationNumber

  string

  TAX Identification nummber of the country to which invoice has to be billed.

  accountId

  required

  string

  Identificationnumber of that account

  accountName

  string

  Name of that account

  billCycle

  string

  A billing cycle is the schedule/frequency that determines when we generate bills/invoices for an account.Each contract is linked to an account, thus, each contract is billed per the corresponding billing cycle.

  defaultAccount

  boolean

  This is a flag internal to our Subscription management System.There is just one default account internally created by the system and any further accounts created by merchants could never be default account. Setting this value to true is not possible.

  businessCode

  number

  Business Code

  charges

  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

  customData

  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

  details

  object

  customerNumber

  string

  Max length: 100

  External customer reference

  discounts

  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

  invoices

  array

  invoiceReferences associated with the contract

  nextBillrunStartDate

  string

  Requested next bill run start date for contract. Format is 'YYYY-MM-DD'.

  options

  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
• 401 Please use a valid subscription
  additionalResultDetails

  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
• 404 Not found
  additionalResultDetails

  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
• 418 Found Multiple
  additionalResultDetails

  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
• 500 Internal Server Error
  additionalResultDetails

  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