Transaction API

Operations related to Peppol messaging

Get Partner accounts transactions

get

/partner/{partnerRegNo}/transaction/{accountRegNo}/{messageType}/{direction}

An API to fetch (GET) your Partner accounts transactions.

Using the prefix of /partner/{partnerRegNo} you, as a partner, can access your accounts transactions through the Qvalia Transaction API. {messageType} and {direction} mirror the Transaction API endpoints, so invoices + incoming resolves to /partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/incoming.

Every {messageType}/{direction} combination available in the Transaction API works here. The read endpoints are reached by appending the Transaction API's read segment, e.g. /partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/incoming/readinvoices.

Request bodies, query parameters and response shapes are identical to the Transaction API — refer to Qvalia Transaction API.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

messageTypestring · enumRequired

Transaction message type, exactly as used by the Transaction API.

Example: invoicesPossible values:

directionstring · enumRequired

Whether to address messages received by, or sent from, the account.

Example: incomingPossible values:

Responses

200

See https://api.qvalia.io/api-documentation/apis/transaction-api

No content

429

Too Many Requests. The account has exceeded its request budget, which is counted per account across all Qvalia APIs.

Read Retry-After and wait at least that many seconds before retrying — retrying immediately is simply rejected again. RateLimit-Remaining on every response tells you how much of the budget is left, so a well-behaved client need not hit this at all. Contact Qvalia Helpdesk if your integration needs a higher limit.

application/json

get/partner/{partnerRegNo}/transaction/{accountRegNo}/{messageType}/{direction}

GET /partner/{partnerRegNo}/transaction/{accountRegNo}/{messageType}/{direction} HTTP/1.1
Host: api-test.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Post Partner accounts transactions

post

/partner/{partnerRegNo}/transaction/{accountRegNo}/{messageType}/{direction}

An API to send (POST) your Partner accounts transactions.

Using the prefix of /partner/{partnerRegNo} you, as a partner, can access your accounts transactions through the Qvalia Transaction API. {messageType} and {direction} mirror the Transaction API endpoints, so invoices + incoming resolves to /partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/incoming.

Every {messageType}/{direction} combination available in the Transaction API works here. The read endpoints are reached by appending the Transaction API's read segment, e.g. /partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/incoming/readinvoices.

Request bodies, query parameters and response shapes are identical to the Transaction API — refer to Qvalia Transaction API.

Authorizations

AuthorizationstringRequired

Path parameters

partnerRegNostringRequired

Partner registration number issued by Qvalia

accountRegNostringRequired

Account registration number issued by Qvalia

messageTypestring · enumRequired

Transaction message type, exactly as used by the Transaction API.

Example: invoicesPossible values:

directionstring · enumRequired

Whether to address messages received by, or sent from, the account.

Example: incomingPossible values:

Responses

200

See https://api.qvalia.io/api-documentation/apis/transaction-api

No content

429

Too Many Requests. The account has exceeded its request budget, which is counted per account across all Qvalia APIs.

Read Retry-After and wait at least that many seconds before retrying — retrying immediately is simply rejected again. RateLimit-Remaining on every response tells you how much of the budget is left, so a well-behaved client need not hit this at all. Contact Qvalia Helpdesk if your integration needs a higher limit.

application/json

post/partner/{partnerRegNo}/transaction/{accountRegNo}/{messageType}/{direction}

POST /partner/{partnerRegNo}/transaction/{accountRegNo}/{messageType}/{direction} HTTP/1.1
Host: api-test.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

No content