itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of Expense Claims, a filter needs to be specified. ScreenId=EP301000
Catalog: VismaNet
Schema: ExpenseClaim
Label: Expense Claims
The data in this table is partitioned per value of the COMPANY_CODE column.
Retrieve: true
Insert: true
Update: true
Delete: false
Select Visma.net Financials API URL: /controller/api/v1/expenseClaim
Insert Visma.net Financials API URL: /controller/api/v1/expenseClaim
Update Visma.net Financials API URL: /controller/api/v1/expenseClaim
Delete Visma.net Financials API URL: /controller/api/v1/expenseClaim
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/expenseClaim
Insert Visma.net Financials API Operation: post /controller/api/v1/expenseClaim
Update Visma.net Financials API Operation: put /controller/api/v1/expenseClaim/{expenseClaimNbr}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function ExpenseClaims. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
customer |
string |
☐ |
|
The customer from the document |
date |
datetime |
☐ |
|
The date of the document |
departmentId |
string |
☐ |
|
Identifies the department |
greaterThanValue |
string |
☐ |
|
Greater-than value. The item which is the object for this, varies from API to API. |
lastModifiedDateTime |
string |
☐ |
|
System-generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present. |
lastModifiedDateTimeCondition |
string |
☐ |
|
System-retrieved information for state/condition. |
numberToRead |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. |
orderBy |
string |
☐ |
|
This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result. |
skipRecords |
int32 |
☐ |
|
This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. |
status |
string |
☐ |
|
The status of the document. (Values: Hold, PendingApproval, Approved, Rejected, Released) |
Table Function Columns
The columns of the table function ExpenseClaims are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert or update.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
approvalDate |
datetime |
Approval Date |
☐ |
The top part > Approval date > The date when the claim was approved. |
approvalStatus |
string |
Approval Status |
☐ |
The top part > Approval status > The status of the claim in Approval. |
approvalStatusText |
string |
Approval Status Text |
☐ |
The top part > Approval status > A text field. |
claimedBy_internalId |
string |
Claimed by - Internal ID |
☐ |
|
claimedBy_name |
string |
Claimed by - Name |
☐ |
The name of the particular destination of the selected type. |
claimedBy_number |
string |
Claimed by - Number |
☐ |
The identifier of the particular destination of the selected type. |
claimTotal |
double |
Claim Total |
☐ |
The top part > Claim total > The total amount of the claim. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
currency |
string |
Currency |
☐ |
The top part > Currency > The currency of the claim. |
customer_name |
string |
Customer Name |
☐ |
Click the magnifier. > The name. |
customer_number |
string |
Customer Number |
☐ |
|
date |
datetime |
Date |
☐ |
Mandatory field: The top part > Date* > The date when the claim was entered. |
department_description |
string |
Department Description |
☐ |
Click on the magnifier. > The description. |
department_id |
string |
Department ID |
☐ |
Click on the magnifier. > The identifier. |
description |
string |
Description |
☐ |
Mandatory field: The top part > Description > A description of the claim. |
errorInfo |
string |
Error Message |
☐ |
|
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information: The lastest time the expense claim was modified |
location_description |
string |
Location Description |
☐ |
Click on the magnifier. > The description. |
location_id |
string |
Location ID |
☐ |
Click on the magnifier. > The identifier. |
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
refNbr |
string |
Reference Number |
☐ |
The top part > Ref. no. > The unique reference number of the expense claim document. |
status |
string |
Status |
☐ |
The top part > Status > The current status of the expense claim: On Hold/Pending Approval/Approved/Rejected/Released. |
vatExemptTotal |
double |
VAT Exempt Total |
☐ |
The top part > VAT exempt total > The document total that is exempt from VAT. |
vatTaxableTotal |
double |
VAT Taxable Total |
☐ |
The top part > VAT taxable total > The document total that is subjected to VAT. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
