Overview

Endpoints

The resources available in this module.

ExpenseClaimListApi

/api/ExpenseClaimListApi

/api/ExpenseClaimListApi
Method	Performed As	Request Query	Request Body	Response
POST Returns a list of Expense Claims		-

ExpenseClaimDefaultsApi

Retrieves expense claim default values for client-side, calculation by PersonID and JobCode.

/api/ExpenseClaimDefaultsApi

/api/ExpenseClaimDefaultsApi
Method	Performed As	Request Query	Request Body	Response
GET Retrieves expense claim default values for client-side, calculation by PersonID and JobCode.		-

GET parameters.

Parameter	Description	Parameter Type	Data Type

Parameter	Description	Parameter Type	Data Type
expenseClaimLineId	Line code.	query	integer
costRate	The cost rate.	query	double
gST	Tax	query	double
gSTRate	Tax rate.	query	double
quantity	Quantity.	query	double
personId	ID of created person.	query	integer
jobCode	ID of the related job.	query	string
finCoCode	Code of financial company.	query	string
activityCode	Code of the Activity	query	string
activityType	Type of activity.	query	string
activitySubType	Sub type of activity.	query	string
workCentreCode	Code of Work Centre.	query	string
currency	The currency in the claim.	query	string
gSTType	Type of the tax.	query	string
relatedRecordId		query	string

ExpenseClaimDetailApi

[Description]

/api/ExpenseClaimDetailApi

/api/ExpenseClaimDetailApi
Method	Performed As	Request Query	Request Body	Response
DELETE
GET		-
POST

DELETE Parameters

Parameter	Value	Data Type

Parameter	Value	Data Type
key	Required	body

GET parameters.

Parameter	Value	Data Type

Parameter	Value	Data Type
expenseClaimId	Required	integer
personId	Required	integer
expenseClaimDate	Required	date-time

POST parameters

Parameter	Value	Description	Parameter Type

Parameter	Value	Description	Parameter Type
model	Required		body

Models

The definitions of models specific to endpoints in this module.

ExpenseClaimApiModel

Property	Type	Description

Property	Type	Description
Form	ExpenseClaimsExpenseClaimFormResult
Rows	Array [ExpenseClaimsDetailLine]
ReadonlyMessages	Array [Tuple_String]	Read Only status.
ValidationErrors	Array [MvcValidationError]	Read Only message.
WarningMessage	String	Warning message.
SuccessMessage	String	Sucess message.
ErrorMessage	String	Error message.

Back to top

ExpenseClaimsDetailKey

Property	Type	Description

Property	Type	Description
ExpenseClaimLineId	Integer	Line code.
CostRate	Number	Cost rate.
GST	Number
GSTRate	Number
Quantity	Number	Quantity.
PersonId	Integer	Id of created person.
JobCode	String	Code of the related job.
FinCoCode	String	Code of financial company related.
ActivityCode	String	Code of Activity related.
ActivityType	String	Activity type.
ActivitySubType	String	Activity Sub-type.
WorkCentreCode	String	Code of related Work Centre.
Currency	String	The currency in the claim.
GSTType	String	Type of the tax.
RelatedRecordId	String	Code of related record

Back to top

ExpenseClaimsDetailLine

Property	Type	Description

Property	Type	Description
FinCoCode	String	Code of the financial company.
JobCode	CellData	Code of the related job.
LogHeader	CellData	Log header.
Activity	CellData	Activity related.
ActivityType	String	Activity type.
WorkCentre	CellData	The related Work Centre.
TranDate	String	The exact day the Cost was incurred.
Quantity	CellData	Quantity. Details.
Currency	String	The local currency for reimbursing.
Gross	CellData	Gross amount
GST	CellData	Tax
Net	CellData	NET amount.
FCRate	CellData	Foreign currency rate.
LCGross	CellData
Details	CellData	Details text
FileAttachment	CellData	File attachment.
Delete	CellData
Status	String	Claim status.
ReadonlyFlag	Integer	Read Only status
ReadonlyMessage	String	Read Only message.
OriginalKey	ExpenseClaimsDetailKey
CurrentKey	ExpenseClaimsDetailKey
Key	ExpenseClaimsDetailKey
Index	Integer

Back to top

ExpenseClaimsExpenseClaimFormResult

Property	Type	Description

Property	Type	Description
Key	ExpenseClaimsKey
ClaimDate	DateViewData	Claim date.
ClaimContent	StringViewData	Claim content.
Notes	StringViewData	Comment.
ApprovedField	BoolViewData
CompletedField	BoolViewData
PaidField	BoolViewData
CanSubmit	Boolean
ClaimType	DropdownViewData	Type of claim

Back to top

ExpenseClaimsKey

Property	Type	Description

Property	Type	Description
ExpenseClaimId	Integer	Code of the claim.
PersonId	Integer	ID of person who made the claim.
ExpenseClaimDate	String
FunctionalCode	String	= ['General', 'PurchaseOrders', 'PurchaseOrderApproval', 'PurchaseRequisitions', 'Timesheets', 'TimesheetReviews', 'TimesheetApproval', 'TimesheetApprovalList', 'ServiceLog', 'ServiceDesk', 'ExpenseClaims', 'ExpenseClaimReviews', 'ExpenseClaimApproval', 'ExpenseClaimAdminApproval', 'TabletTimesheet', 'TabletTimePlant', 'Scheduler', 'LeaveManagement', 'LeaveTypeManagement', 'CrewTimesheets', 'Refueling', 'HumanResources', 'DailyDiary', 'Datasheets', 'Stock', 'LogDaysheet', 'PortalPeople', 'PortalCompany', 'Workflow', 'Reporting', 'ProfitCentres', 'ExternalSalesCodes', 'InternalSalesCodes', 'ActivityReportCode', 'ProfitCentreReportCode', 'SalesCodeReportCode', 'Batch', 'Budget', 'Billing', 'TimeCodes', 'Disbursement', 'Jobs', 'ApInvoices', 'Adjustments', 'Plant', 'NonStockLocation', 'JobContract', 'Processes', 'JobReceipt', 'Forecast', 'SubContracts', 'WorkOrderApproval', 'StockItem', 'ApInvoiceApproval', 'ApCreditApproval', 'TimesheetAdminApproval', 'DocketEntry', 'Revenue', 'Vouchers', 'VoucherApproval', 'Quotes', 'ProductionMeasures', 'StockIssue', 'Utilities', 'SubcontractClaimWorkflowApproval', 'BulkInvoice', 'WorkOrder', 'DocumentRegister', 'Activities', 'SalesCodes', 'ContractorDaysheet', 'Materials', 'ExternalPlant', 'JobInvoices', 'BillOfMaterials', 'Users', 'Daysheet', 'Procurement', 'DocketReconciliation', 'Imports', 'ScheduleStoredProcedure', 'Internal', 'TrustAccount', 'Impersonation', 'SubContractRetentionTrustAccount', 'ContractRetentionTrustAccount'], H (string, optional)

Back to top

ExpenseClaimsListItem

Property	Type	Description

Property	Type	Description
PersonName	CellData	Person who made the claim.
ExpenseClaimId	Integert	Code of the claims.
ClaimDate	String	Date of claims.
Content	String	Claims content.
LocalCurrencyReimburse	CellData	Local currency in claims.
Completed	Boolean	Completed or not.
Approved	Boolean	Approved or not.
Paid	Boolean	Paid or not.
Timesheet	CellData
Delete	CellData
Status	String
ReadonlyFlag	Integer
ReadonlyMessage	String
OriginalKey	ExpenseClaimsKey
CurrentKey	ExpenseClaimsKey
Key	ExpenseClaimsKey
Index	Integer

Back to top

Examples

Get a list of Expense claims.

Request

{
"predicate": {
"PredicateRows": [
    {
	    "LeftOperand":"ClaimDate",
	    "Operator": "Gt",
	    "RightOperand": [
	        ""
	    ]
	}
]},
"sidx": "ClaimDate",
"sord": "desc",
"page": 1,
"rows": 20 }

Response

GridResult_ExpenseClaimsListItem {
total (integer, optional),
page (integer, optional),
records (integer, optional),
rows (Array[ExpenseClaimsListItem], optional),
form (object, optional),
widgets (Array[ViewData_GridWidget], optional)
}
ExpenseClaimsListItem {
PersonName (CellData, optional),
ExpenseClaimId (integer, optional),
ClaimDate (string, optional),
Content (string, optional),
LocalCurrencyReimburse (CellData, optional),
Completed (boolean, optional),
Approved (boolean, optional),
Paid (boolean, optional),
Timesheet (CellData, optional),
Delete (CellData, optional),
Status (string, optional),
ReadonlyFlag (integer, optional),
ReadonlyMessage (string, optional),
OriginalKey (ExpenseClaimsKey, optional),
CurrentKey (ExpenseClaimsKey, optional),
Key (ExpenseClaimsKey, 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)
}
ExpenseClaimsKey {
ExpenseClaimId (integer, optional),
PersonId (integer, optional),
ExpenseClaimDate (string, optional),
FunctionalCode (string, optional) = ['General', 'PurchaseOrders', 'PurchaseOrderApproval', 'PurchaseRequisitions', 'Timesheets', 'TimesheetReviews', 'TimesheetApproval', 'TimesheetApprovalList', 'ServiceLog', 'ServiceDesk', 'ExpenseClaims', 'ExpenseClaimReviews', 'ExpenseClaimApproval', 'ExpenseClaimAdminApproval', 'TabletTimesheet', 'TabletTimePlant', 'Scheduler', 'LeaveManagement', 'LeaveTypeManagement', 'CrewTimesheets', 'Refueling', 'HumanResources', 'DailyDiary', 'Datasheets', 'Stock', 'LogDaysheet', 'PortalPeople', 'PortalCompany', 'Workflow', 'Reporting', 'ProfitCentres', 'ExternalSalesCodes', 'InternalSalesCodes', 'ActivityReportCode', 'ProfitCentreReportCode', 'SalesCodeReportCode', 'Batch', 'Budget', 'Billing', 'TimeCodes', 'Disbursement', 'Jobs', 'ApInvoices', 'Adjustments', 'Plant', 'NonStockLocation', 'JobContract', 'Processes', 'JobReceipt', 'Forecast', 'SubContracts', 'WorkOrderApproval', 'StockItem', 'ApInvoiceApproval', 'ApCreditApproval', 'TimesheetAdminApproval', 'DocketEntry', 'Revenue', 'Vouchers', 'VoucherApproval', 'Quotes', 'ProductionMeasures', 'StockIssue', 'Utilities', 'SubcontractClaimWorkflowApproval', 'BulkInvoice', 'WorkOrder', 'DocumentRegister', 'Activities', 'SalesCodes', 'ContractorDaysheet', 'Materials', 'ExternalPlant', 'JobInvoices', 'BillOfMaterials', 'Users', 'Daysheet', 'Procurement', 'DocketReconciliation', 'Imports', 'ScheduleStoredProcedure', 'Internal', 'TrustAccount', 'Impersonation', 'SubContractRetentionTrustAccount', 'ContractRetentionTrustAccount'],
H (string, optional)
}
ViewData_GridWidgetLine {
WidgetLineId (integer, optional),
WidgetId (integer, optional),
Name (string, optional),
Predicate (string, optional),
Order (integer, optional),
Count (integer, optional)
}

Response sample

{
  "total": 0,
  "page": 0,
  "records": 0,
  "rows": [
    {
      "PersonName": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:29:57.858Z",
        "CellValueInt": 0
      },
      "ExpenseClaimId": 0,
      "ClaimDate": "string",
      "Content": "string",
      "LocalCurrencyReimburse": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:29:57.858Z",
        "CellValueInt": 0
      },
      "Completed": true,
      "Approved": true,
      "Paid": true,
      "Timesheet": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:29:57.858Z",
        "CellValueInt": 0
      },
      "Delete": {
        "CellId": "string",
        "CellValue": "string",
        "CellNumValue": 0,
        "CellBoolValue": true,
        "CellTag": "string",
        "CellValueDate": "2024-04-08T20:29:57.858Z",
        "CellValueInt": 0
      },
      "Status": "string",
      "ReadonlyFlag": 0,
      "ReadonlyMessage": "string",
      "OriginalKey": {
        "ExpenseClaimId": 0,
        "PersonId": 0,
        "ExpenseClaimDate": "2024-04-08T20:29:57.858Z",
        "FunctionalCode": "General",
        "H": "string"
      },
      "CurrentKey": {
        "ExpenseClaimId": 0,
        "PersonId": 0,
        "ExpenseClaimDate": "2024-04-08T20:29:57.858Z",
        "FunctionalCode": "General",
        "H": "string"
      },
      "Key": {
        "ExpenseClaimId": 0,
        "PersonId": 0,
        "ExpenseClaimDate": "2024-04-08T20:29:57.858Z",
        "FunctionalCode": "General",
        "H": "string"
      },
      "Index": 0
    }
  ],
  "form": {},
  "widgets": [
    {
      "WidgetId": 0,
      "LayoutCode": "string",
      "Name": "string",
      "Colour": "string",
      "BGColour": "string",
      "Icon": "string",
      "Type": "string",
      "Visible": true,
      "Order": 0,
      "Count": 0,
      "WidgetLines": [
        {
          "WidgetLineId": 0,
          "WidgetId": 0,
          "Name": "string",
          "Predicate": "string",
          "Order": 0,
          "Count": 0
        }
      ]
    }
  ]
}

Example of ExpenseClaimDefaultsApi GET

Request

Response

Response sample

Example of ExpenseClaimDetailApi DELETE

Request

Response

Response sample

Example of ExpenseClaimDetailApi POST

Request

Response

Response sample

Back to top

On this page

1 Overview
2 Endpoints
- 2.1 ExpenseClaimListApi
- 2.2 ExpenseClaimDefaultsApi
- 2.3 ExpenseClaimDetailApi
3 Models
- 3.1 ExpenseClaimApiModel
- 3.2 ExpenseClaimsDetailKey
- 3.3 ExpenseClaimsDetailLine
- 3.4 ExpenseClaimsExpenseClaimFormResult
- 3.5 ExpenseClaimsKey
- 3.6 ExpenseClaimsListItem
4 Examples