This API call is used to get fields of a(n) OrderCommission(s)

HTTP method	API version
GET	v1

Don’t forget to put the Authorization field in the header

API Path: /OrderCommissions/
or
API Path: /OrderCommissions/{id}

You can make this API call:
* without the key field id to get a list of OrderCommissions
* with the key field id as the path parameter (the specific id of the OrderCommission you want to get)

Fields

The following fields are available:

Field Name	Type
id	Number
order_id	Number
description	String
address_id	Number
address_name	String
employee_id	Number
employee_name	String
amount	Number
percent	Number
applyto_order	Boolean
applyto_chapter	Number
applyto_part	Number
applyto_group	String
application_localized	String

/OrderCommissions/

API Path: /OrderCommissions/

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/OrderCommissions

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: fblfWxfVAIzSfkDPUfzRqlDmfDGPfGbDftjkzfttOkfGGPtOVk

Query Parameters :
ParameterName: limit, ParameterValue: 5
ParameterName: sort, ParameterValue: id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/327”, “Records”: [
  {
    "id": 13,
    "order_id": 260,
    "description": "",
    "address_id": 91,
    "address_name": "AKP",
    "employee_id": 0,
    "employee_name": "",
    "amount": 0.0,
    "percent": 0,
    "applyto_order": false,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": ""
  },
  {
    "id": 28,
    "order_id": 261,
    "description": "architect",
    "address_id": 270,
    "address_name": "BERNAERTS RONALD",
    "employee_id": 0,
    "employee_name": "",
    "amount": 407.420000000000016,
    "percent": 2,
    "applyto_order": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines"
  }
,
…
]
}

/OrderCommissions/{id}

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/OrderCommissions/1443

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GPVfWxfrVbzSftDbVfzRqlGUfkrAGfPtfbtbzOAOOIOftlkVbr

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 1443,
    "order_id": 16124,
    "description": "",
    "address_id": 0,
    "address_name": "",
    "employee_id": 0,
    "employee_name": "",
    "amount": 0.0,
    "percent": 0,
    "applyto_order": true,
    "applyto_chapter": 0,
    "applyto_part": 0,
    "applyto_group": "",
    "application_localized": "All lines"
  }
]
}

https://ra.bouwsoft.be/api/v1/OrderCommissions/25

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: GPVfWxfrVbzSftDbVfzRqlGUfkrAGfPtfbtbzOAOOIOftlkVbr

Query Parameters :
ParameterName: columns, ParameterValue:

Success gives statuscode 404 And the following result

{“RecordChanges”: [
  {
    "Code": "404",
    "Message": "Not Found",
    "Description": "Id not found: 25",
    "Details": {
      "domain": "global",
      "reason": "notValid",
      "reasonType": "value",
      "location": "id",
      "locationType": "path",
      "value": {
        "provided": "25",
        "expected": [
          {
            "reference": {
              "entityField": "id",
              "entityName": "OrderCommissions"
            }
          }
        ]
      },
      "causes": [
        {
          "domain": "global",
          "entityId": 25,
          "entityName": "OrderCommissions",
          "reason": "notFound",
          "reasonType": "entity"
        }
      ]
    }
  }
]
}