Customer Json Schema

In This Topic

Description

Represents a comprehensive Customer record within the OnTime API.

Overview

Customer

Represents a comprehensive Customer record within the OnTime API.

PriceSets : Array[]

The collection of unique Guid identifiers referencing all PriceSet records assigned to this Customer.

DefaultPriceSet : string

The unique Guid identifier referencing the default PriceSet record assigned to this Customer.

Departments : Array[Department]

The collection of comprehensive Department records belonging to this Customer.

ID : string

The unique identifier of this Department.

CustomerID : string

The unique identifier of the Customer associated with this Department.

Name : string

The name assigned to this Department.

Contacts : Array[Contact]

The collection of comprehensive Contact records belonging to this Customer.

ID : string

The unique identifier of this Contact.

CustomerID : string

The unique identifier of the Customer associated with this Contact.

Name : string

The name assigned to this Contact.

Email : string

The email address assigned to this Contact.

Phone : string

The phone number assigned to this Contact.

ID : string

The unique identifier for this Customer record.

Name : string

The name of this Customer.

PrimaryContactName : string

The primary contact name of this Customer.

AddressLine1 : string

The street address of this Customer.

AddressLine2 : string

Additional secondary information related to this Customer's steet address.

City : string

The city or locality this Customer resides within.

State : string

The state, province, or other civil entity this Customer resides within.

PostalCode : string

The assigned postal code this Customer resides within.

Country : string

The country or other national political entity this Customer resides within.

Phone : string

The phone number assigned to this Customer.

Fax : string

The fax number assigned to this Customer.

Email : string

The email address assigned to this Customer.

Website : string

The website URL associated with this Customer.

AccountNumber : string

The account number assigned to this Customer.

DestinationCategories : string

The user-defined category assigned to this Customer.

BillingAdjustmentPercentage : number

The billing adjustment percentage assigned to this Customer.

SendInvoiceByEmail : boolean

The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via email.

SendInvoiceByPostal : boolean

The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via post (i.e. postal services, physical mail, snail mail, etc.).

SendInvoiceByFax : boolean

The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via fax.

HasWebPortalAccess : boolean

Determines if this Customer is authorized to log-in to the Customer Web Portal.

BillingEmail : string

The billing-specific email address assigned to this Customer.

TimeZone : string

The time zone this Customer resides within.

ReferenceNumber : string

The reference number assigned to this Customer.

PurchaseOrderNumber : string

The purchase order number assigned to this Customer.

Comments : string

Any additional comments associated with this Customer.

OrderEntryRequiredFields : string

Defines the required fields this Customer must provide when submitting a new {OnTime.Extensions.SDK.Order} through the Customer Web Portal.

Inactive : boolean

The active status of this Customer.

PricingMethod : string

The pricing method assigned to this Customer. Available Values: [None, ZoneToZone, Distance, FlatRate]

Properties

Name	Description	Data Type
PriceSets	The collection of unique Guid identifiers referencing all PriceSet records assigned to this Customer.	Array[]
DefaultPriceSet	The unique Guid identifier referencing the default PriceSet record assigned to this Customer.	string
Departments	The collection of comprehensive Department records belonging to this Customer.	Array[Department]
Contacts	The collection of comprehensive Contact records belonging to this Customer.	Array[Contact]
ID	The unique identifier for this Customer record.	string
Name	The name of this Customer.	string
PrimaryContactName	The primary contact name of this Customer.	string
AddressLine1	The street address of this Customer.	string
AddressLine2	Additional secondary information related to this Customer's steet address.	string
City	The city or locality this Customer resides within.	string
State	The state, province, or other civil entity this Customer resides within.	string
PostalCode	The assigned postal code this Customer resides within.	string
Country	The country or other national political entity this Customer resides within.	string
Phone	The phone number assigned to this Customer.	string
Fax	The fax number assigned to this Customer.	string
Email	The email address assigned to this Customer.	string
Website	The website URL associated with this Customer.	string
AccountNumber	The account number assigned to this Customer.	string
DestinationCategories	The user-defined category assigned to this Customer.	string
BillingAdjustmentPercentage	The billing adjustment percentage assigned to this Customer.	number
SendInvoiceByEmail	The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via email.	boolean
SendInvoiceByPostal	The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via post (i.e. postal services, physical mail, snail mail, etc.).	boolean
SendInvoiceByFax	The eligibility of an {OnTime.Extensions.SDK.Invoice} being delivered to this Customer via fax.	boolean
HasWebPortalAccess	Determines if this Customer is authorized to log-in to the Customer Web Portal.	boolean
BillingEmail	The billing-specific email address assigned to this Customer.	string
TimeZone	The time zone this Customer resides within.	string
ReferenceNumber	The reference number assigned to this Customer.	string
PurchaseOrderNumber	The purchase order number assigned to this Customer.	string
Comments	Any additional comments associated with this Customer.	string
OrderEntryRequiredFields	Defines the required fields this Customer must provide when submitting a new {OnTime.Extensions.SDK.Order} through the Customer Web Portal.	string
Inactive	The active status of this Customer.	boolean
PricingMethod	The pricing method assigned to this Customer. Available Values: [None, ZoneToZone, Distance, FlatRate]	string