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: CreditNote > Tables

CreditNotes: Visma.net Financials Credit Notes

Contents Previous Home Next More

Get a range of Credit Notes - Method is deprecated start using the new method in endpoint Customer Credit Note

Catalog: VismaNet

Schema: CreditNote

Label: Credit Notes

The data in this table is partitioned per value of the COMPANY_CODE column.

Retrieve: true

Insert: true

Update: true

Delete: false

Select Visma.net Financials API URL: /controller/api/v1/creditNote

Insert Visma.net Financials API URL: /controller/api/v1/creditNote

Update Visma.net Financials API URL: /controller/api/v1/creditNote

Delete Visma.net Financials API URL: /controller/api/v1/creditNote

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: get /controller/api/v1/creditNote

Insert Visma.net Financials API Operation: post /controller/api/v1/creditNote

Update Visma.net Financials API Operation: put /controller/api/v1/creditNote/{creditNoteNumber}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function CreditNotes. 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	Documentation
closedFinancialPeriod	string	☐	The date of the closing of the financial period.
COMPANY_CODE	string	☐	Partition to retrieve data from.
createdDateTime	string	☐	Creation date and time.
createdDateTimeCondition	string	☐	System-retrieved information for state/condition
customerRefNumber	string	☐	The top part > External reference > The external reference used in AutoInvoice.
documentDueDate	datetime	☐	The date when payment for the document is due, in accordance with the credit terms.
documentType	string	☐	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	string	☐	The date and time for when the document last released a dunning letter.
dunningLetterDateTimeCondition	string	☐	Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.
dunningLevel	int32	☐	The dunning level of the document.
expandApplications	boolean	☐	True if you want to see all dunning information regarding this document.
expandAttachments	boolean	☐	True if you want to see all attachments regarding this document.
expandDunningInformation	boolean	☐
expandInvoiceAddress	boolean	☐	True if you want to see all information regarding the invoice address for this document.
expandTaxDetails	boolean	☐	True if you want to see all VAT details regarding this document.
externalReference	string	☐	The top part > External reference > The external reference used in AutoInvoice.
financialPeriod	string	☐	The financial period to which the transactions recorded in the document is posted. Format YYYYMM.
greaterThanValue	string	☐	Greater than value. The item which is the object for this, varies from API to API.
lastModifiedDateTime	string	☐	System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.
lastModifiedDateTimeCondition	string	☐	System retrieved information for state/condition.
numberToRead	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
pageNumber	int32	☐	Pagination parameter. Page number.
pageSize	int32	☐	Pagination parameter. Number of items to be collected.
paymentReference	string	☐	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	string	☐	The project with which the document is associated.
released	int32	☐	Parameter for showing if invoice has been released or not.
skipRecords	int32	☐	This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.
status	string	☐	The status of the document. Use the dropdown to select status. (Values: Hold, Balanced, Voided, Scheduled, Open, Closed, PendingPrint, PendingEmail, CreditHold, CcHold, Reserved)

Table Function Columns

The columns of the table function CreditNotes 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 or update.

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.
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.
contact_id	int32	Contact ID	☐	Click the magnifier > The identifier
contact_name	string	Contact Name	☐	Click the magnifier > The displayed name
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.
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.
discountTotal	double	Discount Total	☐	The top part > Discount total > The document discount total.
discountTotalInCurrency	double		☐	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.
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
dontEmail	boolean	Don't Email	☐
dontPrint	boolean	Don't Print	☐
errorInfo	string	Error Message	☐
externalReference	string	External Reference	☐
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 selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released.
invoiceAddress_addressId	int32	Invoice Address ID	☐
invoiceAddress_addressLine1	string	Invoice Address Line 1	☐	Address 1 > The first line of the customer's contact address.
invoiceAddress_addressLine2	string	Invoice Address Line 2	☐	Address 2 > The second line of the address.
invoiceAddress_addressLine3	string	Invoice Address Line 3	☐	Address 3 > The third line of the address.
invoiceAddress_city	string	Invoice Address City	☐	City > The city.
invoiceAddress_country_errorInfo	string		☐
invoiceAddress_country_id	string	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	string	Invoice Address Country Name	☐	Mandatory field: Country name* > The complete name of the country.
invoiceAddress_county_id	string	Invoice Address County ID	☐	Click the magnifier > The identifier
invoiceAddress_county_name	string	Invoice Address County Name	☐	Click the magnifier > The displayed name
invoiceAddress_overrideAddress	boolean		☐	Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer.
invoiceAddress_postalCode	string	Invoice Address Postal Code	☐	Postcode > The postcode.
invoiceContact_attention	string	Invoice Contact Attention	☐
invoiceContact_businessName	string		☐
invoiceContact_contactId	int32	Invoice Contact ID	☐
invoiceContact_email	string	Invoice Contact Email Address	☐
invoiceContact_overrideContact	boolean		☐
invoiceContact_phone1	string	Invoice Contact Phone 1	☐
invoiceText	string	Invoice Text	☐	The top part > Invoice text > Any user-provided description of the customer ledger document.
lastModifiedDateTime	datetime	Last Modified	☐	System generated field for last modification date/time of document.
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	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.
paymentReference	string	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	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.
salesPerson_description	string	Sales Person Description	☐	Click on the magnifier. > The description.
salesPerson_id	string	Sales Person ID	☐	Click on the magnifier. > The identifier.
salesPersonDescr	string	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
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.
subaccount_active	boolean		☐	Active > The status of the identifier.
subaccount_description	string	Subaccount Description	☐	Description > The description of the identifier.
subaccount_errorInfo	string	Sub Account Error Message	☐
subaccount_lastModifiedDateTime	datetime	Sub Account Last Modified	☐	System generated information.
subaccount_metadata_maxPageSize	int64		☐
subaccount_metadata_totalCount	int64		☐
subaccount_subaccountId	int32	Sub Account ID	☐	SubID > The identifier of the subaccount.
subaccount_subaccountNumber	string	Sub Account Number	☐	Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
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.

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