Create a business transaction

post

https://mapi-sandbox.unimaze.com/api/v1/messages/create-business-transaction

Uploads a document and creates a business transaction that needs to be validated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The call creates a business transaction by uploading a raw binary format (application/octet-stream) and then validates that transaction. You can also submit the data as a stream that is formatted as a base64-encoded ASCII text. In this case, the HTTP Content-Type header must be set to application/base64.

The document must be sent as the request body.

The validation step ensures that the document fulfills the corresponding business and semantic requirements.

The call also informs the server of whether more data is expected or not and then updates the message status. If no more documents will be added, the call sets the status of the message to received.Otherwise, the message remains open and the message status is notset.

Additional documents are added through the POST /messages/:mid/documents call. This is possible if the value of the more parameter was set to true when the message was created.

Query Params

messageId

uuid

required

The identifier of the message in the format of a valid Universally unique identifier (GUID).

transactionGroupIdentifier

string

required

The identifier of the transaction group indicating the action that should be performed on the data, for example, SubmitInvoice, CorrectWithCredit, or SubmitOrder.
See Business transaction groups.

conversationIdentifier

string

The identifier of the conversation. Used as a correlation identifier between different documents in the same business context, for example, between a credit note that was issued based on an invoice and that invoice.

If not provided, it is generated automatically.
In that case, it includes the date when the message was sent, a random token, and the ISO identifier of the sender.

boolean

required

Signals if the current document is the last document that the message is supposed to contain.
If that is true, the processing starts immediately.

processingMode

string

enum

The way the transaction is processed.

Allowed:

services

array of strings

A list of services that the user specifies for additional message processing.

services

FallbackContactName

string

length ≥ 1

The contact name of the fallback receiver.
Optional but recommended.

FallbackEmailAddress

string

length ≤ 160

The email address of the receiver.
This is used if the document cannot be delivered to the receiving party due to processing or other issues.
A list of a few e-mail addresses, delimited with a comma, are allowed.

DesiredDisplayLanguage

string

length ≥ 1

The desired display language of the business document.
Optional.

Sector

string

enum

The business sector of the transaction.
Only used for Croatia; controls how documents are fiscalized.
Default is B2B.

Allowed:

ReferencedDocumentIssuerIdentifier

string

Internal use only. On a tax-handling action message (e.g. register rejection / register payment)
raised without a reference to an existing document message, this carries the identifier of the
referenced document's issuer, so the document can be correlated (best effort) once the tax
authority accepts the report. Not a partner-facing parameter and never set on ordinary transactions.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201Message information

400Invalid input parameters.

422The request was understood but could not be processed.