Create regex matching strategy

post

https://api.instellix.io/v2/payment-assignment-regex-matching-strategies

Creates regular expression payment matching strategy.

Body Params

Regex matching strategy

failOnMultipleRegexMatches

boolean | null

Defaults to false

Should the strategy fail instead of searching a target for each regex match if the regex matched multiple times.

ident

string

required

length between 1 and 100

Unique ident of the matching strategy. Must not be null. Size must be between 1 and 100. Must match with the regular expression '[a-zA-Z0-9_.~-]*'.

regexPattern

string

required

length ≤ 255

Specifies the regular expression that we will try to find in payment description. Must not be null. Must not be blank. Size must be between 0 and 255.

targetIdentPattern

string | null

If specified, this will be used instead of the regular expression's match to search for the ident. Supports referencing capture groups, e.g. $123 or ${name} and $ can be escaped with \$. Example: - with a payment description of INV/01234567/89 - a regularExpression of (\d*)/(\d*) would match 01234567/89, with the capture groups 01234567 and 89 - a replaceWith of $1-$2 would yield 01234567-89

     Therefor the payment would be assigned to an invoice with ident `01234567-89`.

Size must be between 0 and 255.

targetIdentType

string

required

Type of the assignment target.

NOTE:* This does not necessarily need to be the actual targetType of the resulting assignments, as for the ident of orders with a single associated document the payment will be assigned to the document instead. Must not be null. Must be one of:


DOCUMENT	The target is a document
ORDER	The target is an order

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