OrderAgreement APIs

Operations related to OrderAgreements

Get incoming order agreements [transaction-type: OrderAgreement]

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

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!

Authorizations
Path parameters
accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""
Query parameters
limitnumberOptional

How many messages to return in Array (XML is always one!)

Default: 3Example: 5
offsetnumberOptional

Where to start index for using limit/offset listing

Default: 0Example: 0
includeReadbooleanOptional

If you are using the "read" enpoints, make it include previously read messages

Default: falseExample: false
integrationIdstringOptional

Qvalia unique identifier for the transaction/message

Default: ""
documentIdstringOptional

The document identifier of teh message, e.g. Invoice number

Default: ""
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: ""
Header parameters
AuthorizationstringRequired

API key

Default: ""
AcceptstringOptional

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

Default: application/json
Responses
200
OK
get
GET /transaction/{accountRegNo}/orderagreements/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Accept: */*

{
  "status": "success",
  "data": [
    {
      "{transaction-type}": {},
      "integrationId": "text"
    }
  ]
}

Create incoming order agreements [transaction-type: OrderAgreement]

post

The request can be either JSON or XML. Each individual message must be POST'ed as an object, JSON Array is not suported!

Authorizations
Path parameters
accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""
Query parameters
overWritebooleanOptional

For POST requests, chose to overwrite existing message upon 409 Conflict response

Default: falseExample: false
Header parameters
AuthorizationstringRequired

API key

Default: ""
Content-TypestringOptional

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

Default: application/json
Body
OrderResponseobjectOptional
Responses
200
OK
post
POST /transaction/{accountRegNo}/orderagreements/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "OrderResponse": {}
}
{
  "status": "success",
  "data": {
    "message": "{transaction-type} 100-1000 sent",
    "{transaction-type}_id": "100-1000",
    "integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
  }
}

Read incoming order agreements [transaction-type: OrderAgreement]

get

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.

Authorizations
Path parameters
accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""
Query parameters
limitnumberOptional

How many messages to return in Array (XML is always one!)

Default: 3Example: 5
offsetnumberOptional

Where to start index for using limit/offset listing

Default: 0Example: 0
includeReadbooleanOptional

If you are using the "read" enpoints, make it include previously read messages

Default: falseExample: false
Header parameters
AuthorizationstringRequired

API key

Default: ""
AcceptstringOptional

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

Default: application/json
Responses
200
OK
get
GET /transaction/{accountRegNo}/orderagreements/incoming/readorderagreement HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Accept: */*

{
  "status": "success",
  "data": [
    {
      "{transaction-type}": {},
      "integrationId": "text"
    }
  ]
}

Get incoming order agreements [transaction-type: OrderAgreement]

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

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!

Authorizations
Path parameters
accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""
Query parameters
limitnumberOptional

How many messages to return in Array (XML is always one!)

Default: 3Example: 5
offsetnumberOptional

Where to start index for using limit/offset listing

Default: 0Example: 0
includeReadbooleanOptional

If you are using the "read" enpoints, make it include previously read messages

Default: falseExample: false
integrationIdstringOptional

Qvalia unique identifier for the transaction/message

Default: ""
documentIdstringOptional

The document identifier of teh message, e.g. Invoice number

Default: ""
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: ""
Header parameters
AuthorizationstringRequired

API key

Default: ""
AcceptstringOptional

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

Default: application/json
Responses
200
OK
get
GET /transaction/{accountRegNo}/orderagreements/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Accept: */*

{
  "status": "success",
  "data": [
    {
      "{transaction-type}": {},
      "integrationId": "text"
    }
  ]
}

Create order agreements [transaction-type: OrderAgreement]

post

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!

Authorizations
Path parameters
accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""
Query parameters
overWritebooleanOptional

For POST requests, chose to overwrite existing message upon 409 Conflict response

Default: falseExample: false
Header parameters
AuthorizationstringRequired

API key

Default: ""
Content-TypestringOptional

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

Default: application/json
Body
OrderResponseobjectOptional
Responses
200
OK
post
POST /transaction/{accountRegNo}/orderagreements/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "OrderResponse": {}
}
{
  "status": "success",
  "data": {
    "message": "{transaction-type} 100-1000 sent",
    "{transaction-type}_id": "100-1000",
    "integrationId": "4725a033-e501-4e2f-afa5-3a5c24eb5e28"
  }
}

Read order agreements [transaction-type: OrderAgreement]

get

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.

Authorizations
Path parameters
accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""
Query parameters
limitnumberOptional

How many messages to return in Array (XML is always one!)

Default: 3Example: 5
offsetnumberOptional

Where to start index for using limit/offset listing

Default: 0Example: 0
includeReadbooleanOptional

If you are using the "read" enpoints, make it include previously read messages

Default: falseExample: false
Header parameters
AuthorizationstringRequired

API key

Default: ""
AcceptstringOptional

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

Default: application/json
Responses
200
OK
get
GET /transaction/{accountRegNo}/orderagreements/outgoing/readorderagreement HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Accept: */*

{
  "status": "success",
  "data": [
    {
      "{transaction-type}": {},
      "integrationId": "text"
    }
  ]
}
PreviousOrderResponse APIsNextOrderChange APIs

Was this helpful?