Create allowance

post

https://api.instellix.io/v2/contracts/{contractIdent}/allowances

Create an allowance.

Path Params

contractIdent

string

required

length between 1 and 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

enum

Defaults to NEXT_INVOICE

deprecated

DEPRECATED: Applicability determines when and for how long an option allowance will be applied to the given option. Currently only a one time use on the next invoice is supported.

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

A monetary amount along with a currency.

ident

string | null

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

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

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