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

/api/CompanyListApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve the first 20 companies.	Logged in User	-	-	GridResult<CompanyLine>
POST Retrieve a filtered list of companies.	Logged in User	-	GridRequestParametersApi	GridResult<CompanyLine>

CompanyDetailApi

Provides API access to the Company Detail (#/General/CompanyList.aspx) dialog Web Workbench screen.

/api/CompanyDetailApi

/api/CompanyDetailApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieve a specific Company (including details, people, addresses and attributes).	Admin User	CompanyKey	-	CompanyApiModel
POST Update a Company ( or create, when Key.CompanyID = 0)	Admin User	-	CompanyApiModel	CompanyApiModel

Models

The definitions of models specific to endpoints in this module.

CompanyKey

Property	Type	Description

Property	Type	Description
CompanyID	Integer	The unique Company ID of the Company

CompanyLine

Property	Type	Description

Property	Type	Description
Key	CompanyKey	The unique key for the line.
CompanyId	Integer	The unique Company ID of the Company.
CompanyName	String	The name of the Company.
CompanyNameValue	CellData	The name of the Company.
AlphaCode	String	The shorthand code for the Company.
AlphaCodeValue	CellData	The shorthand code for the Company.
ApAccount	String	The AP linking code to the financial system.
ApAccountValue	CellData	The AP linking code to the financial system.
ArAccount	String	The AR linking code to the financial system.
ArAccountValue	CellData	The AR linking code to the financial system.
CreditStatus	String	The Company's credit status with your organization.
CreditStatusValue	CellData	The Company's credit status with your organization.
Location	String	The location the Company has been assigned to.
LocationValue	CellData	The location the Company has been assigned to.
FinancialCompanyCode	String	The internal Financial Company this company sits under.
FinancialCompanyCodeValue	CellData	The internal Financial Company this company sits under.
CompanyType	String	The company type of this Company.
CompanyTypeValue	CellData	The company type of this Company.
Phone	String	The Phone Number of this Company.
PhoneValue	CellData	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

Property	Type	Description
Key	CompanyKey	The unique key of the Company.
Main	CompanyMainFields	General data associated with the Company.
Financials	CompanyFinancialsFields	Financial data associated with the Company.
People.Rows	Array<PersonLine>	People associated with the Company.
Attributes.Rows	Array<AttributeLine>	Attributes associated with the Company.
CompanyInsurance.Rows	Array<CompanyInsuranceLine>	Company Insurances associated with the Company.
Addresses.Rows	Array<AddressLine>	Addresses associated with the Company.
Notes.Rows	Array<NoteLine>	Notes associated with the Company.
ToDoItems.Rows	Array<ToDoLine>	To Do Items associated with the Company.

Back to top

CompanyMainFields

Property	Type	Description

Property	Type	Description
CompanyID	StringViewData	The unique Company ID of the Company.
CompanyName	StringViewData	The name of the Company.
AlphaCode	StringViewData	The shorthand code for the Company.
CompanyType	DropdownViewData	The type of the Company.
PriceCode	PickerViewData	Price code of the Company.
Location	PickerViewData	The location the Company has been assigned to.
Branch	StringViewData	The Branch the Company belongs to.
FinancialCompany	DropdownViewData	The internal Financial Company this Company sits under.
ArAccount	StringViewData	The AR linking code to the financial system.
ApAccount	StringViewData	The AP linking code to the financial system.
Currency	PickerViewData	The default Currency of the Company.
CompanyReference	StringViewData	The reference.
InactiveCompany	BoolViewData	The Inactive flag on the Company.
Client	BoolViewData	The Client flag on the Company.
Supplier	BoolViewData	The Supplier flag on the Company.
Subcontractor	BoolViewData	The Subcontractor flag on the Company.
Other	BoolViewData	The Other flag on the Company.
GSTNumber	StringViewData	The tax identifier for the Company.
DefaultJobManager	PickerViewData	The Person who is the default Job Manager.
DefaultAccountManager	PickerViewData	The Person who is the default Account Manager.

Back to top

CompanyFinancialsFields

Property	Type	Description

Property	Type	Description
PaymentTerms	DecimalViewData	The numerical value for days
PaymentTermsType	DropdownViewData	To nominate the payment terms for Job Sales Invoices to this company
CreditStatus	DropdownViewData	The company's credit status is with your organization
CashLimit	DecimalViewData	To nominate a cash limit.
BankAccountRef1	StringViewData	Account details.
BankAccountRef2	StringViewData	Account details.
BankAccountRef3	StringViewData	Account details.
UseGST	BoolViewData	Have tax or not.
CashOnly	BoolViewData	This company as a cash-only or not
UseBuyerCreatedInvoices	BoolViewData	Use the BCI/RCTI or not.

Back to top

CompanyInsuranceKey

Property	Type	Description

Property	Type	Description
CompanyInsuranceID	Integer	The unique ID of the Company Insurance.
CompanyID	Integer	The ID of the Company this belongs to.

CompanyInsuranceLine

Property	Type	Description

Property	Type	Description
Key	CompanyInsuranceKey	The unique key for the line.
Type	String	The description of the Insurance Type.
TypeValue	CellData	The description of the Insurance Type.
Number	String	The Insurance Certificate Number.
Numbervalue	CellData	The Insurance Certificate Number.
ExpiryDate	DateTime	The Insurance Expiry Date.
Insurer	String	The Insurance name.
InsurerValue	CellData	The Insurance name.
Cover	Decimal	The Insurance limit.
CoverValue	CellData	The Insurance limit.
Excess	Decimal	The Insurance excess.
ExcessValue	CellData	The Insurance excess.
Subcontract	String	The description of the Subcontract.
SubcontractValue	CellData	The description of the Subcontract.
Description	String	The description of the Company Insurance.
DescriptionValue	CellData	The description of the Company Insurance.
Details	String	The details on the Company Insurance.
DetailsValue	CellData	The details on the Company Insurance.
Reviewed	Boolean	The Reviewed flag on the Company Insurance.

AddressKey

Property	Type	Description

Property	Type	Description
AddressID	Integer	The unique ID of the Address.

AddressLine

Property	Type	Description

Property	Type	Description
Key	AddressKey	The unique key for the line.
Title	String	The Address Title.
TitleValue	CellData	The Address Title.
Line1	String	Street line 1 information.
Line1Value	CellData	Street line 1 information.
Line2	String	Street line 2 information.
Line2Value	CellData	Street line 2 information.
Phone	String	The phone number on the address.
PhoneValue	CellData	The phone number on the address.
PostCode	String	The post code of the Address.
PostCodeValue	CellData	The post code of the Address.
Inactive	Boolean	The Reviewed flag on the Address.
IsPostalAddress	Boolean	A flag to indicate if the Address is the Postal Address of the Company.
IsPhysicalAddress	Boolean	A flag to indicate if the Address is the Physical Address of the Company.

Examples

Get list of first 20 companies.

Request

Response

GridResult_GeneralCompanyLine {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[GeneralCompanyLine], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
GeneralCompanyLine {
CompanyId (integer, optional),
CompanyName (string, optional),
AlphaCode (string, optional),
ApAccount (string, optional),
ArAccount (string, optional),
CreditStatus (string, optional),
Location (string, optional),
FinancialCompanyCode (string, optional),
CompanyType (string, optional),
Phone (string, optional),
Client (boolean, optional),
Supplier (boolean, optional),
Subcontractor (boolean, optional),
Other (boolean, optional),
Inactive (boolean, optional),
GSTNumber (string, optional),
Select (CellData, optional),
CompanyNameValue (CellData, optional),
AlphaCodeValue (CellData, optional),
ApAccountValue (CellData, optional),
ArAccountValue (CellData, optional),
CreditStatusValue (CellData, optional),
LocationValue (CellData, optional),
FinancialCompanyCodeValue (CellData, optional),
CompanyTypeValue (CellData, optional),
PhoneValue (CellData, optional),
CostValue (CellData, optional),
CatalogueValue (CellData, optional),
Group1 (string, optional),
Group2 (string, optional),
Group3 (string, optional),
UpdatedDate (string, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (GeneralCompanyKey, optional),
CurrentKey (GeneralCompanyKey, optional),
Key (GeneralCompanyKey, optional),
Index (integer, optional)
}
ViewData_GridWidget {
WidgetId (integer, optional),
LayoutCode (string, optional),
Name (string, optional),
Colour (string, optional),
BGColour (string, optional),
Icon (string, optional),
Type (string, optional),
Visible (boolean, optional),
Order (integer, optional),
Count (integer, optional),
WidgetLines (Array[ViewData_GridWidgetLine], optional)
}
CellData {
CellId (string, optional),
CellValue (string, optional),
CellNumValue (number, optional),
CellBoolValue (boolean, optional),
CellTag (string, optional),
CellValueDate (string, optional),
CellValueInt (integer, optional)
}
GeneralCompanyKey {
CompanyId (integer)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Response sample

{
  "total": 15,
  "page": 1,
  "records": 285,
  "rows": [
    {
      "CompanyId": 596,
      "CompanyName": " Adatum Sandbox",
      "AlphaCode": "ADATUMCORP",
      "ApAccount": "10001",
      "ArAccount": "10000",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "03",
      "CompanyType": "GEN",
      "Phone": "22222221111",
      "Client": true,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "GSTNumber": "31608459409",
      "Select": {
        "CellId": "596",
        "CellValue": " Adatum Sandbox",
        "CellTag": " Adatum Sandbox"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": " Adatum Sandbox",
        "CellTag": "openDialog(\"596\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ADATUMCORP"
      },
      "ApAccountValue": {
        "CellValue": "10001"
      },
      "ArAccountValue": {
        "CellValue": "10000"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "03",
        "CellValue": "03 : ASIA / PACIFIC LABOUR (Business Cent)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "22222221111"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-09-22T03:00:51.4565009+00:00",
      "OriginalKey": {
        "CompanyId": 596
      },
      "CurrentKey": {
        "CompanyId": 596
      },
      "Key": {
        "CompanyId": 596
      },
      "Index": 0
    },
    {
      "CompanyId": 738,
      "CompanyName": "132 Collins",
      "AlphaCode": "132COLLINS",
      "ApAccount": "123COLL",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "04",
      "CompanyType": "GEN",
      "Phone": " 03 3699876",
      "Client": false,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "738",
        "CellValue": "132 Collins",
        "CellTag": "132 Collins"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "132 Collins",
        "CellTag": "openDialog(\"738\")"
      },
      "AlphaCodeValue": {
        "CellValue": "132COLLINS"
      },
      "ApAccountValue": {
        "CellValue": "123COLL"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "04",
        "CellValue": "04 : ASIA / PACIFIC RECYCLING (Xero)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": " 03 3699876"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2024-02-26T23:23:24.3840362+00:00",
      "OriginalKey": {
        "CompanyId": 738
      },
      "CurrentKey": {
        "CompanyId": 738
      },
      "Key": {
        "CompanyId": 738
      },
      "Index": 0
    },
    {
      "CompanyId": 749,
      "CompanyName": "3M International 3",
      "AlphaCode": "3M INTERNA",
      "ArAccount": "3M",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Client": true,
      "Supplier": false,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "749",
        "CellValue": "3M International 3",
        "CellTag": "3M International 3"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "3M International 3",
        "CellTag": "openDialog(\"749\")"
      },
      "AlphaCodeValue": {
        "CellValue": "3M INTERNA"
      },
      "ApAccountValue": {},
      "ArAccountValue": {
        "CellValue": "3M"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {},
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2024-02-29T02:47:23.487+00:00",
      "OriginalKey": {
        "CompanyId": 749
      },
      "CurrentKey": {
        "CompanyId": 749
      },
      "Key": {
        "CompanyId": 749
      },
      "Index": 0
    },
    {
      "CompanyId": 617,
      "CompanyName": "3M International 3",
      "AlphaCode": "3M INTERNA",
      "ApAccount": "4M",
      "ArAccount": "3M",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "02",
      "CompanyType": "GEN",
      "Client": true,
      "Supplier": false,
      "Subcontractor": true,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "617",
        "CellValue": "3M International 3",
        "CellTag": "3M International 3"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "3M International 3",
        "CellTag": "openDialog(\"617\")"
      },
      "AlphaCodeValue": {
        "CellValue": "3M INTERNA"
      },
      "ApAccountValue": {
        "CellValue": "4M"
      },
      "ArAccountValue": {
        "CellValue": "3M"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "02",
        "CellValue": "02 : ASIA / PACIFIC EQUIPMENT (MYOB-ADV)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {},
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-08-10T02:28:35.8535551+00:00",
      "OriginalKey": {
        "CompanyId": 617
      },
      "CurrentKey": {
        "CompanyId": 617
      },
      "Key": {
        "CompanyId": 617
      },
      "Index": 0
    },
    {
      "CompanyId": 613,
      "CompanyName": "7-Eleven",
      "AlphaCode": "7_ELEVEN",
      "ApAccount": "6621",
      "ArAccount": "X001",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "04",
      "CompanyType": "GEN",
      "Phone": "  ",
      "Client": true,
      "Supplier": false,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "613",
        "CellValue": "7-Eleven",
        "CellTag": "7-Eleven"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "7-Eleven",
        "CellTag": "openDialog(\"613\")"
      },
      "AlphaCodeValue": {
        "CellValue": "7_ELEVEN"
      },
      "ApAccountValue": {
        "CellValue": "6621"
      },
      "ArAccountValue": {
        "CellValue": "X001"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "04",
        "CellValue": "04 : ASIA / PACIFIC RECYCLING (Xero)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "  "
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-03-12T00:02:07.2149894+00:00",
      "OriginalKey": {
        "CompanyId": 613
      },
      "CurrentKey": {
        "CompanyId": 613
      },
      "Key": {
        "CompanyId": 613
      },
      "Index": 0
    },
    {
      "CompanyId": 712,
      "CompanyName": "7-Eleven",
      "AlphaCode": "7_ELEVEN",
      "ArAccount": "7Elev1",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "  ",
      "Client": true,
      "Supplier": false,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "712",
        "CellValue": "7-Eleven",
        "CellTag": "7-Eleven"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "7-Eleven",
        "CellTag": "openDialog(\"712\")"
      },
      "AlphaCodeValue": {
        "CellValue": "7_ELEVEN"
      },
      "ApAccountValue": {},
      "ArAccountValue": {
        "CellValue": "7Elev1"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "  "
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-07-20T04:34:49.7561455+00:00",
      "OriginalKey": {
        "CompanyId": 712
      },
      "CurrentKey": {
        "CompanyId": 712
      },
      "Key": {
        "CompanyId": 712
      },
      "Index": 0
    },
    {
      "CompanyId": 645,
      "CompanyName": "A & B CONSTRUCTIONS LTD",
      "AlphaCode": "A&BCONSTRU",
      "ApAccount": "20044",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "6582999231",
      "Client": false,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "GSTNumber": "11 223 344 555",
      "Select": {
        "CellId": "645",
        "CellValue": "A & B CONSTRUCTIONS LTD",
        "CellTag": "A & B CONSTRUCTIONS LTD"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "A & B CONSTRUCTIONS LTD",
        "CellTag": "openDialog(\"645\")"
      },
      "AlphaCodeValue": {
        "CellValue": "A&BCONSTRU"
      },
      "ApAccountValue": {
        "CellValue": "20044"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "6582999231"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-03-31T11:22:12.003+00:00",
      "OriginalKey": {
        "CompanyId": 645
      },
      "CurrentKey": {
        "CompanyId": 645
      },
      "Key": {
        "CompanyId": 645
      },
      "Index": 0
    },
    {
      "CompanyId": 498,
      "CompanyName": "A & B CONSTRUCTIONS PTY LTD",
      "AlphaCode": "A & B CONS",
      "ApAccount": "266",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "7762800461",
      "Client": false,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "498",
        "CellValue": "A & B CONSTRUCTIONS PTY LTD",
        "CellTag": "A & B CONSTRUCTIONS PTY LTD"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "A & B CONSTRUCTIONS PTY LTD",
        "CellTag": "openDialog(\"498\")"
      },
      "AlphaCodeValue": {
        "CellValue": "A & B CONS"
      },
      "ApAccountValue": {
        "CellValue": "266"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "7762800461"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2022-04-25T21:14:14.9809085+00:00",
      "OriginalKey": {
        "CompanyId": 498
      },
      "CurrentKey": {
        "CompanyId": 498
      },
      "Key": {
        "CompanyId": 498
      },
      "Index": 0
    },
    {
      "CompanyId": 521,
      "CompanyName": "ABC & 123 PLUMBER LTD",
      "AlphaCode": "ABC & 123 ",
      "ApAccount": "289",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "3702820496",
      "Client": false,
      "Supplier": true,
      "Subcontractor": true,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "521",
        "CellValue": "ABC & 123 PLUMBER LTD",
        "CellTag": "ABC & 123 PLUMBER LTD"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABC & 123 PLUMBER LTD",
        "CellTag": "openDialog(\"521\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABC & 123 "
      },
      "ApAccountValue": {
        "CellValue": "289"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "3702820496"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-01-31T01:16:17.8709216+00:00",
      "OriginalKey": {
        "CompanyId": 521
      },
      "CurrentKey": {
        "CompanyId": 521
      },
      "Key": {
        "CompanyId": 521
      },
      "Index": 0
    },
    {
      "CompanyId": 612,
      "CompanyName": "ABC Furniture",
      "AlphaCode": "ABCFURNITU",
      "ApAccount": "X002",
      "ArAccount": "X002",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "04",
      "CompanyType": "GEN",
      "Phone": " 0800 124578",
      "Client": true,
      "Supplier": true,
      "Subcontractor": true,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "612",
        "CellValue": "ABC Furniture",
        "CellTag": "ABC Furniture"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABC Furniture",
        "CellTag": "openDialog(\"612\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABCFURNITU"
      },
      "ApAccountValue": {
        "CellValue": "X002"
      },
      "ArAccountValue": {
        "CellValue": "X002"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "04",
        "CellValue": "04 : ASIA / PACIFIC RECYCLING (Xero)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": " 0800 124578"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-09-13T01:48:43.9832641+00:00",
      "OriginalKey": {
        "CompanyId": 612
      },
      "CurrentKey": {
        "CompanyId": 612
      },
      "Key": {
        "CompanyId": 612
      },
      "Index": 0
    },
    {
      "CompanyId": 649,
      "CompanyName": "ABC Furniture",
      "AlphaCode": "ABCFURNITU",
      "ArAccount": "ABCFu1",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "04",
      "CompanyType": "GEN",
      "Phone": " 0800 124578",
      "Client": true,
      "Supplier": false,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "649",
        "CellValue": "ABC Furniture",
        "CellTag": "ABC Furniture"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABC Furniture",
        "CellTag": "openDialog(\"649\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABCFURNITU"
      },
      "ApAccountValue": {},
      "ArAccountValue": {
        "CellValue": "ABCFu1"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "04",
        "CellValue": "04 : ASIA / PACIFIC RECYCLING (Xero)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": " 0800 124578"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-04-05T04:33:01.11+00:00",
      "OriginalKey": {
        "CompanyId": 649
      },
      "CurrentKey": {
        "CompanyId": 649
      },
      "Key": {
        "CompanyId": 649
      },
      "Index": 0
    },
    {
      "CompanyId": 690,
      "CompanyName": "ABC Furniture",
      "AlphaCode": "ABCFURNITU",
      "ArAccount": "ABCFu1",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": " 0800 124578",
      "Client": true,
      "Supplier": false,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "690",
        "CellValue": "ABC Furniture",
        "CellTag": "ABC Furniture"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABC Furniture",
        "CellTag": "openDialog(\"690\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABCFURNITU"
      },
      "ApAccountValue": {},
      "ArAccountValue": {
        "CellValue": "ABCFu1"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": " 0800 124578"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-04-05T05:09:18.59+00:00",
      "OriginalKey": {
        "CompanyId": 690
      },
      "CurrentKey": {
        "CompanyId": 690
      },
      "Key": {
        "CompanyId": 690
      },
      "Index": 0
    },
    {
      "CompanyId": 616,
      "CompanyName": "ABC RESOURCE CO SM Test Mar 2022",
      "AlphaCode": "ABC RESOUR",
      "ArAccount": "ABCRESOURC",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "02",
      "CompanyType": "GEN",
      "Phone": "61396546989",
      "Client": true,
      "Supplier": false,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "616",
        "CellValue": "ABC RESOURCE CO SM Test Mar 2022",
        "CellTag": "ABC RESOURCE CO SM Test Mar 2022"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABC RESOURCE CO SM Test Mar 2022",
        "CellTag": "openDialog(\"616\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABC RESOUR"
      },
      "ApAccountValue": {},
      "ArAccountValue": {
        "CellValue": "ABCRESOURC"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "02",
        "CellValue": "02 : ASIA / PACIFIC EQUIPMENT (MYOB-ADV)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "61396546989"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2022-05-11T04:29:51.257+00:00",
      "OriginalKey": {
        "CompanyId": 616
      },
      "CurrentKey": {
        "CompanyId": 616
      },
      "Key": {
        "CompanyId": 616
      },
      "Index": 0
    },
    {
      "CompanyId": 6,
      "CompanyName": "ABC RESOURCE COMP LTD",
      "AlphaCode": "ABC RESOUR",
      "ApAccount": "test",
      "ArAccount": "ABCRESOURC",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "61396546989",
      "Client": true,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "6",
        "CellValue": "ABC RESOURCE COMP LTD",
        "CellTag": "ABC RESOURCE COMP LTD"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABC RESOURCE COMP LTD",
        "CellTag": "openDialog(\"6\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABC RESOUR"
      },
      "ApAccountValue": {
        "CellValue": "test"
      },
      "ArAccountValue": {
        "CellValue": "ABCRESOURC"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "61396546989"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2024-03-07T20:58:20.2796344+00:00",
      "OriginalKey": {
        "CompanyId": 6
      },
      "CurrentKey": {
        "CompanyId": 6
      },
      "Key": {
        "CompanyId": 6
      },
      "Index": 0
    },
    {
      "CompanyId": 647,
      "CompanyName": "ABPA1",
      "AlphaCode": "ABPA",
      "ApAccount": "ABPAAR",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "04",
      "CompanyType": "GEN",
      "Phone": "  ",
      "Client": false,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "647",
        "CellValue": "ABPA1",
        "CellTag": "ABPA1"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABPA1",
        "CellTag": "openDialog(\"647\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABPA"
      },
      "ApAccountValue": {
        "CellValue": "ABPAAR"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "04",
        "CellValue": "04 : ASIA / PACIFIC RECYCLING (Xero)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "  "
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-11-30T22:40:31.6512052+00:00",
      "OriginalKey": {
        "CompanyId": 647
      },
      "CurrentKey": {
        "CompanyId": 647
      },
      "Key": {
        "CompanyId": 647
      },
      "Index": 0
    },
    {
      "CompanyId": 648,
      "CompanyName": "ABPA1a",
      "AlphaCode": "ABPA",
      "ArAccount": "ABPA1",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "  ",
      "Client": true,
      "Supplier": false,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "648",
        "CellValue": "ABPA1a",
        "CellTag": "ABPA1a"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABPA1a",
        "CellTag": "openDialog(\"648\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABPA"
      },
      "ApAccountValue": {},
      "ArAccountValue": {
        "CellValue": "ABPA1"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "  "
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-10-31T01:54:55.9741035+00:00",
      "OriginalKey": {
        "CompanyId": 648
      },
      "CurrentKey": {
        "CompanyId": 648
      },
      "Key": {
        "CompanyId": 648
      },
      "Index": 0
    },
    {
      "CompanyId": 646,
      "CompanyName": "ABPA4",
      "AlphaCode": "ABPA",
      "ApAccount": "ABPA1",
      "ArAccount": "ABPA1",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "04",
      "CompanyType": "GEN",
      "Phone": "  ",
      "Client": true,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "646",
        "CellValue": "ABPA4",
        "CellTag": "ABPA4"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ABPA4",
        "CellTag": "openDialog(\"646\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ABPA"
      },
      "ApAccountValue": {
        "CellValue": "ABPA1"
      },
      "ArAccountValue": {
        "CellValue": "ABPA1"
      },
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "04",
        "CellValue": "04 : ASIA / PACIFIC RECYCLING (Xero)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "  "
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-07-24T23:30:57.5847388+00:00",
      "OriginalKey": {
        "CompanyId": 646
      },
      "CurrentKey": {
        "CompanyId": 646
      },
      "Key": {
        "CompanyId": 646
      },
      "Index": 0
    },
    {
      "CompanyId": 636,
      "CompanyName": "ACT HIRE",
      "AlphaCode": "ACTHIRE",
      "ApAccount": "20001",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "+614421676915",
      "Client": false,
      "Supplier": true,
      "Subcontractor": true,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "636",
        "CellValue": "ACT HIRE",
        "CellTag": "ACT HIRE"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ACT HIRE",
        "CellTag": "openDialog(\"636\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ACTHIRE"
      },
      "ApAccountValue": {
        "CellValue": "20001"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "+614421676915"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-08-10T02:44:27.8697641+00:00",
      "OriginalKey": {
        "CompanyId": 636
      },
      "CurrentKey": {
        "CompanyId": 636
      },
      "Key": {
        "CompanyId": 636
      },
      "Index": 0
    },
    {
      "CompanyId": 455,
      "CompanyName": "ACT HIRE 2020",
      "AlphaCode": "ACT HIRE 2",
      "ApAccount": "223",
      "CreditStatus": "Credit",
      "Location": "EQUIP",
      "FinancialCompanyCode": "01",
      "CompanyType": "GEN",
      "Phone": "6582999231",
      "Client": false,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "455",
        "CellValue": "ACT HIRE 2020",
        "CellTag": "ACT HIRE 2020"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ACT HIRE 2020",
        "CellTag": "openDialog(\"455\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ACT HIRE 2"
      },
      "ApAccountValue": {
        "CellValue": "223"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "EQUIP",
        "CellValue": "EQUIP : Equipment"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "01",
        "CellValue": "01 : ASIA / PACIFIC CIVIL (AccountRight)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "6582999231"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2022-09-12T02:54:49.4431434+00:00",
      "OriginalKey": {
        "CompanyId": 455
      },
      "CurrentKey": {
        "CompanyId": 455
      },
      "Key": {
        "CompanyId": 455
      },
      "Index": 0
    },
    {
      "CompanyId": 615,
      "CompanyName": "ACT HIRE 2020 US",
      "AlphaCode": "ACT HIRE 2",
      "ApAccount": "223",
      "CreditStatus": "Credit",
      "Location": "0",
      "FinancialCompanyCode": "02",
      "CompanyType": "GEN",
      "Phone": "6582999231",
      "Client": false,
      "Supplier": true,
      "Subcontractor": false,
      "Other": true,
      "Inactive": false,
      "Select": {
        "CellId": "615",
        "CellValue": "ACT HIRE 2020 US",
        "CellTag": "ACT HIRE 2020 US"
      },
      "CompanyNameValue": {
        "CellId": "PopupDialog",
        "CellValue": "ACT HIRE 2020 US",
        "CellTag": "openDialog(\"615\")"
      },
      "AlphaCodeValue": {
        "CellValue": "ACT HIRE 2"
      },
      "ApAccountValue": {
        "CellValue": "223"
      },
      "ArAccountValue": {},
      "CreditStatusValue": {
        "CellValue": "Credit"
      },
      "LocationValue": {
        "CellId": "0",
        "CellValue": "0 : Head Office - Civil company"
      },
      "FinancialCompanyCodeValue": {
        "CellId": "02",
        "CellValue": "02 : ASIA / PACIFIC EQUIPMENT (MYOB-ADV)"
      },
      "CompanyTypeValue": {
        "CellId": "GEN",
        "CellValue": "GEN : General"
      },
      "PhoneValue": {
        "CellValue": "6582999231"
      },
      "CostValue": {
        "CellNumValue": 0
      },
      "CatalogueValue": {},
      "UpdatedDate": "2023-04-19T01:19:51.4653571+00:00",
      "OriginalKey": {
        "CompanyId": 615
      },
      "CurrentKey": {
        "CompanyId": 615
      },
      "Key": {
        "CompanyId": 615
      },
      "Index": 0
    }
  ]
}

Get the list of all Workbench companies.

Request

Response

Response sample

Create a new company.

Request

Response

Response sample

Back to top

On this page

1 Overview
2 Endpoints
- 2.1 CompanyListApi
- 2.2 CompanyDetailApi
3 Models
- 3.1 CompanyKey
- 3.2 CompanyLine
- 3.3 CompanyApiModel
- 3.4 CompanyMainFields
- 3.5 CompanyFinancialsFields
- 3.6 CompanyInsuranceKey
- 3.7 CompanyInsuranceLine
- 3.8 AddressKey
- 3.9 AddressLine
4 Examples