invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomerSalesOrderBasicByCustomerNumber: Visma.net Financials Customer Sales Orders by Customer Number

read only REST

  • Catalog: VismaNet
  • Schema: Customer
  • Label: Customer Sales Orders by Customer Number

Get a range of SO Orders Basic of a specific customer

Can only retrieve data.

API Source

  • Endpoint: /v1/customer/{customerCd}/salesorderbasic
  • Operation: get /v1/customer/{customerCd}/salesorderbasic

Performance Characteristics

Characteristic Value
Average access latency (ms) 155
Full scan rows per minute 29,100
Point query rows per minute 387

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
customerCd ``
greaterThanValue `` Filter on Order no. greater than value.
lastModifiedDateTime `` This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present. Accepted format: * yyyy-MM-dd * yyyy-MM-dd HH:mm:ss * yyyy-MM-dd HH:mm:ss.FFF * yyyy-MM-ddTHH:mm:ss * yyyy-MM-ddTHH:mm:ss.FFF Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive.
lastModifiedDateTimeCondition `` This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive.
orderType `` Filter by Order type.
showNotes `` Set to true to include notes.
status `` Select to filter on status on order. (Values: Open, Hold, CreditHold, Completed, Cancelled, BackOrder, Shipping, Invoiced, PendingApproval, Voided)

Table Columns

The columns of the table CustomerSalesOrderBasicByCustomerNumber 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 and update.

Name Data Type Label Required Marks Documentation
COMPANY_CODE varchar2(30) Company Code writable Partition code, segmenting the data.
COMPANY_NAME varchar2(240) Company Name writable Name of the partition.
branchNumber_name varchar2 Branch Name filters on the platform, writable, branchNumber.name Click the magnifier. > The name.
branchNumber_number varchar2 Branch Number filters on the platform, writable, branchNumber.number Click the magnifier. > The identifier.
contactId int32 Contact ID filters on the platform, writable, contactId The top part > Contact > The contact person of the customer.
currency varchar2 Currency filters on the platform, writable, currency The top part > Currency > The currency of the document.
customerOrder varchar2 Customer Order filters on the platform, writable, customerOrder The top part > Customer order > The reference number of the original customer document that the sales order is based on.
customerRefNo varchar2 Customer Reference Number filters on the platform, writable, customerRefNo 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.
customer_internalId int32 Customer Internal ID filters on the platform, writable, customer.internalId
customer_name varchar2 Customer Name filters on the platform, writable, customer.name The name of the particular destination of the selected type.
customer_number varchar2 Customer Number filters on the platform, writable, customer.number The identifier of the particular destination of the selected type.
date datetime Date filters on the platform, writable, date Mandatory field: The top part > Date* > The date of the document.
description varchar2 Description filters on the platform, writable, description The top part > Description > A brief description of the document.
discountTotal double Discount Total filters on the platform, writable, discountTotal
discountTotalInBaseCurrency double itgen_vnet_discounttotalinbasecurrency filters on the platform, writable, discountTotalInBaseCurrency
errorInfo varchar2 Error Message filters on the platform, writable, errorInfo
exchangeRate double Exchange Rate filters on the platform, writable, exchangeRate
hold char Hold filters on the platform, writable, 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 filters on the platform, writable, lastModifiedDateTime Background information collected from the system.
location_countryId varchar2 Location Country ID filters on the platform, writable, location.countryId Location*.
location_id varchar2 Location ID filters on the platform, writable, location.id Click the magnifier > The identifier
location_name varchar2 Location Name filters on the platform, writable, location.name Click the magnifier > The displayed name
metadata_maxPageSize int64 Metadata Max Pagesize filters on the platform, writable, metadata.maxPageSize
metadata_totalCount int64 Total Count filters on the platform, writable, metadata.totalCount
note varchar2 Note filters on the platform, writable, note Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the order.
orderNo varchar2 Order Number filters on the platform, writable, orderNo The top part > Order no.: > The reference number of the document.
orderTotal double Order Total filters on the platform, writable, orderTotal 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 itgen_vnet_ordertotalinbasecurrency filters on the platform, writable, orderTotalInBaseCurrency
orderType varchar2 Order Type filters on the platform, writable, orderType 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 filters on the platform, writable, requestOn 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 varchar2 Status filters on the platform, writable, 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 filters on the platform, writable, taxTotal The top part > VAT total > The total amount of tax paid on the document.
taxTotalInBaseCurrency double itgen_vnet_taxtotalinbasecurrency filters on the platform, writable, taxTotalInBaseCurrency
vatExemptTotal double VAT Exempt Total filters on the platform, writable, vatExemptTotal The top part > VAT exempt total > The document total that is exempt from VAT.
vatExemptTotalInBaseCurrency double itgen_vnet_vatexempttotalinbasecurrency filters on the platform, writable, vatExemptTotalInBaseCurrency
vatTaxableTotal double VAT Taxable Total filters on the platform, writable, vatTaxableTotal The top part > VAT taxable total > The document total that is subject to VAT.
vatTaxableTotalInBaseCurrency double itgen_vnet_vattaxabletotalinbasecurrency filters on the platform, writable, vatTaxableTotalInBaseCurrency

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: