Create default number strategy

post https://api.nitrobox.io/v2/billing/configuration/document-numbers/strategies/default

Create or update tenant wide document number configuration

Body Params

counterIdent

string

required

Ident of the counter to be used.
Must not be blank.

prefix

string

Document number prefix pattern
In pattern you can use special keywords wrapped with ## e.g. ##YEAR_SHORT##.
Currently supported keywords are:

Pattern	Expands to	Example for 2019-02-05
`##YEAR##`	full year, four digits	`2019`
`##YEAR_SHORT##`	short year, last two digits	`19`
`##MONTH##`	month, two digits	`02`
`##DAY##`	day, two digits	`05`

Note: Yearly counter reset is controlled separately and independent of
the patterns in the counter config.
The expanded length of the pre-/suffix can only be up to 20 characters.

suffix

string

Document number suffix pattern
In pattern you can use special keywords wrapped with ## e.g. ##YEAR_SHORT##.
Currently supported keywords are:

Pattern	Expands to	Example for 2019-02-05
`##YEAR##`	full year, four digits	`2019`
`##YEAR_SHORT##`	short year, last two digits	`19`
`##MONTH##`	month, two digits	`02`
`##DAY##`	day, two digits	`05`

Note: Yearly counter reset is controlled separately and independent of
the patterns in the counter config.
The expanded length of the pre-/suffix can only be up to 20 characters.

Responses

Response body

object

counterIdent

string

required

Ident of the counter to be used.
Must not be blank.

prefix

string

Document number prefix pattern
In pattern you can use special keywords wrapped with ## e.g. ##YEAR_SHORT##.
Currently supported keywords are:

Pattern	Expands to	Example for 2019-02-05
`##YEAR##`	full year, four digits	`2019`
`##YEAR_SHORT##`	short year, last two digits	`19`
`##MONTH##`	month, two digits	`02`
`##DAY##`	day, two digits	`05`

Note: Yearly counter reset is controlled separately and independent of
the patterns in the counter config.
The expanded length of the pre-/suffix can only be up to 20 characters.

suffix

string

Document number suffix pattern
In pattern you can use special keywords wrapped with ## e.g. ##YEAR_SHORT##.
Currently supported keywords are:

Pattern	Expands to	Example for 2019-02-05
`##YEAR##`	full year, four digits	`2019`
`##YEAR_SHORT##`	short year, last two digits	`19`
`##MONTH##`	month, two digits	`02`
`##DAY##`	day, two digits	`05`

Note: Yearly counter reset is controlled separately and independent of
the patterns in the counter config.
The expanded length of the pre-/suffix can only be up to 20 characters.

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.nitrobox.io/v2/billing/configuration/document-numbers/strategies/default \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

200Standard response for successful HTTP requests.

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

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