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

CustomerDocumentSubaccountSegmentsByCustomerNumber: Visma.net Financials Customer Document Subaccount Segments by Customer Number

Gets a range of documents for a specific customer

Catalog: VismaNet

Schema: Customer

Label: Customer Document Subaccount Segments by Customer Number

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 CustomerDocumentSubaccountSegmentsByCustomerNumber. 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
branch	☐	Filter by Branch
closedFinancialPeriod	☐	The date of the closing of the financial period.
createdDateTime	☐	This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created 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:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.
createdDateTimeCondition	☐	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:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.
customer	☐	Filter by Customer
customerNumber	☑	Identifies the customer for which to return data
customerRefNumber	☐	The top part > External reference > The external reference used in AutoInvoice.
documentDate	☐	This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.Accepted format:* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```* ```yyyy-MM-dd```_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.
documentDateCondition	☐	This value represents the condition to be applied to the Document Date 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:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.
documentDueDate	☐	The date when payment for the document is due, in accordance with the credit terms.
documentDueDateCondition	☐	This value represents the condition to be applied to the Due Date 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
documentType	☐	The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint. (Values: Invoice, DebitNote, CreditNote, Payment, VoidPayment, Prepayment, Refund, FinCharge, SmallBalanceWo, SmallCreditWo, CashSale, CashReturn, Undefined, NoUpdate)
dunningLetterDateTime	☐	The date and time for when the document last released a dunning letter.
dunningLetterDateTimeCondition	☐	Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.
dunningLevel	☐	The dunning level of the document.
expandApplications	☐	True if you want to see all dunning information regarding this document.
expandAttachments	☐	True if you want to see all attachments regarding this document.
expandDunningInformation	☐
expandInvoiceAddress	☐	True if you want to see all information regarding the invoice address for this document.
expandTaxDetails	☐	True if you want to see all VAT details regarding this document.
externalReference	☐	The top part > External reference > The external reference used in AutoInvoice.
financialPeriod	☐	The financial period to which the transactions recorded in the document is posted. Format YYYYMM.
greaterThanValue	☐	Greater than value. The item which is the object for this, varies from API to API.
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__.
paymentReference	☐	The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..
project	☐	The project with which the document is associated.
released	☐	Parameter for showing if invoice has been released or not.
status	☐	The status of the document. Use the dropdown to select status. (Values: Hold, Balanced, Voided, Scheduled, Open, Closed, PendingPrint, PendingEmail, CreditHold, CcHold, Reserved)

Columns of Table Function

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

Name	Data Type	Label	Required	Documentation
account_active	char	Account Active	☐
account_description	varchar2	Account Description	☐	Name of item/description
account_externalCode1	varchar2	Account External Code 1	☐	Account class > The identifier of the account class.
account_externalCode2	varchar2	Account External Code 2	☐	Account class > The name of the account class.
account_number	varchar2	Account Number	☐	Number of item
account_type	varchar2	Account Type	☐	Account > The account number.
active	char	Active	☐	Active > The status of the identifier.
amount	double	Amount	☐	The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.If the check box is cleared, then the value appears when the document status is Open.
amountInCurrency	double	Amount in Currency	☐	Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.
balance	double	Balance	☐	The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. For a document used in the application process, this is the balance after the payments were applied.
balanceInCurrency	double	Balance in Currency	☐	Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.
branch_name	varchar2	Branch Name	☐	Click the magnifier. > The name.
branch_number	varchar2	Branch Number	☐	Click the magnifier. > The identifier.
branchNumber_name	varchar2	Branch Name	☐	Click the magnifier. > The name.
branchNumber_number	varchar2	Branch Number	☐	Click the magnifier. > The identifier.
cashAccount	varchar2	Cash Account	☐	Financial details tab > The payment information section > Cash account > The cash account associated with the payment method.
cashDiscount	double	Cash Discount	☐	The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.
cashDiscountInCurrency	double	Cash Discount in Currency	☐	Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.
closedFinancialPeriod	varchar2	Closed Financial Period	☐	Format YYYYMM.
COMPANY_CODE	varchar2(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	varchar2(240)	Company Name	☑	Name of the partition.
createdDateTime	datetime	Created	☐	The Attachments tab > Creation time > The date the attachment was created.
currencyId	varchar2	Currency ID	☐	The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window.
customer_name	varchar2	Customer Name	☐	Click the magnifier. > The name.
customer_number	varchar2	Customer Number	☐
customerProject	varchar2	Customer Project	☐	The top part > Customer project no. > The customer project no. used in AutoInvoice.
customerRefNumber	varchar2	Custom Reference Number	☐	The top part > External reference > The external reference used in AutoInvoice.
description	varchar2	Description	☐	Description > The description of the identifier.
documentDate	datetime	Document Date	☐	The top part > Date* > The date when the customer ledger document was created.By default, for a new document, it is the current business date, but you can change the date.
documentDueDate	datetime	Document Due Date	☐
documentType	varchar2	Document Type	☐	The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off
errorInfo_2	varchar2	Error Information 2	☐
errorInfo	varchar2	Error Message	☐
financialPeriod	varchar2	Financial Period	☐	The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.
invoiceText	varchar2	Invoice Text	☐	The top part > Invoice text > Any user-provided description of the customer ledger document.
lastModifiedDateTime_2	datetime	Last Modified Date/Time 2	☐	System generated field for last modification date/time of document.
lastModifiedDateTime	datetime	Last Modified	☐	System generated information.
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_2	int64		☐
metadata_maxPageSize	int64	Metadata Max Pagesize	☐
metadata_totalCount_2	int64		☐
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 document.
origInvoiceDate	datetime	Original Invoice Date	☐	The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting "Use Orig Invoice Date" is active in AR Preferences.By default, for a new document, it is the current business date, but you can change the date.
paymentMethod_description	varchar2	Payment Method Description	☐	Click on the magnifier. > The description.
paymentMethod_id	varchar2	Payment Method ID	☐	Click on the magnifier. > The identifier.
postPeriod	varchar2	Post Period	☐	The top part > Post period > The period to which the document should be posted. Format YYYYMM.
project_description	varchar2	Project Description	☐	Click on the magnifier. > The description.
project_id	varchar2	Project ID	☐	Click on the magnifier. > The identifier.
project_internalId	int32		☐	The internal identifier.
referenceNumber	varchar2	Reference Number	☐	The Top part > Ref. no. > The reference number of the customer ledger document in the system.
segmentDescription	varchar2		☐	The Segment values window > The Top part > The description of the segment.
segmentId	int32	Segment ID	☐	The Segment values window > The Top part > The ID of the segment.
segmentValue	varchar2	Segment Value	☐	The Segment values window > The table > The value of the segment, alphanumeric.
segmentValueDescription	varchar2	Segment Value Description	☐	The Segment values window > The table > The description of the segment value.
status	varchar2	Status	☐	The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email.
subaccountId	int32		☐	SubID > The identifier of the subaccount.
subaccountNumber	varchar2		☐	Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
timeStamp	blob	Timestamp	☐	The timestamp of the subaccount, used for concurrency control.
vatTotal	double	VAT Total	☐	The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.
vatTotalInCurrency	double	VAT Total in Currency	☐	Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.

Please enable JavaScript to view this site.

Visma.net Financials API Data Model

CustomerDocumentSubaccountSegmentsByCustomerNumber: Visma.net Financials Customer Document Subaccount Segments by Customer Number

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information