Peppol Sender API Documentation
Base URL: {baseUrl}
API Version: 1.0
Send Peppol Test Message
Description
Send a test Peppol message using the specified parameters.
HTTP Method
POST
Endpoint
/sendtest/{senderId}/{receiverId}/{docTypeId}/{processId}/{countryC1}
Parameters
- senderId: Sender ID (required)
- receiverId: Receiver ID (required)
- docTypeId: Document Type ID (required)
- processId: Process ID (required)
- countryC1: Country C1 (required)
- skip-check: Skip check (optional, header, default: false)
Request Body
The request body must contain the Peppol message in JSON format.
- Content-Type: application/json
- Schema: ```json"<Peppol message>"```
200 Responses
Message Sent Successfully
Content type: Application/json
Schema: ```json"<Response message>"```
400 Responses
Invalid Input Data
Content type: Application/json
Schema: ```json"<Error message>"```
Send Peppol Prod Message
HTTP Method
POST
Endpoint
/sendprod/{senderId}/{receiverId}/{docTypeId}/{processId}/{countryC1}
Parameters
- senderId: Sender ID (required)
- receiverId: Receiver ID (required)
- docTypeId: Document Type ID (required)
- processId: Process ID (required)
- countryC1: Country C1 (required)
Request Body
The request body must contain the Peppol message in JSON format.
- Content-Type: application/json
- Schema:```json"<Peppol message>"```
400 Responses
Invalid Input Data
Content-Type: application/json
Schema:```json"<Error message>"```
200 Responses
Message Sent Successfully
Content-Type: application/json
Schema:```json<Responsemessage>"```
Get Version
HTTP Method
GET
Endpoint
/version
200 Responses
OK
Content-Type: */*
Schema:```json"<Version information>"```
Summary
sendPeppolTestMessage: Sends a test Peppol message.
sendPeppolProdMessage: Sends a production Peppol message.
getVersion: Retrieves the version of the API.
Components
Schemas: None
Responses: Described under the endpoint responses.
Request Bodies: Described under the request body for the endpoints.
Tags
- - peppol-sender-controller - -
- - version-controller - -