Expense Claims
- Bao TRINH
- Cam Mackay
Overview
Provides access to Expense Claims related data.
Endpoints
The resources available in this module.
ExpenseClaimListApi
Provides API access to the Expense Claims List (#/ExpenseClaims/List.aspx) Web Workbench screen.
/api/ExpenseClaimListApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
POST | Logged in User | - | ||
ExpenseClaimDetailApi
Provides API access to the Expense Claim Detail (#/ExpenseClaims/List.aspx) dialog Web Workbench screen.
/api/ExpenseClaimDetailApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET | ExpenseClaimKey.PersonId | - | ||
POST | ExpenseClaimApiModel.Form.Key.PersonId | - | ||
ExpenseClaimDefaultsApi
Provides API access to the default line logic on the Expense Claim Detail (#/ExpenseClaims/List.aspx) dialog Web Workbench screen.
/api/ExpenseClaimDefaultsApi | ||||
|---|---|---|---|---|
Method | Performed As | Request Query | Request Body | Response |
GET | ExpenseClaimDetailKey.PersonId | - | ||
Models
The definitions of models specific to endpoints in this module.
ExpenseClaimKey
Property | Type | Description |
|---|---|---|
ExpenseClaimId | Integer | The unique ID of the Expense Claim. |
PersonId | Integer | The ID of the Person this Expense Claim is for. |
ExpenseClaimDate | DateTime | The Expense Claim Date. |
ExpenseClaimLine
Property | Type | Description |
|---|---|---|
Key | The unique key for the line. | |
PersonName | The Person this Expense Claim if for. | |
ClaimDate | String | The Expense Claim Date, formatted. |
Content | String | The Content text on the Expense Claim. |
LocalCurrencyReimburse | The total amount to be reimbursed. | |
Completed | Boolean | The Completed flag on the Expense Claim. |
Approved | Boolean | The Approved flag on the Expense Claim. |
Paid | Boolean | The Paid flag on the Expense Claim. |
ExpenseClaimApiModel
Property | Type | Description |
|---|---|---|
Form | The general data associated withe the Expense Claim. | |
Rows | Array<ExpenseClaimDetailLine> | The Expense Claim Lines. |
WarningMessage | String | A warning message about the updated Expense Claim. |
SuccessMessage | String | A message indicating the update was successful. |
ValidationErrors | Array<MvcValidationError> | A list of specific validation errors if the save was unsuccessful. |
ExpenseClaimForm
Property | Type | Length | Description |
|---|---|---|---|
Key |
| The unique key of the Expense Claim. | |
ExpenseClaimId | Integer |
| The unique ID of the Expense Claim. |
ExpenseClaimDate | String |
| The Expense Claim Date, formatted. |
ClaimDate |
| The Expense Claim Date. | |
ApprovedField |
| The Approved flag on the Expense Claim. | |
CompletedField |
| The Completed flag on the Expense Claim. | |
PaidField |
| The Paid flag on the Expense Claim. | |
ClaimType |
| The Type of Expense Claim. Either 0 (Reimbursable) or 1 (Credit Card). | |
ClaimContent | 50 | The Content text on the Expense Claim. | |
Notes | 2000 | The Notes on the Expense Claim. | |
NoEditMessage | String |
| A message indicating the Expense Claim is read-only. |
ExpenseClaimDetailKey
Property | Type | Length | Description |
|---|---|---|---|
ExpenseClaimLineId | Integer |
| The unique ID of the Expense Claim Line. |
PersonId | Integer | 5 | The ID of the Person this Expense Claim is for. |
Currency | String | 10 | The Currency Code. |
FinCoCode | String | 5 | The Financial Company Code on the line. |
JobCode | String | 20 | The Job Code on the line. |
ActivityCode | String | 10 | The Activity Code on the line. |
ActivityType | String | 12 | The Activity Type of the Activity. |
ActivitySubType | String | 10 | The Activity Sub-Type of the Activity. |
GSTRate | Number | 8,5 | The GST Rate of the Activity |
GSTType | String | 10 | The GST Type of the Activity. |
CostRate | Number |
| The Cost Rate of the Activity. |
WorkCentreCode | String | 10 | The Work Centre Code on the line. |
Quantity | Number | 15,4 | The Quantity on the Line. |
ExpenseClaimDetailLine
Property | Type | Length | Description |
|---|---|---|---|
FinCoCode | String | 5 | Code of the financial company. |
JobCode | 20 | Code of the related job. | |
LogHeader |
| Log header. | |
Activity |
| Code of Activity related. | |
ActivityType | String | 12 | Activity type. |
WorkCentre | 10 | The related Work Centre. | |
TranDate | String | 8 | Transaction date. |
Quantity |
| Quantity. Details. | |
Currency | String | 10 | The local currency code for reimbursing. |
Gross |
| Gross amount. | |
GST |
| Tax amount. | |
Net |
| NET amount. | |
FCRate |
| Foreign currency rate. | |
LCGross |
| Gross amount in local currency. | |
Details |
| Details text | |
FileAttachment |
| File attachment. | |
Delete |
|
| |
Status | String |
| Claim status. |
ReadonlyFlag | Integer |
| Read Only status |
ReadonlyMessage | String |
| Read Only message. |
OriginalKey |
|
| |
CurrentKey |
|
| |
Key |
|
| |
Index | Integer |
|
|
On this page