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": "2b04dd73-708a-4dbc-b264-d337acd42df5",
"jobs_id": "525ad01d-35d4-4954-a8e0-dbe940b5d39e",
"job_status_id": "4b22d34a-71d4-4d64-b05f-228246d110da",
"is_daily_approval": true,
"contact_id": "920e14cc-d11c-4b74-b2ec-8ecfe9adca76",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-11-12T14:28:19.7285605+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "3423ce07-cc61-4fd5-9b1b-12274c734905",
"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": "5c447d15-dab8-403a-a99e-0052bf412fe2",
"db_payment_method_id": "b924c864-23fb-4ad8-8550-6a51aca608ea",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-11-12T14:28:19.7285605+00:00",
"technican_date_signed": "2026-11-12T14:28:19.7285605+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "1bd4197a-1798-4f01-b45d-c55f2b0f77ee",
"company_vat_id": "3f8bf725-d9a5-43fb-b212-2c26be0bb723",
"sys_nb_job_approval_list": 25,
"db_language_id": "7064594d-6f23-4c11-8646-c73ae265a2be",
"modified_dateutc": "2026-11-12T14:28:19.7285605+00:00",
"dateutc_generated": "2026-11-12T14:28:19.7285605+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>3f8bf725-d9a5-43fb-b212-2c26be0bb723</company_vat_id> <contact_id>920e14cc-d11c-4b74-b2ec-8ecfe9adca76</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-11-12T14:28:19.728Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-11-12T14:28:19.728Z</date_generated> <dateutc_generated>2026-11-12T14:28:19.728Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>7064594d-6f23-4c11-8646-c73ae265a2be</db_language_id> <db_payment_method_id>b924c864-23fb-4ad8-8550-6a51aca608ea</db_payment_method_id> <email_notification_communication_id>3423ce07-cc61-4fd5-9b1b-12274c734905</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>2b04dd73-708a-4dbc-b264-d337acd42df5</id> <is_daily_approval>true</is_daily_approval> <job_status_id>4b22d34a-71d4-4d64-b05f-228246d110da</job_status_id> <jobs_id>525ad01d-35d4-4954-a8e0-dbe940b5d39e</jobs_id> <modified_dateutc>2026-11-12T14:28:19.728Z</modified_dateutc> <pdf_template_id>1bd4197a-1798-4f01-b45d-c55f2b0f77ee</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:19.728Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>5c447d15-dab8-403a-a99e-0052bf412fe2</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": "25e4c782-aa6a-4798-9a0f-12c9f0bc2195",
"jobs_id": "267a8089-1d43-4b6f-bbf2-eca15277f84e",
"job_status_id": "049c79ba-1504-46e7-888d-715b8a80ea36",
"is_daily_approval": true,
"contact_id": "534c4943-9c81-4612-848d-803a7a14b230",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-11-12T14:28:19.7285605+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "5c7f3817-829b-45ea-ab2d-43a044212a8b",
"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": "0c03ef20-c72a-4316-92f4-7685f6167e5b",
"db_payment_method_id": "fbf48719-00ff-4875-ac2c-fc68bc7fec13",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-11-12T14:28:19.7285605+00:00",
"technican_date_signed": "2026-11-12T14:28:19.7285605+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "adfdd3ac-6a1c-4a1b-980f-de08daa9655a",
"company_vat_id": "81974eb6-b3b4-4e0f-adc7-7f11b7ff417b",
"sys_nb_job_approval_list": 25,
"db_language_id": "c9f434e7-c26a-46aa-a0c1-8fbee9b6bf4b",
"modified_dateutc": "2026-11-12T14:28:19.7285605+00:00",
"dateutc_generated": "2026-11-12T14:28:19.7285605+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>81974eb6-b3b4-4e0f-adc7-7f11b7ff417b</company_vat_id> <contact_id>534c4943-9c81-4612-848d-803a7a14b230</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-11-12T14:28:19.728Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-11-12T14:28:19.728Z</date_generated> <dateutc_generated>2026-11-12T14:28:19.728Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>c9f434e7-c26a-46aa-a0c1-8fbee9b6bf4b</db_language_id> <db_payment_method_id>fbf48719-00ff-4875-ac2c-fc68bc7fec13</db_payment_method_id> <email_notification_communication_id>5c7f3817-829b-45ea-ab2d-43a044212a8b</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>25e4c782-aa6a-4798-9a0f-12c9f0bc2195</id> <is_daily_approval>true</is_daily_approval> <job_status_id>049c79ba-1504-46e7-888d-715b8a80ea36</job_status_id> <jobs_id>267a8089-1d43-4b6f-bbf2-eca15277f84e</jobs_id> <modified_dateutc>2026-11-12T14:28:19.728Z</modified_dateutc> <pdf_template_id>adfdd3ac-6a1c-4a1b-980f-de08daa9655a</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:19.728Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>0c03ef20-c72a-4316-92f4-7685f6167e5b</user_id> </job_approval>