receiveInterchange

Collect inbound XML invoices from your eXite® mailbox.

Property	Value
SOAPAction	`http://www.exite.net/ws/communication/receiveinterchange/2020/12/`
Namespace	`xmlns:rcvich="http://www.exite.net/ws/communication/receiveinterchange/2020/12/"`

Request

Specify one or more filter criteria groups. Multiple interchangeRequest elements are evaluated with OR logic — documents matching any group are returned.

Wildcard support

Fields senderID, recipientID, interchangeControlReference, applicationReference support wildcard * at any position. Example: 9001234* matches any GLN starting with that prefix.

Header fields

See Authentication for the sessionRequest structure. Additional fields available for receive:

Element	Card.	Type	Description
`sessionLimits`	0-1	complex	Limit response size. Strongly recommended in production.
`maxInterchangeReceive`	0-1	integer	Max number of invoices to return (system ceiling: 1,000)
`maxSizeReceive`	0-1	integer	Max total bytes to return (system ceiling: 200 MB)
`transformationType`	0-1	enum	Encoding for returned payloads: `"b64"` \| `"zipb64"`. Default: `b64`

Body fields

Element	Card.	Type	Description
`interchangeRequest`	1-n	complex	Filter criteria group. Repeat for multiple criteria (OR logic).
`dataFormat`	1	enum	`"XML"` for invoice documents, `"ALL"` for any format
`eXiteInterchangeID`	0-1	string	Fetch a specific document by its eXite® ID
`senderID`	0-1	string	GLN filter. Wildcard `*` supported.
`recipientID`	0-1	string	Recipient GLN filter. Wildcard `*` supported.
`applicationReference`	0-1	string	Filter by message class, e.g. `Invoice` or `CreditNote`. Wildcard `*` supported.
`sendingTimeFrom`	0-1	dateTime	Start of sending time range (ISO 8601 with timezone)
`sendingTimeTo`	0-1	dateTime	End of sending time range
`mailbox`	0-1	string	Collect from a specific mailbox
`externalID`	0-1	string	Filter by sender's internal document ID
`testMessage`	0-1	boolean	Filter test vs. production documents

Request example

<rcvich:sessionRequest env:mustUnderstand="true">
  <eXite:login>...</eXite:login>
  <eXite:sessionLimits>
    <eXite:maxInterchangeReceive>100</eXite:maxInterchangeReceive>
    <eXite:maxSizeReceive>52428800</eXite:maxSizeReceive> <!-- 50 MB -->
  </eXite:sessionLimits>
  <eXite:uniqueTransmissionID>f88b3b23-78ff-495a-a3ea-a2a4e4a988a1</eXite:uniqueTransmissionID>
  <eXite:transformationType>b64</eXite:transformationType>
</rcvich:sessionRequest>

<rcvich:receiveInterchange>
  <rcvich:interchangesRequest>
    <!-- collect invoices -->
    <rcvich:interchangeRequest>
      <eXite:dataFormat>XML</eXite:dataFormat>
      <eXite:applicationReference>Invoice</eXite:applicationReference>
    </rcvich:interchangeRequest>
    <!-- also collect credit notes -->
    <rcvich:interchangeRequest>
      <eXite:dataFormat>XML</eXite:dataFormat>
      <eXite:applicationReference>CreditNote</eXite:applicationReference>
    </rcvich:interchangeRequest>
  </rcvich:interchangesRequest>
</rcvich:receiveInterchange>

Response

REFETCH / EXTENDLIMITS

REFETCH — more invoices remain in the queue. Send another request to continue collecting.
EXTENDLIMITS — session limits are too low to return even one document. Increase maxInterchangeReceive and/or maxSizeReceive.

Header fields

Element	Card.	Type	Description
`sessionID`	1	string	12-digit eXite® internal session ID
`sessionResponseTime`	1	dateTime	Response timestamp
`totals[@type="COLLECTED"]`	1	complex	`totalNo` + `totalSize` of collected invoices
`sessionProcessing`	0-1	complex	Warning codes: `UTIDREUSED`, `REFETCH`, `EXTENDLIMITS`
`uniqueTransmissionID`	0-1	string	Echoed back from the request

Body fields

Element	Card.	Type	Description
`interchangeResponse`	0-n	complex	One element per collected invoice (includes payload)
`eXiteInterchangeID`	1	string	12-digit eXite® invoice ID
`dataFormat`	1	string	`"XML"`
`dataSubFormat`	0-1	string	e.g. `"GS1XML"`
`senderID`	1	string	Sender GLN / party address
`recipientID`	1	string	Recipient GLN / party address
`interchangeControlReference`	1	string	Reference number from the document
`applicationReference`	0-1	string	Message class (e.g. `Invoice`, `CreditNote`)
`externalID`	0-1	string	Sender's internal document ID (if set during send)
`testMessage`	1	boolean	Test flag
`messageSize`	1	integer	Payload size in bytes (uncompressed)
`sendingTime`	1	dateTime	When the document was processed in eXite®
`origin`	1	string	`"IN"` standard, `"RESTART"` re-fetched document
`gatewayTransmission`	1	boolean	`true` if gateway surcharges apply
`payload`	1	base64	The XML invoice content, encoded per `transformationType`
`transformationType`	1	enum	`"b64"` or `"zipb64"`