Skip to content

getInterchangeStatus

Query the delivery status of sent (outbound) or received (inbound) invoices. Returns metadata only — no payload.

Property Value
SOAPAction http://www.exite.net/ws/communication/getinterchangestatus/2020/12/
Namespace xmlns:ichstat="http://www.exite.net/ws/communication/getinterchangestatus/2020/12/"

Request

Useful for delivery confirmation, monitoring uncollected inbound documents, and auditing invoice flow.

Wildcard support

Fields senderID, recipientID, interchangeControlReference, applicationReference support wildcard * at any position.

Header fields

See Authentication. The sessionLimits element is also available (system max: 10,000 items / 1 GB).

Body fields

Element Card. Type Description
interchangeRequest 1-n complex Filter criteria. Multiple groups = OR logic.
  direction 1 enum "INBOUND" | "OUTBOUND" | "ALL"
  dataFormat 1 enum "XML" for invoice documents, "ALL" for any format
  messageStatus 0-1 enum Filter by status — see Interchange States
  eXiteInterchangeID 0-1 string Query a specific document by eXite® ID
  senderID 0-1 string GLN filter. Wildcard * supported.
  recipientID 0-1 string Recipient GLN filter. Wildcard * supported.
  applicationReference 0-1 string e.g. Invoice, CreditNote. Wildcard * supported.
  externalID 0-1 string Filter by your internal document ID
  sendingTimeFrom 0-1 dateTime Sending time range — start
  sendingTimeTo 0-1 dateTime Sending time range — end
  receivingTimeFrom 0-1 dateTime Collection time range — start (inbound)
  receivingTimeTo 0-1 dateTime Collection time range — end
  minDaysNotCollected 0-1 integer Min. days uncollected — for monitoring stale inbound invoices
  maxDaysNotCollected 0-1 integer Max. days uncollected
  minInterchangeAge 0-1 integer Min. age of the invoice in days (by sendingTime)
  maxInterchangeAge 0-1 integer Max. age in days
  mailbox 0-1 string Filter by specific mailbox

Request examples

<ichstat:getInterchangeStatus>
  <ichstat:interchangesRequest>
    <ichstat:interchangeRequest>
      <eXite:direction>OUTBOUND</eXite:direction>
      <eXite:dataFormat>XML</eXite:dataFormat>
      <eXite:eXiteInterchangeID>241015a3fB24</eXite:eXiteInterchangeID>
    </ichstat:interchangeRequest>
  </ichstat:interchangesRequest>
</ichstat:getInterchangeStatus>

<ichstat:getInterchangeStatus>
  <ichstat:interchangesRequest>
    <ichstat:interchangeRequest>
      <eXite:direction>INBOUND</eXite:direction>
      <eXite:dataFormat>XML</eXite:dataFormat>
      <eXite:messageStatus>RECEIVABLE</eXite:messageStatus>
      <eXite:minDaysNotCollected>2</eXite:minDaysNotCollected>
    </ichstat:interchangeRequest>
  </ichstat:interchangesRequest>
</ichstat:getInterchangeStatus>

<ichstat:getInterchangeStatus>
  <ichstat:interchangesRequest>
    <ichstat:interchangeRequest>
      <eXite:direction>ALL</eXite:direction>
      <eXite:dataFormat>XML</eXite:dataFormat>
      <eXite:applicationReference>Invoice</eXite:applicationReference>
      <eXite:sendingTimeFrom>2024-10-01T00:00:00+02:00</eXite:sendingTimeFrom>
      <eXite:sendingTimeTo>2024-10-31T23:59:59+02:00</eXite:sendingTimeTo>
    </ichstat:interchangeRequest>
  </ichstat:interchangesRequest>
</ichstat:getInterchangeStatus>

Response

Header totals are split into three categories. Body contains invoice metadata — no payload is returned.

Header fields

Element Card. Type Description
sessionID 1 string 12-digit eXite® session ID
sessionResponseTime 1 dateTime Response timestamp
totals[@type="COMPLETE"] 1 complex Invoices in a final state (RECEIVED, PROCESSED, DELETED…)
totals[@type="INCOMPLETE"] 1 complex Invoices in an intermediate state (RECEIVABLE, PROCESSING…)
totals[@type="ERROR"] 1 complex Invoices in an error state
sessionProcessing 0-1 complex Warning codes: REFETCH, EXTENDLIMITS

Body fields

Element Card. Type Description
interchangeResponse 0-n complex Metadata per invoice — no payload
  direction 1 enum "INBOUND" or "OUTBOUND"
  eXiteInterchangeID 1 string 12-digit eXite® invoice ID
  dataFormat 1 string "XML"
  senderID 0-1 string Sender GLN
  recipientID 0-1 string Recipient GLN
  applicationReference 0-1 string Message class
  externalID 0-1 string Your internal document ID (if set during send)
  testMessage 1 boolean Test flag
  messageSize 1 integer Payload size in bytes
  messageStatus 1 enum Current status — see Interchange States
  sendingTime 1 dateTime Processing time in eXite®
  receivingTime 0-1 dateTime When invoice was collected by recipient
  origin 1 string Source type of the document
  mailbox 1 string Mailbox the invoice belongs to
  gatewayTransmission 1 boolean true if gateway surcharges applied