Add/update job_part_usage
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 | globally unique identifier | ||
| included_on_last_stock_compute | boolean | ||
| signed_by_company |
Needed for integration |
boolean | |
| company_vat_id | globally unique identifier | ||
| vat_value | decimal number | ||
| vat_rate | decimal number | ||
| invoice_id | globally unique identifier | ||
| invoice_details_id | globally unique identifier | ||
| is_customized | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
{
"id": "104d37b0-189d-4d91-a42e-51d9f27cad6c",
"jobs_id": "149edbae-feda-4a2b-8d16-e49a0c4022f5",
"job_approval_id": "e65ff2dc-ba72-4cd6-8944-52f34e378021",
"article_stock_location_id": "395ce9fc-c281-42b8-991d-64d9cd61bcfd",
"article_id": "ba4c8569-19d6-4b64-b387-d7832f0a3313",
"is_dummy": true,
"article_code": "sample string 7",
"article_name": "sample string 8",
"article_description": "sample string 9",
"working_date": "2026-01-11T23:49:10.0225526+00:00",
"quantity": 11.0,
"serial_number": "sample string 12",
"price": 13.0,
"is_under_warranty": true,
"discount": 15.0,
"purchase_order_details_id": "64d44ad6-6d17-4802-915b-23fa2f9d9974",
"user_id": "edf78750-dbdd-4f41-bd41-7ce86a444db0",
"remark": "sample string 18",
"no_warranty_reason": "sample string 19",
"db_unit_of_measure_id": "5e2e2b06-3a73-4803-977a-10f299555cbe",
"included_on_last_stock_compute": true,
"signed_by_company": true,
"company_vat_id": "3d539a98-f117-4ebc-befa-ea5bfb9f45ad",
"vat_value": 24.0,
"vat_rate": 25.0,
"invoice_id": "228e9a8a-88f4-49d0-bdda-38af63150a76",
"invoice_details_id": "123d748b-5feb-4a86-8e3e-de36725438a1",
"is_customized": true,
"modified_dateutc": "2026-01-11T23:49:10.0225526+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>ba4c8569-19d6-4b64-b387-d7832f0a3313</article_id> <article_name>sample string 8</article_name> <article_stock_location_id>395ce9fc-c281-42b8-991d-64d9cd61bcfd</article_stock_location_id> <company_vat_id>3d539a98-f117-4ebc-befa-ea5bfb9f45ad</company_vat_id> <db_unit_of_measure_id>5e2e2b06-3a73-4803-977a-10f299555cbe</db_unit_of_measure_id> <discount>15</discount> <id>104d37b0-189d-4d91-a42e-51d9f27cad6c</id> <included_on_last_stock_compute>true</included_on_last_stock_compute> <invoice_details_id>123d748b-5feb-4a86-8e3e-de36725438a1</invoice_details_id> <invoice_id>228e9a8a-88f4-49d0-bdda-38af63150a76</invoice_id> <is_customized>true</is_customized> <is_dummy>true</is_dummy> <is_under_warranty>true</is_under_warranty> <job_approval_id>e65ff2dc-ba72-4cd6-8944-52f34e378021</job_approval_id> <jobs_id>149edbae-feda-4a2b-8d16-e49a0c4022f5</jobs_id> <modified_dateutc>2026-01-11T23:49:10.022Z</modified_dateutc> <no_warranty_reason>sample string 19</no_warranty_reason> <price>13</price> <purchase_order_details_id>64d44ad6-6d17-4802-915b-23fa2f9d9974</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>edf78750-dbdd-4f41-bd41-7ce86a444db0</user_id> <vat_rate>25</vat_rate> <vat_value>24</vat_value> <working_date>2026-01-11T23:49:10.022Z</working_date> </job_part_usage>
Response Information
Resource Description :
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 | globally unique identifier | ||
| included_on_last_stock_compute | boolean | ||
| signed_by_company |
Needed for integration |
boolean | |
| company_vat_id | globally unique identifier | ||
| vat_value | decimal number | ||
| vat_rate | decimal number | ||
| invoice_id | globally unique identifier | ||
| invoice_details_id | globally unique identifier | ||
| is_customized | boolean | ||
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "4d2145ad-c341-4569-95e5-3a7e1b4c5ec8",
"jobs_id": "66f931ca-7274-4a4b-b799-632c7633760a",
"job_approval_id": "5c8966e0-d75d-4803-b31d-1648af304e2a",
"article_stock_location_id": "ff018d3d-1b7c-4326-b576-7f5642cb173b",
"article_id": "caf2dca5-717e-422c-810a-d715837bcbff",
"is_dummy": true,
"article_code": "sample string 7",
"article_name": "sample string 8",
"article_description": "sample string 9",
"working_date": "2026-01-11T23:49:10.0486849+00:00",
"quantity": 11.0,
"serial_number": "sample string 12",
"price": 13.0,
"is_under_warranty": true,
"discount": 15.0,
"purchase_order_details_id": "bf0047f0-b448-4dcb-96b0-34b4d02c9d63",
"user_id": "2cb862a7-c311-42a1-ade0-aad047793180",
"remark": "sample string 18",
"no_warranty_reason": "sample string 19",
"db_unit_of_measure_id": "6668141b-19cc-4747-aca6-27f01f3d6eb9",
"included_on_last_stock_compute": true,
"signed_by_company": true,
"company_vat_id": "2497be7e-9fb3-46e8-b4ef-1a8f14159e94",
"vat_value": 24.0,
"vat_rate": 25.0,
"invoice_id": "4eb4c5f0-8348-4cb2-bfdd-bacaf921a6ea",
"invoice_details_id": "e4467570-ef6c-4740-9b49-f4c768bcb6cd",
"is_customized": true,
"modified_dateutc": "2026-01-11T23:49:10.0486849+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>caf2dca5-717e-422c-810a-d715837bcbff</article_id> <article_name>sample string 8</article_name> <article_stock_location_id>ff018d3d-1b7c-4326-b576-7f5642cb173b</article_stock_location_id> <company_vat_id>2497be7e-9fb3-46e8-b4ef-1a8f14159e94</company_vat_id> <db_unit_of_measure_id>6668141b-19cc-4747-aca6-27f01f3d6eb9</db_unit_of_measure_id> <discount>15</discount> <id>4d2145ad-c341-4569-95e5-3a7e1b4c5ec8</id> <included_on_last_stock_compute>true</included_on_last_stock_compute> <invoice_details_id>e4467570-ef6c-4740-9b49-f4c768bcb6cd</invoice_details_id> <invoice_id>4eb4c5f0-8348-4cb2-bfdd-bacaf921a6ea</invoice_id> <is_customized>true</is_customized> <is_dummy>true</is_dummy> <is_under_warranty>true</is_under_warranty> <job_approval_id>5c8966e0-d75d-4803-b31d-1648af304e2a</job_approval_id> <jobs_id>66f931ca-7274-4a4b-b799-632c7633760a</jobs_id> <modified_dateutc>2026-01-11T23:49:10.048Z</modified_dateutc> <no_warranty_reason>sample string 19</no_warranty_reason> <price>13</price> <purchase_order_details_id>bf0047f0-b448-4dcb-96b0-34b4d02c9d63</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>2cb862a7-c311-42a1-ade0-aad047793180</user_id> <vat_rate>25</vat_rate> <vat_value>24</vat_value> <working_date>2026-01-11T23:49:10.048Z</working_date> </job_part_usage>