Get message list (filtered)

get

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

Retrieves messages using filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

If no filters are set, the call returns the 50 newest messages that the user has permission to view. The messages are sorted by date, in descending order.

Users with basic access rights see the messages that were sent or received by their own party. Manager users can view the messages owned by the parties that they manage, while administrator users can view the messages from all the parties in the system.

The returned results can be paged.The maximum number of messages per page is 100.

Multiple filters can be used at the same time.If there are no matching messages, the call returns an empty array.

Query Params

SourcePartyIdentifier

string

The sender of the wanted messages.
The party is specified using the {identifierType}:{identifier} format, for example, 0196:xxxxxxyyyy.

SinkPartyIdentifier

string

The receiver of the requested messages.
Uses the business participant identifier in the {identifierType}:{identifier} format, for example, 0196:xxxxxxyyyy.

OwnerPartyIdentifier

string

The owner of the selected messages.
The message owner is either the sender or the receiver of the message.
Takes the business participant identifier provided in the {identifierType}:{identifier} format, for example, 0196:xxxxxxyyyy.

Status

string

enum

The requested message status.

For more details, see Message flow.

Transfer

string

The transfer status of the requested messages.
Valid values are: inbound, outbound, internal, routed, incoming, outgoing.

The incoming status includes both inbound and internal messages, and the outgoing status covers both outbound and internal messages.
Internal messages are exchanged within the same party, for example, between different departments of one company.

TransactionGroup

string

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

For more details, see Business transaction groups.

TimeReceivedFrom

date-time

Defines the date starting from which the messages were received.
The date provided is included in the time range.

The date must be in the following format {yyyy-mm-dd}.
When specifying both date and time, the format is {yyyy-mm-dd}T{hh:mm:ss.s}.

TimeReceivedTo

date-time

Defines the date up to which the messages were received.
The date provided is not included in the time range.

The date must be in the following format {yyyy-mm-dd}.
When specifying both date and time, the format is {yyyy-mm-dd}T{hh:mm:ss.s}.

FromTextFilter

string

The sender of the wanted messages.
Uses the name of the business participant.

ToTextFilter

string

The receiver of the requested messages.
Requires the name of the business participant.

MessageReference

string

The reference number of the document contained in the message or the unique message identifier (GUID).

For example, if this parameter is used for a document reference number, it might be the invoice number.

ValidationStatus

string

enum

The validation status of the document contained in the message.

Allowed:

Conversation

string

Conversation identifier is used to group together related messages,
for example response messages (MLR or invoice response, for example) with business documents or one business document with another (e.g. order or credit note with an invoice).

Offset

int32

0 to 2147483647

The number of items that are skipped before the results are returned.

The value must be a multiple of the value of the limit parameter.

Limit

int32

1 to 10000

The number of messages returned.
The maximum value is 1000, the minimum value is 1.

If not set, the default value is 10.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200List of messages.

400Invalid input parameters.

422The request was understood but could not be processed.