Navigation: Catalog: VismaNet > Schemas > Schema: Customer > Tables

CustomerOrderShipmentsByCustomerCode: Visma.net Financials Customer Order Shipments by CustomerCode

Get a range of SO Orders of a specific customer

Catalog: VismaNet

Schema: Customer

Label: Customer Order Shipments by CustomerCode

This is a read-only table function. The Visma.net Financials API may not support changing the data or the Invantive UniversalSQL 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.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function CustomerOrderShipmentsByCustomerCode. 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 evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `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	Required	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__.
orderBy	☐	This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.
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)

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
branchNumber_name	varchar2	Branch Name	☐	Click the magnifier. > The name.
branchNumber_number	varchar2	Branch Number	☐	Click the magnifier. > The identifier.
cancelBy	datetime	Cancel by	☐	Delivery settings tab > Shipping information section > Cancel by > The date when the order should be cancelled if the Back order allowed option has been selected in the Shipping rule field.
canceled	char	Canceled	☐	The Delivery settings tab > The Shipping information section > Cancelled > A check box that indicates that the order has been cancelled on the date specified in Cancel by.
cashAccount	varchar2	Cash Account	☐	Payment settings tab > Cash account
cashDiscountDate	datetime	Cash Discount Date	☐	Financial settings tab > Financial information section > Cash discount date > The date when the cash discount is available for the invoice based on the credit terms.
commissionableAmount	varchar2		☐	The Commissions tab > Commissionable amount> The amount used to calculate the commission.
commissionAmount	varchar2	Commission Amount	☐	The Commissions tab > Commission amt. >The commission amount earned by the salesperson on this document.
commissionPercent	varchar2	Commission Percentage	☐	The Commissions tab > Commission (%) > The percentage of commission generally earned by the salesperson.
COMPANY_CODE	varchar2(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	varchar2(240)	Company Name	☑	Name of the partition.
contactId	int32	Contact ID	☐	The top part > Contact > The contact person of the customer.
currency	varchar2	Currency	☐	The top part > Currency > The currency of the document.
customer_internalId	int32	Customer Internal ID	☐
customer_name	varchar2	Customer Name	☐	The name of the particular destination of the selected type.
customer_number	varchar2	Customer Number	☐	The identifier of the particular destination of the selected type.
customerOrder	varchar2	Customer Order	☐	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	☐	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.
customerVATZone_defaultTaxCategory_description	varchar2	VAT Zone Default Tax Category Description	☐	Name of item/description
customerVATZone_defaultTaxCategory_number	varchar2	VAT Zone Default Tax Category Number	☐	Number of item
customerVATZone_defaultVatCategory	varchar2	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.
customerVATZone_description	varchar2	VAT Zone Description	☐	Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window.
customerVATZone_errorInfo	varchar2		☐
customerVATZone_id	varchar2	VAT Zone ID	☐	Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window.
customerVATZone_metadata_maxPageSize	int64		☐
customerVATZone_metadata_totalCount	int64		☐
date	datetime	Date	☐	Mandatory field: The top part > Date* > The date of the document.
description	varchar2	Description	☐	The top part > Description > A brief description of the document.
discountTotal	double	Discount Total	☐
discountTotalInBaseCurrency	double		☐
dueDate	datetime	Due Date	☐	Financial settings tab > Financial information section > Due date > The due date of the invoice according to the credit terms.
emailed	char	Emailed	☐	A check box indicating if the document is emailed
errorInfo	varchar2	Error Message	☐
exchangeRate	double	Exchange Rate	☐
fobPoint_description	varchar2	FOB Point Description	☐	Click on the magnifier. > The description.
fobPoint_id	varchar2	FOB Point ID	☐	Click on the magnifier. > The identifier.
hold	char	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.
insurance	char	Insurance	☐	Delivery settings tab > Shipping information section > Insurance > A check box that you select to indicate that insurance is required for this order.
inventoryDocType	varchar2		☐
inventoryRefNo	varchar2		☐
invoiceDate	datetime	Invoice Date	☐	Financial settings tab > Financial information section > Invoice date> The date of the invoice generated for the order.
invoiceNbr	varchar2	Invoice Number	☐	Financial settings tab > Financial information section > Invoice no.> The invoice number of the invoice generated for this order.
invoiceNo	varchar2		☐
invoiceSeparately	char	Invoice Separately	☐	Financial settings tab > Financial information section > Invoice separately > A check box that indicating that this document is to be invoiced separately (if that is required).
invoiceType	varchar2		☐
isRotRutDeductible	char		☐	A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)
lastModifiedDateTime	datetime	Last Modified	☐	Background information collected from the system.
location_countryId	varchar2	Location Country ID	☐	Location*.
location_id	varchar2	Location ID	☐	Click the magnifier > The identifier
location_name	varchar2	Location Name	☐	Click the magnifier > The displayed name
metadata_maxPageSize	int64	Metadata Max Pagesize	☐
metadata_totalCount	int64	Total Count	☐
note	varchar2	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	☐	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	varchar2	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.
origOrderNbr	varchar2	Original Order Number	☐	The top part > Order no. > The order number of the document.
origOrderType	varchar2	Original 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 window SO201000.
owner_employeeId	varchar2	Owner Employee ID	☐	The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee ID > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEEsegmented key. This information is retrieved from window EP203000.
owner_id	guid	Owner ID	☐	Employee internal user ID. This is the ID of the user linked to the employee
owner_name	varchar2	Owner Name	☐	The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee name > The name of this employee. This information is retrieved from window EP203000.
paymentMethod_description	varchar2	Payment Method Description	☐	Click on the magnifier. > The description.
paymentMethod_id	varchar2	Payment Method ID	☐	Click on the magnifier. > The identifier.
paymentRef	varchar2	Payment Reference	☐	Payment settings tab > Payment ref.
postPeriod	varchar2	Post Period	☐	The Financial settings tab > Financial information section > Post period > The period to post the transactions generated by the invoice. Format MMYYYY.
preferredWarehouse_description	varchar2	Preferred Warehouse Description	☐	Click on the magnifier. > The description.
preferredWarehouse_id	varchar2	Preferred Warehouse ID	☐	Click on the magnifier. > The identifier.
printDescriptionOnInvoice	char	Print Description on Invoice	☐	The top part > Print description on invoice > A check box
printNoteOnExternalDocuments	char	Print Note on External Documents	☐	The top part > Print note on external sales documents > A check box
printNoteOnInternalDocuments	char	Print Note on Internal Documents	☐	The top part > Print line note on internal sales documents > A check box
priority	int32	Priority	☐	Delivery settings tab > Shipping information section > Priority > Field only for informational purposes. The level of priority for processing order of this customer, as specified for the customer on the Shipping settings tab on the AR303000 window.
projectCD	varchar2	Project Code	☐	Mandatory field: The top part > Project* > The field consists of Project ID and Project description. Project ID: The identifier for the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) 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.
residentialDelivery	char	Residential Delivery	☐	Delivery settings tab > Shipping information section > Residential delivery > A check box that you select to indicate that the shipment should be delivered to a residential area.
salesPerson_description	varchar2	Sales Person Description	☐	Click on the magnifier. > The description.
salesPerson_id	varchar2	Sales Person ID	☐	Click on the magnifier. > The identifier.
saturdayDelivery	char	Saturday Delivery	☐	Delivery settings tab > Shipping information section > Saturday delivery > A check box that indicates that the order may be delivered on Saturday.
schedShipment	datetime	Scheduled Shipment	☐	Delivery settings tab > Shipping information section > Sched. shipment > The date when the ordered goods are scheduled to be shipped.
shipComplete	varchar2	Ship Complete	☐	Delivery settings tab > Shipping information section > Shipping rule > An option that controls whether incomplete and partial shipments for the order are allowed.
shipmentDate	datetime	Shipment Date	☐
shipmentNo	varchar2		☐
shipmentType	varchar2	Shipment Type	☐
shippedQty	double	Shipped Quantity	☐
shippedVolume	double	Shipped Volume	☐
shippedWeight	double	Shipped Weight	☐
shippingTerms_description	varchar2	Shipping Terms Description	☐	Click on the magnifier. > The description.
shippingTerms_id	varchar2	Shipping Terms ID	☐	Click on the magnifier. > The identifier.
shippingZone_description	varchar2	Shipping Zone Description	☐	Click on the magnifier. > The description.
shippingZone_id	varchar2	Shipping Zone ID	☐	Click on the magnifier. > The identifier.
shipSeparately	char	Ship Separately	☐	Delivery settings tab > Shipping information section > Ship separately > This check box indicates that the goods for the customer should be shipped separately for each sales order.
shipVia_description	varchar2	Ship via Description	☐	Click on the magnifier. > The description.
shipVia_id	varchar2	Ship via ID	☐	Click on the magnifier. > The identifier.
soBillingAddress_addressId	int32	SO Billing Address ID	☐
soBillingAddress_addressLine1	varchar2		☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
soBillingAddress_addressLine2	varchar2		☐	Address 2 > The second line of the address.
soBillingAddress_addressLine3	varchar2		☐	Address 3 > The third line of the address.
soBillingAddress_city	varchar2		☐	City > The city.
soBillingAddress_country_errorInfo	varchar2		☐
soBillingAddress_country_id	varchar2		☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
soBillingAddress_country_metadata_maxPageSize	int64		☐
soBillingAddress_country_metadata_totalCount	int64		☐
soBillingAddress_country_name	varchar2		☐	Mandatory field: Country name* > The complete name of the country.
soBillingAddress_county_id	varchar2		☐	Click the magnifier > The identifier
soBillingAddress_county_name	varchar2		☐	Click the magnifier > The displayed name
soBillingAddress_overrideAddress	char		☐	Override address > A check box indicating that you want to override the default address information.
soBillingAddress_postalCode	varchar2		☐	Postcode > The postcode.
soBillingContact_attention	varchar2		☐	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.
soBillingContact_contactId	int32		☐
soBillingContact_email	varchar2		☐	Email > The email address of the customer/supplier/company as a business entity.
soBillingContact_fax	varchar2		☐	Fax > The fax number.
soBillingContact_name	varchar2		☐	Name > The legal name of to appear on the documents.
soBillingContact_overrideContact	char		☐	Override contact > A check box indicating that you want to override the default contact information.
soBillingContact_phone1	varchar2		☐	Phone 1 > The default phone number.
soBillingContact_phone2	varchar2		☐	Phone 2 > An additional phone number.
soBillingContact_web	varchar2		☐	Web > The website of the company, if one exists.
soShippingAddress_addressId	int32		☐
soShippingAddress_addressLine1	varchar2		☐	Address 1 > The first line of the customer's/supplier's/company's/employee's contact address.
soShippingAddress_addressLine2	varchar2		☐	Address 2 > The second line of the address.
soShippingAddress_addressLine3	varchar2		☐	Address 3 > The third line of the address.
soShippingAddress_city	varchar2		☐	City > The city.
soShippingAddress_country_errorInfo	varchar2		☐
soShippingAddress_country_id	varchar2		☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
soShippingAddress_country_metadata_maxPageSize	int64		☐
soShippingAddress_country_metadata_totalCount	int64		☐
soShippingAddress_country_name	varchar2		☐	Mandatory field: Country name* > The complete name of the country.
soShippingAddress_county_id	varchar2		☐	Click the magnifier > The identifier
soShippingAddress_county_name	varchar2		☐	Click the magnifier > The displayed name
soShippingAddress_overrideAddress	char		☐	Override address > A check box indicating that you want to override the default address information.
soShippingAddress_postalCode	varchar2		☐	Postcode > The postcode.
soShippingContact_attention	varchar2		☐	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.
soShippingContact_contactId	int32		☐
soShippingContact_email	varchar2		☐	Email > The email address of the customer/supplier/company as a business entity.
soShippingContact_fax	varchar2		☐	Fax > The fax number.
soShippingContact_name	varchar2		☐	Name > The legal name of to appear on the documents.
soShippingContact_overrideContact	char		☐	Override contact > A check box indicating that you want to override the default contact information.
soShippingContact_phone1	varchar2		☐	Phone 1 > The default phone number.
soShippingContact_phone2	varchar2		☐	Phone 2 > An additional phone number.
soShippingContact_web	varchar2		☐	Web > The website of the company, if one exists.
status	varchar2	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		☐
terms_description	varchar2	Terms Description	☐	Click on the magnifier. > The description.
terms_id	varchar2	Terms ID	☐	Click on the magnifier. > The identifier.
transactionType_description	varchar2	Transaction Type Description	☐	Click on the magnifier. > The description.
transactionType_id	int32	Transaction Type ID	☐	Click on the magnifier. > The identifier.
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		☐

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

CustomerOrderShipmentsByCustomerCode: Visma.net Financials Customer Order Shipments by CustomerCode

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information