Firm
GET {{base_url}}/firm/:ClientID
Use this endpoint to retrieve a single firm from the Firms hub by specifying the firm's clientID.
Response
| Field | Description |
|---|---|
| Clientid | Unique identifier of the client record |
| Client | Unique number identifier for the client |
| Name | Full name of the firm |
| Status | Afor Active.D forDormant .I forInactive". |
| ExportInd | Yindicates the export option is selected on the General tab of the UI. Nindicates the export option is not selected. Default: N. |
| WebSite | Publicly available website address |
| Memo | Notes about the object |
| CurrentStatus | Current client status. Valid values from CodeTable: CFGClientCurrentStatus. |
| CustomCurrencyCode | Three digit code that a user chooses to define the type of currency used. Valid values from CodeTable: FW_CFGCurrency. |
| ClientInd | Yindicates the client / firm option is selected on the General tab of the UI. Nindicates the firm option is not selected. |
| VendorInd | Yindicates the vendor option is selected on the General tab of the UI. Nindicates the vendor option is not selected. |
| PriorWork | Yindicates that the consultant's vendor record has prior work selected. Nindicates that the consultant's vendor record does not have prior work selected. |
| Recommend | Yindicates that the consultant's vendor record has recommended selected. Nindicates that the consultant's vendor record does not have recommended selected. |
| DisadvBusiness | Yindicates the business is owned or controlled by 51% or more disadvantaged persons. Nindicates the business does not self-represent their status as disadvantaged. |
| DisabledVetOwnedSmallBusiness | Yindicates the small business is owned or controlled by 51% or more service-disabled veterans. Nindicates the small business does not self-represent their status as being owned or controlled by service-disabled veterans. |
| HBCU | Yindicates the organization is classified as a historically black college and university HBCU or minority institution. Nindicates the organization is not classified as an HBCU or minority institution. |
| MinorityBusiness | Yindicates the business is classified as a for profit enterprise and owned, operated and controlled by minority group members. Nindicates the business is not classified as a minority owned business. |
| SmallBusiness | Yfirm self-represents their status as being a small business. Nindicates the business is not a small business. |
| VetOwnedSmallBusiness | Yindicates the small business is owned or controlled by 51% or more veterans. Nindicates the small business does not self-represent their status as being owned or controlled by veterans. |
| WomanOwned | Yindicates the small business is owned by a woman or the minimum women required to met the designation. Nindicates the small business is not owned by a woman. |
| AlaskaNative | Yindicates the small business is majority owned or controlled by Alaska Natives. Nindicates the small business is not majority owned by a Alaskan Natives. |
| SpecialtyType | Value of the selected specialty field in the linked vendor record |
| Specialty | Text of the specialty description in the linked vendor record |
| ParentID | Unique identifier for the top parent level of the firm |
| ParentLevel1 | Unique identifier for parent level 1 of the firm |
| ParentLevel2 | Unique identifier for parent level 2 of the firm |
| ParentLevel3 | Unique identifier for parent level 3 of the firm |
| ParentLevel4 | Unique identifier for parent level 4 of the firm |
| Employees | >Number of employees that a firm has |
| AnnualRevenue | Total revenue generated by services for a given fiscal year where the fiscal calendar is defined by accounting |
| GovernmentAgency | Yindicates this firm record is a government agency. Nindicates that this firm is not a government agency. |
| Competitor | Yindicates that this business is a competitor to your firm. Nindicates that this business is not a competitor to your firm. |
| EightA | Yindicates that this business qualifies for the socioeconomic status of 8(a). Nindicates that this business does not qualify for the 8(a) status. |
| HUBZone | Yindicates that the business qualifies for the socioeconomic status of Historically Underutilized Business Zone HUBZone. Nindicates that the business does not qualify for HUBZone status. |
| IQID | ID from the IQ system for imported clients |
| Incumbent | Yindicates the firm is an incumbent, official currently holding office, from the IQ system. Nindicates that the firm is not an incumbent. |
| AjeraSync | Indicates whether or not the Ajera module is active |
| TLInternalKey | TrafficLIVE internal key |
| TLSyncModDate | Date and timestamp when TrafficLIVE synchronization occurred |
| Owner | Employee who is the designated owner |
| Vendor | Consultant or partner name |
| SortName | Employee name ordered as lastname, firstnamefor sorting purposes |
| Category | Category for the vendor type such as consultant, employee, trade, or other. Valid values from CodeTable: CFGVendorType. |
| AvailableForCRM | Yindicates that the record is available to CRM users. Nindicates that the record is not available to CRM users. |
| ReadyForApproval | Yindicates that the record is available for approval by accounting users. Nindicates that the record is not ready for approval. |
| ReadyForProcessing | Yindicates that the record is approved for use in transaction processing. Nthe record is not ready. |
| FedID | Federal tax identification number |
| Org | Client defined value that defines the organization up to 5 sublevels. Each level is two characters and are each separated by a user-defined delimiter. Sample valid values SF:AR:00:TS, BO:EN, CO:00, DC:AD. |
| Type | Client type. Valid values from CodeTable: CFGClientType. |
| TypeOfTIN | Identifies the type of taxpayer identification number. 1for FEINthe federal employer identification number. 2for SSN, ITIN, ATINthe social security number, individual taxpayer identification number, adoption taxpayer identification number. |
| SFID | Globally unique Salesforce identifier |
| SFLastModifiedDate | Date and the time Salesforce was last changed |
| VName | Alphanumeric short string identifier for the consultant or partner name |
| ParentName | Name of the parent firm |
| emParentfl | Full name of the parent organization |
| CreateUser | Name of the person who created the new record |
| CreateDate | Date and timestamp when the new record was created |
| ModUser | Name of the person who modified an existing record of this type |
| ModDate | Date and timestamp when the existing record of this type was modified |
| TopTPStartDate | Date and timestamp of the most recent touchpoint that shows in the activities list |
| TopTPSubject | Activity name that displays as the last activity subject from for the most recent touchpoint |
| TopTPContactID | Unique identifier for the contact associated with the most recent touchpoint |
| TopTPCreateEmployee | Employee identifier for the most recent touchpoint |
| TopTPCreateUserName | Username of the user who created the most recent touchpoint |
| OrgName | Name of the organization |
| emOwner | Identifier of the employee designated as the owner |
| emOwnerfl | Full name of the employee designated as the owner |
| emOwnerPhone | Phone number of the employee designated as the owner |
| emOwnerEmail | Email address of the employee designated as the owner |
| emOwnerTitle | Title of the employee designated as the owner |
| emOwnerLocation | Location of the employee designated as the owner |
| HasPhoto | 0 or 1. 0 - The object does not have a photo. 1 - The object does have a photo. |
| PhotoModDate | Date and timestamp of when the photo was updated |
| PrimaryAddress1 | Line 1 of the payment address |
| PrimaryAddress2 | Line 2 of the payment address |
| PrimaryAddress3 | Line 3 of the payment address |
| PrimaryAddress4 | Line 4 of the payment address |
| PrimaryCity | City of the payment address |
| PrimaryState | State of the payment address |
| PrimaryZip | Postal or zip code of the payment address |
| PrimaryCountry | Country of the payment address |
| PrimaryPhone | Phone number for the payment address |
| PrimaryFax | Fax number for the payment address |
| PrimaryEmail | Email address for payment |
| BillingAddress1 | Line 1 of the billing address |
| BillingAddress2 | Line 2 of the billing address |
| BillingAddress3 | Line 3 of the billing address |
| BillingAddress4 | Line 4 of the billing address |
| BillingCity | City of the billing address |
| BillingState | State of the billing address |
| BillingZip | Postal or zip code of the billing address |
| BillingCountry | Country of the billing address |
| BillingPhone | Phone number for the billing address |
| BillingFax | Fax number for the billing address |
| BillingEmail | Email address for billing |
| PaymentAddress1 | Line 1 of the payment address |
| PaymentAddress2 | Line 2 of the payment address |
| PaymentAddress3 | Line 3 of the payment address |
| PaymentAddress4 | Line 4 of the payment address |
| PaymentCity | City of the payment address |
| PaymentState | State of the payment address |
| PaymentZip | Postal or zip code of the payment address |
| PaymentCountry | Country of the payment address |
| PaymentPhone | Phone number for the payment address |
| PaymentFax | Fax number for the payment address |
| PaymentEmail | Email address for payment |
| QBOID | Identifier of the Quickbooks client or vendor |
| QBOLastUpdated | Date and time the Quickbooks transaction was last changed |
| HasHierarchy | Yindicates the firm has a hierarchy of levels. Nindicates that the firm does not have a hierarchy of levels. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: OK
[{"ClientID":"ADMIN1159973315458","Client":"7EX0000000","Name":"Andrew Payne Assoc.","Status":"A","ExportInd":"N","WebSite":"","Memo":"","CurrentStatus":"Existing","CustomCurrencyCode":"USD","ClientInd":"Y","VendorInd":"N","PriorWork":"N","Recommend":"N","DisadvBusiness":"N","DisabledVetOwnedSmallBusiness":"N","HBCU":"N","MinorityBusiness":"N","SmallBusiness":"N","VetOwnedSmallBusiness":"N","WomanOwned":"N","AlaskaNative":"N","SpecialtyType":"","Specialty":"","ParentID":"","ParentLevel1":"","ParentLevel2":"","ParentLevel3":"","ParentLevel4":"","Employees":0,"AnnualRevenue":0,"GovernmentAgency":"N","Competitor":"N","EightA":"N","HUBZone":"N","IQID":"","Incumbent":"N","AjeraSync":"N","TLInternalKey":"","TLSyncModDate":"","Owner":"","Vendor":"","SortName":"","Category":"","AvailableForCRM":"Y","ReadyForApproval":"Y","ReadyForProcessing":"N","FedID":"","Org":"","Type":"05","TypeOfTIN":"","SFID":"","SFLastModifiedDate":"","VName":"","ParentName":"","emParentfl":"","CreateUser":"Brenda Gray, PE","CreateDate":"2006-10-04T14:51:40.000","ModUser":"Brenda Gray, PE","ModDate":"2016-03-14T21:52:08.567","TopTPStartDate":"2008-11-06T18:00:44.627","TopTPSubject":"Report: Client Audit","TopTPContactID":"","TopTPCreateEmployee":"00101","TopTPCreateUserName":"ADMIN","OrgName":"","emOwner":"","emOwnerfl":"","emOwnerPhone":"","emOwnerEmail":"","emOwnerTitle":"","emOwnerLocation":"","HasPhoto":0,"PhotoModDate":"","PrimaryAddress1":"","PrimaryAddress2":"","PrimaryAddress3":"","PrimaryAddress4":"","PrimaryCity":"","PrimaryState":"","PrimaryZip":"","PrimaryCountry":"","PrimaryPhone":"","PrimaryFax":"","PrimaryEmail":"","BillingAddress1":"","BillingAddress2":"","BillingAddress3":"","BillingAddress4":"","BillingCity":"","BillingState":"","BillingZip":"","BillingCountry":"","BillingPhone":"","BillingFax":"","BillingEmail":"","PaymentAddress1":"","PaymentAddress2":"","PaymentAddress3":"","PaymentAddress4":"","PaymentCity":"","PaymentState":"","PaymentZip":"","PaymentCountry":"","PaymentPhone":"","PaymentFax":"","PaymentEmail":"","QBOID":"","QBOLastUpdated":"","HasHierarchy":0,"custClientType":"","custNotes":"","custCheckBox":"N","custCUR":0,"custLEAD":"","desc_custLEAD":"","custDate":"","custORG":"","desc_custORG":"","custClientManager":"","desc_custClientManager":"","custtest":"","custRIGHT":"","custLEFT":""}]