OrderAgreement APIs

Operations related to OrderAgreements

Get incoming order agreements [transaction-type: OrderAgreement]

get

https://api-qa.qvalia.comhttps://api.qvalia.com

/transaction/{accountRegNo}/orderagreements/incoming

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

api_key

AuthorizationstringRequired

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

application/jsonapplication/xml

204

No content

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get

/transaction/{accountRegNo}/orderagreements/incoming

HTTPcURLJavaScriptPython

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

https://api-qa.qvalia.comhttps://api.qvalia.com

/transaction/{accountRegNo}/orderagreements/incoming

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

Authorizations

api_key

AuthorizationstringRequired

Path parameters

accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""

Query parameters

overwritebooleanOptional

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)

Default: falseExample: false

Header parameters

AuthorizationstringRequired

API key

Default: ""

Content-TypestringOptional

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

Default: application/json

Body

application/jsonapplication/xml

OrderResponseobjectOptional

Responses

200

OK

application/jsonapplication/xml

204

No content

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post

/transaction/{accountRegNo}/orderagreements/incoming

HTTPcURLJavaScriptPython

POST /transaction/{accountRegNo}/orderagreements/incoming HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "OrderResponse": {}
}

application/jsonapplication/xml

{
  "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

https://api-qa.qvalia.comhttps://api.qvalia.com

/transaction/{accountRegNo}/orderagreements/incoming/readorderagreement

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

api_key

AuthorizationstringRequired

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

application/jsonapplication/xml

204

No content

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get

/transaction/{accountRegNo}/orderagreements/incoming/readorderagreement

HTTPcURLJavaScriptPython

GET /transaction/{accountRegNo}/orderagreements/incoming/readorderagreement HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Accept: */*

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

Get outgoing order agreements [transaction-type: OrderAgreement]

get

https://api-qa.qvalia.comhttps://api.qvalia.com

/transaction/{accountRegNo}/orderagreements/outgoing

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

api_key

AuthorizationstringRequired

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

application/jsonapplication/xml

204

No content

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get

/transaction/{accountRegNo}/orderagreements/outgoing

HTTPcURLJavaScriptPython

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

https://api-qa.qvalia.comhttps://api.qvalia.com

/transaction/{accountRegNo}/orderagreements/outgoing

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

api_key

AuthorizationstringRequired

Path parameters

accountRegNostringRequired

Account registration number issued by Qvalia

Default: ""

Query parameters

overwritebooleanOptional

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)

Default: falseExample: false

Header parameters

AuthorizationstringRequired

API key

Default: ""

Content-TypestringOptional

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

Default: application/json

Body

application/jsonapplication/xml

OrderResponseobjectOptional

Responses

200

OK

application/jsonapplication/xml

204

No content

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post

/transaction/{accountRegNo}/orderagreements/outgoing

HTTPcURLJavaScriptPython

POST /transaction/{accountRegNo}/orderagreements/outgoing HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "OrderResponse": {}
}

application/jsonapplication/xml

{
  "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

https://api-qa.qvalia.comhttps://api.qvalia.com

/transaction/{accountRegNo}/orderagreements/outgoing/readorderagreement

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

api_key

AuthorizationstringRequired

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

application/jsonapplication/xml

204

No content

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

get

/transaction/{accountRegNo}/orderagreements/outgoing/readorderagreement

HTTPcURLJavaScriptPython

GET /transaction/{accountRegNo}/orderagreements/outgoing/readorderagreement HTTP/1.1
Host: api-qa.qvalia.com
Authorization: 
Accept: */*

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