Methods

  • get - Get company contact by id

Resource

{
    "assets": [
        {
            "active": "boolean",
            "assetType": "string",
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "id": "string",
            "key": "string",
            "largeURL": "string",
            "largeX2URL": "string",
            "mediumURL": "string",
            "modified": "int64",
            "name": "string",
            "origURL": "string",
            "priority": "int32",
            "publicURL": "string",
            "secured": "boolean",
            "thumbURL": "string",
            "type": "string",
            "updated": "boolean"
        }
    ],
    "companyId": "string",
    "created": "int64",
    "customerCompany": {
        "accountOwnerId": "string",
        "active": "boolean",
        "additionalAddressList": [
            {
                "address": "string",
                "addressLine2": "string",
                "city": "string",
                "companyId": "string",
                "country": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "latitude": "number",
                "longitude": "number",
                "modified": "int64",
                "state": "string",
                "updated": "boolean",
                "zipCode": "string"
            }
        ],
        "address": {
            "address": "string",
            "addressLine2": "string",
            "city": "string",
            "companyId": "string",
            "country": "string",
            "created": "int64",
            "deleted": "boolean",
            "id": "string",
            "latitude": "number",
            "longitude": "number",
            "modified": "int64",
            "state": "string",
            "updated": "boolean",
            "zipCode": "string"
        },
        "armsLengthType": "string",
        "assets": [
            {
                "active": "boolean",
                "assetType": "string",
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "key": "string",
                "largeURL": "string",
                "largeX2URL": "string",
                "mediumURL": "string",
                "modified": "int64",
                "name": "string",
                "origURL": "string",
                "priority": "int32",
                "publicURL": "string",
                "secured": "boolean",
                "thumbURL": "string",
                "type": "string",
                "updated": "boolean"
            }
        ],
        "backOrderEnabled": "boolean",
        "brands": [
            "string"
        ],
        "companyId": "string",
        "companyLicenses": [
            {
                "companyType": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "licenseExpirationDate": "int64",
                "licenseNumber": "string",
                "licenseType": "string",
                "modified": "int64",
                "toDefault": "boolean",
                "updated": "boolean"
            }
        ],
        "companyType": "string",
        "connectedShop": "string",
        "contactPerson": "string",
        "created": "int64",
        "createdBy": "string",
        "credits": "number",
        "dbaName": "string",
        "defaultContactId": "string",
        "defaultPaymentTerm": "string",
        "deleted": "boolean",
        "description": "string",
        "email": "string",
        "externalId": "string",
        "fax": "string",
        "firstName": "string",
        "id": "string",
        "importId": "string",
        "lastName": "string",
        "licenceType": "string",
        "licenseExpirationDate": "int64",
        "licenseNumber": "string",
        "mobileNumber": "string",
        "modified": "int64",
        "name": "string",
        "notes": [
            {
                "created": "int64",
                "deleted": "boolean",
                "enableOnFleet": "boolean",
                "id": "string",
                "message": "string",
                "modified": "int64",
                "updated": "boolean",
                "writerId": "string",
                "writerName": "string"
            }
        ],
        "phone": "string",
        "qbVendorRef": [
            {
                "<key>": "string"
            }
        ],
        "relatedEntity": "boolean",
        "salesPerson": "string",
        "toDefault": "boolean",
        "updated": "boolean",
        "vendorKey": "string",
        "vendorType": "string",
        "website": "string"
    },
    "customerCompanyId": "string",
    "deleted": "boolean",
    "dirty": "boolean",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "modified": "int64",
    "note": {
        "created": "int64",
        "deleted": "boolean",
        "enableOnFleet": "boolean",
        "id": "string",
        "message": "string",
        "modified": "int64",
        "updated": "boolean",
        "writerId": "string",
        "writerName": "string"
    },
    "officeNumber": "string",
    "phoneNumber": "string",
    "role": "string",
    "salutation": "string",
    "shopId": "string",
    "updated": "boolean",
    "userPhoto": {
        "active": "boolean",
        "assetType": "string",
        "companyId": "string",
        "created": "int64",
        "deleted": "boolean",
        "id": "string",
        "key": "string",
        "largeURL": "string",
        "largeX2URL": "string",
        "mediumURL": "string",
        "modified": "int64",
        "name": "string",
        "origURL": "string",
        "priority": "int32",
        "publicURL": "string",
        "secured": "boolean",
        "thumbURL": "string",
        "type": "string",
        "updated": "boolean"
    }
}

Properties

Name Type Description Additional
assets[] array Optional
assets[].active boolean Optional
assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
assets[].companyId string Optional
assets[].created int64 Optional
assets[].deleted boolean Optional
assets[].id string Optional
assets[].key string Optional
assets[].largeURL string Optional
assets[].largeX2URL string Optional
assets[].mediumURL string Optional
assets[].modified int64 Optional
assets[].name string Optional
assets[].origURL string Optional
assets[].priority int32 Optional
assets[].publicURL string Optional
assets[].secured boolean Optional
assets[].thumbURL string Optional
assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
assets[].updated boolean Optional
companyId string Optional
created int64 Optional
customerCompany object Vendor Optional
customerCompany.accountOwnerId string Optional
customerCompany.active boolean Optional
customerCompany.additionalAddressList[] array Optional
customerCompany.additionalAddressList[].address string Optional
customerCompany.additionalAddressList[].addressLine2 string Optional
customerCompany.additionalAddressList[].city string Optional
customerCompany.additionalAddressList[].companyId string Optional
customerCompany.additionalAddressList[].country string Optional
customerCompany.additionalAddressList[].created int64 Optional
customerCompany.additionalAddressList[].deleted boolean Optional
customerCompany.additionalAddressList[].id string Optional
customerCompany.additionalAddressList[].latitude number Optional
customerCompany.additionalAddressList[].longitude number Optional
customerCompany.additionalAddressList[].modified int64 Optional
customerCompany.additionalAddressList[].state string Optional
customerCompany.additionalAddressList[].updated boolean Optional
customerCompany.additionalAddressList[].zipCode string Optional
customerCompany.address object Address Optional
customerCompany.address.address string Optional
customerCompany.address.addressLine2 string Optional
customerCompany.address.city string Optional
customerCompany.address.companyId string Optional
customerCompany.address.country string Optional
customerCompany.address.created int64 Optional
customerCompany.address.deleted boolean Optional
customerCompany.address.id string Optional
customerCompany.address.latitude number Optional
customerCompany.address.longitude number Optional
customerCompany.address.modified int64 Optional
customerCompany.address.state string Optional
customerCompany.address.updated boolean Optional
customerCompany.address.zipCode string Optional
customerCompany.armsLengthType string

Possible values are:

  • ARMS_LENGTH
  • NON_ARMS_LENGTH
Optional
customerCompany.assets[] array Optional
customerCompany.assets[].active boolean Optional
customerCompany.assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
customerCompany.assets[].companyId string Optional
customerCompany.assets[].created int64 Optional
customerCompany.assets[].deleted boolean Optional
customerCompany.assets[].id string Optional
customerCompany.assets[].key string Optional
customerCompany.assets[].largeURL string Optional
customerCompany.assets[].largeX2URL string Optional
customerCompany.assets[].mediumURL string Optional
customerCompany.assets[].modified int64 Optional
customerCompany.assets[].name string Optional
customerCompany.assets[].origURL string Optional
customerCompany.assets[].priority int32 Optional
customerCompany.assets[].publicURL string Optional
customerCompany.assets[].secured boolean Optional
customerCompany.assets[].thumbURL string Optional
customerCompany.assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
customerCompany.assets[].updated boolean Optional
customerCompany.backOrderEnabled boolean Optional
customerCompany.brands[] array of string Optional
customerCompany.companyId string Optional
customerCompany.companyLicenses[] array Optional
customerCompany.companyLicenses[].companyType string

Possible values are:

  • DISTRIBUTOR
  • CULTIVATOR
  • RETAILER
  • MANUFACTURER
  • TRANSPORTER
  • OTHER
  • TESTING_FACILITY
Optional
customerCompany.companyLicenses[].created int64 Optional
customerCompany.companyLicenses[].deleted boolean Optional
customerCompany.companyLicenses[].id string Optional
customerCompany.companyLicenses[].licenseExpirationDate int64 Optional
customerCompany.companyLicenses[].licenseNumber string Optional
customerCompany.companyLicenses[].licenseType string

Possible values are:

  • RECREATIONAL
  • MEDICINAL
  • BOTH
Optional
customerCompany.companyLicenses[].modified int64 Optional
customerCompany.companyLicenses[].toDefault boolean Optional
customerCompany.companyLicenses[].updated boolean Optional
customerCompany.companyType string

Possible values are:

  • DISTRIBUTOR
  • CULTIVATOR
  • RETAILER
  • MANUFACTURER
  • TRANSPORTER
  • OTHER
  • TESTING_FACILITY
Optional
customerCompany.connectedShop string Optional
customerCompany.contactPerson string Optional
customerCompany.created int64 Optional
customerCompany.createdBy string Optional
customerCompany.credits number Optional
customerCompany.dbaName string Optional
customerCompany.defaultContactId string Optional
customerCompany.defaultPaymentTerm string Optional
customerCompany.deleted boolean Optional
customerCompany.description string Optional
customerCompany.email string Optional
customerCompany.externalId string Optional
customerCompany.fax string Optional
customerCompany.firstName string Optional
customerCompany.id string Optional
customerCompany.importId string Optional
customerCompany.lastName string Optional
customerCompany.licenceType string

Possible values are:

  • RECREATIONAL
  • MEDICINAL
  • BOTH
Optional
customerCompany.licenseExpirationDate int64 Optional
customerCompany.licenseNumber string Optional
customerCompany.mobileNumber string Optional
customerCompany.modified int64 Optional
customerCompany.name string Optional
customerCompany.notes[] array Optional
customerCompany.notes[].created int64 Optional
customerCompany.notes[].deleted boolean Optional
customerCompany.notes[].enableOnFleet boolean Optional
customerCompany.notes[].id string Optional
customerCompany.notes[].message string Optional
customerCompany.notes[].modified int64 Optional
customerCompany.notes[].updated boolean Optional
customerCompany.notes[].writerId string Optional
customerCompany.notes[].writerName string Optional
customerCompany.phone string Optional
customerCompany.qbVendorRef[] array of object Optional
customerCompany.qbVendorRef[].<key> map of string Optional
customerCompany.relatedEntity boolean Optional
customerCompany.salesPerson string Optional
customerCompany.toDefault boolean Optional
customerCompany.updated boolean Optional
customerCompany.vendorKey string Optional, read only.
customerCompany.vendorType string

Possible values are:

  • CUSTOMER
  • VENDOR
  • BOTH
Optional
customerCompany.website string Optional
customerCompanyId string Optional
deleted boolean Optional
dirty boolean Optional
email string Optional
firstName string Optional
id string Optional
lastName string Optional
modified int64 Optional
note object Note Optional
note.created int64 Optional
note.deleted boolean Optional
note.enableOnFleet boolean Optional
note.id string Optional
note.message string Optional
note.modified int64 Optional
note.updated boolean Optional
note.writerId string Optional
note.writerName string Optional
officeNumber string Optional
phoneNumber string Optional
role string Optional
salutation string Optional
shopId string Optional
updated boolean Optional
userPhoto object CompanyAsset Optional
userPhoto.active boolean Optional
userPhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
userPhoto.companyId string Optional
userPhoto.created int64 Optional
userPhoto.deleted boolean Optional
userPhoto.id string Optional
userPhoto.key string Optional
userPhoto.largeURL string Optional
userPhoto.largeX2URL string Optional
userPhoto.mediumURL string Optional
userPhoto.modified int64 Optional
userPhoto.name string Optional
userPhoto.origURL string Optional
userPhoto.priority int32 Optional
userPhoto.publicURL string Optional
userPhoto.secured boolean Optional
userPhoto.thumbURL string Optional
userPhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
userPhoto.updated boolean Optional