Overview

Provides access to Account related data and Workbench User data.

Endpoints

The resources available in this module.

Provides access to logged in user info.

/api/AccountApi
Method	Description	Performed As	Request Query	Request Body	Response
GET	Retrieve current logged in user	Logged in User	-	-	AccountApiModel

Provides API access to the “People“ (#/General/PersonList.aspx) Web Workbench screen.

/api/PeopleListApi
Method	Description	Performed As	Request Query	Request Body	Response
POST	Retrieve a filtered list of people	Logged in User	-	GridRequestParametersApi	GridResult<PersonLine>

Provides API access to the “People“ (#/General/PersonList.aspx) dialog Web Workbench screen.

The definitions of models specific to endpoints in this module.

Field	Type	Description
PersonID	Integer	The unique Person ID of the Logged in User
FullName	String	The Full Name of the Logged in User
FinCoCode	String	The Code of the Financial Company the Logged in User belongs to

Field	Type	Description
PersonID	Integer	The unique PersonID of the Person

Field	Type	CellData	Description
Key	PersonKey		The unique key for the line
PersonId	Integer	PersonIdValue.CellValue	The unique ID of the Person
DisplayName	String
Surname	String	Surname.CellValue
FirstName	String	FirstNameValue.CellValue
Company	String	CompanyValue.CellValue	The name of the Company this Person belongs to
CompanyId	Integer	CompanyValue.CellId	The ID of the Company this Person belongs to
Role	String	RoleValue.CellValue	the Purchase Requisition Role of this Person
JobTitle	String	JobTitleValue.CellValue
EmailAddress	String	EmailAddressValue.CellValue
MobilePhone	String	MobilePhoneValue.CellValue
BusinessPhone	String	BusinessPhone.CellValue
IsEmployee	Boolean
IsActive	Boolean
IsInactive	Boolean
IsBillingContact	Boolean		Billing Contact of the Company
IsSiteContact	Boolean		Site Contact of the Company
IsCommercialContact	Boolean		Commercial Contact of the Company
EmployeeNo	String
Group1	String		The Attribute Group of the first Category filter
Group2	String		The Attribute Group of the second Category filter
Group3	String		The Attribute Group of the third Category filter
UpdatedDate	DateTime		The DateTime this record was last updated
Delete	CellData

Field	Type	Description
Key	PersonKey	The unique key of the Person
Main	PersonMainFields	General data associated with the Person
Attributes.Rows	Array<AttributeLine>	Attributes associated with the Person
Notes.Rows	Array<NoteLine>	Notes associated with the Person
ToDoItems.Rows	Array<ToDoLine>	To Do Items associated with the Person

On this page

Unable to render {include} The included page could not be found.