Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Return list of companies in Workbench.
Endpoints
The resources available in this module.
CompanyListApi
Return companies list in Workbench.
/api/CompanyListApi | |||||
---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | Return first 20 companies. | - | |||
POST | Get list of all companies |
CompanyDetailApi
Return company details, people, addresses and attributes.
/api/CompanyDetailApi | |||||
---|---|---|---|---|---|
Method | Description | Performed As | Request Query | Request Body | Response |
GET | Return company details, people, addresses and attributes. | - |
Models
The definitions of models specific to endpoints in this module.
CompanyApiModel
Field | Type | Description |
---|---|---|
Key | GeneralCompanyKey | |
Main | GeneralCompanyMainFields | |
Financials | GeneralCompanyFinancialsFields | |
People | CompanyApiGridLines_GeneralPersonLine | |
Attributes | CompanyApiGridLines_GeneralAttributeLine | |
Addresses | CompanyApiGridLines_GeneralAddressLine | |
Notes | CompanyApiGridLines_GeneralNoteLine |
GeneralCompanyLine
Field | Type | Description |
---|---|---|
CompanyId | Integer | Unique ID code of the company. |
CompanyName | String | Company name. |
AlphaCode | String | The shorthand code for the company |
ApAccount | String | The AP linking code to the financial system |
ArAccount | String | The AR linking code to the financial system |
CreditStatus | String | The company's credit status is with your organization. |
Location | String | The location has been assigned to this company. |
FinancialCompanyCode | String | The internal Financial Company this company sits under. |
CompanyType | String | The company type of this company. |
Phone | String | Phone number. |
Client | Boolean | This company as a client or not. |
Supplier | Boolean | This company as a supplier or not. |
Subcontractor | Boolean | This company as a Subcontractor or not. |
Other | Boolean | The company is marked as Other type or not. |
Inactive | Boolean | The company is inactive or not. |
GSTNumber | String | The tax identifier for the company. |
Select | ||
CompanyNameValue | Company name. | |
AlphaCodeValue | The shorthand code for the company. | |
ApAccountValue | The AP linking code to the financial system. | |
ArAccountValue | The AR linking code to the financial system. | |
CreditStatusValue | The company's credit status is with your organization. | |
LocationValue | The location has been assigned to this company. | |
FinancialCompanyCodeValue | The internal Financial Company this company sits under. | |
CompanyTypeValue | The company type of this company. | |
PhoneValue | Phone number. | |
CostValue | Price cost? | |
CatalogueValue | ||
Group 1 | String | The group of the company. |
Group 2 | String | The group of the company. |
Group 3 | String | The group of the company. |
UpdatedDate | String | Updated date. |
Status | String | |
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
GeneralCompanyKey
Field | Type | Description |
---|---|---|
CompanyID | Integer | Code of the company |
GeneralCompanyMainFields
Field | Type | Description |
---|---|---|
CompanyID | Code of the company | |
CompanyName | Company name | |
AlphaCode | The shorthand code for the company. | |
CompanyType | The type of the company. | |
PriceCode | Price code of the company. | |
Location | Location has been assigned to company. | |
Branch | ||
FinancialCompany | The internal Financial Company this company sits under. | |
ArAccount | The AR linking code to the financial system | |
ApAccount | The AP linking code to the financial system | |
Currency | The default currency of the company. | |
CompanyReference | ||
InactiveCompany | ||
Client | Marked as Client or not. | |
Supplier | Marked as Supplier or not. | |
Subcontractor | Marked as Subcontractor or not. | |
Other | Marked as Other or not. | |
GSTNumber | The tax identifier for the company. | |
DefaultJobManager | Person as default Job manager. | |
DefaultAccountManager | Person as default Account manager. |
GeneralCompanyFinancialsFields
Field | Type | Description |
---|---|---|
PaymentTerms | The numerical value for days | |
PaymentTermsType | To nominate the payment terms for Job Sales Invoices to this company | |
CreditStatus | The company's credit status is with your organization | |
CashLimit | To nominate a cash limit. | |
BankAccountRef1 | Account details. | |
BankAccountRef2 | Account details. | |
BankAccountRef3 | Account details. | |
UseGST | Include tax on any sales to this company or not | |
CashOnly | This company as a cash-only or not | |
UseBuyerCreatedInvoices | Use the BCI/RCTI with this company or not. |
CompanyApiGridLines_GeneralPersonLine
Field
Type
Description
Rows
Array [GeneralPersonLine]
. |
GeneralPersonLine
Field | Type | Description |
---|---|---|
PersonId | Integer | The unique ID of the Person |
DisplayName | String |
|
Surname | String | Family name |
FirstName | String | First name |
CompanyId | Integer | The company id of the person. |
Company | String | The company name of this person. |
Role | String | Person role. |
JobTitle | String | User's official title. |
EmailAddress | String | Email address. |
MobilePhone | String | Mobile number |
BusinessPhone | String | Working phone number |
IsEmployee | Boolean | The person is an employee or not. |
IsActive | Boolean | The account is active or not. |
Inactive | Boolean | The account status is inactive or not. |
IsBillingContact | Boolean | The person is the billing contact or not. |
IsSiteContact | Boolean | The person is the primary project contact or not. |
IsCommercialContact | Boolean | The person is the Site Contact or not. |
EmployeeNo | String | Employee code |
SelectId | String | |
SelectTag | String | |
Select | ||
PersonIdValue | Code of the person | |
SurnameValue | Surname of the person | |
FirstNameValue | First name of the person. | |
CompanyValue | Company of the person. | |
RoleValue | Person role. | |
JobTitleValue | User's official title. | |
EmailAddressValue | Person email address | |
MobilePhoneValue | Person mobile number | |
BusinessPhoneValue | Person business phone | |
Delete | ||
Group1 | String | The Attribute Group of the first Attribute Category filter |
Group2 | String | The Attribute Group of the second Attribute Category filter |
Group3 | String | The Attribute Group of the third Attribute Category filter |
UpdatedDate | String | Updated date. |
Status | String |
|
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | GeneralPersonKey | |
CurrentKey | GeneralPersonKey | |
Key | GeneralPersonKey | |
Index | Integer |
Examples
Get list of first 20 companies
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Get the list of all Workbench companies
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
⬆️ Back to top
On this page
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|