PEPPOL Service Bus deliveryOption

For sending documents it is good to know the partyId that will garanty the best delivery. The Generic/deliveryOption (Beta) you can request the best partyId to used with the salesInvoice/send. A organisation can have more than one partyID that can be used for sending documents if there are documents registered in the SMP to the partyId.   The deliveryOption  will return the partyId that is registered with documents that best fits the sending request.

deliveryOption

DeliveryOption can make a decision based on the following query parameters with the GET /api/v1-beta/generic/deliveryOption  endpoint. If there is no match the response will be empty. Use the parameters to limit the returned values to values that can be used.

Name Type Description
partyIds array[string] (query) All possible partyIds of the recipient party
protocols array[string] (query) Filter on protocol
Available values : As2, As4
documentTypeIds array[string] (query) Filter on document formats
isCredit boolean (query) Example: Set it to true, to search only for CreditNotes or to false if you don’t want to include CreditNotes in our result set.

Example: GET https://accp-psb.econnect.eu/api/v1-beta/generic/deliveryOption?partyIds=0106%3A24387570&partyIds=9944%3ANL815275018B01&partyIds=9918%3ANL66RABO0322298342&protocols=As2&protocols=As4&isCredit=false

This will give a response containing a list of data to be used for sending sorted on best value first.

DeliveryOption Response
Name Type
partyId string
documentTypeId string

The document format type id
processId string
protocol string

AS2, AS4

Enum:
Array [ 2 ]

url string

Ap url
certificate string

AP cert (Only valid OpenPeppol PKI)

Response

[
    {
        "partyId":"9918:nl66rabo0322298342",
        "documentTypeId":"urn:oasis:names:specification:ubl:schema:xsd:ApplicationResponse-2::ApplicationResponse##urn:www.cenbii.eu:transaction:biitrns071:ver2.0:extended:urn:www.peppol.eu:bis:peppol36a:ver1.0::2.1",
        "processId":"urn:www.cenbii.eu:profile:bii36:ver2.0",
        "protocol":"As2",
        "url":"https://accp-ap.econnect.eu/as2/v1",
        "certificate":"MIIF .... AT00kF4Xw=="
    },
    {
        "partyId":"9918:nl66rabo0322298342",
        "documentTypeId":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0:extended:urn:www.simplerinvoicing.org:si:si-ubl:ver1.2::2.1",
        "processId":"urn:www.cenbii.eu:profile:bii04:ver1.0",
        "protocol":"As2",
        "url":"https://accp-ap.econnect.eu/as2/v1",
        "certificate":"MIIF0 ... GItkAT00kF4Xw=="
    },
    {
        "partyId":"9918:nl66rabo0322298342",
        "documentTypeId":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0:extended:urn:www.simplerinvoicing.org:si:si-ubl:ver1.2::2.1",
        "processId":"urn:www.cenbii.eu:profile:bii04:ver2.0",
        "protocol":"As2",
        "url":"https://accp-ap.econnect.eu/as2/v1","
        certificate":"MIIF0 ... GItkAT00kF4Xw=="
    },
    {
        "partyId":"9918:nl66rabo0322298342",
        "documentTypeId":"urn:oasis:names:specification:ubl:schema:xsd:Invoice-2::Invoice##urn:www.cenbii.eu:transaction:biitrns010:ver2.0:extended:urn:www.peppol.eu:bis:peppol4a:ver2.0::2.1",
        "processId":"urn:www.cenbii.eu:profile:bii04:ver2.0",
        "protocol":"As2",
        "url":"https://accp-ap.econnect.eu/as2/v1",
        "certificate":"MIIF0z ... GItkAT00kF4Xw=="
    }]

Was this article helpful?