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": "823fa87d-b045-456b-84ff-1bbc66c59120",
"jobs_id": "8742260e-5991-45e2-ba56-8343b36e9938",
"job_status_id": "24c68bd3-8c1e-4272-a218-d32713c890f9",
"is_daily_approval": true,
"contact_id": "60da4b33-df33-45ac-b237-911967954731",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-09-16T10:16:35.2314992+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "236bd98c-35fd-4d59-95b2-9a933c3b0c84",
"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": "192c711b-34b0-409e-a1c3-e640e3726176",
"db_payment_method_id": "14ece684-86dc-4bbf-b680-17522112c14f",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-09-16T10:16:35.2314992+00:00",
"technican_date_signed": "2026-09-16T10:16:35.2314992+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "fb0c0b0f-c82c-4fa3-8dd4-df305f7e58c8",
"company_vat_id": "b9c9ed5f-bbeb-48b0-acd7-fec4905124f1",
"sys_nb_job_approval_list": 25,
"db_language_id": "32968d40-d293-4137-b604-447e65a81acd",
"modified_dateutc": "2026-09-16T10:16:35.2314992+00:00",
"dateutc_generated": "2026-09-16T10:16:35.2314992+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>b9c9ed5f-bbeb-48b0-acd7-fec4905124f1</company_vat_id> <contact_id>60da4b33-df33-45ac-b237-911967954731</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-09-16T10:16:35.231Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-09-16T10:16:35.231Z</date_generated> <dateutc_generated>2026-09-16T10:16:35.231Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>32968d40-d293-4137-b604-447e65a81acd</db_language_id> <db_payment_method_id>14ece684-86dc-4bbf-b680-17522112c14f</db_payment_method_id> <email_notification_communication_id>236bd98c-35fd-4d59-95b2-9a933c3b0c84</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>823fa87d-b045-456b-84ff-1bbc66c59120</id> <is_daily_approval>true</is_daily_approval> <job_status_id>24c68bd3-8c1e-4272-a218-d32713c890f9</job_status_id> <jobs_id>8742260e-5991-45e2-ba56-8343b36e9938</jobs_id> <modified_dateutc>2026-09-16T10:16:35.231Z</modified_dateutc> <pdf_template_id>fb0c0b0f-c82c-4fa3-8dd4-df305f7e58c8</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:16:35.231Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>192c711b-34b0-409e-a1c3-e640e3726176</user_id> </job_approval>