Add Decision for OPOS Case

post https://api.nitrobox.io/v2/opos-cases/{oposCaseIdent}/decisions

Add a decision to an OPOS Case

Path Params

oposCaseIdent

string

required

Body Params

ident

string

required

length between 1 and 100

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

type

string

required

Type of this decision. Not all decisions are always available,
depending on the balanceDebitCreditIndicator of the OposCase.

For DEBIT:

UNCOLLECTABLE_RECEIVABLE
DOUBTFUL_RECEIVABLE
DISCOUNT
CASH_DISCOUNT
BANK_FEE
EXTERNAL_CLOSED

For CREDIT:

OTHER_REVENUE
EXTERNAL_CLOSED

Must not be null.

note

string

length between 0 and 255

Optional note attached to this decision.
Size must be between 0 and 255.

amount

number

The amount becomes mandatory if any active prebooked item exists on the opos case.
Otherwise the balance of the opos case is used as amount.
Must be greater than or equal to 0.

Responses

Response body

object

ident

string

required

length between 1 and 100

Unique ident of this opos case decision.
Must not be null.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

oposCaseIdent

string

required

length between 1 and 100

Unique ident of the related OPOS case.
Must not be null.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

oposCaseClearingRunIdent

string | null

required

If filled the Decision was created by a clearing run. The given ident relates to a specific clearing run.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

oposCaseClearingRunItemIdent

string | null

required

If filled the Decision was created by a clearing run. The given ident relates to a specific Item in the clearing run.
Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

type

string

required

Type of this decision. Not all decisions are always available,
depending on the balanceDebitCreditIndicator of the OposCase.

For DEBIT:

UNCOLLECTABLE_RECEIVABLE
DOUBTFUL_RECEIVABLE
DISCOUNT
CASH_DISCOUNT
BANK_FEE
EXTERNAL_CLOSED

For CREDIT:

OTHER_REVENUE
EXTERNAL_CLOSED

Additionally it can be REVERSION in case this decision reverses
another decision, which will be referenced in reversionTargetIdent.
Must not be null.

note

string | null

required

Optional note attached to this decision.
Size must be between 0 and 255.

amount

object

required

The amount becomes mandatory if any active prebooked item exists on the opos case.
Otherwise the balance of the opos case is used as amount.

amount

number

required

Amount.
Must not be null.

currency

string

required

Currency code according to 'ISO-4217'.
Must not be null.

debitCreditIndicator

string

required

Indicates if this amount is debit or credit.
Must not be null.
Must be one of:

DEBIT

CREDIT

reverted

boolean

required

Indicates if this decision was reverted.
Must not be null.

reversionTargetIdent

string

OposCaseDecision that was reverted with this decision. Only filled if type is REVERSION.

reversionTargetType

string

Type of the OposCaseDecision that was reverted with this decision. Only filled if type is REVERSION.
Must be one of:

UNCOLLECTABLE_RECEIVABLE

DOUBTFUL_RECEIVABLE

DISCOUNT

OTHER_REVENUE

REVERSION

CASH_DISCOUNT

BANK_FEE

EXTERNAL_CLOSED

createdAt

date-time

required

Technical creation date and time of data record. ISO 8601 date-time with an offset from UTC/Greenwich (see: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC).

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.nitrobox.io/v2/opos-cases/oposCaseIdent/decisions \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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