LocationModel

Location data.

Breaking Changes

No breaking changes.

Examples

Template

Fill this template out with real values.

{
"address": "[LocationAddressModel](/docs/data_types/LocationAddressModel)",
"allow_new_asset_numbers": "Boolean",
"asset_number_required": "Boolean",
"auto_billing_setup": "Boolean",
"auto_complete_dumps": "Boolean",
"auto_rollover_enabled": "Boolean",
"bar_code_type": "String",
"billing_accounts_global": "Boolean",
"contact": "[LocationContactModel](/docs/data_types/LocationContactModel)",
"delivery_hidden": "Boolean",
"delivery_name": "String",
"distance_factor": "Float",
"distance_label": "String",
"do_share_drivers": "Boolean",
"driver_self_assignment": "Boolean",
"dropoff_hidden": "Boolean",
"dropoff_name": "String",
"dtt_enabled": "Boolean",
"exchange_hidden": "Boolean",
"exchange_name": "String",
"id": "Integer",
"is_active": "Boolean",
"leed_enabled": "Boolean",
"main_inventory_name": "String",
"name": "String",
"notify_on_acknowledged_job": "Boolean",
"notify_on_completed_job": "Boolean",
"notify_on_dispatched_job": "Boolean",
"notify_on_failed_job": "Boolean",
"pickup_hidden": "Boolean",
"pickup_name": "String",
"require_reason_fail_delay": "Boolean",
"require_reference_number": "Boolean",
"require_signature": "Boolean",
"service_disclaimer": "String",
"service_hidden": "Boolean",
"service_name": "String",
"use_additional_items": "Boolean"
}

Fields

address Object, Required

LocationAddressModel

---

allow_new_asset_numbers Boolean, Required

Allow input of new asset numbers.

• One of 0, 1, True, False (case insensitive).

---

asset_number_required Boolean, Required

Require assets to have numbers.

• One of 0, 1, True, False (case insensitive).

---

auto_billing_setup Boolean, Required

Automatically open billing when a customer is created through the CC.

• One of 0, 1, True, False (case insensitive).

---

auto_complete_dumps Boolean, Required

Automatically complete dump jobs.

• One of 0, 1, True, False (case insensitive).

---

auto_rollover_enabled Boolean, Required

Automatically move pending jobs scheduled for a date in the past to the current date.

• One of 0, 1, True, False (case insensitive).

---

bar_code_type String, Required

(deprecated) Set to any value to enable barcode scanning.

• At least 1 and no more than 64 characters.

---

billing_accounts_global Boolean, Required

Share billing accounts between locations.

• One of 0, 1, True, False (case insensitive).

---

contact Object, Required

LocationContactModel

---

delivery_hidden Boolean, Required

Hide delivery job type in user interfaces, except for existing delivery jobs (job type 'L').

• One of 0, 1, True, False (case insensitive).

---

delivery_name String, Required

Name used in the UI which replaces the word 'Delivery' for job types (job type 'L').

• At least 1 and no more than 12 characters.

---

distance_factor Float, Required

Conversion factor to get from kilometers to the desired distance unit of measurement

• Greater than or equal to 0.0.

---

distance_label String, Required

Distance unit of measurement

• At least 0 and no more than 20 characters.

---

do_share_drivers Boolean, Required

Share drivers between locations

• One of 0, 1, True, False (case insensitive).

---

driver_self_assignment Boolean, Required

Driver can self assign.

• One of 0, 1, True, False (case insensitive).

---

dropoff_hidden Boolean, Required

Hide dropoff job type in user interfaces, except for existing delivery jobs (job type 'D').

• One of 0, 1, True, False (case insensitive).

---

dropoff_name String, Required

Name used in the UI which replaces the word 'Dropoff' for job types (job type 'D').

• At least 1 and no more than 12 characters.

---

dtt_enabled Boolean, Required

Enables the Daily Truck Timeline.

• One of 0, 1, True, False (case insensitive).

---

exchange_hidden Boolean, Required

Hide exchange job type in user interfaces, except for existing exchange jobs (job type 'E').

• One of 0, 1, True, False (case insensitive).

---

exchange_name String, Required

Name used in the UI which replaces the word 'Exchange' for job types (job type 'E').

• At least 1 and no more than 12 characters.

---

id Integer, Required

Location identifier.

---

is_active Boolean, Required

Records marked inactive are treated as deleted (soft delete).

• One of 0, 1, True, False (case insensitive).

---

leed_enabled Boolean, Required

Enable LEED features.

• One of 0, 1, True, False (case insensitive).

---

main_inventory_name String, Required

Name of the location's main inventory.

• At least 0 and no more than 64 characters.

---

name String, Required

Name for a location.

• At least 1 and no more than 64 characters.

---

notify_on_acknowledged_job Boolean, Required

Send email notification to the location's contact when a job is acknowledged.

• One of 0, 1, True, False (case insensitive).

---

notify_on_completed_job Boolean, Required

Send email notification to the location's contact when a job is completed.

• One of 0, 1, True, False (case insensitive).

---

notify_on_dispatched_job Boolean, Required

Send email notification to the location's contact when a job is dispatched.

• One of 0, 1, True, False (case insensitive).

---

notify_on_failed_job Boolean, Required

Send email notification to the location's contact when a job is failed.

• One of 0, 1, True, False (case insensitive).

---

pickup_hidden Boolean, Required

Hide pickup job type in user interfaces, except for existing pickup jobs (job type 'P').

• One of 0, 1, True, False (case insensitive).

---

pickup_name String, Required

Name used in the UI which replaces the word 'Pickup' for job types (job type 'P').

• At least 1 and no more than 12 characters.

---

require_reason_fail_delay Boolean, Required

Require drivers to input the reason that a job was failed or delayed

• One of 0, 1, True, False (case insensitive).

---

require_reference_number Boolean, Required

Require reference numbers when creating or editing jobs.

• One of 0, 1, True, False (case insensitive).

---

require_signature Boolean, Required

Require drivers to collect signatures when completing jobs.

• One of 0, 1, True, False (case insensitive).

---

service_disclaimer String, Required

Service disclaimer text presented to customers when drivers acquire signatures.

• At least 0 and no more than 10485760 characters.

---

service_hidden Boolean, Required

Hide service job type in user interfaces, except for existing service jobs (job type 'R').

• One of 0, 1, True, False (case insensitive).

---

service_name String, Required

Name used in the UI which replaces the word 'Service' for job types (job type 'R').

• At least 1 and no more than 12 characters.

---

use_additional_items Boolean, Required

Use additional items.

• One of 0, 1, True, False (case insensitive).