HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Assign Payment

post
https://api.instellix.io/v2/payment-assignments

Create manual assignment between a payment and a given entity: DOCUMENT (invoice, credit memo, ...) or ORDER.

    NOTE: When assigning to an order, if the order has exactly one associated document the payment will be assigned to that document instead.
Body Params

Create payment assignment request. If the assigned amount is not explicitly set, the remaining transaction amount is used for payment transaction assignments, and the batch item amount is used for batch items

amount
object | null

A monetary amount along with a currency.

string
required
length between 1 and 100

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

string | null

Ident of the payment transaction batch item

string
required
length ≥ 1

Ident of the payment transaction. Must not be null. Must not be blank.

string
required
length ≥ 1

Ident of the assignment target, i.e. document or order ident. Must not be null. Must not be blank.

string
required

Type of the assignment target. Must not be null. Must be one of:

DOCUMENTThe target is a document
ORDERThe target is an order
Responses

Updated 24 days ago

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 24 days ago