Order APIs

Get incoming orders

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}/creditNotes/incoming?limit=10&offset=10

To get new messages only, use the "Get incoming read orders" 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 /transaction/{accountRegNo}/orders/incoming HTTP/1.1
Host: api.qvalia.com
Accept: */*

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

Post incoming order

post

APIs related to order handing

Path parameters

accountRegNoStringOptionalDefault: ""

Query parameters

overwriteStringOptionalDefault: ""

Header parameters

AuthorizationstringOptionalDefault: ""

Content-TypeStringOptionalDefault: ""

AcceptStringOptional

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

Default: ""

Body

OrderobjectOptional

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}/orders/incoming HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "Order": {}
}

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

Get incoming read orders

get

APIs related to order handing

Path parameters

accountRegNoStringOptionalDefault: ""

Query parameters

limitStringOptionalDefault: ""

includeReadStringOptionalDefault: ""

offsetStringOptionalDefault: ""

documentIdStringOptionalDefault: ""

fromStringOptionalDefault: ""

toStringOptionalDefault: ""

updatedAtFromStringOptionalDefault: ""

updatedAtToStringOptionalDefault: ""

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}/orders/incoming/readOrders HTTP/1.1
Host: api.qvalia.com
Accept: */*

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

Get outgoing orders

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}/creditNotes/incoming?limit=10&offset=10

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}/orders/outgoing HTTP/1.1
Host: api.qvalia.com
Accept: */*

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

Post outgoing order

post

APIs related to order handing

Path parameters

accountRegNoStringOptionalDefault: ""

Header parameters

AuthorizationstringOptionalDefault: ""

Content-TypeStringOptionalDefault: ""

AcceptStringOptional

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

Default: ""

Body

OrderobjectOptional

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}/orders/outgoing HTTP/1.1
Host: api.qvalia.com
Content-Type: application/json
Accept: */*
Content-Length: 12

{
  "Order": {}
}

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