Create allowance

post

https://api.isx-stage-westeurope.instellix.io/v2/contracts/{contractIdent}/allowances

Create an allowance.

Path Params

contractIdent

string

required

length between 1 and 100

[a-zA-Z0-9_.~-]{1,100}

The ident of the contract.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

Body Params

A request to create an option allowance of a contract for an option.

applicability

string | null

enum

deprecated

DEPRECATED: Legacy applicability setting. The only supported value is NEXT_INVOICE, which means the allowance applies to the next billing period only. Use applicabilityDetails instead.

Allowed:

applicabilityDetails

object | null

Information on how this option allowance should be applied to the option

description

string | null

Description.
Size must be between 0 and 255.

fixedAmount

object | null

Amount the referenced option will be reduced. Is considered net or gross depending on how the option price is configured.

ident

string | null

[a-zA-Z0-9_.~-]{1,100}

Unique identifier of an option allowance. When not provided NBX will generate an identifier.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

name

string | null

Name of the option allowance to be printed on a document or referenced as booking text.
Size must be between 0 and 100.

optionIdent

string

required

length ≥ 1

Should reference a valid option for this contract.
Must not be blank.

percentage

number | null

1 to 100

Option price will be reduced by the given percentage.
Must be greater than 0.
Must be less than or equal to 100.

type

string

enum

Defaults to DISCOUNT

Indicates the kind of an option allowance.

Allowed:

Responses

201The request has been fulfilled, resulting in the creation of a new resource.

4XXerror response for all http error codes in range 4XX

5XXerror response for all http error codes in range 5XX