Invoice APIs

Get incoming invoices

get

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).

Use limit parameter to change the number of returned messages and combine it with offset to traverse down the list, e.g: https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/incoming?limit=10&offset=10

To get new messages only, use the "Get incoming read invoices" endpoint instead.

Path parameters

accountRegNoStringOptionalDefault: ""

Query parameters

limitStringOptionalDefault: ""

includeReadStringOptionalDefault: ""

offsetStringOptionalDefault: ""

documentIdStringOptionalDefault: ""

fromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

toStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

updatedAtFromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

updatedAtToStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

integrationIdStringOptionalDefault: ""

Header parameters

AuthorizationStringOptionalDefault: ""

AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""

Responses

200Success

application/json

204

No content

application/json

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

500Error

application/json

get

HTTPcURLJavaScriptPython

GET /{accountRegNo}/invoices/incoming HTTP/1.1
Host: api.qvalia.comtransaction
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}

Post incoming invoice

post

APIs related to invoice handling

Path parameters

accountRegNoStringOptionalDefault: ""

Header parameters

AuthorizationstringOptionalDefault: ""

Content-TypeStringOptionalDefault: ""

AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""

Body

InvoiceobjectOptional

Responses

200Success

application/json

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

422Error

application/json

500Error

application/json

post

HTTPcURLJavaScriptPython

POST /transaction/{accountRegNo}/invoices/incoming HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "Invoice": {}
}

{
  "status": "success",
  "data": {
    "message": "invoice 12335675 sent",
    "invoice_id": "12335675"
  }
}

Get incoming read invoices

get

APIs related to invoice handling

Path parameters

accountRegNoStringOptionalDefault: ""

Header parameters

AuthorizationstringOptionalDefault: ""

AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""

Responses

200Success

application/json

204

No content

application/json

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

500Error

application/json

get

HTTPcURLJavaScriptPython

GET /transaction/{accountRegNo}/invoices/incoming/readInvoices HTTP/1.1
Host: api.qvalia.com
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}

Get outgoing invoices

get

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).

Use limit parameter to change the number of returned messages and combine it with offset to traverse down the list, e.g: https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/outgoing?limit=10&offset=10

Path parameters

accountRegNoStringOptionalDefault: ""

Query parameters

limitStringOptionalDefault: ""

includeReadStringOptionalDefault: ""

documentIdStringOptionalDefault: ""

fromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

toStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

updatedAtFromStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

updatedAtToStringOptional

YYYY-MM-DD, e.g. 2024-01-01

Default: ""

integrationIdStringOptionalDefault: ""

Header parameters

AuthorizationstringOptionalDefault: ""

AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""

Responses

200Success

application/json

204

No content

application/json

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

500Error

application/json

get

HTTPcURLJavaScriptPython

GET /transaction/{accountRegNo}/invoices/outgoing HTTP/1.1
Host: api.qvalia.com
Accept: */*

{
  "status": "success",
  "data": [
    {}
  ]
}

Post outgoing invoice

post

APIs related to invoice handling

Path parameters

accountRegNoStringOptionalDefault: ""

Header parameters

AuthorizationstringOptionalDefault: ""

Content-TypeStringOptionalDefault: ""

AcceptStringOptional

Either "application/json" (default) or "application/xml"

Default: ""

Body

InvoiceobjectOptional

Responses

200Success

application/json

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

422Error

application/json

500Error

application/json

post

HTTPcURLJavaScriptPython

POST /transaction/{accountRegNo}/invoices/outgoing HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "Invoice": {}
}

{
  "status": "success",
  "data": {
    "message": "invoice 12335675 sent",
    "order_id": "text"
  }
}