Disover Network Participant

v1.0.0

Discover a network participant and capabilities.

Input

{
  "type": "object",
  "description": "A participant to be discovered.",
  "required": [
    "identifier",
    "scheme"
  ],
  "properties": {
    "documentTypes": {
      "type": "array",
      "description": "An array of document types to discover. The default is '[\"invoice\", \"creditnote\"]'. This is ignored when only checking existence.",
      "items": {
        "type": "string",
        "enum": [
          "invoice",
          "creditnote",
          "invoice_response",
          "order",
          "ordering",
          "order_response"
        ]
      }
    },
    "identifier": {
      "type": "string",
      "description": "The actual identifier."
    },
    "metaScheme": {
      "type": "string",
      "description": "The meta scheme of the identifier. For Peppol this is always 'iso6523-actorid-upis'."
    },
    "network": {
      "type": "string",
      "description": "The network to check. Currently only 'peppol' is supported."
    },
    "scheme": {
      "type": "string",
      "description": "The scheme of the identifier. See <<_receiver_identifiers_list>> for a list."
    }
  }
}

Output

{
  "type": "object",
  "description": "A public identifier for this customer.",
  "properties": {
    "code": {
      "type": "string",
      "description": "The response code.",
      "enum": [
        "OK",
        "NOK"
      ]
    },
    "email": {
      "type": "boolean",
      "description": "Whether or not an 'OK' response means the document will be sent via Peppol, but delivered by email. This happens in the Belgian Hermes system where all identifiers have been registered, but if the receiver hasn't registered with a service provider, the Hermes system will send a PDF created from the electronic invoice and email that. The electronic document will itself not be emailed. Also see https://einvoice.belgium.be/en/article/send-structured-invoices-all-your-customers-hermes[Hermes^]."
    }
  }
}