GetInboxDocument

This API is used to retrieve a single inbox document. A ExternalId, which is required to fire this API, can be obtained by firing the Get Inbox Documents API. On receiving the ExtrenalId, the Get Inbox Document API can be fired to fetch the complete information about that particular document. The request and response format for the Get Inbox Document API are given below.

Header fields
Fieldname Description
SOAPAction [Mandatory] http://api.everbinding.nl/v3_1/GetInboxDocument
Request fields
Fieldname Description
ExternalId Id from document to be fetched. This Id can be retrieved with GetInboxDocuments
Response fields
Fieldname Description
Details Details of the document including the document as payload. This is the UBL file without the XML Prolog
Statuses List of possible statuses for the used template. This list should be used for changing the status of the documents.

Request body

<?xml version="1.0" ?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><S:Header><h:Authentication xmlns="http://api.everbinding.nl/v3_1/" xmlns:h="http://api.everbinding.nl/v3_1/"><SecurityToken>o2S1qTusL29hp3IgMKWsn2I5CFV2LmZ2ZmR2AQp4AGN0BQZmATH3ZwHkAQH1LGL2AGx0VvkiLKI0nS9ho25wMG0vZGZlAmp2ZwLvYT9uqKEbK3EcoJImqTSgpQ0vZGHjAwZlBGH5AFVfo2S1qTusp2yaozS0qKWyK21yqTuiMQ0vFR1ODl1GFRRkVvkiLKI0nS92MKWmnJ9hCFVkYwNvYT9uqKEbK3Ein2IhCFWEn29SM2flLH9cp21zIaADoHpjomqUBQujqaMMBHqCpFVfo2S1qTusp2yaozS0qKWyCFWPpScMnzS4GaAuF1unnQWdpJuVrH1dM1M4FTfyZ0Dv</SecurityToken></h:Authentication></S:Header><S:Body xmlns="http://api.everbinding.nl/v3_1/">
    <GetInboxDocument xmlns="http://api.everbinding.nl/v3_1/">
        <ExternalId>XCNIN97369</ExternalId>
</GetInboxDocument></S:Body></S:Envelope>

Response 200

<?xml version="1.0" encoding="utf-8"?>
<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"><SOAP:Body>
<GetInboxDocumentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.everbinding.nl/v3_1/">
    <Details>
        <ExternalId>XCNIN97369</ExternalId>
        <DocumentId />
        <Subject>Test 10 Nove 1</Subject>
        <CreatedOn>2016-11-16T08:49:34.853Z</CreatedOn>
        <ModifiedOn>2017-09-12T14:50:47.735Z</ModifiedOn>
        <Sender>
            <EConnectPartyId>XCNL10019</EConnectPartyId>
            <Name>eLien Test Company B.V.</Name>
        </Sender>
        <Receiver>
            <EConnectPartyId>XCNL10019</EConnectPartyId>
            <Name>eLien Test Company B.V.</Name>
        </Receiver>
        <Status>
            <Name>Afgekeurd</Name>
            <Code>50</Code>
            <Info>
                <UserId>UA000000218000001</UserId>
                <UserName>test elien</UserName>
                <AccountId>A000000218</AccountId>
                <AccountName>eLien</AccountName>
                <ChangedOn>2017-09-12T14:50:47.735Z</ChangedOn>
            </Info>
        </Status>
        <Template>
            <Id>GLDT9223370666504283001RA000000006DTP2000001</Id>
            <Name>Factuur</Name>
            <MasterId>GLDT9223370666504283001RA000000006DTP2000001</MasterId>
            <MasterName>Factuur</MasterName>
        </Template>
        <Transaction>
            <MessageId>EM0001</MessageId>
            <DeliveryMethod>ToInbox</DeliveryMethod>
            <SenderReferenceId>XCNL10019</SenderReferenceId>
            <ReceiverReferenceId>LEA0000002189223370641816620154EXCP2000001</ReceiverReferenceId>
        </Transaction>
        <Payload>
            .
            .
        </Payload>
    </Details>
    <Statuses>
        <Status>
            <Name>Opgeslagen</Name>
            <Code>05</Code>
        </Status>
        <Status>
            <Name>Ontvangen</Name>
                <Code>10</Code>
        </Status>
        <Status>
            <Name>Geopend</Name>
            <Code>20</Code>
        </Status><Status><Name>Gedownload</Name><Code>30</Code></Status><Status><Name>Opgeslagen</Name><Code>05</Code></Status><Status><Name>Ontvangen</Name><Code>10</Code></Status><Status><Name>Geopend</Name><Code>20</Code></Status><Status><Name>Gedownload</Name><Code>30</Code></Status><Status><Name>Ter goedkeuring</Name><Code>35</Code></Status><Status><Name>Goedgekeurd</Name><Code>40</Code></Status><Status><Name>Afgekeurd</Name><Code>50</Code></Status><Status><Name>Betaalbaar gesteld</Name><Code>60</Code></Status><Status><Name>Betaald</Name><Code>70</Code></Status>
    </Statuses>
</GetInboxDocumentResponse></SOAP:Body></SOAP:Envelope>

 

Was this article helpful?