Skip to main content

DispatchCustomerSettingsModel

Customer location profile.

Breaking Changes​

No breaking changes.

Examples​

Fill this template out with real values.

{
"created_on": "String",
"customer_id": "Integer",
"is_active": "Boolean",
"is_commercial": "Boolean, optional",
"last_updated_on": "String",
"location_id": "Integer",
"note": "String, optional",
"reference_number": "String, optional",
"renewal_date": "String",
"sales_rep": "String, optional",
"sales_rep_id": "String, optional",
"suspension_id": "Integer, optional"
}

Fields​

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.

note String, Optional

Notes (free text).

  • At least 0 and no more than 2048 characters.

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.