Creates or updates a job approval.
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": "c73dc662-8f32-4f10-94b3-4f785cd18cef",
"jobs_id": "ffa69d73-10be-4b49-a148-c38e763cd529",
"job_status_id": "45bb4251-78c6-4584-9536-73fc6301b67b",
"is_daily_approval": true,
"contact_id": "d42f7afb-c8f7-4a06-be2f-f6ec6972ddb4",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-09-16T10:14:53.2539531+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "d5c72efa-bb0a-44fc-8659-58e10dd32305",
"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": "dfd8f772-f30c-4151-9c2e-0856771cc3fc",
"db_payment_method_id": "0895ff5c-a396-4a47-b9ed-9bb028248da8",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-09-16T10:14:53.2539531+00:00",
"technican_date_signed": "2026-09-16T10:14:53.2539531+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "b23c6c6c-336a-43a4-84d8-25e0f0cbed20",
"company_vat_id": "b78fa849-64c5-4d8c-ac30-51c44daee7d4",
"sys_nb_job_approval_list": 25,
"db_language_id": "ce1f7af2-5de3-4bf1-bfb6-85ae6116a2bd",
"modified_dateutc": "2026-09-16T10:14:53.2539531+00:00",
"dateutc_generated": "2026-09-16T10:14:53.2539531+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>b78fa849-64c5-4d8c-ac30-51c44daee7d4</company_vat_id> <contact_id>d42f7afb-c8f7-4a06-be2f-f6ec6972ddb4</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-09-16T10:14:53.253Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-09-16T10:14:53.253Z</date_generated> <dateutc_generated>2026-09-16T10:14:53.253Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>ce1f7af2-5de3-4bf1-bfb6-85ae6116a2bd</db_language_id> <db_payment_method_id>0895ff5c-a396-4a47-b9ed-9bb028248da8</db_payment_method_id> <email_notification_communication_id>d5c72efa-bb0a-44fc-8659-58e10dd32305</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>c73dc662-8f32-4f10-94b3-4f785cd18cef</id> <is_daily_approval>true</is_daily_approval> <job_status_id>45bb4251-78c6-4584-9536-73fc6301b67b</job_status_id> <jobs_id>ffa69d73-10be-4b49-a148-c38e763cd529</jobs_id> <modified_dateutc>2026-09-16T10:14:53.253Z</modified_dateutc> <pdf_template_id>b23c6c6c-336a-43a4-84d8-25e0f0cbed20</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-16T10:14:53.253Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>dfd8f772-f30c-4151-9c2e-0856771cc3fc</user_id> </job_approval>
Response Information
Resource Description :
IHttpActionResult containing the saved job approval.
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": "03d3a7ae-6b41-4929-a232-677bafac8dfd",
"jobs_id": "d679ce08-abf6-45b0-b8cf-2e62e09956cf",
"job_status_id": "15450f7f-316f-434a-b456-26b6825bbc7f",
"is_daily_approval": true,
"contact_id": "f0ab7565-0c00-44f2-a163-4c950be9569a",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-09-16T10:14:53.2539531+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "8a144d27-efa0-470f-9328-6d8aa4488a8a",
"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": "6268c50c-92d2-40ee-8d83-e17f6da106aa",
"db_payment_method_id": "fb93e88a-b1f6-461e-9625-cd69e1ba0443",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-09-16T10:14:53.2539531+00:00",
"technican_date_signed": "2026-09-16T10:14:53.2539531+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "109cc19c-c264-4cce-8cb3-587077bc4d65",
"company_vat_id": "7f1d472e-6f27-4c44-94ed-0dc374ce5a36",
"sys_nb_job_approval_list": 25,
"db_language_id": "2d29fba1-9103-4ddc-a38e-931b9bbf4590",
"modified_dateutc": "2026-09-16T10:14:53.2539531+00:00",
"dateutc_generated": "2026-09-16T10:14:53.2539531+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>7f1d472e-6f27-4c44-94ed-0dc374ce5a36</company_vat_id> <contact_id>f0ab7565-0c00-44f2-a163-4c950be9569a</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-09-16T10:14:53.253Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-09-16T10:14:53.253Z</date_generated> <dateutc_generated>2026-09-16T10:14:53.253Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>2d29fba1-9103-4ddc-a38e-931b9bbf4590</db_language_id> <db_payment_method_id>fb93e88a-b1f6-461e-9625-cd69e1ba0443</db_payment_method_id> <email_notification_communication_id>8a144d27-efa0-470f-9328-6d8aa4488a8a</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>03d3a7ae-6b41-4929-a232-677bafac8dfd</id> <is_daily_approval>true</is_daily_approval> <job_status_id>15450f7f-316f-434a-b456-26b6825bbc7f</job_status_id> <jobs_id>d679ce08-abf6-45b0-b8cf-2e62e09956cf</jobs_id> <modified_dateutc>2026-09-16T10:14:53.253Z</modified_dateutc> <pdf_template_id>109cc19c-c264-4cce-8cb3-587077bc4d65</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-16T10:14:53.253Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>6268c50c-92d2-40ee-8d83-e17f6da106aa</user_id> </job_approval>