DispatchCustomerLocationModel

Customer location profile.

Breaking Changes

2021/04/07

• customer_id was renamed to id.

Examples

Template

Fill this template out with real values.

{
"account_number_1": "String",
"account_number_2": "String",
"addresses": "array[[CustomerAddressModel](/docs/data_types/CustomerAddressModel)]",
"contacts": "array[[CustomerContactModel](/docs/data_types/CustomerContactModel)]",
"created_on": "String",
"customer_id": "Integer",
"is_active": "Boolean",
"is_commercial": "Boolean, optional",
"last_updated_on": "String",
"location_id": "Integer",
"name": "String",
"note": "String, optional",
"parent_id": "Integer",
"reference_number": "String, optional",
"renewal_date": "String",
"sales_rep": "String, optional",
"sales_rep_id": "String, optional",
"suspension_id": "Integer, optional"
}

Fields

account_number_1 String, Required

Customer account number.

• At least 0 and no more than 128 characters.

---

account_number_2 String, Required

Customer account number.

• At least 0 and no more than 128 characters.

---

addresses Array[CustomerAddressModel], Required

Refer to CustomerAddressModel.

---

contacts Array[CustomerContactModel], Required

Refer to CustomerContactModel.

---

created_on String, Required

Timestamp of creation (must be in past).

• Date occurring in the past in an ISO 8601 compatible format.

---

customer_id Integer, Required

Customer identifier.

---

is_active Boolean, Required

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

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

---

is_commercial Boolean, Optional

Commercial address if true, private if false.

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

---

last_updated_on String, Required

• Date occurring in the past in an ISO 8601 compatible format.

---

location_id Integer, Required

Location identifier.

---

name String, Required

Name (free text).

• At least 1 and no more than 64 characters.

---

note String, Optional

Notes (free text).

• At least 0 and no more than 2048 characters.

---

parent_id Integer, Required

Parent record identifier.

---

reference_number String, Optional

Reference number (free text).

• At least 1 and no more than 256 characters.

---

renewal_date String, Required

Renewal date.

• Date in an ISO 8601 format.

---

sales_rep String, Optional

Name of sales representative.

• At least 1 and no more than 64 characters.

---

sales_rep_id String, Optional

Sales rep identifier.

---

suspension_id Integer, Optional

Suspension identifier.