Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Here is a list of additional object references for BBA Integration APIs.

...

Name

Description

Schema

addressLine1

optional

Address line 1

string

addressLine2

optional

Address line 2

string

company

optional

Address company

string

customerCarrierAccountCode

optional

string

email

optional

Address email

string

firstName

optional

Address first name

string

lastName

optional

Address last name

string

latitude

optional

${swagger.model.address.latitude}

number (double)

location

optional

Address location

Location

longitude

optional

${swagger.model.address.longitude}

number (double)

phone

optional

Address phone number

string

receiverCode

optional

string

senderCode

optional

string

...

Name

Description

Schema

addressLine1

optional

Address line 1

string

addressLine2

optional

Address line 2

string

company

optional

Address company

string

email

optional

Address email

string

firstName

optional

Address FirstName

string

lastName

optional

Address last name

string

location

optional

address location

Location

phone

optional

Address phone

string

...

Name

Description

Schema

active

optional

Office activation status

Example : false

boolean

addressLine1

optional

Office address line 1

string

addressLine2

optional

Office address line 2

string

code

optional

Office code

string

company

optional

Office’s company

Company

currency

optional

Office currency

string

description

optional

Office description

string

email

optional

Office email address

string

firstName

optional

Office first name

string

id

optional

Office identifier

string

lastName

optional

Office last name

string

location

optional

Office location

Location

locationProfile

optional

Office location profile

LocationProfileProjection

measurementUnit

optional

Office measure unit

enum (cm, in, m, ft, mm)

name

optional

Office name

string

notificationPreferences

optional

Office notification preferences

NotificationPreferences

officeConfiguration

optional

${swagger.model.office.office_configuration}

OfficeConfiguration

parent

optional

Parent office

string

phone1

optional

Office primary phone number

string

phone2

optional

Office secondary phone number

string

website

optional

Office website

string

weightUnit

optional

Office weight unit

enum (grams, kilograms, ounces, pounds)

...

Name

Description

Schema

active

optional

Company activation status

Example : false

boolean

addressLine1

optional

Company address line 1

string

addressLine2

optional

Company address line 2

string

billingProfile

optional

Company billing profile

PublicBillingProfileProjection

customerCarrierAccountCode

optional

${swagger.model.company.customer_carrier_account_code }

string

email

optional

Company email address

string

enableServiceSharing

optional

Company carrier and service profile services

Example : false

boolean

id

optional

Company identifier

integer (int64)

isReseller

optional

Indicate if the company is reseller

Example : false

boolean

location

optional

Company location

Location

logoUrl

optional

Company logo url

string

name

optional

Company name

string

networkEnabled

optional

Network Effect enabled company display

Example : false

boolean

phone1

optional

Company primary phone number

string

phone2

optional

Company secondary phone number

string

primaryContact

optional

Company primary contact

PrimaryContact

reseller

optional

read-only

${swagger.model.company.reseller}

PublicResellerProjection

smsNotificationEnabled

optional

SMS notifications enabled

Example : false

boolean

website

optional

Company website

string

...

Name

Description

Schema

address1

optional

Billing profile address line 1

string

address2

optional

Billing profile address line 2

string

email

optional

Billing profile email address

string

firstName

optional

Billing profile first name

string

lastName

optional

Billing profile last name

string

location

optional

Billing profile location

Location

phone1

optional

Billing profile primary phone

string

phone2

optional

Billing profile secondary phone

string

...

Name

Description

Schema

active

optional

Company activation status

Example : false

boolean

addressLine1

optional

Company address line 1

string

addressLine2

optional

Company address line 2

string

billingProfile

optional

Company billing profile

PublicBillingProfileProjection

email

optional

Company email address

string

enableServiceSharing

optional

Company carrier and service profile services

Example : false

boolean

id

optional

Company identifier

integer (int64)

isReseller

optional

Indicate if the company is reseller

Example : false

boolean

location

optional

Company location

Location

logoUrl

optional

Company logo url

string

name

optional

Company name

string

networkEnabled

optional

Network Effect enabled company display

Example : false

boolean

phone1

optional

Company primary phone number

string

phone2

optional

Company secondary phone number

string

primaryContact

optional

Company primary contact

PrimaryContact

smsNotificationEnabled

optional

SMS notifications enabled

Example : false

boolean

website

optional

Company website

string