Companies

Manage company records including customers, vendors, carriers, and franchisees. Companies are the core entities in the system that can place orders, provide services, or act as shipping partners.

Quick Reference

Method	Endpoint	Description
GET	/api/companies/{id}	Get company by ID
GET	/api/companies/{companyId}/details	Get company details
GET	/api/companies/availableByCurrentUser	Get companies available to current user
GET	/api/companies/search	Search companies
POST	/api/companies/search/v2	Advanced company search
POST	/api/companies/list
POST	/api/companies/simplelist
GET	/api/companies/{companyId}/fulldetails	Get complete company information
PUT	/api/companies/{companyId}/fulldetails	Update complete company information
POST	/api/companies/fulldetails
GET	/api/companies/infoFromKey
GET	/api/companies/{companyId}/geosettings
POST	/api/companies/{companyId}/geosettings
GET	/api/companies/geosettings
POST	/api/companies/filteredCustomers
GET	/api/companies/{companyId}/carrierAcounts
POST	/api/companies/{companyId}/carrierAcounts
GET	/api/companies/{companyId}/capabilities
POST	/api/companies/{companyId}/capabilities
GET	/api/companies/{companyId}/packagingsettings
POST	/api/companies/{companyId}/packagingsettings
GET	/api/companies/{companyId}/inheritedPackagingTariffs
GET	/api/companies/{companyId}/packaginglabor
POST	/api/companies/{companyId}/packaginglabor
GET	/api/companies/{companyId}/inheritedpackaginglabor
GET	/api/companies/geoAreaCompanies
GET	/api/companies/brands
GET	/api/companies/brandstree
GET	/api/companies/{companyId}/franchiseeAddresses

GET /api/companies/{id}

Get company by ID

Retrieves detailed information about a specific company using its unique identifier.

Parameters:

Path Parameters:

• id (string, path) (required): No description available

Response Type:

CompanyBasic

See the model documentation for detailed field descriptions.

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{id}"
,
    id="789e0123-e89b-12d3-a456-426614174002"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

GET /api/companies/{companyId}/details

Get company details

Retrieves comprehensive details about a company including contacts, addresses, settings, and financial information.

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Response Type:

CompanyDetails

See the model documentation for detailed field descriptions.

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/details"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "companyID": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "companyName": "Training",
  "companyCode": "TRAINING",
  "companyEmail": "training@abconnect.co",
  "companyPhone": "8009814202",
  "mainAddress": {
    "id": 407491,
    "address1": "2534 Vista Dr",
    "city": "Castle Rock",
    "state": "CO",
    "zipCode": "80104",
    "latitude": 39.2942344,
    "longitude": -104.8221147
  },
  "companyInfo": {
    "companyId": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
    "companyName": "Training",
    "companyCode": "TRAINING",
    "isThirdParty": false,
    "isActive": true
  }
}

---

GET /api/companies/availableByCurrentUser

Get companies available to current user

Returns a list of companies that the currently authenticated user has permission to access.

Response Type:

Array of CompanyBasic objects

See the model documentation for detailed field descriptions.

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/availableByCurrentUser"

)

# Process the response
print(response)

Sample Response:

[
  {
    "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
    "code": "TRAINING",
    "name": "Training",
    "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
  }
]

---

GET /api/companies/search

Search companies

Search for companies using various filters such as name, code, type, or location.

Parameters:

Query Parameters:

• searchValue (string, query): No description available

Response Type:

Array of CompanyBasic objects

See the model documentation for detailed field descriptions.

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/search"

)

# Process the response
print(response)

Sample Response:

[]

---

POST /api/companies/search/v2

Advanced company search

Perform advanced searches on companies with complex filtering, sorting, and pagination options.

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/search/v2"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

[]

---

POST /api/companies/list

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/list"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

POST /api/companies/simplelist

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/simplelist"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/companies/{companyId}/fulldetails

Get complete company information

Retrieves all available information about a company including details, preferences, capabilities, pricing, and insurance settings.

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Response Type:

CompanyFullDetails

See the model documentation for detailed field descriptions.

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/fulldetails"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "details": {
    "displayId": "694618",
    "name": "Training",
    "code": "TRAINING",
    "parentId": "5e2eefc1-d616-e911-b00c-00155d426802",
    "companyTypeId": "e7f85166-34cf-429b-805d-261b44cb0c04",
    "phone": "8009814202",
    "email": "training@abconnect.co",
    "isActive": true
  },
  "preferences": {
    "isQbUser": false,
    "skipIntacct": true,
    "pzCode": "PZ100"
  },
  "capabilities": 135,
  "address": {
    "id": 407491,
    "address1": "2534 Vista Dr",
    "city": "Castle Rock",
    "state": "CO",
    "zipCode": "80104"
  },
  "pricing": {
    "transportationCharge": {
      "baseTripFee": 100.0,
      "baseTripMile": 3000.0
    },
    "transportationMarkups": {
      "wholeSale": 1.0,
      "base": 1.25,
      "medium": 2.3,
      "high": 2.5
    }
  }
}

---

PUT /api/companies/{companyId}/fulldetails

Update complete company information

Updates all company information including details, preferences, capabilities, pricing, and insurance settings.

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.put(
    "/api/companies/{companyId}/fulldetails"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{}

---

POST /api/companies/fulldetails

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/fulldetails"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{}

---

GET /api/companies/infoFromKey

Parameters:

Query Parameters:

• key (string, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/infoFromKey"

)

# Process the response
print(response)

Sample Response:

{
  "status": "success",
  "data": {}
}

---

GET /api/companies/{companyId}/geosettings

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/geosettings"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

POST /api/companies/{companyId}/geosettings

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/{companyId}/geosettings"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/companies/geosettings

Parameters:

Query Parameters:

• Latitude (number, query): No description available

• Longitude (number, query): No description available

• milesRadius (integer, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/geosettings"

)

# Process the response
print(response)

Sample Response:

[]

---

POST /api/companies/filteredCustomers

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/filteredCustomers"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/companies/{companyId}/carrierAcounts

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/carrierAcounts"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

POST /api/companies/{companyId}/carrierAcounts

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/{companyId}/carrierAcounts"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/companies/{companyId}/capabilities

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/capabilities"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

POST /api/companies/{companyId}/capabilities

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/{companyId}/capabilities"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/companies/{companyId}/packagingsettings

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/packagingsettings"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

POST /api/companies/{companyId}/packagingsettings

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/{companyId}/packagingsettings"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/companies/{companyId}/inheritedPackagingTariffs

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Query Parameters:

• inheritFrom (string, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/inheritedPackagingTariffs"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

GET /api/companies/{companyId}/packaginglabor

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/packaginglabor"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

POST /api/companies/{companyId}/packaginglabor

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.post(
    "/api/companies/{companyId}/packaginglabor"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"
,
    data=
    {
        "example": "data"
}

)

# Process the response
print(response)

Sample Response:

{
  "id": "789e0123-e89b-12d3-a456-426614174002",
  "status": "created",
  "message": "Resource created successfully"
}

---

GET /api/companies/{companyId}/inheritedpackaginglabor

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Query Parameters:

• inheritFrom (string, query): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/inheritedpackaginglabor"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}

---

GET /api/companies/geoAreaCompanies

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/geoAreaCompanies"

)

# Process the response
print(response)

Sample Response:

[]

---

GET /api/companies/brands

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/brands"

)

# Process the response
print(response)

Sample Response:

[]

---

GET /api/companies/brandstree

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/brandstree"

)

# Process the response
print(response)

Sample Response:

{
  "status": "success",
  "data": {}
}

---

GET /api/companies/{companyId}/franchiseeAddresses

Parameters:

Path Parameters:

• companyId (string, path) (required): No description available

Example Request:

PythonCLIcurl

from ABConnect import ABConnectAPI

# Initialize the API client
api = ABConnectAPI()

# Make the API call
response = api.raw.get(
    "/api/companies/{companyId}/franchiseeAddresses"
,
    companyId="ed282b80-54fe-4f42-bf1b-69103ce1f76c"

)

# Process the response
print(response)

Sample Response:

{
  "id": "ed282b80-54fe-4f42-bf1b-69103ce1f76c",
  "code": "TRAINING",
  "name": "Training",
  "parentCompanyId": "5e2eefc1-d616-e911-b00c-00155d426802"
}