API Documentation

Get the inbox list for IMR and MLR files

Via the GET Peppol inbox (endpoint on sandbox https://api.sandbox.billit.be/v1/peppol/inbox ), the list of incoming files can be retrieved

Type of files that can occur in the list:

  • Incoming invoices and incoming credit notes (supplier related) - this is not relevant for sales invoices.
  • Feedback from receivers on the delivered sales invoices, this is sales/income related. The feedback can consist of:
    • Invoice Responses = IMR
    • Message Level Responses or MLR
TypeValue (example)Sample value
InboxItemIDthe ID to perform a Get as a next step to get the file69791
SenderPeppolIDidentifier and value of the Sender"0208:0759529999"
PeppolDocumentTypeThis indicates that it is an Invoice, a credit note, and IMR and MLR"IMR"
ReceiverPeppolIDidentifier type and value of the Receiver"9925:BE0437295999"
ReceiverCompanyIDvalue for the receiver company"BE0437295999"
CreationDateDate and time when it was received at Billit"2025-04-07T13:30:32.1327398"
PeppolFileIDwith this fileID the file can be obtained with a separate call"8758f630-1fbe-478c-b872-77f5652e2999"

Specific remarks:

  • It is a list of files, Odata filtering on that list is not supported.
  • The list displays maximum 10 entries (the oldest files).

Below an Example of a result with 4 incoming IMR - Invoice Response files (feedback from receiver related to your sales invoice):

{
    "InboxItems": [
        {
            "InboxItemID": 69873,
            "SenderPeppolID": "9925:BE0759529202",
            "PeppolDocumentType": "IMR",
            "ReceiverPeppolID": "0208:0437295202",
            "ReceiverCompanyID": "BE0437295202",
            "CreationDate": "2025-04-09T09:02:10.0168981",
            "PeppolFileID": "cc41ebf6-974c-4f32-8ef2-04d78836d999"
        },
        {
            "InboxItemID": 69886,
            "SenderPeppolID": "9925:BE0759529202",
            "PeppolDocumentType": "IMR",
            "ReceiverPeppolID": "0208:0437295202",
            "ReceiverCompanyID": "BE0437295202",
            "CreationDate": "2025-04-09T09:03:09.9704004",
            "PeppolFileID": "2ab35770-7f44-43be-8fc8-ea3c724e7999"
        },
        {
            "InboxItemID": 69887,
            "SenderPeppolID": "9925:BE0759529202",
            "PeppolDocumentType": "IMR",
            "ReceiverPeppolID": "0208:0437295202",
            "ReceiverCompanyID": "BE0437295202",
            "CreationDate": "2025-04-09T09:03:09.9546929",
            "PeppolFileID": "6814ff29-ae4c-47a0-a9b6-478da2ee3999"
        },
        {
            "InboxItemID": 69888,
            "SenderPeppolID": "9925:BE0759529202",
            "PeppolDocumentType": "IMR",
            "ReceiverPeppolID": "0208:0437295202",
            "ReceiverCompanyID": "BE0437295202",
            "CreationDate": "2025-04-09T09:03:41.0017427",
            "PeppolFileID": "c4be227d-6415-44ed-bf13-048bfd95b999"
        }
    ]
}