Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Return list of companies in WorkbenchProvides access to Company related data.
Endpoints
CompanyDetailApi
Return company details, people, addresses and attributesThe resources available in this module.
CompanyListApi
Provides API access to the Companies (#/General/CompanyList.aspx) Web Workbench screen.
/api/ |
---|
CompanyListApi | ||||
---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET |
-
POST
Update or create a new company (when Key.CompanyID=0)
CompanyListApi
Return companies list in WorkbenchRetrieve the first 20 companies. | Logged in User | - | - | |
POST | Logged in User | - |
CompanyDetailApi
Provides API access to the Company Detail (#/General/CompanyList.aspx) dialog Web Workbench screen.
/api/ |
---|
CompanyDetailApi | ||||
---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET |
Get list of all companies
company details, people, addresses and attributes. | - | |||
POST |
Models
The definitions of models specific to endpoints in this module.
CompanyApiModel
Property | Type | Description |
---|---|---|
Key | ||
Main | ||
Financials | ||
People | CompanyApiGridLines_GeneralPersonLine | |
Attributes | CompanyApiGridLines_GeneralAttributeLine | |
Addresses | CompanyApiGridLines_GeneralAddressLine | |
Notes | CompanyApiGridLines_GeneralNoteLine |
⬆️ Back to top
GeneralCompanyLine
Property | 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 | 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 | Read Only status. |
ReadonlyMessage | String | Read Only message. |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
GeneralCompanyKey
Property | Type | Description |
---|---|---|
CompanyID | Integer | Code of the company |
⬆️ Back to top
GeneralCompanyMainFields
Property | 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 | Reference. | |
InactiveCompany | Inactive status. | |
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. |
⬆️ Back to top
GeneralCompanyFinancialsFields
Property | 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 | Have tax or not. | |
CashOnly | This company as a cash-only or not | |
UseBuyerCreatedInvoices | Use the BCI/RCTI or not. |
⬆️ Back to top
GeneralPersonLine
Property | Type | Description |
---|---|---|
PersonId | Integer | The unique ID of the Person |
DisplayName | String | Displayed name. |
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 Site 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 first Attribute Group. |
Group2 | String | The second Attribute Group. |
Group3 | String | The Third Attribute Group. |
UpdatedDate | String | Updated date. |
Status | String |
|
ReadonlyFlag | Integer | |
ReadonlyMessage | String | |
OriginalKey | ||
CurrentKey | ||
Key | ||
Index | Integer |
⬆️ Back to top
Examples
Get list of first 20 companies.
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Get the list of all Workbench companies.
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
Create a new company.
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Request
Response
Response sample
|
⬆️ Back to top
On this page
Table of Contents | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|