Visma.net Financials API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: CustomerCreditWriteOff > Tables

CustomerCreditWriteOffBycreditWriteOffNumber_SubaccountSegments

Contents Previous Home Next More

Get a specific Customer Credit WriteOffData for Customer Credit WriteOff

Catalog: VismaNet

Schema: CustomerCreditWriteOff

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/customerCreditWriteOff/{creditWriteOffNumber}

Insert Visma.net Financials API URL: /controller/api/v1/customerCreditWriteOff/{creditWriteOffNumber}

Update Visma.net Financials API URL: /controller/api/v1/customerCreditWriteOff/{creditWriteOffNumber}

Delete Visma.net Financials API URL: /controller/api/v1/customerCreditWriteOff/{creditWriteOffNumber}

Field Selection Method: NotRequired

Base Path: subaccount.segments[*]

Select Visma.net Financials API Operation: get /controller/api/v1/customerCreditWriteOff/{creditWriteOffNumber}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function CustomerCreditWriteOffBycreditWriteOffNumber_SubaccountSegments. 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.
creditWriteOffNumber	string	☑		Identifies the Customer Credit WriteOff

Table Function Columns

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

Name	Data Type	Label	Required	Documentation
account_description	string	Account Description	☐	Name of item/description
account_externalCode1	string	Account External Code 1	☐	Account class > The identifier of the account class.
account_externalCode2	string	Account External Code 2	☐	Account class > The name of the account class.
account_number	string	Account Number	☐	Number of item
account_type	string	Account Type	☐	Account > The account number.
active	boolean	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.
branchNumber_name	string	Branch Name	☐	Click the magnifier. > The name.
branchNumber_number	string	Branch Number	☐	Click the magnifier. > The identifier.
cashAccount	string	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	string	Closed Financial Period	☐	Format YYYYMM.
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
createdDateTime	datetime	Created	☐	The Attachments tab > Creation time > The date the attachment was created.
currencyId	string	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	string	Customer Name	☐	Click the magnifier. > The name.
customer_number	string	Customer Number	☐
customerProject	string		☐	The top part > Customer project no. > The customer project no. used in AutoInvoice.
customerRefNumber	string	Custom Reference Number	☐	The top part > External reference > The external reference used in AutoInvoice.
customerVatZone_description	string	VAT Zone Description	☐	Click on the magnifier. > The description.
customerVatZone_id	string	VAT Zone ID	☐	Click on the magnifier. > The identifier.
description	string	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.
documentType	string	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_1	string		☐
errorInfo	string	Error Message	☐
financialPeriod	string	Financial Period	☐	The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.
hold	boolean	Hold	☐	The top part > Hold > A check box that indicates if the document is a draft. A document with the On Hold status may be edited and cannot be released.
invoiceText	string	Invoice Text	☐	The top part > Invoice text > Any user-provided description of the customer ledger document.
lastModifiedDateTime_1	datetime		☐	System generated field for last modification date/time of document.
lastModifiedDateTime	datetime	Last Modified	☐	System generated information.
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_1	int64		☐
metadata_maxPageSize	int64		☐
metadata_totalCount_1	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 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	string	Payment Method Description	☐	Click on the magnifier. > The description.
paymentMethod_id	string	Payment Method ID	☐	Click on the magnifier. > The identifier.
postPeriod	string	Post Period	☐	The top part > Post period > The period to which the document should be posted. Format YYYYMM.
project_description	string	Project Description	☐	Click on the magnifier. > The description.
project_id	string	Project ID	☐	Click on the magnifier. > The identifier.
referenceNumber	string	Reference Number	☐	The Top part > Ref. no. > The reference number of the customer ledger document in the system.
roundingDiff	double	Rounding Difference	☐	The top part > Rounding diff. > The difference between the original amount and the rounded amount.
segmentDescription	string		☐	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	string	Segment Value	☐	The Segment values window > The table > The value of the segment, alphanumeric.
segmentValueDescription	string	Segment Value Description	☐	The Segment values window > The table > The description of the segment value.
status	string	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	string		☐	Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
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.

06-04-2021 14:55 Version 20.1.393-BETA+3152

Please enable JavaScript to view this site.

itgendoc001X

Visma.net Financials API Data Model

Table Function Parameters

Table Function Columns