Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Provides access to Company related data.
Endpoints
The 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 | 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 | Admin User | - | ||
POST | Admin User | - |
Models
The definitions of models specific to endpoints in this module.
CompanyKey
Property | Type | Description |
---|---|---|
CompanyID | Integer | The unique Company ID of the Company |
CompanyLine
Property | Type | Description |
---|---|---|
Key | The unique key for the line. | |
CompanyId | Integer | The unique Company ID of the Company |
CompanyName | String | The name of the Company. |
CompanyNameValue | The name of the Company. | |
AlphaCode | String | The shorthand code for the Company. |
AlphaCodeValue | The shorthand code for the Company. | |
ApAccount | String | The AP linking code to the financial system. |
ApAccountValue | The AP linking code to the financial system. | |
ArAccount | String | The AR linking code to the financial system. |
ArAccountValue | The AR linking code to the financial system. | |
CreditStatus | String | The Company's credit status with your organization. |
CreditStatusValue | The Company's credit status with your organization. | |
Location | String | The location the Company has been assigned to. |
LocationValue | The location the Company has been assigned to. | |
FinancialCompanyCode | String | The internal Financial Company this company sits under. |
FinancialCompanyCodeValue | The internal Financial Company this company sits under. | |
CompanyType | String | The company type of this Company. |
CompanyTypeValue | The company type of this Company. | |
Phone | String | The Phone Number of this Company. |
PhoneValue | The Phone Number of this Company. | |
Client | Boolean | The Client flag on the Company. |
Supplier | Boolean | The Supplier flag on the Company. |
Subcontractor | Boolean | The Subcontractor flag on the Company. |
Other | Boolean | The Other flag on the Company. |
Inactive | Boolean | The Inactive flag on the Company. |
GSTNumber | String | The tax identifier for the Company. |
CostValue | CellData | (if GridRequestParametersApi.IntValue2 is populated with an ItemID) The Cost on the Catalogue Line |
CatalogueValue | CellData | (if GridRequestParametersApi.IntValue2 is populated with an ItemID) The Name of the Catalogue |
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 | DateTime | The Date this record was last updated. |
CompanyApiModel
Property | Type | Description |
---|---|---|
Key | ||
Main | ||
Financials | ||
People.Rows | CompanyApiGridLines_GeneralPersonLineArray<PersonLine> | |
AttributesCompanyApiGridLines_GeneralAttributeLine.Rows | Array<AttributeLine> | |
CompanyInsurance.Rows | Array<CompanyInsuranceLine> | |
Addresses.Rows | CompanyApiGridLines_GeneralAddressLineArray<AddressLine> | |
NotesCompanyApiGridLines_GeneralNoteLine.Rows | Array<NoteLine> | |
ToDoItems.Rows | Array<ToDoLine> |
⬆️ Back to top
CompanyMainFields
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 | The Branch the Company belongs to. | |
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
CompanyFinancialsFields
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
PersonLine
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 | ||||
---|---|---|---|---|
|