Saves a job approval together with its detail lines in one call: the request body is a JSON array whose first element is the job_approval and whose remaining elements are its job_approval_list entries.
Request Information
URI Parameters :
None.
Body Parameters :
job_approval| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of jobs |
globally unique identifier |
Required |
| job_status_id |
Job Status that will be used to alter the jobs (WaitingFurtherAction,Completed) |
globally unique identifier | |
| is_daily_approval |
Indicate if it's just a daily approval or a complete approval |
boolean | |
| contact_id |
The contact that confirm the job is done |
globally unique identifier | |
| contact_name |
The contact name |
string | |
| customer_remarks |
Additionnal remarks from the customer |
string |
Max length: 4000 |
| customer_signature |
Captured image bytes of the customer's signature confirming the job is done. |
Collection of byte | |
| technician_signature |
Captured image bytes of the technician's signature confirming the job is done. |
Collection of byte | |
| date_generated |
Local datetime when it has been finished |
date | |
| rating |
Rating (0,5) the quality of the jobs |
integer | |
| db_file_ids |
List of file selected (checked) on the job approval |
string | |
| email_notification_communication_id |
Foreign key of the record generated for the completion email notification. |
globally unique identifier | |
| email_notification_email_to |
Mail to |
string | |
| email_notification_email_cc |
Mail cc |
string | |
| email_notification_email_bcc |
Mail bcc |
string | |
| email_notification_email_subject |
Mail subject |
string |
Max length: 255 |
| email_notification_email_body |
Mail body |
string | |
| user_id |
Foreign key of the user (typically the technician) who recorded this approval. |
globally unique identifier | |
| db_payment_method_id |
Foreign key of the payment method used, when payment was collected on approval. |
globally unique identifier | |
| ready_for_multi_approval |
Indicate if it's just a daily approval or a complete approval |
boolean | |
| customer_date_signed |
Date signed of customer |
date | |
| technican_date_signed |
Date signed of technican |
date | |
| sys_selected_items |
Serialized list of the item ids that were selected (checked) for this approval. |
string | |
| pdf_template_id |
Foreign key of the PDF template used to generate the approval document. |
globally unique identifier | |
| company_vat_id |
Foreign key of the VAT regime applied on this approval. |
globally unique identifier | |
| sys_nb_job_approval_list |
Readonly: number of lines included in this approval. |
integer | |
| db_language_id |
Foreign key of the language used to generate the approval document/email. |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| dateutc_generated |
UTC datetime when it has been finished |
date |
Request Formats :
application/json, text/json
{
"id": "1a8987eb-72e4-4678-b43f-aa95fa3a019a",
"jobs_id": "ee3ea35e-2ec2-47b9-bcb8-f4e185778079",
"job_status_id": "96b70e8d-239f-45f4-a9cb-1c3f6616a3e6",
"is_daily_approval": true,
"contact_id": "585e9cb8-56ea-469a-ba61-1aa1203604e2",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-09-16T09:25:07.5181555+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "ee9cefb1-af8b-4bae-98f4-5298eb608e64",
"email_notification_email_to": "sample string 12",
"email_notification_email_cc": "sample string 13",
"email_notification_email_bcc": "sample string 14",
"email_notification_email_subject": "sample string 15",
"email_notification_email_body": "sample string 16",
"user_id": "9f8c765a-b2eb-4197-af10-90c62157128c",
"db_payment_method_id": "6c84d2e8-fd28-4d44-ae61-688c9d6b6117",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-09-16T09:25:07.5181555+00:00",
"technican_date_signed": "2026-09-16T09:25:07.5181555+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "a444cceb-62d7-4b6e-a6f5-3118c628037f",
"company_vat_id": "19d99c83-408c-4231-8af6-3385589144f6",
"sys_nb_job_approval_list": 25,
"db_language_id": "949554c5-80bf-488a-9974-0041b0723cc6",
"modified_dateutc": "2026-09-16T09:25:07.5181555+00:00",
"dateutc_generated": "2026-09-16T09:25:07.5181555+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>19d99c83-408c-4231-8af6-3385589144f6</company_vat_id> <contact_id>585e9cb8-56ea-469a-ba61-1aa1203604e2</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-09-16T09:25:07.518Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-09-16T09:25:07.518Z</date_generated> <dateutc_generated>2026-09-16T09:25:07.518Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>949554c5-80bf-488a-9974-0041b0723cc6</db_language_id> <db_payment_method_id>6c84d2e8-fd28-4d44-ae61-688c9d6b6117</db_payment_method_id> <email_notification_communication_id>ee9cefb1-af8b-4bae-98f4-5298eb608e64</email_notification_communication_id> <email_notification_email_bcc>sample string 14</email_notification_email_bcc> <email_notification_email_body>sample string 16</email_notification_email_body> <email_notification_email_cc>sample string 13</email_notification_email_cc> <email_notification_email_subject>sample string 15</email_notification_email_subject> <email_notification_email_to>sample string 12</email_notification_email_to> <id>1a8987eb-72e4-4678-b43f-aa95fa3a019a</id> <is_daily_approval>true</is_daily_approval> <job_status_id>96b70e8d-239f-45f4-a9cb-1c3f6616a3e6</job_status_id> <jobs_id>ee3ea35e-2ec2-47b9-bcb8-f4e185778079</jobs_id> <modified_dateutc>2026-09-16T09:25:07.518Z</modified_dateutc> <pdf_template_id>a444cceb-62d7-4b6e-a6f5-3118c628037f</pdf_template_id> <rating>9</rating> <ready_for_multi_approval>true</ready_for_multi_approval> <sys_nb_job_approval_list>25</sys_nb_job_approval_list> <sys_selected_items>sample string 22</sys_selected_items> <technican_date_signed>2026-09-16T09:25:07.518Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>9f8c765a-b2eb-4197-af10-90c62157128c</user_id> </job_approval>
Response Information
Resource Description :
IHttpActionResult containing the combined save result.
job_approval| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of jobs |
globally unique identifier |
Required |
| job_status_id |
Job Status that will be used to alter the jobs (WaitingFurtherAction,Completed) |
globally unique identifier | |
| is_daily_approval |
Indicate if it's just a daily approval or a complete approval |
boolean | |
| contact_id |
The contact that confirm the job is done |
globally unique identifier | |
| contact_name |
The contact name |
string | |
| customer_remarks |
Additionnal remarks from the customer |
string |
Max length: 4000 |
| customer_signature |
Captured image bytes of the customer's signature confirming the job is done. |
Collection of byte | |
| technician_signature |
Captured image bytes of the technician's signature confirming the job is done. |
Collection of byte | |
| date_generated |
Local datetime when it has been finished |
date | |
| rating |
Rating (0,5) the quality of the jobs |
integer | |
| db_file_ids |
List of file selected (checked) on the job approval |
string | |
| email_notification_communication_id |
Foreign key of the record generated for the completion email notification. |
globally unique identifier | |
| email_notification_email_to |
Mail to |
string | |
| email_notification_email_cc |
Mail cc |
string | |
| email_notification_email_bcc |
Mail bcc |
string | |
| email_notification_email_subject |
Mail subject |
string |
Max length: 255 |
| email_notification_email_body |
Mail body |
string | |
| user_id |
Foreign key of the user (typically the technician) who recorded this approval. |
globally unique identifier | |
| db_payment_method_id |
Foreign key of the payment method used, when payment was collected on approval. |
globally unique identifier | |
| ready_for_multi_approval |
Indicate if it's just a daily approval or a complete approval |
boolean | |
| customer_date_signed |
Date signed of customer |
date | |
| technican_date_signed |
Date signed of technican |
date | |
| sys_selected_items |
Serialized list of the item ids that were selected (checked) for this approval. |
string | |
| pdf_template_id |
Foreign key of the PDF template used to generate the approval document. |
globally unique identifier | |
| company_vat_id |
Foreign key of the VAT regime applied on this approval. |
globally unique identifier | |
| sys_nb_job_approval_list |
Readonly: number of lines included in this approval. |
integer | |
| db_language_id |
Foreign key of the language used to generate the approval document/email. |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| dateutc_generated |
UTC datetime when it has been finished |
date |
Response Formats
application/json, text/json
{
"id": "45b8fe62-249c-481c-9b95-5c71193bbd97",
"jobs_id": "f18e9dbd-1c29-4a28-92ee-6430c1089456",
"job_status_id": "13d7e272-140f-4077-80df-bbe49c832dac",
"is_daily_approval": true,
"contact_id": "7077fe51-8f21-496f-86e8-3fcdd55b9b91",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-09-16T09:25:07.5658332+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "a8e23889-91f4-4b3d-abca-eff8926f20c4",
"email_notification_email_to": "sample string 12",
"email_notification_email_cc": "sample string 13",
"email_notification_email_bcc": "sample string 14",
"email_notification_email_subject": "sample string 15",
"email_notification_email_body": "sample string 16",
"user_id": "a0ace165-8429-482a-a353-d96f1169fc89",
"db_payment_method_id": "a0cd19ba-2106-4710-8e76-85d8fc5b8ddb",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-09-16T09:25:07.5658332+00:00",
"technican_date_signed": "2026-09-16T09:25:07.5658332+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "4a710b26-7f08-44b6-a3b9-1f8372dde373",
"company_vat_id": "dc7ea6f0-f3e2-4d1d-856b-27a4a7bbb58a",
"sys_nb_job_approval_list": 25,
"db_language_id": "1b1f3b7b-8f5f-453e-bb6b-b221890bd3b0",
"modified_dateutc": "2026-09-16T09:25:07.5658332+00:00",
"dateutc_generated": "2026-09-16T09:25:07.5658332+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>dc7ea6f0-f3e2-4d1d-856b-27a4a7bbb58a</company_vat_id> <contact_id>7077fe51-8f21-496f-86e8-3fcdd55b9b91</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-09-16T09:25:07.565Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-09-16T09:25:07.565Z</date_generated> <dateutc_generated>2026-09-16T09:25:07.565Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>1b1f3b7b-8f5f-453e-bb6b-b221890bd3b0</db_language_id> <db_payment_method_id>a0cd19ba-2106-4710-8e76-85d8fc5b8ddb</db_payment_method_id> <email_notification_communication_id>a8e23889-91f4-4b3d-abca-eff8926f20c4</email_notification_communication_id> <email_notification_email_bcc>sample string 14</email_notification_email_bcc> <email_notification_email_body>sample string 16</email_notification_email_body> <email_notification_email_cc>sample string 13</email_notification_email_cc> <email_notification_email_subject>sample string 15</email_notification_email_subject> <email_notification_email_to>sample string 12</email_notification_email_to> <id>45b8fe62-249c-481c-9b95-5c71193bbd97</id> <is_daily_approval>true</is_daily_approval> <job_status_id>13d7e272-140f-4077-80df-bbe49c832dac</job_status_id> <jobs_id>f18e9dbd-1c29-4a28-92ee-6430c1089456</jobs_id> <modified_dateutc>2026-09-16T09:25:07.565Z</modified_dateutc> <pdf_template_id>4a710b26-7f08-44b6-a3b9-1f8372dde373</pdf_template_id> <rating>9</rating> <ready_for_multi_approval>true</ready_for_multi_approval> <sys_nb_job_approval_list>25</sys_nb_job_approval_list> <sys_selected_items>sample string 22</sys_selected_items> <technican_date_signed>2026-09-16T09:25:07.565Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>a0ace165-8429-482a-a353-d96f1169fc89</user_id> </job_approval>