CreateCustomerModel

New customer profile.

  • Customer must have a billing and shipping address. A single address may be used with both is_billing and is_shipping set to True, or two separate addresses may be used. If two addresses are used, one must be set with is_billing=True and the other is_shipping=True.

Examples

Fill this template out with real values.

{
"addresses": "array[CreateCustomerAddressModel]",
"contacts": "array[CreateCustomerContactModel]",
"is_commercial": "Boolean, optional",
"name": "String",
"note": "String, optional",
"parent_id": "Integer, optional",
"reference_number": "String, optional",
"renewal_date": "String, optional",
"sales_rep": "String, optional",
"sales_rep_id": "String, optional",
"suspension_id": "Integer, optional"
}

Fields

addresses Array[CreateCustomerAddressModel], Required

Refer to CreateCustomerAddressModel.


contacts Array[CreateCustomerContactModel], Required

Refer to CreateCustomerContactModel.


is_commercial Boolean, Optional

Commercial address if true, private if false.

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

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, Optional

Parent record identifier.


reference_number String, Optional

Reference number (free text).

  • At least 1 and no more than 256 characters.

renewal_date String, Optional

Renewal date.

  • Date in an ISO 8601 compatible 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. May be an integer provider id, the sales user UUID, or the username.

  • At least 0 and no more than 64 characters.

suspension_id Integer, Optional

Suspension identifier.