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

CustomerOverdueChargeSubAccountSegmentLines

Get a range of Customer Overdue Charges - ScreenId=AR301000Request 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 Customer Overdue Charge

Catalog: VismaNet

Schema: CustomerOverdueCharge

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 CustomerOverdueChargeSubAccountSegmentLines. 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
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 CustomerOverdueChargeSubAccountSegmentLines are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
account_active_2	char	Account Active 2	☐
account_active	char	Account Active	☐
account_description_2	varchar2	Account Description 2	☐	Name of item/description
account_description	varchar2	Account Description	☐	Name of item/description
account_externalCode1_2	varchar2	Account External Code 1 2	☐	Account class > The identifier of the account class.
account_externalCode1	varchar2	Account External Code 1	☐	Account class > The identifier of the account class.
account_externalCode2_2	varchar2	Account External Code 2 2	☐	Account class > The name of the account class.
account_externalCode2	varchar2	Account External Code 2	☐	Account class > The name of the account class.
account_number_2	varchar2	Account Number 2	☐	Number of item
account_number	varchar2	Account Number	☐	Number of item
account_type_2	varchar2	Account Type 2	☐	Account > The account number.
account_type	varchar2	Account Type	☐	Account > The account number.
active	char	Active	☐	Active > The status of the identifier.
amount_2	double		☐	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.
amount	double	Amount	☐	Amount > The amount after the discount has been applied. The value of this read-only boxis calculated automatically by deducting the discount amount from the extended price.
amountInCurrency_2	double	Amount in Currency 2	☐	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.
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 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.
branchNumber_name_2	varchar2	Branch Number Name 2	☐	Click the magnifier. > The name.
branchNumber_name	varchar2	Branch Name	☐	Click the magnifier. > The name.
branchNumber_number_2	varchar2	Branch Number 2	☐	Click the magnifier. > The identifier.
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.
cashDiscountDate	datetime	Cash Discount Date	☐	Madatory field: The top part > Cash discount date* > The end date of the cash discount period, which the system calculates by using the 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.
contact_id	int32	Contact ID	☐	Click the magnifier > The identifier
contact_name	varchar2	Contact Name	☐	Click the magnifier > The displayed name
cost	double	Cost	☐	Cost > The total cost of the line in default currency. The value will always be 0 for unreleased documents.
createdDateTime	datetime	Created	☐	The Attachments tab > Creation time > The date the attachment was created.
creditTerms_description	varchar2	Credit Terms Description	☐	Click on the magnifier. > The description.
creditTerms_id	varchar2	Credit Terms ID	☐	Click on the magnifier. > The identifier.
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.
customerVatZone_description	varchar2	VAT Zone Description	☐	Click on the magnifier. > The description.
customerVatZone_id	varchar2	VAT Zone ID	☐	Click on the magnifier. > The identifier.
deferralCode	varchar2		☐	The deferral code assigned to the stock item or non-stock item specified in thisdocument line.Upon release of the document, the system generates a deferralschedule (or schedules) based on the settings defined in this deferral code.
deferralSchedule	int32		☐	Original deferral schedule > A read-only column filled in by the system in the Cash return documents created by the reversing process. It shows the identifier of the deferral schedule associated with the original Cash sale document.
description_2	varchar2	Description 2	☐	Transaction descr. > Any brief comment relevant to the transaction.The alphanumeric string may contain up to 30 characters.
description	varchar2	Description	☐	Description > The description of the identifier.
detailTotal	double	Detail Total	☐	The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.
detailTotalInCurrency	double	Detail Total in Currency	☐	Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in a another currency than your default.
discountAmount	double		☐	Discount amount > The amount of the line-level discount that has been applied manually orautomatically to this line.The system selects the Manual Discount check boxand calculates the line amount after you have entered the discount amountmanually and save your changes or added a new line.
discountAmountInCurrency	double		☐	Background calculation giving you the Discount amount in your default currency. This field is applicable if the amount is given in another currency than your default.
discountCode	varchar2	Discount Code	☐	The code of the line discount that has been applied to this line automatically or manually.
discountPercent	double	Discount Percent	☐	Discount percent > The percent of the line-level discount that has been applied manually orautomatically.The system selects the Manual Discount check box andcalculates the discount amount after you have entered the percent manually andsaved your changes or added a new line.
discountTotal	double	Discount Total	☐	The top part > Discount total > The document discount total.
discountTotalInCurrency	double	Discount Total in Currency	☐	The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.
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	☐	Mandatory field: The Top part > Due date* > The date when payment for the document is due, in accordance with the credit terms.
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
dontEmail	char	Don't Email	☐
dontPrint	char	Don't Print	☐
dunningLetterDate	datetime	Dunning Letter Date	☐	Financial details tab > Dunning information section > Dunning letter date > The date of the last released dunning letter in which the document was listed.
dunningLetterLevel	int32	Dunning Letter Level	☐	Financial details tab > Dunning information section > Dunning level > The dunning level of the document.
errorInfo_2	varchar2	Error Information 2	☐
errorInfo	varchar2	Error Message	☐
exchangeRate	double	Exchange Rate	☐	The top part > Currency > The currency of the document.
externalLink	varchar2		☐
externalReference	varchar2	External Reference	☐	The top part > External reference > The external reference used in AutoInvoice.
financialPeriod	varchar2	Financial Period	☐	The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.
hold	char	Hold	☐	The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released.
inventoryNumber	varchar2	Inventory Number	☐	Item ID > The item ID of the line item, if applicable. Only a non-stock item can be selected.
invoiceAddress_addressId	int32	Invoice Address ID	☐
invoiceAddress_addressLine1	varchar2	Invoice Address Line 1	☐	Address 1 > The first line of the customer's contact address.
invoiceAddress_addressLine2	varchar2	Invoice Address Line 2	☐	Address 2 > The second line of the address.
invoiceAddress_addressLine3	varchar2	Invoice Address Line 3	☐	Address 3 > The third line of the address.
invoiceAddress_city	varchar2	Invoice Address City	☐	City > The city.
invoiceAddress_country_errorInfo	varchar2	Invoice Address Country Error Information	☐
invoiceAddress_country_id	varchar2	Invoice Address Country ID	☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
invoiceAddress_country_metadata_maxPageSize	int64		☐
invoiceAddress_country_metadata_totalCount	int64		☐
invoiceAddress_country_name	varchar2	Invoice Address Country Name	☐	Mandatory field: Country name* > The complete name of the country.
invoiceAddress_county_id	varchar2	Invoice Address County ID	☐	Click the magnifier > The identifier
invoiceAddress_county_name	varchar2	Invoice Address County Name	☐	Click the magnifier > The displayed name
invoiceAddress_overrideAddress	char		☐	Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer.
invoiceAddress_postalCode	varchar2	Invoice Address Postal Code	☐	Postcode > The postcode.
invoiceContact_attention	varchar2	Invoice Contact Attention	☐
invoiceContact_businessName	varchar2		☐
invoiceContact_contactId	int32	Invoice Contact ID	☐
invoiceContact_email	varchar2	Invoice Contact Email Address	☐
invoiceContact_overrideContact	char		☐
invoiceContact_phone1	varchar2	Invoice Contact Phone 1	☐
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.
lineNumber	int32	Line Number	☐	Line no. > A counter of lines in the overview of cash sales document overview.
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
manualAmount	double	Manual Amount	☐	Manual amount > a check box indicating that the amount has been entered manually.
manualAmountInCurrency	double		☐	Background calculation giving you the Manual amount in your default currency. This field is applicable if the amount is given in another currency than your default.
manualDiscount	char	Manual Discount	☐	Manual discount > A check box that indicates (if selected) that the discount has been appliedmanually.If you clear the check box, the system clears entered discount percent,or discount amount, or selected discount code.
metadata_maxPageSize_2	int64		☐
metadata_maxPageSize	int64	Metadata Max Pagesize	☐
metadata_totalCount_2	int64		☐
metadata_totalCount	int64	Total Count	☐
note_2	varchar2	Note 2	☐	Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document.
note	varchar2	Note	☐	Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order.
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.
paymentReference	varchar2	Payment Reference	☐	///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..
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.
quantity	double	Quantity	☐	Quantity > The quantity of items (goods or services) of a particular type sold to the customer.
referenceNumber	varchar2	Reference Number	☐	The Top part > Ref. no. > The reference number of the customer ledger document in the system.
revoked	char	Revoke	☐
roundingDiff	double	Rounding Difference	☐	The top part > Rounding diff. > The difference between the original amount and the rounded amount.
salesPerson_2_description	varchar2	Salesperson 2 Description	☐	Click on the magnifier. > The description.
salesPerson_2_id	varchar2	Salesperson 2 ID	☐	Click on the magnifier. > The identifier.
salesperson	varchar2	Salesperson	☐	The field is deprecated for customer document endpoints, please use Seller instead
salesPersonDescr	varchar2	Sales Person Name	☐	The field is deprecated for customer document endpoints, please use SalesPerson instead
salesPersonID	int32	Sales Person ID	☐	The field is deprecated for customer document endpoints, please use SalesPerson instead
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.
seller_description	varchar2	Seller Description	☐	Click on the magnifier. > The description.
seller_id	varchar2	Seller ID	☐	Click on the magnifier. > The identifier.
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.
subaccount_active	char	Sub Account Active 2	☐	Active > The status of the identifier.
subaccount_description	varchar2	Subaccount Description	☐	Description > The description of the identifier.
subaccount_errorInfo	varchar2	Sub Account Error Message	☐
subaccount_lastModifiedDateTime	datetime	Sub Account Last Modified	☐	System generated information.
subaccount_metadata_maxPageSize	int64	Sub Account Metadata Max Pagesize	☐
subaccount_metadata_totalCount	int64	Sub Account Metadata Total Count	☐
subaccount_subaccountId	int32	Sub Account ID	☐	SubID > The identifier of the subaccount.
subaccount_subaccountNumber	varchar2	Sub Account Number	☐	Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
subaccount_timeStamp	blob		☐	The timestamp of the subaccount, used for concurrency control.
subaccountId	int32		☐	SubID > The identifier of the subaccount.
subaccountNumber	varchar2		☐	Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
timeStamp_2	blob		☐	Identifier that represents a specific version of the resource.It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)
timeStamp	blob	Timestamp	☐	The timestamp of the subaccount, used for concurrency control.
unitPrice	double		☐	Unit price > The unit price set for the item or service. If you want to update the unit priceautomatically to the current value(that is, the applicable sales or default price),you can use the Recalculate Prices and Discounts action.If you have modifiedthe unit price and saved the document, the value will not be updated by thesystem if you change the document date.
unitPriceInCurrency	double	Unit Price in Currency	☐	Background calculation giving you the Unit price in your default currency. This field is applicable if the amount is given in another currency than your default.
uom	varchar2	Unit of Measure	☐	UoM > The unit of measure (UoM) for the item.
vatCode_description	varchar2	VAT Code Description	☐	Click on the magnifier. > The description.
vatCode_id	varchar2	VAT Code 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. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.
vatExemptTotalInCurrency	double	VAT Exempt Total in Currency	☐	Background calculation giving you the VAT exempt. total in your default currency. This field is applicable if the amount is given in a another currency than your default.
vatTaxableTotal	double	VAT Taxable Total	☐	The top part > VAT taxable total > The document total that is subjected to VAT.
vatTaxableTotalInCurrency	double	VAT Taxable Total in Currency	☐	Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in a another currency than your default.
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

CustomerOverdueChargeSubAccountSegmentLines

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information