Add options to Contract

Path

POST /businesses/{businessCode}/customers/{customerNumber}/contracts/{contractId}/options

Request Parameters

businessCode

required

string

Business Code

customerNumber

required

string

External customer reference

contractId

required

string

External contract reference or arvato internal contract reference to be used

X-Request-ID

string

The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.

Request Body

application/json

currency

string

Currency: Possible values according to ISO 4217

array

additionalInvoiceInformation

string

Max length: 255

Additional information for the invoice

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 %

description

string

Max length: 100

Description of option

externalContractId

string

Max length: 40

External Contract ID

productID

required

string

Max length: 100

External specific reference for option

proofURL

string

Max length: 255

Proof URL of the extra fees

quantity

integer

Max length: 100

Quantity of options in line item

orderReference

string

Max length: 16

External order reference from merchant. Sent as externalOrderId to BSS backend. If not supplied, will use first externalContractId from the options array or .

Responses

array

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

array

contractId

integer

ContractID returned

externalContractReference

string

External Contract Reference

customerNumber

integer

customer number defined by Arvato

example

object

externalCustomerReference

string

External customer number defined by Merchant

externalSignUpReference

string

External SignUp reference

signUpId
required

integer

SignupID
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