itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet a range of SO Orders Basic of a specific customer
Catalog: VismaNet
Schema: Customer
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/customer/{customerCd}/salesorderbasic
Insert Visma.net Financials API URL: /controller/api/v1/customer/{customerCd}/salesorderbasic
Update Visma.net Financials API URL: /controller/api/v1/customer/{customerCd}/salesorderbasic
Delete Visma.net Financials API URL: /controller/api/v1/customer/{customerCd}/salesorderbasic
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/customer/{customerCd}/salesorderbasic
Table Function Parameters
The following parameters can be used to control the behaviour of the table function CustomerSalesOrderBasicByCustomerNumber. 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. |
customerCd |
string |
☑ |
|
|
greaterThanValue |
string |
☐ |
|
Filter on Order no. greater than value. |
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. |
orderType |
string |
☐ |
|
Filter by Order type. |
pageNumber |
int32 |
☐ |
|
Pagination parameter. Page number. |
pageSize |
int32 |
☐ |
|
Pagination parameter. Number of items to be collected. |
showNotes |
boolean |
☐ |
|
Set to true to include notes. |
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 |
☐ |
|
Select to filter on status on order. (Values: Open, Hold, CreditHold, Completed, Cancelled, BackOrder, Shipping, Invoiced, PendingApproval, Voided) |
Table Function Columns
The columns of the table function CustomerSalesOrderBasicByCustomerNumber are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
branchNumber_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
branchNumber_number |
string |
Branch Number |
☐ |
Click the magnifier. > The identifier. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
contactId |
int32 |
Contact ID |
☐ |
The top part > Contact > The contact person of the customer. |
currency |
string |
Currency |
☐ |
The top part > Currency > The currency of the document. |
customer_internalId |
int32 |
Customer Internal ID |
☐ |
|
customer_name |
string |
Customer Name |
☐ |
The name of the particular destination of the selected type. |
customer_number |
string |
Customer Number |
☐ |
The identifier of the particular destination of the selected type. |
customerOrder |
string |
Customer Order |
☐ |
The top part > Customer order > The reference number of the original customer document that the sales order is based on. |
customerRefNo |
string |
Customer Reference Number |
☐ |
The top part > External reference > The reference number of the sales order in a third-party application if Visma.net Financials is integrated with such an application and imports the sales orders from it. |
date |
datetime |
Date |
☐ |
Mandatory field: The top part > Date* > The date of the document. |
description |
string |
Description |
☐ |
The top part > Description > A brief description of the document. |
discountTotal |
double |
Discount Total |
☐ |
|
discountTotalInBaseCurrency |
double |
|
☐ |
|
errorInfo |
string |
Error Message |
☐ |
|
exchangeRate |
double |
Exchange Rate |
☐ |
|
hold |
boolean |
Hold |
☐ |
The top part > Hold > A check box that you select if the document is on hold and should not be processed further at this time. |
lastModifiedDateTime |
datetime |
Last Modified |
☐ |
Background information collected from the system. |
location_countryId |
string |
Location Country ID |
☐ |
Location*. |
location_id |
string |
Location ID |
☐ |
Click the magnifier > The identifier |
location_name |
string |
Location Name |
☐ |
Click the magnifier > The displayed name |
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
note |
string |
Note |
☐ |
Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the order. |
orderNo |
string |
Order Number |
☐ |
The top part > Order no.: > The reference number of the document. |
orderTotal |
double |
Order Total |
☐ |
The top part > Order total > The total amount of the document, which is calculated as follows:Line Total + Misc.Charges + Freight + Premium Freight – Discount Total+ Tax Total |
orderTotalInBaseCurrency |
double |
|
☐ |
|
orderType |
string |
Order Type |
☐ |
Mandatory field: The top part > Order type > The type of the document, which is one of the predefined order types or a custom order type created by using the (SO201000) window. |
requestOn |
datetime |
Request On |
☐ |
Mandatory field: The top part > Requested on > The date when the customer wants to receive the goods; this date provides the default values for the Requested on dates for order lines. |
status |
string |
Status |
☐ |
The top part > Status > The status of the document, which can be one of the following options: On hold, Credit hold, Pending aååroval, Rejected, Open, Cancelled, Shipping, Back order, Invoiced, Completed. |
taxTotal |
double |
Tax Total |
☐ |
The top part > VAT total > The total amount of tax paid on the document. |
taxTotalInBaseCurrency |
double |
|
☐ |
|
vatExemptTotal |
double |
VAT Exempt Total |
☐ |
The top part > VAT exempt total > The document total that is exempt from VAT. |
vatExemptTotalInBaseCurrency |
double |
|
☐ |
|
vatTaxableTotal |
double |
VAT Taxable Total |
☐ |
The top part > VAT taxable total > The document total that is subject to VAT. |
vatTaxableTotalInBaseCurrency |
double |
|
☐ |
|
06-04-2021 14:55 Version 20.1.393-BETA+3152
