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

LocationsByBAccountId

Get a range of Locations for a BAccountRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page sizeData for the Locations

Catalog: VismaNet

Schema: Location

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

Retrieve: true

Insert: false

Update: true

Delete: false

Select Visma.net Financials API URL: /controller/api/v1/location/{bAccountId}

Insert Visma.net Financials API URL: /controller/api/v1/location/{bAccountId}

Update Visma.net Financials API URL: /controller/api/v1/location/{bAccountId}

Delete Visma.net Financials API URL: /controller/api/v1/location/{bAccountId}

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: get /controller/api/v1/location/{bAccountId}

Update Visma.net Financials API Operation: put /controller/api/v1/location/{bAccountId}/{locationId}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function LocationsByBAccountId. 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
bAccountId	string	☑	Identifies the BAccount
COMPANY_CODE	string	☐	Partition to retrieve data from.
createdDateTime	string	☐	Creation date and time.
createdDateTimeCondition	string	☐	System-retrieved information for state/condition
gln	string	☐
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.
locationId	string	☐
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.
pageNumber	int32	☐	Pagination parameter. Page number.
pageSize	int32	☐	Pagination parameter. Number of items to be collected.
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.

Table Function Columns

The columns of the table function LocationsByBAccountId 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 update.

Name	Data Type	Label	Required	Documentation
active	boolean	Active	☐	The top part > Active > A check box that you select if the location is active.
address_addressId	int32	Address ID	☐
address_addressLine1	string	Address Line 1	☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
address_addressLine2	string	Address Line 2	☐	Address 2 > The second line of the address.
address_addressLine3	string	Address Line 3	☐	Address 3 > The third line of the address.
address_city	string	City	☐	City > The city.
address_country_errorInfo	string		☐
address_country_id	string	Country ID	☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
address_country_metadata_maxPageSize	int64		☐
address_country_metadata_totalCount	int64		☐
address_country_name	string	Country Name	☐	Mandatory field: Country name* > The complete name of the country.
address_county_id	string	County ID	☐	Click the magnifier > The identifier
address_county_name	string	County Name	☐	Click the magnifier > The displayed name
address_postalCode	string	Postal Code	☐	Postcode > The postcode.
baccount_internalId	int32		☐
baccount_name	string		☐	The name of the particular destination of the selected type.
baccount_number	string		☐	The identifier of the particular destination of the selected type.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
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.
contact_contactId	int32	Contact ID	☐
contact_email	string	Contact Email	☐	Email > The email address of the customer/supplier/company as a business entity.
contact_fax	string	Contact Fax	☐	Fax > The fax number.
contact_name	string	Contact Name	☐	Name > The legal name of to appear on the documents.
contact_phone1	string	Contact Phone 1	☐	Phone 1 > The default phone number.
contact_phone2	string	Contact Phone 2	☐	Phone 2 > An additional phone number.
contact_web	string	Contact Website	☐	Web > The website of the company, if one exists.
corporateId	string	Corporate ID	☐	General information tab > Location address section > Corporate ID > The corporate ID associated with the customer location.
ediCode	string	EDI Code	☐	General information tab > Location address section > EDI code > The EDI code to be used for the customer location.
errorInfo	string	Error Message	☐
gln	string	GLN	☐	General information tab > Location address section > GLN > The GLN to be used for the customer location.
lastModifiedDateTime	datetime	Last Modified	☐	System generation information
locationId	string	Location ID	☐	Mandatory field: The top part > Location ID* > The identifier of the location. Click the magnifier.
locationName	string	Location Name	☐	The top part > Location name > A descriptive name to help users recognize the location.
metadata_maxPageSize	int64		☐
metadata_totalCount	int64	Total Count	☐
vatRegistrationId	string	VAT Registration ID	☐	General information tab > Location address section > VAT registration ID > The optional VAT registration ID associated with the location.
vatZone_defaultTaxCategory_description	string	VAT Zone Default Tax Category Description	☐	Name of item/description
vatZone_defaultTaxCategory_number	string	VAT Zone Default Tax Category Number	☐	Number of item
vatZone_defaultVatCategory	string	VAT Zone Default VAT Category	☐	Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window.
vatZone_description	string	VAT Zone Description	☐	Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.
vatZone_errorInfo	string		☐
vatZone_id	string	VAT Zone ID	☐	Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.
vatZone_metadata_maxPageSize	int64		☐
vatZone_metadata_totalCount	int64		☐

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