HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Create a correction for a document

post
https://api.instellix.io/v2/documents//corrections

Create a document correction by referencing a document ident and specifying item corrections.

Path Params
string
required
length between 1 and 100

The ident of the document (e.g. invoice) the correction belongs to.

Body Params
corrections
array of objects
required
length between 1 and 20

Must not be empty. Size must be between 1 and 20.

corrections*
number
required

Correction amount as a positive value (> 0) in the currency of the related document/item. This amount is a GROSS value (incl. VAT). Semantics: the value is booked as a credit and reduces the item amount. Example: 20.00 means a credit of 20.00 (i.e. -20.00 on the item). The maximum allowed value is the remaining correctable amount (item amount minus sum of prior credits). Must not be null. Must be greater than 0. Must be a number with up to 19 integral digits and up to 4 fractional digits.

string
required
length ≥ 1

Unique identifier of the affected document item the correction (credit) should be applied to. Must not be blank.

string
required
length between 1 and 100

Must be a unique external reference. Cannot be changed later on. Prevents duplicated execution when sending the same request. Must have size between 1 and 100 and match with the regular expression '[a-zA-Z0-9_.~-]{1,100}'.

properties
array of objects
properties
string
length ≤ 255

Reason for the correction. Applies to all correction items in this request. Size must be between 0 and 255.

Responses
202

The request has been accepted for processing, but the processing has not been completed.

Updated about 1 month ago

Language
Credentials
OAuth2
Missing 1 required scope
Response 
 Choose an example:
application/json
Updated about 1 month ago