Skip to main content

Nymus API Xpress

This contains the Nymus API Xpress documentation.

API docs by Redocly

NymusApiXpress (1.0.0)

Download OpenAPI specification:Download

E-mail: support@nymus.be

The "NymusApiXpress" API enables interaction with the Peppol Network, offering features to manage participants (sender/receiver), document types, document sending and receiving and document status. Security is maintained through API key authentication. Responses provide information of the processing.

Our in-depth documentation

Peppol

Everything related to the Peppol Network

Our in-depth documentation

Retrieves the buyers/suppliers in your environment.

Retrieves the configuration of the buyers/suppliers of your Nymus environment.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Registers a new buyer/supplier in your environment.

Registers a new buyer/supplier in your Nymus environment. The registration allows you to specify the capability to send to the Peppol Network. Also to specify the document types that can be received via the Peppol Network for that specific buyer/supplier.

Authorizations:
apiKey
Request Body schema: application/json

Registers a new buyer/supplier in your environment.

participantId
required
string
participantName
required
string
countryCode
required
string
isSender
boolean
isReceiver
boolean
Array of objects (PeppolDocumentType)

Responses

Request samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Retrieves a buyer/supplier in your environment.

Retrieves the configuration of a buyer/supplier in your Nymus environment. It includes the capability to send to the Peppol Network. Also to specify the document types that can be received via the Peppol Network for that specific buyer/supplier.

Authorizations:
apiKey
path Parameters
participantId
required
string

Buyer/supplier to retrieve in your environment.

Responses

Response samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Updates a buyer/supplier in your environment.

Updates a buyer/supplier in your Nymus environment. The entire configuration is overwritten.

Authorizations:
apiKey
path Parameters
participantId
required
string

Buyer/supplier to update in your environment.

Request Body schema: application/json

Update a buyer/supplier in your Nymus environment.

participantId
required
string
participantName
required
string
countryCode
required
string
isSender
boolean
isReceiver
boolean
Array of objects (PeppolDocumentType)

Responses

Request samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Deletes a buyer/supplier in your environment.

Deletes a buyer/supplier in your Nymus environment. This buyer/supplier will be deleted on both the sending and receiving side. Also the Peppol Network registration is deleted.

Authorizations:
apiKey
path Parameters
participantId
required
string

Buyer/supplier to remove in your environment.

Responses

Response samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Adds document types to your buyer/supplier.

Adds to your buyer/supplier additional document types you want to receive via the Peppol Network. This will not overwrite your current supported documents but will append the new document types. Either peppolDocumentTypeIdentifiers or documentType is required.

Authorizations:
apiKey
path Parameters
participantId
required
string

ParticipantId to add documents to.

Request Body schema: application/json

Document types to add to your buyer/supplier.

Array
peppolDocumentTypeIdentifier
required
string
documentType
required
string
Enum: "BIS_BILLING_INVOICE_V3" "BIS_BILLING_CREDIT_NOTE_V3" "INVOICE_RESPONSE_3_0" "ORDER_3_0" "ORDER_AGREEMENT_3_0" "ORDER_RESPONSE_3_0" "CATALOGUE_3_0" "CATALOGUE_RESPONSE_3_0" "PUNCH_OUT_3_0" "DESPATCH_ADVICE_3_0" "MESSAGE_LEVEL_RESPONSE_3_0" "ORDER_CHANGE" "ORDER_CANCELLATION" "ORDER_RESPONSE_ADVANCED" "UNKNOWN"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Removes document types from your buyer/supplier.

Removes from your buyer/supplier the document types you no longer want to receive via the Peppol Network. This will not overwrite your current supported documents but will remove the specified document types. One of either peppolDocumentTypeIdentifiers or documentType is required.

Authorizations:
apiKey
path Parameters
participantId
required
string

Participant Id to add documents to.

Request Body schema: application/json

Document types to remove from your buyer/supplier.

Array
peppolDocumentTypeIdentifier
required
string
documentType
required
string
Enum: "BIS_BILLING_INVOICE_V3" "BIS_BILLING_CREDIT_NOTE_V3" "INVOICE_RESPONSE_3_0" "ORDER_3_0" "ORDER_AGREEMENT_3_0" "ORDER_RESPONSE_3_0" "CATALOGUE_3_0" "CATALOGUE_RESPONSE_3_0" "PUNCH_OUT_3_0" "DESPATCH_ADVICE_3_0" "MESSAGE_LEVEL_RESPONSE_3_0" "ORDER_CHANGE" "ORDER_CANCELLATION" "ORDER_RESPONSE_ADVANCED" "UNKNOWN"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "participantId": "string",
  • "participantName": "string",
  • "countryCode": "BE",
  • "isSender": true,
  • "isReceiver": true,
  • "documentTypes": [
    ]
}

Retrieves the registration info of a buyer/supplier on the Peppol Network.

Retrieves the receiving document types supported by a Peppol buyer/supplier. This can be used to check if your business parties can receive certain Peppol document types.

Authorizations:
apiKey
path Parameters
participantId
required
string

Participant ID of the buyer/supplier to look up on the Peppol Network.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sends an UBL through the Peppol Network

Sends an UBL through the Peppol Network. In order to successfully send an UBL on the Peppol Network 1) the sending party must be registered on your environment 2) the receiving party must be registered on the Peppol Network for the document type specified in your UBL 3) the UBL must be a valid Peppol supported UBL format. All these checks are performed in the background when using this endpoint before transmitting the UBL on the Peppol Network. If all the checks pass then an unique document ID will be returned.

Authorizations:
apiKey
Request Body schema: multipart/form-data
ubl
string <binary>

Responses

Response samples

Content type
application/json
{
  • "documentId": "string",
  • "validSender": true,
  • "validReceiver": true,
  • "validUBL": true,
  • "ublErrors": null
}

Retrieves where your incoming Peppol documents will be forwarded to

Retrieves the configuration where your incoming Peppol documents will be forwarded to.

Authorizations:
apiKey

Responses

Response samples

Content type
application/json
{
  • "webhookConfig": {
    },
  • "emailConfig": {
    },
  • "ftpConfig": {
    }
}

Registers or updates where your incoming Peppol documents should be forwarded to

Registers or updates the configuration where your incoming Peppol documents should be forwarded to. Possible options are 1) a webhook endpoint 2) a FTP-server 3) an e-mail address

Authorizations:
apiKey
Request Body schema: application/json

Registers or updates where your incoming Peppol documents should be forwarded to

object (WebhookConfiguration)
object (EmailConfiguration)
object (FtpConfiguration)

Responses

Request samples

Content type
application/json
{
  • "webhookConfig": {
    },
  • "emailConfig": {
    },
  • "ftpConfig": {
    }
}

Response samples

Content type
application/json
{
  • "webhookConfig": {
    },
  • "emailConfig": {
    },
  • "ftpConfig": {
    }
}

Deletes where your incoming Peppol documents should be forwarded to

Deletes the configuration where the incoming Peppol documents should be forwarded to.

Authorizations:
apiKey

Responses

Retrieves the status of a sent Peppol document.

Retrieves the delivery information and status of a sent Peppol document.

Authorizations:
apiKey
path Parameters
documentId
required
string

Document ID of the document to retrieve the status of.

Responses

Response samples

Content type
application/json
[
  • {
    }
]