Get Status Info of a Sales Invoice

Importance of the Status

More then one status update might arrive, so it might be needed to execute the GET more then 1 time. The status includes information about 1) The delivery 2) Feedback from the receiver. Status feedback is avaible for multiple networks.

About the GET

Information is retrieved via :

Endpoint	Method	Response
/v1/orders/{UniqueID}	GET	Order Object

This does not only deliver information about the data of the invoice/credit note, but also information of the status.

CurrentDocumentDeliveryDetails

Expected values when IsDocumentDelivered is true (positive feedback):

Type	Definition
IsDocumentDelivered	true. The main element to verify.
DocumentDeliveryStatus	Used to set a invoicing address on a invoice. This is the last status available. Typical final value: Delivered
DocumentDeliveryDate	Example 2025-03-26T14:30:48.11. Contains date and time stamp when status delivered has been triggered
DocumentDeliveryInfo (if present)	Can contain more info about the status., e.g. last status of an Invoice Response (IMR, MLR). Typical values Received (Ontvangen), Approved (Goedgekeurd), Paid (Betaald). This feedback can depend on language.

Expected values delivery status is negative:

Type	Definition
IsDocumentDelivered	false
DocumentDeliveryStatus	Error
DocumentRefusedDate	Example 2025-03-26T14:30:48.11. Contains date and time stamp when status delivered has been triggered
DocumentRefusedInfo	Longer description
DocumentRefusedReasonTC	Can contain more info about the status., e.g. last status of an Invoice Response (IMR, MLR).

Expected values delivery is in progress:

Type	Definition
IsDocumentDelivered	false. (in progress is not delivered)
DocumentDeliveryStatus	Pending

Below 3 examples:

    "CurrentDocumentDeliveryDetails": {
        "DocumentDeliveryDate": "2025-04-23T12:57:23.23",
        "IsDocumentDelivered": true,
        "DocumentDeliveryStatus": "Delivered"
    },

    "CurrentDocumentDeliveryDetails": {
        "IsDocumentDelivered": false,
        "DocumentDeliveryStatus": "Pending"
    },

    "CurrentDocumentDeliveryDetails": {
        "DocumentRefusedDate": "2025-04-28T19:30:03.203",
        "DocumentRefusedReasonTC": "InvalidInvoice",
        "DocumentRefusedInfo": "Inconsistency between VAT number and tax code of the recipient of the invoice (acquirer)",
        "IsDocumentDelivered": false,
        "DocumentDeliveryStatus": "Error"
    },

Status Messages

The status messages are also stored as the final part of the feedback file. They are not strictly needed, but there is a requirement to store the feedback messages then this is possible.

Below 2 examples:

2 Messages : 1. Delivered with Succes in Peppol network. 2. Receiver has send a Peppol IMR feedback : AB : The document has been successfully received.
3 Messages : 1. Delivered with Succes in Peppol network. 2. Receiver has send a Peppol IMR feedback : AB : The document has been successfully received. 3. Receiver has send an additional Peppol IMR feedback : PD: The document has been paid.

"CurrentDocumentDeliveryDetails": {
        "DocumentDeliveryDate": "2025-05-07T14:09:17.563",
        "DocumentDeliveryInfo": "Ontvangen",
        "IsDocumentDelivered": true,
        "DocumentDeliveryStatus": "Delivered"
    },
    "Messages": [
        {
            "FileID": "845e4774-7d76-4d2c-a7de-e6d790cb57c6",
            "CreationDate": "2025-05-07T14:08:07.813",
            "TransportType": "Peppol",
            "Success": true,
            "Trials": 1,
            "Destination": "0208:0446725877",
            "MessageDirection": "Outgoing"
        },
        {
            "Description": "AB: The document has been successfully received.",
            "FileID": "7ee8b70c-3dd7-423a-8269-79f8bc49e0c5",
            "CreationDate": "2025-05-07T14:09:54.203",
            "TransportType": "Peppol",
            "Success": true,
            "Trials": 0,
            "Destination": "0208:0446725877",
            "MessageDirection": "Incoming"
        },
            ]
}

"CurrentDocumentDeliveryDetails": {
        "DocumentDeliveryDate": "2025-05-07T14:09:17.563",
        "DocumentDeliveryInfo": "Betaald",
        "IsDocumentDelivered": true,
        "DocumentDeliveryStatus": "Delivered"
    },
    "Messages": [
        {
            "FileID": "845e4774-7d76-4d2c-a7de-e6d790cb57c6",
            "CreationDate": "2025-05-07T14:08:07.813",
            "TransportType": "Peppol",
            "Success": true,
            "Trials": 1,
            "Destination": "0208:0446725877",
            "MessageDirection": "Outgoing"
        },
        {
            "Description": "AB: The document has been successfully received.",
            "FileID": "7ee8b70c-3dd7-423a-8269-79f8bc49e0c5",
            "CreationDate": "2025-05-07T14:09:54.203",
            "TransportType": "Peppol",
            "Success": true,
            "Trials": 0,
            "Destination": "0208:0446725877",
            "MessageDirection": "Incoming"
        },
        {
            "Description": "PD: The document has been paid.",
            "FileID": "b39065a9-8c82-4beb-9c04-010435f4c5fa",
            "CreationDate": "2025-05-07T14:25:11.427",
            "TransportType": "Peppol",
            "Success": true,
            "Trials": 0,
            "Destination": "0208:0446725877",
            "MessageDirection": "Incoming"
        }
    ]
}

The fileID allows with GET Files to receive each specific message.

OrderStatus

Any document has always an OrderStatus. The status can be retrieved. The possible values are mentioned on the page : Types .

They can be useful, but Document Delivery details might be the most efficient.

Type	Definition
ToSend	When document is created, but not sent, then ToSend is the status.
ToPay	Invoice has been sent, status in Billit is ToPay (status might stay at this level)