General Description

HTTP method	API version
POST	v1

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

API Path: /Assignments
or

Fields

The following fields are available:

Field Name	Type
id	Number
maintenancesheet_id	Number
company_id	Number
company_name	String
date	String
nr	Number
title	String
subject	String
status	String
planned	Boolean
executed	Boolean
executed_on	String
checked	Boolean
invoiced	Boolean
finished	Boolean
sent	Boolean
sent_on	String
reschedule	Boolean
readonly	Boolean
employee_id	Number
employee_name	String
machine_id	Number
machine_nr	String
machine_description	String
execute	Boolean
description_customer	String
note_technician	String
address_id	Number
address_name	String
address_address	String
address_addressline2	String
address_countrycode	String
address_zipcode	String
address_city	String
addresscontact_id	Number
contact_salutation	String
contact_name	String
project_id	Number
project_pnr	Number
project_unr	Number
project_name	String
yourreference	String
ts_lastupdate	String
actualcost_id	Number
actualcost_nr	Number
actualcost_datestart	String
actualcostitem_id	Number
actualcostitem_description	String
actualcostitem_description_localized	String

/Assignments

API Path: /Assignments/

If everything succeeds the HTTP response status is 201
(201 CREATED)

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

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/Assignments

with the following parameters :

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

Query Parameters :
ParameterName: columns, ParameterValue: address_id=%7B%22v1_POST_Addresses%20%28test1%29%22%3A%20%22id%22%7D,maintenancesheet_id=553

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 1294,
    "maintenancesheet_id": 553,
    "company_id": 2,
    "company_name": "Groensoft",
    "date": "2025–02–12",
    "nr": 20210379,
    "title": "",
    "subject": "",
    "status": "To schedule",
    "planned": false,
    "executed": false,
    "executed_on": "",
    "checked": false,
    "invoiced": false,
    "finished": false,
    "sent": false,
    "sent_on": "",
    "reschedule": false,
    "readonly": false,
    "employee_id": 0,
    "employee_name": "",
    "machine_id": 0,
    "machine_nr": "",
    "machine_description": "",
    "execute": false,
    "description_customer": "",
    "note_technician": "",
    "address_id": 328891,
    "address_name": "DirkAPICust",
    "address_address": "Molleweg 9",
    "address_addressline2": "",
    "address_countrycode": "BE",
    "address_zipcode": "8377",
    "address_city": "Houtave",
    "addresscontact_id": 0,
    "contact_salutation": "",
    "contact_name": "",
    "project_id": 0,
    "project_pnr": 0,
    "project_unr": 0,
    "project_name": "",
    "yourreference": "",
    "ts_lastupdate": "2025–02–12 14:27:08",
    "actualcost_id": 0,
    "actualcost_nr": 0,
    "actualcost_datestart": "2025–02–12",
    "actualcostitem_id": 0,
    "actualcostitem_description": "",
    "actualcostitem_description_localized": ""
  }
]
}