VismaBouwsoftAPICalls.v1_GET_PurchaseInvoiceProjects Method
v1_GET_PurchaseInvoiceProjects() as String

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

HTTP method API version
GET v1

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

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

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

Fields

The following fields are available:

Field Name Type
id Number
purchaseinvoice_id Number
purchaseinvoice_nr Number
purchaseinvoice_nr_supplier String
address_supplier_id Number
address_supplier_name String
project_id Number
project_pnr Number
project_unr Number
project_name String
project_yourreference String
actualcostitem_id Number
actualcostitem_nr String
actualcostitem_name String
job_id Number
job_code String
job_name String
amount Number
type String
type_localized String
type_id Number
note String
purchaseinvoice_linkedinvoice_id Number
purchaseinvoice_linkedinvoice_nr Number
purchaseinvoice_linkedinvoice_nr_supplier String

/PurchaseInvoiceProjects/

API Path: /PurchaseInvoiceProjects/

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

with the following parameters :

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

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–4/286”, “Records”: [
  {
    "id": 2,
    "purchaseinvoice_id": 11,
    "purchaseinvoice_nr": 20120001,
    "purchaseinvoice_nr_supplier": "",
    "address_supplier_id": 34,
    "address_supplier_name": "A. OTTE EN ZOON",
    "project_id": 15,
    "project_pnr": 20110001,
    "project_unr": 8,
    "project_name": "Isabelle Kreps",
    "project_yourreference": "(Uw Ref.)",
    "actualcostitem_id": 21,
    "actualcostitem_nr": "",
    "actualcostitem_name": "Volledig project",
    "job_id": 0,
    "job_code": "",
    "job_name": "",
    "amount": 5410.0,
    "type": "subcontractor",
    "type_localized": "Sub-contractor",
    "type_id": 0,
    "note": "",
    "purchaseinvoice_linkedinvoice_id": 0,
    "purchaseinvoice_linkedinvoice_nr": 0,
    "purchaseinvoice_linkedinvoice_nr_supplier": ""
  },
  {
    "id": 6,
    "purchaseinvoice_id": 15,
    "purchaseinvoice_nr": 20120014,
    "purchaseinvoice_nr_supplier": "AF2013555",
    "address_supplier_id": 15880,
    "address_supplier_name": "11Force4",
    "project_id": 8,
    "project_pnr": 20120005,
    "project_unr": 5,
    "project_name": "Binnendeuren",
    "project_yourreference": ",,n",
    "actualcostitem_id": 12,
    "actualcostitem_nr": "BD GL 01",
    "actualcostitem_name": "Schuifdeur in glas \"Thytan Mat\" Afm. : H.215cm x L.93cm",
    "job_id": 0,
    "job_code": "",
    "job_name": "",
    "amount": 450.0,
    "type": "product",
    "type_localized": "Article",
    "type_id": 1,
    "note": "",
    "purchaseinvoice_linkedinvoice_id": 0,
    "purchaseinvoice_linkedinvoice_nr": 0,
    "purchaseinvoice_linkedinvoice_nr_supplier": ""
  }
,

]
}

/PurchaseInvoiceProjects/{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/PurchaseInvoiceProjects/487

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 487,
    "purchaseinvoice_id": 884,
    "purchaseinvoice_nr": 202000122,
    "purchaseinvoice_nr_supplier": "",
    "address_supplier_id": 328892,
    "address_supplier_name": "DirkAPISupp",
    "project_id": 3149,
    "project_pnr": 2013086,
    "project_unr": 1275,
    "project_name": "Schilderen van API blokjes",
    "project_yourreference": "",
    "actualcostitem_id": 2576,
    "actualcostitem_nr": "",
    "actualcostitem_name": "Volledig Project",
    "job_id": 0,
    "job_code": "",
    "job_name": "",
    "amount": 80.549999999999997,
    "type": "subcontractor",
    "type_localized": "Sub-contractor",
    "type_id": 0,
    "note": "abcd",
    "purchaseinvoice_linkedinvoice_id": 0,
    "purchaseinvoice_linkedinvoice_nr": 0,
    "purchaseinvoice_linkedinvoice_nr_supplier": ""
  }
]
}