Invoice APIs
Operations related to Invoices
The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseQvalia unique identifier for the transaction/message
""The document identifier of teh message, e.g. Invoice number
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""API key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoices/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The request can be either JSON or XML. Each individual message must be POST'ed as an object, JSON Array is not suported!
Account registration number issued by Qvalia
""For POST requests, chose to overwrite upon a 409 Conflict response to reprocess the message with the same document ID and receiver (i.e. send the same message again)
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /transaction/{accountRegNo}/invoices/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"Invoice": {}
}{
"status": "success",
"data": {
"message": "{transaction-type} 100-1000 sent",
"{transaction-type}_id": "100-1000",
"integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
}
}Through this endpoint you will get any unread (=previously fetched) message(s). After you have fetched through this request the message will be automatically marked as read
The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoices/incoming/readinvoices HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseQvalia unique identifier for the transaction/message
""The document identifier of teh message, e.g. Invoice number
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""API key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoices/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""For POST requests, chose to overwrite upon a 409 Conflict response to reprocess the message with the same document ID and receiver (i.e. send the same message again)
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /transaction/{accountRegNo}/invoices/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"Invoice": {}
}{
"status": "success",
"data": {
"message": "{transaction-type} 100-1000 sent",
"{transaction-type}_id": "100-1000",
"integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
}
}Through this endpoint you will get any unread (=previously fetched) message(s). After you have fetched through this request the message will be automatically marked as read
The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoices/outgoing/readinvoices HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseQvalia unique identifier for the transaction/message
""The document identifier of teh message, e.g. Invoice number
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""API key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoiceresponses/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The request can be either JSON or XML. Each individual message must be POST'ed as an object, JSON Array is not suported!
Account registration number issued by Qvalia
""For POST requests, chose to overwrite upon a 409 Conflict response to reprocess the message with the same document ID and receiver (i.e. send the same message again)
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /transaction/{accountRegNo}/invoiceresponses/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"ApplicationResponse": {}
}{
"status": "success",
"data": {
"message": "{transaction-type} 100-1000 sent",
"{transaction-type}_id": "100-1000",
"integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
}
}Through this endpoint you will get any unread (=previously fetched) message(s). After you have fetched through this request the message will be automatically marked as read
The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoiceresponses/incoming/readinvoice responses HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseQvalia unique identifier for the transaction/message
""The document identifier of teh message, e.g. Invoice number
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""API key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoiceresponses/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""For POST requests, chose to overwrite upon a 409 Conflict response to reprocess the message with the same document ID and receiver (i.e. send the same message again)
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /transaction/{accountRegNo}/invoiceresponses/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"ApplicationResponse": {}
}{
"status": "success",
"data": {
"message": "{transaction-type} 100-1000 sent",
"{transaction-type}_id": "100-1000",
"integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
}
}Through this endpoint you will get any unread (=previously fetched) message(s). After you have fetched through this request the message will be automatically marked as read
The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/invoiceresponses/outgoing/readinvoice responses HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseQvalia unique identifier for the transaction/message
""The document identifier of teh message, e.g. Invoice number
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""API key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/selfbillinginvoices/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The request can be either JSON or XML. Each individual message must be POST'ed as an object, JSON Array is not suported!
Account registration number issued by Qvalia
""For POST requests, chose to overwrite upon a 409 Conflict response to reprocess the message with the same document ID and receiver (i.e. send the same message again)
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /transaction/{accountRegNo}/selfbillinginvoices/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"Invoice": {}
}{
"status": "success",
"data": {
"message": "{transaction-type} 100-1000 sent",
"{transaction-type}_id": "100-1000",
"integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
}
}Through this endpoint you will get any unread (=previously fetched) message(s). After you have fetched through this request the message will be automatically marked as read
The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/selfbillinginvoices/incoming/readselfbillinginvoices HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseQvalia unique identifier for the transaction/message
""The document identifier of teh message, e.g. Invoice number
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""YYYY-MM-DD, e.g. 2024-01-01
""API key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/selfbillinginvoices/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
To get new messages only, use the "Read" endpoint instead!
Account registration number issued by Qvalia
""For POST requests, chose to overwrite upon a 409 Conflict response to reprocess the message with the same document ID and receiver (i.e. send the same message again)
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
POST /transaction/{accountRegNo}/selfbillinginvoices/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"Invoice": {}
}{
"status": "success",
"data": {
"message": "{transaction-type} 100-1000 sent",
"{transaction-type}_id": "100-1000",
"integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
}
}Through this endpoint you will get any unread (=previously fetched) message(s). After you have fetched through this request the message will be automatically marked as read
The response, in JSON, will always include the three latest messages, per default. Using XML you always only get one (as there's no "array" function for XML).
With JSON, use the limit parameter to change the number of returned messages and combine it with offset to traverse through your available messages.
Account registration number issued by Qvalia
""How many messages to return in Array (XML is always one!)
3Example: 5Where to start index for using limit/offset listing
0Example: 0If you are using the "read" enpoints, make it include previously read messages
falseExample: falseAPI key
""Either "application/json" (default) or "application/xml"
application/jsonOK
No content
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Unprocessable Entity
Internal Server Error
GET /transaction/{accountRegNo}/selfbillinginvoices/outgoing/readselfbillinginvoices HTTP/1.1
Host: api-qa.qvalia.com
Authorization:
Accept: */*
{
"status": "success",
"data": [
{
"{transaction-type}": {},
"integrationId": "text"
}
]
}Was this helpful?