Retrieves all job approvals, optionally filtered via OData query options.
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult containing the list of job approvals.
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": "be42e2ea-1b46-4421-87db-f0056e533d05",
"jobs_id": "deb66c60-0aba-4839-8f2e-841a6ad23766",
"job_status_id": "a9709d7a-108c-48ca-ba9f-6ad6904f6661",
"is_daily_approval": true,
"contact_id": "ede7411e-1392-4939-9bb2-867a787fa1a6",
"contact_name": "sample string 6",
"customer_remarks": "sample string 7",
"customer_signature": "QEA=",
"technician_signature": "QEA=",
"date_generated": "2026-11-12T14:28:08.4627649+00:00",
"rating": 9,
"db_file_ids": "sample string 10",
"email_notification_communication_id": "5314a8b5-e624-462e-8892-e4868c49fcb1",
"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": "739f54ee-b888-4718-af0d-d5f6692a743b",
"db_payment_method_id": "5a7f2b0a-ba50-4b61-8fad-4e9764c2a1de",
"ready_for_multi_approval": true,
"customer_date_signed": "2026-11-12T14:28:08.4627649+00:00",
"technican_date_signed": "2026-11-12T14:28:08.4627649+00:00",
"sys_selected_items": "sample string 22",
"pdf_template_id": "32baf11f-3bc8-440b-b350-6e2b9001a511",
"company_vat_id": "1f661937-17f2-4c76-86ff-0cbe1d2dab13",
"sys_nb_job_approval_list": 25,
"db_language_id": "67cea4cb-f778-4c22-ab20-ae09d4bf4966",
"modified_dateutc": "2026-11-12T14:28:08.4627649+00:00",
"dateutc_generated": "2026-11-12T14:28:08.4627649+00:00"
}
application/xml, text/xml
<job_approval xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <company_vat_id>1f661937-17f2-4c76-86ff-0cbe1d2dab13</company_vat_id> <contact_id>ede7411e-1392-4939-9bb2-867a787fa1a6</contact_id> <contact_name>sample string 6</contact_name> <customer_date_signed>2026-11-12T14:28:08.462Z</customer_date_signed> <customer_remarks>sample string 7</customer_remarks> <customer_signature>QEA=</customer_signature> <date_generated>2026-11-12T14:28:08.462Z</date_generated> <dateutc_generated>2026-11-12T14:28:08.462Z</dateutc_generated> <db_file_ids>sample string 10</db_file_ids> <db_language_id>67cea4cb-f778-4c22-ab20-ae09d4bf4966</db_language_id> <db_payment_method_id>5a7f2b0a-ba50-4b61-8fad-4e9764c2a1de</db_payment_method_id> <email_notification_communication_id>5314a8b5-e624-462e-8892-e4868c49fcb1</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>be42e2ea-1b46-4421-87db-f0056e533d05</id> <is_daily_approval>true</is_daily_approval> <job_status_id>a9709d7a-108c-48ca-ba9f-6ad6904f6661</job_status_id> <jobs_id>deb66c60-0aba-4839-8f2e-841a6ad23766</jobs_id> <modified_dateutc>2026-11-12T14:28:08.462Z</modified_dateutc> <pdf_template_id>32baf11f-3bc8-440b-b350-6e2b9001a511</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:08.462Z</technican_date_signed> <technician_signature>QEA=</technician_signature> <user_id>739f54ee-b888-4718-af0d-d5f6692a743b</user_id> </job_approval>