Odyssee Web API - POST api/JobPartUsage/Save

Creates or updates a job part usage record.

Request Information

URI Parameters :

None.

Body Parameters :

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

Sample:

{
  "id": "cf57ee05-0382-4aaa-adab-3b49f611e305",
  "jobs_id": "73cddbee-a6f9-4b86-a6ec-2fd24fe3d7c0",
  "job_approval_id": "eda36889-e1ca-43c9-8c5a-58686c708914",
  "article_stock_location_id": "a5ae2849-67d1-4c60-9ae9-1ee3a5e4762b",
  "article_id": "3318d36a-ceee-4ed4-bd3d-860e3a947b7a",
  "is_dummy": true,
  "article_code": "sample string 7",
  "article_name": "sample string 8",
  "article_description": "sample string 9",
  "working_date": "2026-11-12T14:27:21.5870152+00:00",
  "quantity": 11.0,
  "serial_number": "sample string 12",
  "price": 13.0,
  "is_under_warranty": true,
  "discount": 15.0,
  "purchase_order_details_id": "d1b193ae-15dd-4314-bd66-9b8b09a3ece5",
  "user_id": "531d3dea-f962-4436-b46c-fce433ea6efc",
  "remark": "sample string 18",
  "no_warranty_reason": "sample string 19",
  "db_unit_of_measure_id": "a9b71f9a-4a6b-4f8a-b861-bd86b1597665",
  "included_on_last_stock_compute": true,
  "signed_by_company": true,
  "company_vat_id": "cf46a67f-2004-4ff6-8dd0-e70dedda2ee7",
  "vat_value": 24.0,
  "vat_rate": 25.0,
  "invoice_id": "534f720c-704d-4c39-8ba5-91eceaa28bd4",
  "invoice_details_id": "85bf3efd-9745-4ff6-a8b1-6ca1f6130634",
  "is_customized": true,
  "modified_dateutc": "2026-11-12T14:27:21.5870152+00:00"
}

application/xml, text/xml

Sample:

<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>3318d36a-ceee-4ed4-bd3d-860e3a947b7a</article_id>
  <article_name>sample string 8</article_name>
  <article_stock_location_id>a5ae2849-67d1-4c60-9ae9-1ee3a5e4762b</article_stock_location_id>
  <company_vat_id>cf46a67f-2004-4ff6-8dd0-e70dedda2ee7</company_vat_id>
  <db_unit_of_measure_id>a9b71f9a-4a6b-4f8a-b861-bd86b1597665</db_unit_of_measure_id>
  <discount>15</discount>
  <id>cf57ee05-0382-4aaa-adab-3b49f611e305</id>
  <included_on_last_stock_compute>true</included_on_last_stock_compute>
  <invoice_details_id>85bf3efd-9745-4ff6-a8b1-6ca1f6130634</invoice_details_id>
  <invoice_id>534f720c-704d-4c39-8ba5-91eceaa28bd4</invoice_id>
  <is_customized>true</is_customized>
  <is_dummy>true</is_dummy>
  <is_under_warranty>true</is_under_warranty>
  <job_approval_id>eda36889-e1ca-43c9-8c5a-58686c708914</job_approval_id>
  <jobs_id>73cddbee-a6f9-4b86-a6ec-2fd24fe3d7c0</jobs_id>
  <modified_dateutc>2026-11-12T14:27:21.587Z</modified_dateutc>
  <no_warranty_reason>sample string 19</no_warranty_reason>
  <price>13</price>
  <purchase_order_details_id>d1b193ae-15dd-4314-bd66-9b8b09a3ece5</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>531d3dea-f962-4436-b46c-fce433ea6efc</user_id>
  <vat_rate>25</vat_rate>
  <vat_value>24</vat_value>
  <working_date>2026-11-12T14:27:21.587Z</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

Sample:

{
  "id": "d19dd7b4-0c03-41e1-ab16-6d1da61f3ff9",
  "jobs_id": "4dab4ba9-97ac-4c9f-b6d5-f0610907fecf",
  "job_approval_id": "347826d9-bddc-422e-bffa-27a8a1a283b5",
  "article_stock_location_id": "da705570-a602-4dde-b56b-f1d0c370f292",
  "article_id": "d87176a4-6791-4b64-b954-e7373e2cfa04",
  "is_dummy": true,
  "article_code": "sample string 7",
  "article_name": "sample string 8",
  "article_description": "sample string 9",
  "working_date": "2026-11-12T14:27:21.5870152+00:00",
  "quantity": 11.0,
  "serial_number": "sample string 12",
  "price": 13.0,
  "is_under_warranty": true,
  "discount": 15.0,
  "purchase_order_details_id": "cd718aa6-08fc-49a0-a399-25849a7b6c7f",
  "user_id": "70cfb5b9-357c-4142-a640-6251c92292db",
  "remark": "sample string 18",
  "no_warranty_reason": "sample string 19",
  "db_unit_of_measure_id": "daf05df7-59c9-4804-a18d-52647a5596c5",
  "included_on_last_stock_compute": true,
  "signed_by_company": true,
  "company_vat_id": "841c295d-3688-4e03-9362-d13f7b963cfb",
  "vat_value": 24.0,
  "vat_rate": 25.0,
  "invoice_id": "28082927-240f-42da-924d-84b92887553e",
  "invoice_details_id": "08ca373a-2123-4cb6-a99b-d67fab263f2d",
  "is_customized": true,
  "modified_dateutc": "2026-11-12T14:27:21.5870152+00:00"
}

application/xml, text/xml

Sample:

<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>d87176a4-6791-4b64-b954-e7373e2cfa04</article_id>
  <article_name>sample string 8</article_name>
  <article_stock_location_id>da705570-a602-4dde-b56b-f1d0c370f292</article_stock_location_id>
  <company_vat_id>841c295d-3688-4e03-9362-d13f7b963cfb</company_vat_id>
  <db_unit_of_measure_id>daf05df7-59c9-4804-a18d-52647a5596c5</db_unit_of_measure_id>
  <discount>15</discount>
  <id>d19dd7b4-0c03-41e1-ab16-6d1da61f3ff9</id>
  <included_on_last_stock_compute>true</included_on_last_stock_compute>
  <invoice_details_id>08ca373a-2123-4cb6-a99b-d67fab263f2d</invoice_details_id>
  <invoice_id>28082927-240f-42da-924d-84b92887553e</invoice_id>
  <is_customized>true</is_customized>
  <is_dummy>true</is_dummy>
  <is_under_warranty>true</is_under_warranty>
  <job_approval_id>347826d9-bddc-422e-bffa-27a8a1a283b5</job_approval_id>
  <jobs_id>4dab4ba9-97ac-4c9f-b6d5-f0610907fecf</jobs_id>
  <modified_dateutc>2026-11-12T14:27:21.587Z</modified_dateutc>
  <no_warranty_reason>sample string 19</no_warranty_reason>
  <price>13</price>
  <purchase_order_details_id>cd718aa6-08fc-49a0-a399-25849a7b6c7f</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>70cfb5b9-357c-4142-a640-6251c92292db</user_id>
  <vat_rate>25</vat_rate>
  <vat_value>24</vat_value>
  <working_date>2026-11-12T14:27:21.587Z</working_date>
</job_part_usage>

Odyssee Mobile

API User Guide

Odyssee Web API - POST api/JobPartUsage/Save

Request Information

URI Parameters :

Body Parameters :

Request Formats :

application/json, text/json

application/xml, text/xml

Response Information

Resource Description :

Response Formats

application/json, text/json

application/xml, text/xml