Creates or updates a job part usage record.
Request Information
URI Parameters :
None.
Body Parameters :
job_part_usage| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of jobs |
globally unique identifier | |
| job_approval_id |
Job approval Id |
globally unique identifier | |
| article_stock_location_id |
In case of stock management enabled, the stock that has been used |
globally unique identifier | |
| article_id |
Foreign key of article. Can be empty if user keys in manually the object |
globally unique identifier | |
| is_dummy |
In case of dummy |
boolean | |
| article_code |
Article code |
string |
Max length: 255 |
| article_name |
Article name |
string |
Max length: 255 |
| article_description |
Article description |
string |
Max length: 255 |
| working_date |
Date when the part has been used |
date | |
| quantity |
Quantity |
decimal number | |
| serial_number |
When the article.use_serial then the serial should be saved here |
string |
Max length: 255 |
| price |
Unit price of the part. Computed with the price logic or filled via purchase_order_details.price |
decimal number | |
| is_under_warranty |
In case the logic detect that the parts was in warranty, this field will be set to true and the discount will be set equal to the price |
boolean | |
| discount |
Manual discount , in money, added by the technician |
decimal number | |
| purchase_order_details_id |
Foreign key of purchase_order_details, if the line was generated based on a purchase_order_details |
globally unique identifier | |
| user_id |
User Id |
globally unique identifier | |
| remark | string |
Max length: 255 |
|
| no_warranty_reason | string |
Max length: 255 |
|
| db_unit_of_measure_id |
Foreign key of the unit of measure is expressed in. |
globally unique identifier | |
| included_on_last_stock_compute |
Indicates this usage line was already accounted for in the most recent stock recomputation, to avoid double-counting. |
boolean | |
| signed_by_company |
Needed for integration |
boolean | |
| company_vat_id |
Foreign key of the VAT regime applied to this line. |
globally unique identifier | |
| vat_value |
VAT amount computed for this line. |
decimal number | |
| vat_rate |
VAT rate applied to this line (percentage). |
decimal number | |
| invoice_id |
Foreign key of the invoice this line was billed on, once invoiced. |
globally unique identifier | |
| invoice_details_id |
Foreign key of the invoice detail line this usage was billed on, once invoiced. |
globally unique identifier | |
| is_customized |
Indicates the article details on this line were manually customized rather than copied as-is from the article record. |
boolean | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{
"id": "ef7ef3df-ea01-4215-82b1-83cc239c1248",
"jobs_id": "6f7c45b5-dacd-4476-ae0d-1f3444f8ff41",
"job_approval_id": "19c95fb8-189a-42db-811c-05cb823fbd02",
"article_stock_location_id": "14e1354d-2cd0-4ad9-9281-342d30a6cf07",
"article_id": "81309fb0-0a7d-470d-a91e-a10997170fc7",
"is_dummy": true,
"article_code": "sample string 7",
"article_name": "sample string 8",
"article_description": "sample string 9",
"working_date": "2026-09-16T09:22:26.321664+00:00",
"quantity": 11.0,
"serial_number": "sample string 12",
"price": 13.0,
"is_under_warranty": true,
"discount": 15.0,
"purchase_order_details_id": "23f558b9-01a5-47a9-a657-7620efa33e16",
"user_id": "5583e7aa-14bb-4000-a6f9-fc91233aed90",
"remark": "sample string 18",
"no_warranty_reason": "sample string 19",
"db_unit_of_measure_id": "c6f1075c-2b3a-495d-af66-8ccea8e0b9aa",
"included_on_last_stock_compute": true,
"signed_by_company": true,
"company_vat_id": "719300c3-50af-4e4c-b6f3-7497ac4810a3",
"vat_value": 24.0,
"vat_rate": 25.0,
"invoice_id": "7a328a50-cdf1-468e-9407-37db5bea4e0d",
"invoice_details_id": "8eaaa1a7-f95d-46da-9a51-2a2a6503aac7",
"is_customized": true,
"modified_dateutc": "2026-09-16T09:22:26.321664+00:00"
}
application/xml, text/xml
<job_part_usage xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <article_code>sample string 7</article_code> <article_description>sample string 9</article_description> <article_id>81309fb0-0a7d-470d-a91e-a10997170fc7</article_id> <article_name>sample string 8</article_name> <article_stock_location_id>14e1354d-2cd0-4ad9-9281-342d30a6cf07</article_stock_location_id> <company_vat_id>719300c3-50af-4e4c-b6f3-7497ac4810a3</company_vat_id> <db_unit_of_measure_id>c6f1075c-2b3a-495d-af66-8ccea8e0b9aa</db_unit_of_measure_id> <discount>15</discount> <id>ef7ef3df-ea01-4215-82b1-83cc239c1248</id> <included_on_last_stock_compute>true</included_on_last_stock_compute> <invoice_details_id>8eaaa1a7-f95d-46da-9a51-2a2a6503aac7</invoice_details_id> <invoice_id>7a328a50-cdf1-468e-9407-37db5bea4e0d</invoice_id> <is_customized>true</is_customized> <is_dummy>true</is_dummy> <is_under_warranty>true</is_under_warranty> <job_approval_id>19c95fb8-189a-42db-811c-05cb823fbd02</job_approval_id> <jobs_id>6f7c45b5-dacd-4476-ae0d-1f3444f8ff41</jobs_id> <modified_dateutc>2026-09-16T09:22:26.321Z</modified_dateutc> <no_warranty_reason>sample string 19</no_warranty_reason> <price>13</price> <purchase_order_details_id>23f558b9-01a5-47a9-a657-7620efa33e16</purchase_order_details_id> <quantity>11</quantity> <remark>sample string 18</remark> <serial_number>sample string 12</serial_number> <signed_by_company>true</signed_by_company> <user_id>5583e7aa-14bb-4000-a6f9-fc91233aed90</user_id> <vat_rate>25</vat_rate> <vat_value>24</vat_value> <working_date>2026-09-16T09:22:26.321Z</working_date> </job_part_usage>
Response Information
Resource Description :
IHttpActionResult containing the saved job part usage record.
job_part_usage| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of jobs |
globally unique identifier | |
| job_approval_id |
Job approval Id |
globally unique identifier | |
| article_stock_location_id |
In case of stock management enabled, the stock that has been used |
globally unique identifier | |
| article_id |
Foreign key of article. Can be empty if user keys in manually the object |
globally unique identifier | |
| is_dummy |
In case of dummy |
boolean | |
| article_code |
Article code |
string |
Max length: 255 |
| article_name |
Article name |
string |
Max length: 255 |
| article_description |
Article description |
string |
Max length: 255 |
| working_date |
Date when the part has been used |
date | |
| quantity |
Quantity |
decimal number | |
| serial_number |
When the article.use_serial then the serial should be saved here |
string |
Max length: 255 |
| price |
Unit price of the part. Computed with the price logic or filled via purchase_order_details.price |
decimal number | |
| is_under_warranty |
In case the logic detect that the parts was in warranty, this field will be set to true and the discount will be set equal to the price |
boolean | |
| discount |
Manual discount , in money, added by the technician |
decimal number | |
| purchase_order_details_id |
Foreign key of purchase_order_details, if the line was generated based on a purchase_order_details |
globally unique identifier | |
| user_id |
User Id |
globally unique identifier | |
| remark | string |
Max length: 255 |
|
| no_warranty_reason | string |
Max length: 255 |
|
| db_unit_of_measure_id |
Foreign key of the unit of measure is expressed in. |
globally unique identifier | |
| included_on_last_stock_compute |
Indicates this usage line was already accounted for in the most recent stock recomputation, to avoid double-counting. |
boolean | |
| signed_by_company |
Needed for integration |
boolean | |
| company_vat_id |
Foreign key of the VAT regime applied to this line. |
globally unique identifier | |
| vat_value |
VAT amount computed for this line. |
decimal number | |
| vat_rate |
VAT rate applied to this line (percentage). |
decimal number | |
| invoice_id |
Foreign key of the invoice this line was billed on, once invoiced. |
globally unique identifier | |
| invoice_details_id |
Foreign key of the invoice detail line this usage was billed on, once invoiced. |
globally unique identifier | |
| is_customized |
Indicates the article details on this line were manually customized rather than copied as-is from the article record. |
boolean | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "f473cff8-7f7c-4f34-9322-1d84a0f560cb",
"jobs_id": "265f54fc-f1cb-447b-9b90-09b30a45f6fe",
"job_approval_id": "78da58af-7672-4a9c-a527-9176bfa6b07b",
"article_stock_location_id": "62c4620f-ca4f-4876-b90e-b8fb3a6ba585",
"article_id": "9ed154d2-6d33-41d8-b67a-b244586d3667",
"is_dummy": true,
"article_code": "sample string 7",
"article_name": "sample string 8",
"article_description": "sample string 9",
"working_date": "2026-09-16T09:22:26.321664+00:00",
"quantity": 11.0,
"serial_number": "sample string 12",
"price": 13.0,
"is_under_warranty": true,
"discount": 15.0,
"purchase_order_details_id": "318a775e-d1f3-4add-a1e1-053488478401",
"user_id": "92590272-3fdf-41b9-b9b0-9541b7fb0f82",
"remark": "sample string 18",
"no_warranty_reason": "sample string 19",
"db_unit_of_measure_id": "10e42c9c-d663-415c-92b3-fc5c57e621d2",
"included_on_last_stock_compute": true,
"signed_by_company": true,
"company_vat_id": "075e5678-c2a1-4e04-9e07-80f10283bb27",
"vat_value": 24.0,
"vat_rate": 25.0,
"invoice_id": "58f3291b-e5cc-4090-8d44-0348cf3304b9",
"invoice_details_id": "ea893946-5d19-4cda-9355-e5ba72b5a2e3",
"is_customized": true,
"modified_dateutc": "2026-09-16T09:22:26.321664+00:00"
}
application/xml, text/xml
<job_part_usage xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <article_code>sample string 7</article_code> <article_description>sample string 9</article_description> <article_id>9ed154d2-6d33-41d8-b67a-b244586d3667</article_id> <article_name>sample string 8</article_name> <article_stock_location_id>62c4620f-ca4f-4876-b90e-b8fb3a6ba585</article_stock_location_id> <company_vat_id>075e5678-c2a1-4e04-9e07-80f10283bb27</company_vat_id> <db_unit_of_measure_id>10e42c9c-d663-415c-92b3-fc5c57e621d2</db_unit_of_measure_id> <discount>15</discount> <id>f473cff8-7f7c-4f34-9322-1d84a0f560cb</id> <included_on_last_stock_compute>true</included_on_last_stock_compute> <invoice_details_id>ea893946-5d19-4cda-9355-e5ba72b5a2e3</invoice_details_id> <invoice_id>58f3291b-e5cc-4090-8d44-0348cf3304b9</invoice_id> <is_customized>true</is_customized> <is_dummy>true</is_dummy> <is_under_warranty>true</is_under_warranty> <job_approval_id>78da58af-7672-4a9c-a527-9176bfa6b07b</job_approval_id> <jobs_id>265f54fc-f1cb-447b-9b90-09b30a45f6fe</jobs_id> <modified_dateutc>2026-09-16T09:22:26.321Z</modified_dateutc> <no_warranty_reason>sample string 19</no_warranty_reason> <price>13</price> <purchase_order_details_id>318a775e-d1f3-4add-a1e1-053488478401</purchase_order_details_id> <quantity>11</quantity> <remark>sample string 18</remark> <serial_number>sample string 12</serial_number> <signed_by_company>true</signed_by_company> <user_id>92590272-3fdf-41b9-b9b0-9541b7fb0f82</user_id> <vat_rate>25</vat_rate> <vat_value>24</vat_value> <working_date>2026-09-16T09:22:26.321Z</working_date> </job_part_usage>