Visma.net Financials API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: ExpenseClaim > Tables

ExpenseClaimDetailsByExpenseClaimCd

Contents Previous Home Next More

Get a specific Expense Claim

Catalog: VismaNet

Schema: ExpenseClaim

The data in this table is partitioned per value of the COMPANY_CODE column.

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive SQL driver for Visma.net Financials does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net Financials API.

Select Visma.net Financials API URL: /controller/api/v1/expenseClaim/{expenseClaimCd}

Insert Visma.net Financials API URL: /controller/api/v1/expenseClaim/{expenseClaimCd}

Update Visma.net Financials API URL: /controller/api/v1/expenseClaim/{expenseClaimCd}

Delete Visma.net Financials API URL: /controller/api/v1/expenseClaim/{expenseClaimCd}

Field Selection Method: NotRequired

Base Path: details[*]

Select Visma.net Financials API Operation: get /controller/api/v1/expenseClaim/{expenseClaimCd}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ExpenseClaimDetailsByExpenseClaimCd. 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.
expenseClaimCd	string	☑		Identifies the expense claim

Table Function Columns

The columns of the table function ExpenseClaimDetailsByExpenseClaimCd are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
amountInClaimCurr	double		☐	Amount in claim currency > The amount claimed by the employee, which is expressed in the currency of the expense claim.
approvalDate	datetime	Approval Date	☐	The top part > Approval date > The date when the claim was approved.
approvalStatus_1	string		☐	The top part > Approval status > The status of the claim in Approval.
approvalStatus	string	Approval Status	☐	Approval status > The approval status, which indicates whether the detail row requires approval and, if it does, what the current state of approval is.
approvalStatusText_1	string		☐	The top part > Approval status > A text field.
approvalStatusText	string	Approval Status Text	☐	Last approval comment > The approval status text suitable for display
approver	string	Approver	☐	Pending approver > The identifier of the person authorized to approve the activity, if approval is required. This is either the approver of the project task or, if no approver is assigned to the project task, the project manager.
arReferenceNbr	string		☐	REef.no. customer > The reference number of the customer ledger document.
branch_name	string	Branch Name	☐	Click the magnifier. > The name.
branch_number	string	Branch Number	☐	Click the magnifier. > The identifier.
claimAmount	double	Claim Amount	☐	Claim amount > The amount claimed by the employee, which is calculated as the total claim amount minus the employee part.
claimDetailId	int32	Claim Detail ID	☐	Identifies the expense claim detail id, necessary when updating detail information
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_1	string		☐	The top part > Currency > The currency of the claim.
currency	string	Currency	☐	Currency > The currency of the expense receipt. However, if you enter a claim line directly, the currency value is read-only and matching the claim currency.
customer_name_1	string		☐	Click the magnifier. > The name.
customer_name	string	Customer Name	☐	Click the magnifier. > The name.
customer_number_1	string		☐
customer_number	string	Customer Number	☐
date_1	datetime		☐	Mandatory field: The top part > Date* > The date when the claim was entered.
date	datetime	Date	☐	Mandatory field: Date > The date when the expense was incurred.
department_description	string	Department Description	☐	Click on the magnifier. > The description.
department_id	string	Department ID	☐	Click on the magnifier. > The identifier.
description_1	string		☐	Mandatory field: The top part > Description > A description of the claim.
description	string	Description	☐	Mandatory field: Description* > A description of the transaction.
employeePart	double		☐	Employee part > The part of the total amount that will not be paid back to the employee. The percentage depends on the company policy.
errorInfo	string	Error Message	☐
expenseAccount_description	string	Expense Account Description	☐	Name of item/description
expenseAccount_externalCode1	string		☐	Account class > The identifier of the account class.
expenseAccount_externalCode2	string		☐	Account class > The name of the account class.
expenseAccount_number	string	Expense Account Number	☐	Number of item
expenseAccount_type	string	Expense Account Type	☐	Account > The account number.
expenseItem_description	string		☐	Name of item/description
expenseItem_number	string		☐	Number of item
expenseSubaccount_description	string		☐	Click on the magnifier. > The description.
expenseSubaccount_id	string		☐	Click on the magnifier. > The identifier.
invoiceable	boolean	Invoiceable	☐	Invoicable > A check box that, if selected, indicates that the claim amount is invoiceable to the customer (the total amount minus the employee's part).
lastModifiedDateTime	datetime	Last Modified	☐	System generated information: The lastest time the expense claim was modified
lineId	string		☐	The expense claim line id
location_description_1	string		☐	Click on the magnifier. > The description.
location_description	string	Location Description	☐	Click on the magnifier. > The description.
location_id_1	string		☐	Click on the magnifier. > The identifier.
location_id	string	Location ID	☐	Click on the magnifier. > The identifier.
metadata_maxPageSize	int64		☐
metadata_totalCount	int64	Total Count	☐
project_description	string	Project Description	☐	Click on the magnifier. > The description.
project_id	string	Project ID	☐	Click on the magnifier. > The identifier.
projectTask_description	string	Project Task Description	☐	Click on the magnifier. > The description.
projectTask_id	string	Project Task ID	☐	Click on the magnifier. > The identifier.
quantity	double	Quantity	☐	Quantity > The quantity of this expense item.
refNbr_1	string		☐	The top part > Ref. no. > The unique reference number of the expense claim document.
refNbr	string	Reference Number	☐	Ref. no. > The identifier of the transaction.
salesAccount_description	string		☐	Name of item/description
salesAccount_externalCode1	string		☐	Account class > The identifier of the account class.
salesAccount_externalCode2	string		☐	Account class > The name of the account class.
salesAccount_number	string		☐	Number of item
salesAccount_type	string		☐	Account > The account number.
salesSubaccount_description	string		☐	Click on the magnifier. > The description.
salesSubaccount_id	string		☐	Click on the magnifier. > The identifier.
status	string	Status	☐	The top part > Status > The current status of the expense claim: On Hold/Pending Approval/Approved/Rejected/Released.
taxCategory_description	string		☐	Name of item/description
taxCategory_number	string		☐	Number of item
totalAmount	double	Total Amount	☐	Amount > The total amount paid for the expense item in the specified quantity.
unitCost	double	Unit Cost	☐	Unit cost > The cost of a unit of the item.
uom	string	Unit of Measure	☐	Mandatory field: UoM > The unit of measure in which the quantity is shown.
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

Please enable JavaScript to view this site.

itgendoc001X

Visma.net Financials API Data Model

Table Function Parameters

Table Function Columns