![\"Workflow\"](\"/images/levels-logo.svg\"){kind=logo}
\n \n OPTIONAL: The full name of the company (e.g., Gold Crest Surveyors).
\n","type":"text"},{"key":"short_name","value":"","description":"OPTIONAL: The short name of the company (e.g., Gold Crest).
\n","type":"text"},{"key":"address_building","value":"","description":"OPTIONAL: The name of the building the company is in.
\n","type":"text"},{"key":"address_line1","value":"","description":"OPTIONAL: Address line 1 (e.g., street, PO Box, or company name).
\n","type":"text"},{"key":"address_line2","value":"","description":"OPTIONAL: Address line 2 (e.g., apartment, suite, unit, or building).
\n","type":"text"},{"key":"address_city","value":"","description":"OPTIONAL: City, district, suburb, town, or village.
\n","type":"text"},{"key":"address_county","value":"","description":"OPTIONAL: County or state.
\n","type":"text"},{"key":"country_id","value":"","description":"OPTIONAL: Country, links to the Country API.
\n","type":"text"},{"key":"address_postcode","value":"","description":"OPTIONAL: ZIP or postal code.
\n","type":"text"},{"key":"logo","value":"","description":"OPTIONAL: The logo of the company.
\n","type":"text"},{"key":"main_phone","value":"","description":"OPTIONAL: The main contact number for the company.
\n","type":"text"},{"key":"main_email","value":"","description":"OPTIONAL: The main email address for the company.
\n","type":"text"},{"key":"contact_name","value":"","description":"OPTIONAL: The full name of the main contact for the company.
\n","type":"text"},{"key":"contact_phone","value":"","description":"OPTIONAL: The telephone number for the main contact for the company.
\n","type":"text"},{"key":"contact_mobile","value":"","description":"OPTIONAL: The mobile number for the main contact for the company.
\n","type":"text"},{"key":"contact_email","value":"","description":"OPTIONAL: The emailed address for the main contact for the company.
\n","type":"text"},{"key":"website","value":"","description":"OPTIONAL: The company's website url.
\n","type":"text"},{"key":"rics_num_membership","value":"","description":"OPTIONAL: The company's RICS membership number.
\n","type":"text"},{"key":"rics_num_hb","value":"","description":"OPTIONAL: The company's RICS Building Survey (Level 3) licence number.
\n","type":"text"},{"key":"rics_num_bs","value":"","description":"OPTIONAL: The company's RICS Homebuyer Report (Level 2) licence number.
\n","type":"text"},{"key":"_method","value":"PATCH","description":"This is needed or the request will fail.
\n","type":"text"}]},"url":"{{base_url}}/api/company/company/{company}","description":"Updating a Company
\nUpdates the specified company by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"REQUIRED: The customer's first name.
\n"},{"key":"contact_last_name","value":"","type":"text","description":"REQUIRED: The customer's last name.
\n"},{"key":"contact_number","value":"","type":"text","description":"REQUIRED: The customer's contact number.
\n"},{"key":"contact_number_alt","value":"","type":"text","description":"NULLABLE: The customer's alternative contact number.
\n"},{"key":"contact_email","value":"","type":"text","description":"REQUIRED: The customer's email address.
\n"},{"key":"address_building","value":"","type":"text","description":"NULLABLE: The building name of the customer's address (if applicable).
\n"},{"key":"address_line1","value":"","type":"text","description":"REQUIRED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"address_line2","value":"","type":"text","description":"NULLABLE: Address line 2 (e.g., apartment, suite, unit, or building).
\n"},{"key":"address_city","value":"","type":"text","description":"REQUIRED: City, district, suburb, town, or village.
\n"},{"key":"address_county","value":"","type":"text","description":"REQUIRED: County or state.
\n"},{"key":"address_country","value":"","type":"text","description":"REQUIRED: Country, links to the Country API.
\n"},{"key":"address_postcode","value":"","type":"text","description":"REQUIRED: ZIP or postal code.
\n"}]},"url":"{{base_url}}/api/company/customer","description":"Creating a new customer as a Company
\nCreates a new customer by setting the values of the parameters passed.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Updating a Company
\nUpdates the specified company by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"REQUIRED: The customer's first name.
\n"},{"key":"contact_last_name","value":"","type":"text","description":"REQUIRED: The customer's last name.
\n"},{"key":"contact_number","value":"","type":"text","description":"REQUIRED: The customer's contact number.
\n"},{"key":"contact_number_alt","value":"","type":"text","description":"NULLABLE: The customer's alternative contact number.
\n"},{"key":"contact_email","value":"","type":"text","description":"REQUIRED: The customer's email address.
\n"},{"key":"address_building","value":"","type":"text","description":"NULLABLE: The building name of the customer's address (if applicable).
\n"},{"key":"address_line1","value":"","type":"text","description":"REQUIRED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"address_line2","value":"","type":"text","description":"NULLABLE: Address line 2 (e.g., apartment, suite, unit, or building).
\n"},{"key":"address_city","value":"","type":"text","description":"REQUIRED: City, district, suburb, town, or village.
\n"},{"key":"address_county","value":"","type":"text","description":"REQUIRED: County or state.
\n"},{"key":"address_country","value":"","type":"text","description":"REQUIRED: Country, links to the Country API.
\n"},{"key":"address_postcode","value":"","type":"text","description":"REQUIRED: ZIP or postal code.
\n"},{"key":"_method","value":"","description":"This is needed or the request will fail.
\n","type":"text"}]},"url":"{{base_url}}/api/company/customer/{customer}","description":"Updating a customer as a Company
\nUpdates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"Deleting a customer as a Company
\nDeletes the specified customer from the Company records.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"NULLABLE: Uses the 'filled' validation rule so is not required unless it is filled out. This is the device UUID in the database.
\n","type":"text"},{"key":"customer_first_name","value":"","description":"REQUIRED: The customer's first name.
\n","type":"text"},{"key":"customer_last_name","value":"","description":"REQUIRED: The customer's last name.
\n","type":"text"},{"key":"customer_phone","value":"","description":"REQUIRED: The customer's contact number.
\n","type":"text"},{"key":"customer_email","value":"","description":"REQUIRED: The customer's email address.
\n","type":"text"},{"key":"address_building","value":"","description":"FILLED: The building name for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_line1","value":"","description":"FILLED: The first line of address for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_line2","value":"","description":"FILLED: The second line of address for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_city","value":"","description":"FILLED: The city for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_county","value":"","description":"FILLED: The county for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_country_id","value":"","description":"FILLED: The country for the property the customer's enquiring about. Links to the Countries API using the 'id' field.
\n","type":"text"},{"key":"address_postcode","value":"","description":"FILLED: The lead's postcode.
\n","type":"text"},{"key":"survey_type","value":"","description":"FILLED: The type of survey required for the customer.
\n","type":"text"},{"key":"week_commencing","value":"","description":"REQUIRED: The earliest date available to survey the property.
\n","type":"text"},{"key":"tenure","value":"","description":"FILLED: The tenure of the property the customer's enquiring about.
\n","type":"text"},{"key":"leasehold_years","value":"","description":"REQUIRED: The number of years remaining on the lease (if applicable).
\n","type":"text"},{"key":"contact_via","value":"","description":"FILLED: How the customer has been contacted by admin staff (e.g., called, emailed, texted).
\n","type":"text"},{"key":"comments","value":"","description":"FILLED: Notes from admin staff (for admin use only).
\n","type":"text"},{"key":"access_details","value":"","description":"FILLED: Access information for the property the customer's enquiring about (e.g, vendor or estate agent).
\n","type":"text"},{"key":"property_value","value":"","description":"FILLED: The value of the property the customer's enquiring about.
\n","type":"text"},{"key":"fee_quoted","value":"","description":"FILLED: Must be a number. The fee quoted to the customer.
\n","type":"text"},{"key":"is_wanting_hard_copy","value":"","description":"FILLED: A boolean to show whether the customer has requested a Hard Copy of their report or not.
\n","type":"text"},{"key":"valuation_quote","value":"","description":"FILLED: The fee for a valuation if requested.
\n","type":"text"},{"key":"repair_costs_quote","value":"","description":"FILLED: The fee to add repair costs if requested.
\n","type":"text"},{"key":"is_repair_costs","value":"","description":"FILLED: A boolean to show whether the customer has requested repair costs or not.
\n","type":"text"},{"key":"total_quote","value":"","description":"REQUIRED: The total sum of all fees related to the survey.
\n","type":"text"},{"key":"discount","value":"","description":"FILLED: Depending on the discount type, this will be the percentage of a discount or the exact figure discounted from the fee quoted.
\n","type":"text"},{"key":"discount_type","value":"","description":"FILLED: A boolean to show whether the discount is a percentage or exact value.
\n","type":"text"},{"key":"sales_advisor","value":"","description":"FILLED: The name of the Sales Advisor.
\n","type":"text"},{"key":"sales_advisor_email","value":"","description":"FILLED: The email address of the Sales Advisor.
\n","type":"text"},{"key":"source","value":"","description":"REQUIRED: The source used by the customer to find our services (e.g., comparison website, referral, poster).
\n","type":"text"},{"key":"callback_at","value":"","description":"FILLED: A date field to show when a customer has requested a callback, if required.
\n","type":"text"},{"key":"is_property_size_checked","value":"","description":"REQUIRED: A boolean to show whether the admin have checked the property size.
\n","type":"text"},{"key":"is_urgent","value":"","description":"FILLED: A boolean to show whether a callback is urgent or not.
\n","type":"text"},{"key":"is_valuation","value":"","description":"NULLABLE: A boolean to show whether the Survey requires a Valuation or not.
\n","type":"text"},{"key":"valuation_purpose","value":"","description":"NULLABLE: The purpose of the Valuation if applicable.
\n","type":"text"}]},"url":"{{base_url}}/api/company/lead","description":"Creating a new lead as a Company
\nCreates a new lead by setting the values of the parameters passed. Any fields that use the 'FILLED' validation are not required unless the field has been filled out.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"OPTIONAL: The customer's first name.
\n","type":"text"},{"key":"customer_last_name","value":"","description":"OPTIONAL: The customer's last name.
\n","type":"text"},{"key":"customer_phone","value":"","description":"OPTIONAL: The customer's contact number.
\n","type":"text"},{"key":"customer_email","value":"","description":"OPTIONAL: The customer's email address.
\n","type":"text"},{"key":"address_building","value":"","description":"OPTIONAL: The building name for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_line1","value":"","description":"OPTIONAL: The first line of address for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_line2","value":"","description":"OPTIONAL: The second line of address for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_city","value":"","description":"OPTIONAL: The city for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_county","value":"","description":"OPTIONAL: The county for the property the customer's enquiring about.
\n","type":"text"},{"key":"address_country_id","value":"","description":"OPTIONAL: The country for the property the customer's enquiring about. Links to the Countries API using the 'id' field.
\n","type":"text"},{"key":"week_commencing","value":"","description":"REQUIRED: The earliest date available to survey the property.
\n","type":"text"},{"key":"address_postcode","value":"","description":"OPTIONAL: The lead's postcode.
\n","type":"text"},{"key":"survey_type","value":"","description":"OPTIONAL: The type of survey required for the customer.
\n","type":"text"},{"key":"tenure","value":"","description":"OPTIONAL: The tenure of the property the customer's enquiring about.
\n","type":"text"},{"key":"leasehold_years","value":"","description":"REQUIRED: The number of years remaining on the lease (if applicable).
\n","type":"text"},{"key":"contact_via","value":"","description":"OPTIONAL: How the customer has been contacted by admin staff (e.g., called, emailed, texted).
\n","type":"text"},{"key":"comments","value":"","description":"OPTIONAL: Notes from admin staff (for admin use only).
\n","type":"text"},{"key":"access_details","value":"","description":"OPTIONAL: Access information for the property the customer's enquiring about (e.g, vendor or estate agent).
\n","type":"text"},{"key":"property_value","value":"","description":"OPTIONAL: The value of the property the customer's enquiring about.
\n","type":"text"},{"key":"fee_quoted","value":"","description":"REQUIRED: The source used by the customer to find our services (e.g., comparison website, referral, poster).
\n","type":"text"},{"key":"is_wanting_hard_copy","value":"","description":"OPTIONAL: A boolean to show whether the customer has requested a Hard Copy of their report or not.
\n","type":"text"},{"key":"valuation_quote","value":"","description":"OPTIONAL: The fee for a valuation if requested.
\n","type":"text"},{"key":"repair_costs_quote","value":"","description":"OPTIONAL: The fee to add repair costs if requested.
\n","type":"text"},{"key":"is_repair_costs","value":"","description":"OPTIONAL: A boolean to show whether the customer has requested repair costs or not.
\n","type":"text"},{"key":"total_quote","value":"","description":"REQUIRED: The total sum of all fees related to the survey.
\n","type":"text"},{"key":"discount","value":"","description":"OPTIONAL: Depending on the discount type, this will be the percentage of a discount or the exact figure discounted from the fee quoted.
\n","type":"text"},{"key":"discount_type","value":"","description":"OPTIONAL: A boolean to show whether the discount is a percentage or exact value.
\n","type":"text"},{"key":"sales_advisor","value":"","description":"OPTIONAL: The name of the Sales Advisor.
\n","type":"text"},{"key":"sales_advisor_email","value":"","description":"OPTIONAL: The email address of the Sales Advisor.
\n","type":"text"},{"key":"source","value":"","description":"REQUIRED: The source used by the customer to find our services (e.g., comparison website, referral, poster).
\n","type":"text"},{"key":"callback_at","value":"","description":"OPTIONAL: A date field to show when a customer has requested a callback, if required.
\n","type":"text"},{"key":"is_property_size_checked","value":"","description":"REQUIRED: A boolean to show whether the admin have checked the property size.
\n","type":"text"},{"key":"is_urgent","value":"","description":"OPTIONAL: A boolean to show whether a callback is urgent or not.
\n","type":"text"},{"key":"is_valuation","value":"","description":"NULLABLE: A boolean to show whether the Survey requires a Valuation or not.
\n","type":"text"},{"key":"valuation_purpose","value":"","description":"NULLABLE: The purpose of the Valuation if applicable.
\n","type":"text"},{"key":"_method","value":"PATCH","description":"This is needed or the request will fail.
\n","type":"text"}]},"url":"{{base_url}}/api/company/lead/{lead}","description":"Updating a lead as a Company
\nUpdates the specified lead by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"REQUIRED: The type of the survey (e.g., Building Survey, HomeBuyer Report). ID links to 'survey_types' table.
\n"},{"key":"survey_status_id","value":"","type":"text","description":"REQUIRED: The status of the survey (e.g., Active, Completed, Cancelled). ID links to 'survey_statuses' table.
\n"},{"key":"assigned_surveyor_id","value":"","description":"OPTIONAL: The surveyor assigned to the survey. ID links to 'user_surveyors' table.
\n","type":"text"},{"key":"overseen_by_user_id","value":"","description":"OPTIONAL: The user who has over the survey report. ID links to the 'users' table.
\n","type":"text"},{"key":"company_customer_id","value":"","type":"text","description":"REQUIRED: The customer that survey is for. ID links to 'company_customers' table.
\n"},{"key":"source","value":"","description":"REQUIRED: The source of where the customer heard about the company.
\n","type":"text"},{"key":"survey_address_building","value":"","type":"text","description":"FILLED: The name of the building the survey is in.
\n"},{"key":"survey_address_line1","value":"","type":"text","description":"REQUIRED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"survey_address_line2","value":"","type":"text","description":"FILLED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"survey_address_city","value":"","type":"text","description":"REQUIRED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"survey_address_county","value":"","type":"text","description":"REQUIRED: County or state.
\n"},{"key":"survey_address_country","value":"","type":"text","description":"REQUIRED: Country. ID links to 'countries' table.
\n"},{"key":"survey_address_postcode","value":"","type":"text","description":"REQUIRED: ZIP or postal code.
\n"},{"key":"is_valuation","value":"","type":"text","description":"REQUIRED: Checkbox for whether a valuation is required (only for Building Surveys).
\n"},{"key":"valuation_purpose","value":"","type":"text","description":"FILLED: The purpose of the Valuation.
\n"},{"key":"other_users_of_the_report","value":"","description":"OPTIONAL: When selecting 'Valuation' as a Survey Type, this is can be selected if another person(s) requires access to the report.
\n","type":"text"},{"key":"property_tenure","value":"","type":"text","description":"REQUIRED: The tenure of the property (e.g., Freehold/Leasehold).
\n"},{"key":"property_construction","value":"","type":"text","description":"REQUIRED: The type of construction for the property.
\n"},{"key":"other_construction_type","value":"","description":"OPTIONAL: If the property construction type is not on the standard list, this field can be filled out with a different value.
\n","type":"text"},{"key":"property_purchase_price","value":"","type":"text","description":"REQUIRED: The purchase price of the property.
\n"},{"key":"is_property_size_checked","value":"","type":"text","description":"REQUIRED: Checkbox for whether the size of the property has been checked.
\n"},{"key":"leasehold_years","value":"","type":"text","description":"FILLED: The number of years remaining in the lease (if applicable).
\n"},{"key":"instruction_taken_on_date","value":"","description":"OPTIONAL: The date the instruction was taken on.
\n","type":"text"},{"key":"fee_quoted","value":"","type":"text","description":"REQUIRED: The fee quoted for the survey.
\n"},{"key":"repair_costs_quote","value":"","description":"OPTIONAL: The fee for adding repair costs to the report.
\n","type":"text"},{"key":"is_repair_costs","value":"","description":"OPTIONAL: A boolean to show whether repair costs should be included or not.
\n","type":"text"},{"key":"discount","value":"","description":"OPTIONAL: The numeric value for the discount to be applied to the fee quoted.
\n","type":"text"},{"key":"discount_type","value":"","description":"OPTIONAL: A boolean to show whether the discount is a percentage or fixed value.
\n","type":"text"},{"key":"valuation_quote","value":"","description":"OPTIONAL: The fee for adding a valuation to the report.
\n","type":"text"},{"key":"total_quote","value":"","description":"OPTIONAL: The total quote after calculat all quote fields.
\n","type":"text"},{"key":"quoted_at","value":"","type":"text","description":"REQUIRED: The date/time the survey was created.
\n"},{"key":"fee_taken","value":"","type":"text","description":"FILLED: The amount by the client for the fee.
\n"},{"key":"agreed_at","value":"","type":"text","description":"FILLED: The date the payment was made by the client.
\n"},{"key":"terms_sent_at","value":"","type":"text","description":"FILLED: The date the terms and conditions were sent to the client.
\n"},{"key":"terms_accepted_at","value":"","type":"text","description":"FILLED: The date the terms and conditions were accepted by the client.
\n"},{"key":"admin_notes","value":"","type":"text","description":"FILLED: Administration notes relating to the survey.
\n"},{"key":"surveyor_notes","value":"","description":"OPTIONAL: Additional information for the surveyor's reference.
\n","type":"text"},{"key":"survey_access_details","value":"","type":"text","description":"FILLED: The details for access to the property.
\n"},{"key":"vendor_email","value":"","description":"OPTIONAL: The vendor's email address.
\n","type":"text"},{"key":"vendor_number","value":"","description":"OPTIONAL: The vendor's contact number.
\n","type":"text"},{"key":"amount_refunded","value":"","type":"text","description":"FILLED: The amount refunded to the client.
\n"},{"key":"refunded_at","value":"","type":"text","description":"FILLED: The date/time the client was refunded.
\n"},{"key":"original_survey_date","value":"","type":"text","description":"FILLED: The original date of a Valuation (only applicable for Desktop Valuations).
\n"},{"key":"visit_booked_at","value":"","type":"text","description":"FILLED: The date/time of the inspection for the survey.
\n"},{"key":"visit_completed_at","value":"","type":"text","description":"FILLED: The date/time the inspection was completed for the survey.
\n"},{"key":"report_due_at","value":"","type":"text","description":"FILLED: The date the report is due.
\n"},{"key":"is_quality_checked","value":"","type":"text","description":"FILLED: Checkbox for whether the quality checks have been completed.
\n"},{"key":"is_report_sent","value":"","type":"text","description":"FILLED: Checkbox for whether the report has been sent.
\n"},{"key":"report_sent_at","value":"","type":"text","description":"FILLED: The date/time the report was sent.
\n"},{"key":"full_set_site_notes","value":"","description":"OPTIONAL: Shows whether the full set of site notes is available.
\n","type":"text"},{"key":"valuation_checked_against_rationale","value":"","description":"OPTIONAL: Shows whether valuation has been given rationale.
\n","type":"text"},{"key":"appropriate_comparables","value":"","description":"OPTIONAL: Shows whether comparables are available for a valuation.
\n","type":"text"},{"key":"reasoning_or_methodology_included","value":"","description":"OPTIONAL: Shows whether reasoning or methodology is available for a valuation.
\n","type":"text"},{"key":"contract_compliant","value":"","description":"OPTIONAL: Shows whether the customer has accepted our terms and conditions.
\n","type":"text"},{"key":"all_appropriate_documents_saved","value":"","description":"OPTIONAL: Shows whether any relevant documents are available for the survey/valuation.
\n","type":"text"},{"key":"signed_copy_on_file","value":"","description":"OPTIONAL: Shows whether the customer's acceptance of our terms are available.
\n","type":"text"},{"key":"is_report_sent","value":"","description":"OPTIONAL: Boolean to show whether the report has been sent.
\n","type":"text"},{"key":"report_sent_at","value":"","description":"OPTIONAL: Date field to show when the report has been sent.
\n","type":"text"},{"key":"is_wanting_hard_copy","value":"","type":"text","description":"FILLED: Checkbox for whether the client wants a hard copy of their report.
\n"},{"key":"is_client_callback","value":"","type":"text","description":"FILLED: Checkbox for whether the client wants a call after the inspection (for brief verbal feedback).
\n"},{"key":"is_client_contacted","value":"","type":"text","description":"FILLED: Checkbox for whether the client has been contact to follow up post-report.
\n"},{"key":"is_review_email_sent","value":"","type":"text","description":"FILLED: Checkbox for whether a Trustpilot review email has been sent to the client.
\n"},{"key":"is_invoiced","value":"","type":"text","description":"FILLED: Boolean for whether the invoice has been sent to the client.
\n"},{"key":"created_by_user_id","value":"","type":"text","description":"REQUIRED: The user who created the survey. ID links to 'users' table.
\n"},{"key":"instruction_taken_by_user_id","value":"","description":"OPTIONAL: The user who's converted the survey. Links to the id field in 'users' table.
\n","type":"text"},{"key":"lead_id","value":"","type":"text","description":"FILLED: The lead if the survey was converted from an exisiting lead. ID links to 'leads' table.
\n"},{"key":"updated_at","value":"","type":"text","description":"FILLED: The date/time the survey was last updated.
\n"},{"key":"device_id","value":"","type":"text","description":"SOMETIMES: UUID from the device for the component.
\n"},{"key":"sfy_job_id","value":"","type":"text","description":"FILLED: Links to a lead if provided by Surveyor For You client (usually Estate Agents). ID does not link to a table at the moment.
\n"}]},"url":"{{base_url}}/api/company/survey","description":"Creating a new survey as a Company
\nCreates a new user by setting the values of the parameters passed.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"REQUIRED: The type of the survey (e.g., Building Survey, HomeBuyer Report). ID links to 'survey_types' table.
\n"},{"key":"survey_status_id","value":"","type":"text","description":"REQUIRED: The status of the survey (e.g., Active, Completed, Cancelled). ID links to 'survey_statuses' table.
\n"},{"key":"assigned_surveyor_id","value":"","type":"text","description":"OPTIONAL: The surveyor assigned to the survey. ID links to 'user_surveyors' table.
\n"},{"key":"overseen_by_user_id","value":"","type":"text","description":"OPTIONAL: The user who has over the survey report. ID links to the 'users' table.
\n"},{"key":"company_customer_id","value":"","type":"text","description":"REQUIRED: The customer that survey is for. ID links to 'company_customers' table.
\n"},{"key":"source","value":"","type":"text","description":"REQUIRED: The source of where the customer heard about the company.
\n"},{"key":"survey_address_building","value":"","type":"text","description":"FILLED: The name of the building the survey is in.
\n"},{"key":"survey_address_line1","value":"","type":"text","description":"REQUIRED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"survey_address_line2","value":"","type":"text","description":"FILLED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"survey_address_city","value":"","type":"text","description":"REQUIRED: Address line 1 (e.g., street, PO Box, or company name).
\n"},{"key":"survey_address_county","value":"","type":"text","description":"REQUIRED: County or state.
\n"},{"key":"survey_address_country","value":"","type":"text","description":"REQUIRED: Country. ID links to 'countries' table.
\n"},{"key":"survey_address_postcode","value":"","type":"text","description":"REQUIRED: ZIP or postal code.
\n"},{"key":"is_valuation","value":"","type":"text","description":"REQUIRED: Checkbox for whether a valuation is required (only for Building Surveys).
\n"},{"key":"valuation_purpose","value":"","type":"text","description":"FILLED: The purpose of the Valuation.
\n"},{"key":"other_users_of_the_report","value":"","type":"text","description":"OPTIONAL: When selecting 'Valuation' as a Survey Type, this is can be selected if another person(s) requires access to the report.
\n"},{"key":"property_tenure","value":"","type":"text","description":"REQUIRED: The tenure of the property (e.g., Freehold/Leasehold).
\n"},{"key":"property_construction","value":"","type":"text","description":"REQUIRED: The type of construction for the property.
\n"},{"key":"other_construction_type","value":"","type":"text","description":"OPTIONAL: If the property construction type is not on the standard list, this field can be filled out with a different value.
\n"},{"key":"property_purchase_price","value":"","type":"text","description":"REQUIRED: The purchase price of the property.
\n"},{"key":"is_property_size_checked","value":"","type":"text","description":"REQUIRED: Checkbox for whether the size of the property has been checked.
\n"},{"key":"leasehold_years","value":"","type":"text","description":"FILLED: The number of years remaining in the lease (if applicable).
\n"},{"key":"instruction_taken_on_date","value":"","type":"text","description":"OPTIONAL: The date the instruction was taken on.
\n"},{"key":"fee_quoted","value":"","type":"text","description":"REQUIRED: The fee quoted for the survey.
\n"},{"key":"repair_costs_quote","value":"","type":"text","description":"OPTIONAL: The fee for adding repair costs to the report.
\n"},{"key":"is_repair_costs","value":"","type":"text","description":"OPTIONAL: A boolean to show whether repair costs should be included or not.
\n"},{"key":"discount","value":"","type":"text","description":"OPTIONAL: The numeric value for the discount to be applied to the fee quoted.
\n"},{"key":"discount_type","value":"","type":"text","description":"OPTIONAL: A boolean to show whether the discount is a percentage or fixed value.
\n"},{"key":"valuation_quote","value":"","type":"text","description":"OPTIONAL: The fee for adding a valuation to the report.
\n"},{"key":"total_quote","value":"","type":"text","description":"OPTIONAL: The total quote after calculat all quote fields.
\n"},{"key":"quoted_at","value":"","type":"text","description":"REQUIRED: The date/time the survey was created.
\n"},{"key":"fee_taken","value":"","type":"text","description":"FILLED: The amount by the client for the fee.
\n"},{"key":"agreed_at","value":"","type":"text","description":"FILLED: The date the payment was made by the client.
\n"},{"key":"terms_sent_at","value":"","type":"text","description":"FILLED: The date the terms and conditions were sent to the client.
\n"},{"key":"terms_accepted_at","value":"","type":"text","description":"FILLED: The date the terms and conditions were accepted by the client.
\n"},{"key":"admin_notes","value":"","type":"text","description":"FILLED: Administration notes relating to the survey.
\n"},{"key":"surveyor_notes","value":"","type":"text","description":"OPTIONAL: Additional information for the surveyor's reference.
\n"},{"key":"survey_access_details","value":"","type":"text","description":"FILLED: The details for access to the property.
\n"},{"key":"vendor_email","value":"","type":"text","description":"OPTIONAL: The vendor's email address.
\n"},{"key":"vendor_number","value":"","type":"text","description":"OPTIONAL: The vendor's contact number.
\n"},{"key":"amount_refunded","value":"","type":"text","description":"FILLED: The amount refunded to the client.
\n"},{"key":"refunded_at","value":"","type":"text","description":"FILLED: The date/time the client was refunded.
\n"},{"key":"original_survey_date","value":"","type":"text","description":"FILLED: The original date of a Valuation (only applicable for Desktop Valuations).
\n"},{"key":"visit_booked_at","value":"","type":"text","description":"FILLED: The date/time of the inspection for the survey.
\n"},{"key":"visit_completed_at","value":"","type":"text","description":"FILLED: The date/time the inspection was completed for the survey.
\n"},{"key":"report_due_at","value":"","type":"text","description":"FILLED: The date the report is due.
\n"},{"key":"is_quality_checked","value":"","type":"text","description":"FILLED: Checkbox for whether the quality checks have been completed.
\n"},{"key":"is_report_sent","value":"","type":"text","description":"FILLED: Checkbox for whether the report has been sent.
\n"},{"key":"report_sent_at","value":"","type":"text","description":"FILLED: Checkbox for whether the report has been sent.
\n"},{"key":"full_set_site_notes","value":"","type":"text","description":"OPTIONAL: Shows whether the full set of site notes is available.
\n"},{"key":"valuation_checked_against_rationale","value":"","type":"text","description":"OPTIONAL: Shows whether valuation has been given rationale.
\n"},{"key":"appropriate_comparables","value":"","type":"text","description":"OPTIONAL: Shows whether comparables are available for a valuation.
\n"},{"key":"reasoning_or_methodology_included","value":"","type":"text","description":"OPTIONAL: Shows whether reasoning or methodology is available for a valuation.
\n"},{"key":"contract_compliant","value":"","type":"text","description":"OPTIONAL: Shows whether the customer has accepted our terms and conditions.
\n"},{"key":"all_appropriate_documents_saved","value":"","type":"text","description":"OPTIONAL: Shows whether any relevant documents are available for the survey/valuation.
\n"},{"key":"signed_copy_on_file","value":"","type":"text","description":"OPTIONAL: Shows whether the customer's acceptance of our terms are available.
\n"},{"key":"is_report_sent","value":"","type":"text","description":"OPTIONAL: Boolean to show whether the report has been sent.
\n"},{"key":"report_sent_at","value":"","type":"text","description":"OPTIONAL: Date field to show when the report has been sent.
\n"},{"key":"is_wanting_hard_copy","value":"","type":"text","description":"FILLED: Checkbox for whether the client wants a hard copy of their report.
\n"},{"key":"is_client_callback","value":"","type":"text","description":"FILLED: Checkbox for whether the client wants a call after the inspection (for brief verbal feedback).
\n"},{"key":"is_client_contacted","value":"","type":"text","description":"FILLED: Checkbox for whether the client has been contact to follow up post-report.
\n"},{"key":"is_review_email_sent","value":"","type":"text","description":"FILLED: Checkbox for whether a Trustpilot review email has been sent to the client.
\n"},{"key":"is_invoiced","value":"","type":"text","description":"FILLED: Boolean for whether the invoice has been sent to the client.
\n"},{"key":"created_by_user_id","value":"","type":"text","description":"REQUIRED: The user who created the survey. ID links to 'users' table.
\n"},{"key":"instruction_taken_by_user_id","value":"","type":"text","description":"OPTIONAL: The user who's converted the survey. Links to the id field in 'users' table.
\n"},{"key":"lead_id","value":"","type":"text","description":"FILLED: The lead if the survey was converted from an exisiting lead. ID links to 'leads' table.
\n"},{"key":"updated_at","value":"","type":"text","description":"FILLED: The date/time the survey was last updated.
\n"},{"key":"device_id","value":"","type":"text","description":"SOMETIMES: UUID from the device for the component.
\n"},{"key":"sfy_job_id","value":"","type":"text","description":"FILLED: Links to a lead if provided by Surveyor For You client (usually Estate Agents). ID does not link to a table at the moment.
\n"},{"key":"_method","value":"PATCH","description":"This is needed or the request will fail.
\n","type":"text"}]},"url":"{{base_url}}/api/company/survey/{survey}","description":"Updating a survey as a Company
\nUpdates the specified survey by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[{"key":"accessToken","value":"REQUIRED: The user's full name.
\n","type":"text"},{"key":"email","value":"","description":"REQUIRED: The user's email address.
\n","type":"text"},{"key":"address_building","value":"","description":"REQUIRED: The user's building name.
\n","type":"text"},{"key":"address_line1","value":"","description":"REQUIRED: The user's first line of address.
\n","type":"text"},{"key":"address_line2","value":"","description":"REQUIRED: The user's second line of address.
\n","type":"text"},{"key":"address_city","value":"","description":"REQUIRED: The user's city.
\n","type":"text"},{"key":"address_county","value":"","description":"REQUIRED: The user's county.
\n","type":"text"},{"key":"country_id","value":"","description":"REQUIRED: The user's country. Links to the Countries API using the 'id' field.
\n","type":"text"},{"key":"address_postcode","value":"","description":"REQUIRED: The user's postcode.
\n","type":"text"},{"key":"profile_picture","description":"REQUIRED: The user's profile picture. Must be an image.
\n","type":"file","value":null},{"key":"company_id","value":"","description":"REQUIRED: The user's associated company. Links to the Company API using the 'id' field.
\n","type":"text"},{"key":"_method","value":"PATCH","description":"This is needed or the request will fail.
\n","type":"text"}]},"url":"{{base_url}}/api/company/survey/{survey}","description":"Updating a user as a Company
\nUpdates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n