Ready to Learn?Ex Libris products all provide open APIs


 Alma supports sending claims to vendors via EDI. In Alma, EDI is defined as one of the possible channels of communication with the vendors (in addition to emails). If a vendor is defined as an EDI vendor that supports claims (that is, the Claims check box is selected in the EDI Information tab), Alma attempts to send the claims via EDI. The message structure in EDI is as follows:

Note that each EDI claim message from Alma contains a claim for a single PO line.

see EDIfact standard for claims.


Message Segments

  1. UNH (header):

UNH+{sender's unique message reference number)+OSTENQ:D:96A:UN:EAN008’

  • Sender's unique message reference number - By convention, incorporates a sequence number of the message within the interchange.
  • OSTENQ– claim
  • D – message type version number
  • 96A = message type release number - EDIFACT Directory D.96A
  • UN = controlling agency
  • EAN008 = association-assigned code - EAN version number


  1. BGM (Beginning of Message):

BGM+{order type}::9+{order number}+9'

  • order type -  92E for monograph, 92J for serial
  •  document/message number - order number assigned by document sender: mandatory in EANCOM


  1. DTM (Date Time Message):

DTM+137:{message date}:102'

  • message date - in CCYYMMDD format


  1. NAD (Name and Address): 

NAD+BY+{buyer identification}::9'
NAD+SU+{supplier identification}::9'

  • Identification - For BY, it is the Alma library. For SU it is the vendor code.


  1. LIN  (line number):

LIN+{claim line number}'

  • line number – Alma creates a separate message for each claim, hence only one line item will appear in a claim message.


  1. PIA (Additional Product ID):
Unless the item is identified by an EAN article number in LIN segment 33, there must be one mandatory occurrence per line, coded 5 – or exceptionally, 5V in DE 4347 – to identify the product to which the line or sub-line refers.

PIA+5+{item id}:{identifier type}

  • identifier type:



  1. IMD (item description):

IMD+L+{bibliographic information code}+::{bibliographic information}.'Alma populates the following bibliographic information (if exists):

  • 009 – contributor
  • 050 – title
  • 109 – publisher


  1. QTY (quantity):


  • quantity - number of ordered items


  1. RFF (referance):

    RFF+LI:{order number}’

  • order number - the Alma PO line number


  1. FTX (free text):

    FTX+LI:{free text}’

  • free text - related to the specific line


EDI claim sample: