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: ExpenseReceipt > Tables

ExpenseReceipts

Contents Previous Home Next More

Get a range of Expense Receipts, a filter needs to be specified. ScreenId=EP301020

Catalog: VismaNet

Schema: ExpenseReceipt

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/expenseReceipt

Insert Visma.net Financials API URL: /controller/api/v1/expenseReceipt

Update Visma.net Financials API URL: /controller/api/v1/expenseReceipt

Delete Visma.net Financials API URL: /controller/api/v1/expenseReceipt

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: get /controller/api/v1/expenseReceipt

Insert Visma.net Financials API Operation: post /controller/api/v1/expenseReceipt

Update Visma.net Financials API Operation: put /controller/api/v1/expenseReceipt/{receiptNumber}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ExpenseReceipts. 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	Documentation
claimedBy	string	☐	Identifies the employee from the document
COMPANY_CODE	string	☐	Partition to retrieve data from.
customer	string	☐	Identifies the customer from the document
date	string	☐	The date of the document
dateCondition	string	☐
inventory	string	☐	Identifies the inventory item from the document
invoiceable	boolean	☐	If the document is invoiceable
project	string	☐	Identifies the project from the document
projectTask	string	☐	Filter on Task ID.
status	string	☐	The status of the document. (Values: Open, Pending, Approved, Rejected, Released)

Table Function Columns

The columns of the table function ExpenseReceipts 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
branch_name	string	Branch Name	☐	Click the magnifier. > The name.
branch_number	string	Branch Number	☐	Click the magnifier. > The identifier.
claimAmount	double	Claim Amount	☐	Receipt details tab > Expense details section > Expense claim > The expense claim with which the expense receipt is associated.
claimedBy_address_addressId	int32		☐
claimedBy_address_addressLine1	string		☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
claimedBy_address_addressLine2	string		☐	Address 2 > The second line of the address.
claimedBy_address_addressLine3	string		☐	Address 3 > The third line of the address.
claimedBy_address_city	string		☐	City > The city.
claimedBy_address_country_errorInfo	string		☐
claimedBy_address_country_id	string		☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
claimedBy_address_country_metadata_maxPageSize	int64		☐
claimedBy_address_country_metadata_totalCount	int64		☐
claimedBy_address_country_name	string		☐	Mandatory field: Country name* > The complete name of the country.
claimedBy_address_county_id	string		☐	Click the magnifier > The identifier
claimedBy_address_county_name	string		☐	Click the magnifier > The displayed name
claimedBy_address_postalCode	string		☐	Postcode > The postcode.
claimedBy_contact_attention	string		☐	Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person.
claimedBy_contact_contactId	int32		☐
claimedBy_contact_email	string		☐	Email > The email address of the customer/supplier/company as a business entity.
claimedBy_contact_employeeContact	string		☐	Employee contact > The link to the contact record associated with the employee.
claimedBy_contact_fax	string		☐	Fax > The fax number.
claimedBy_contact_firstName	string		☐	First name > The first name of the employee.
claimedBy_contact_lastName	string		☐	Mandatory field: Last name* > The last name of the employee.
claimedBy_contact_midName	string		☐	Middle name > The middle name of the employee.
claimedBy_contact_name	string		☐	Name > The legal name of to appear on the documents.
claimedBy_contact_phone1	string		☐	Phone 1 > The default phone number.
claimedBy_contact_phone2	string		☐	Phone 2 > An additional phone number.
claimedBy_contact_phone3	string		☐	Phone 3 > An additional phone number of the employee.
claimedBy_contact_title	string		☐	Title > The courtesy title to be used for the employee.
claimedBy_contact_web	string		☐	Web > The website of the company, if one exists.
claimedBy_department	string		☐	Mandatory field: General information tab > Employee section > Department* > The department the employee works for.
claimedBy_employeeId	int32		☐	Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.
claimedBy_employeeName	string		☐	The top part > Employee name > The name of this employee.
claimedBy_employeeNumber	string		☐	General information tab > Employee settings section > Employee ref. no. > A reference number for the employee.
claimedBy_employeeUserId	string		☐	Employee internal user ID. This is the ID of the user linked to the employee
claimedBy_errorInfo	string		☐
claimedBy_lastModifiedDateTime	datetime		☐
claimedBy_metadata_maxPageSize	int64		☐
claimedBy_metadata_totalCount	int64		☐
claimedBy_status	string		☐	Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
currency_description	string	Currency Description	☐	Click on the magnifier. > The description.
currency_id	string	Currency ID	☐	Click on the magnifier. > The identifier.
customer_name	string	Customer Name	☐	Click the magnifier. > The name.
customer_number	string	Customer Number	☐
date	datetime	Date	☐	Both tabs > Date > The date of the expense receipt.
description	string	Description	☐	Open the receiptMandatory field: Receipt details tab > Expense details section > Description* > The expense description, which is displayed as a link.
employeePart	double		☐	Receipt details tab > Expense details section > Employee part > The part of the total amount that will not be paid back to the employee.
expenseAccount_description	string	Expense Account Description	☐	Name of item/description
expenseAccount_number	string	Expense Account Number	☐	Number of item
expenseAccount_type	string	Expense Account Type	☐
expenseClaim_description	string	Expense Claim Description	☐	Name of item/description
expenseClaim_number	string	Expense Claim Number	☐	Number of item
expenseSub_description	string		☐	Click on the magnifier. > The description.
expenseSub_id	string		☐	Click on the magnifier. > The identifier.
image_id	string	Image ID	☐	The ID of the attachment
image_name	string	Image Name	☐	The name of the attachment.
image_revision	int32	Image Revision	☐	The version of the attachment.
internalId	int32	Internal ID	☐
inventory_description	string	Inventory Description	☐	Name of item/description
inventory_number	string	Inventory Number	☐	Number of item
invoiceable	boolean	Invoiceable	☐	Receipt details tab > Financial details section > Invoiceable > A check box that indicates (if selected) that the customer should be invoiced for the claim amount.
location_description	string	Location Description	☐	Click on the magnifier. > The description.
location_id	string	Location ID	☐	Click on the magnifier. > The identifier.
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	☐	Receipt details tab > Expense details section > Quantity > The quantity of the expense item that the employee purchased according to the receipt.
receiptId	string	Receipt ID	☐	The top part > Employee > The identifier of the employee whose expense receipts you want to manage.
refNbr	string	Reference Number	☐	Both tabs > Ref. no. > The reference number, which usually matches the number of the original receipt.
salesAccount_description	string		☐	Name of item/description
salesAccount_number	string		☐	Number of item
salesAccount_type	string		☐
salesSub_description	string		☐	Click on the magnifier. > The description.
salesSub_id	string		☐	Click on the magnifier. > The identifier.
status	string	Status	☐	Receipt details tab > Expense details section > Expense claim status > The current status of the associated expense claim, which can be one of the following options: On hold, Pending apporval, Approved, Rejected, Released.
taxCategory_description	string		☐	Name of item/description
taxCategory_number	string		☐	Number of item
totalAmount	double	Total Amount	☐	Receipt details tab > Expense details section > Amount > The total amount of the receipt (for VAT-inclusive taxes), or the total amount before taxes (for VAT-exclusive taxes).
unitCost	double	Unit Cost	☐	Receipt details tab > Expense details section > Unit cost > The cost of one unit of the expense item.
uom	string	Unit of Measure	☐	Receipt details tab > Expense details section > UoM > The unit of measure of the expense item.

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