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": "16e7a4c0-5988-447d-af91-30e5b2cc33df",
"jobs_id": "e01619bc-3431-48ca-b71c-1f34aaecdf7a",
"job_status_id": "4b33a547-b544-488f-93d7-b0457588efa0",
"is_daily_approval": true,
"contact_id": "3f9d7e6b-7986-4ac4-8f99-703e119df642",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-11-12T14:28:57.6353963+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "93af8097-3d89-4e54-a0b8-5584e087bf7c",
"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": "24ad7e30-0637-463f-ac96-9f4b7863f9a4",
"db_payment_method_id": "86ccea15-2c10-4423-8fd4-1a42ec05689d",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-11-12T14:28:57.6353963+00:00",
"technican_date_signed": "2026-11-12T14:28:57.6353963+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "297bbbbd-cffb-4f47-90ad-b1c98c8888be",
"company_vat_id": "b7aace57-1b28-467e-9044-4b4eee86b4a2",
"sys_nb_job_approval_list": 25,
"db_language_id": "6bf845d8-6fc8-4764-9381-443062893fb6",
"modified_dateutc": "2026-11-12T14:28:57.6353963+00:00",
"dateutc_generated": "2026-11-12T14:28:57.6353963+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>b7aace57-1b28-467e-9044-4b4eee86b4a2</company_vat_id> <contact_id>3f9d7e6b-7986-4ac4-8f99-703e119df642</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-11-12T14:28:57.635Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-11-12T14:28:57.635Z</date_generated> <dateutc_generated>2026-11-12T14:28:57.635Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>6bf845d8-6fc8-4764-9381-443062893fb6</db_language_id> <db_payment_method_id>86ccea15-2c10-4423-8fd4-1a42ec05689d</db_payment_method_id> <email_notification_communication_id>93af8097-3d89-4e54-a0b8-5584e087bf7c</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>16e7a4c0-5988-447d-af91-30e5b2cc33df</id> <is_daily_approval>true</is_daily_approval> <job_status_id>4b33a547-b544-488f-93d7-b0457588efa0</job_status_id> <jobs_id>e01619bc-3431-48ca-b71c-1f34aaecdf7a</jobs_id> <modified_dateutc>2026-11-12T14:28:57.635Z</modified_dateutc> <pdf_template_id>297bbbbd-cffb-4f47-90ad-b1c98c8888be</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-11-12T14:28:57.635Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>24ad7e30-0637-463f-ac96-9f4b7863f9a4</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": "b98a9a62-ad40-459c-8984-a7f75e02392a",
"jobs_id": "5f7f65b2-abc1-4508-85e7-cf9eb7686198",
"job_status_id": "aaa6e9b9-7b3b-4ca8-abc2-9b3a2f9433d0",
"is_daily_approval": true,
"contact_id": "85e2341a-8e97-4d31-af0f-f712b2429407",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-11-12T14:28:57.6353963+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "6c50d273-56f6-48ae-8b57-322a262da821",
"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": "fe768109-2ba0-4cc1-8674-ce5cd377280c",
"db_payment_method_id": "ffd39018-6851-4894-b121-e5011ed71613",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-11-12T14:28:57.6353963+00:00",
"technican_date_signed": "2026-11-12T14:28:57.6353963+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "f97b68ed-b8bc-4ee1-8900-f59e44fc3444",
"company_vat_id": "dd38defa-38ac-490f-bbec-445b1dc5e722",
"sys_nb_job_approval_list": 25,
"db_language_id": "ed96dea3-873e-421c-b393-5f443b1fe2bf",
"modified_dateutc": "2026-11-12T14:28:57.6353963+00:00",
"dateutc_generated": "2026-11-12T14:28:57.6353963+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>dd38defa-38ac-490f-bbec-445b1dc5e722</company_vat_id> <contact_id>85e2341a-8e97-4d31-af0f-f712b2429407</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-11-12T14:28:57.635Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-11-12T14:28:57.635Z</date_generated> <dateutc_generated>2026-11-12T14:28:57.635Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>ed96dea3-873e-421c-b393-5f443b1fe2bf</db_language_id> <db_payment_method_id>ffd39018-6851-4894-b121-e5011ed71613</db_payment_method_id> <email_notification_communication_id>6c50d273-56f6-48ae-8b57-322a262da821</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>b98a9a62-ad40-459c-8984-a7f75e02392a</id> <is_daily_approval>true</is_daily_approval> <job_status_id>aaa6e9b9-7b3b-4ca8-abc2-9b3a2f9433d0</job_status_id> <jobs_id>5f7f65b2-abc1-4508-85e7-cf9eb7686198</jobs_id> <modified_dateutc>2026-11-12T14:28:57.635Z</modified_dateutc> <pdf_template_id>f97b68ed-b8bc-4ee1-8900-f59e44fc3444</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-11-12T14:28:57.635Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>fe768109-2ba0-4cc1-8674-ce5cd377280c</user_id> </job_approval>