Retrieves the job approval with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The job approval id. |
globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the job approval, or 404 Not Found if it doesn't exist.
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": "5c8bd4d5-7eb8-4a21-8d3e-f033e85817da",
"jobs_id": "21bc8f1a-11a8-4ab5-89e9-176248b7813d",
"job_status_id": "733ced79-6ff9-420b-abf9-d9c2e702b8be",
"is_daily_approval": true,
"contact_id": "319dabfd-49a3-45f3-9382-1ee270c2c74e",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-11-12T14:28:48.1508758+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "06c9d518-0863-49c8-bffc-7138ea6bf1f2",
"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": "da0e2d9e-2771-4c29-b261-04236bd101a5",
"db_payment_method_id": "217706c1-cbf5-4a45-8833-2466f6d1ceff",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-11-12T14:28:48.1508758+00:00",
"technican_date_signed": "2026-11-12T14:28:48.1508758+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "02e70902-374b-4ff2-8151-b6307a145fc9",
"company_vat_id": "22feff68-3782-49c8-82af-eaf581c8f7b4",
"sys_nb_job_approval_list": 25,
"db_language_id": "827eb6f3-2e8c-4826-9201-6c78ec905b03",
"modified_dateutc": "2026-11-12T14:28:48.1508758+00:00",
"dateutc_generated": "2026-11-12T14:28:48.1508758+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>22feff68-3782-49c8-82af-eaf581c8f7b4</company_vat_id> <contact_id>319dabfd-49a3-45f3-9382-1ee270c2c74e</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-11-12T14:28:48.150Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-11-12T14:28:48.150Z</date_generated> <dateutc_generated>2026-11-12T14:28:48.150Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>827eb6f3-2e8c-4826-9201-6c78ec905b03</db_language_id> <db_payment_method_id>217706c1-cbf5-4a45-8833-2466f6d1ceff</db_payment_method_id> <email_notification_communication_id>06c9d518-0863-49c8-bffc-7138ea6bf1f2</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>5c8bd4d5-7eb8-4a21-8d3e-f033e85817da</id> <is_daily_approval>true</is_daily_approval> <job_status_id>733ced79-6ff9-420b-abf9-d9c2e702b8be</job_status_id> <jobs_id>21bc8f1a-11a8-4ab5-89e9-176248b7813d</jobs_id> <modified_dateutc>2026-11-12T14:28:48.150Z</modified_dateutc> <pdf_template_id>02e70902-374b-4ff2-8151-b6307a145fc9</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:48.150Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>da0e2d9e-2771-4c29-b261-04236bd101a5</user_id> </job_approval>