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

CustomerInvoiceReverseByInvoiceNumber

Contents Previous Home Next More

Reverse an InvoiceThe action result dto contains information about the result of running the action

Catalog: VismaNet

Schema: CustomerInvoice

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/customerinvoice/{invoiceNumber}/action/reverse

Insert Visma.net Financials API URL: /controller/api/v1/customerinvoice/{invoiceNumber}/action/reverse

Update Visma.net Financials API URL: /controller/api/v1/customerinvoice/{invoiceNumber}/action/reverse

Delete Visma.net Financials API URL: /controller/api/v1/customerinvoice/{invoiceNumber}/action/reverse

Field Selection Method: NotRequired

Select Visma.net Financials API Operation: post /controller/api/v1/customerinvoice/{invoiceNumber}/action/reverse

Table Function Parameters

The following parameters can be used to control the behaviour of the table function CustomerInvoiceReverseByInvoiceNumber. 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
COMPANY_CODE	string	☐	Partition to retrieve data from.
invoiceNumber	string	☑	Reference number of the released invoice to be reversed
reverseActionDto	string	☑	The action the dto use to condition the action

Table Function Columns

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

Name	Data Type	Label	Required	Documentation
actionId	string	Action ID	☐
actionResult	string	Action Result	☐
COMPANY_CODE	string(30)	Company Code	☑	Partition code, segmenting the data.
COMPANY_NAME	string(240)	Company Name	☑	Name of the partition.
creditNoteDto_account_description	string		☐	Name of item/description
creditNoteDto_account_externalCode1	string		☐	Account class > The identifier of the account class.
creditNoteDto_account_externalCode2	string		☐	Account class > The name of the account class.
creditNoteDto_account_number	string		☐	Number of item
creditNoteDto_account_type	string		☐	Account > The account number.
creditNoteDto_amount	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.
creditNoteDto_amountInCurrency	double		☐	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.
creditNoteDto_balance	double		☐	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.
creditNoteDto_balanceInCurrency	double		☐	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.
creditNoteDto_branchNumber_name	string		☐	Click the magnifier. > The name.
creditNoteDto_branchNumber_number	string		☐	Click the magnifier. > The identifier.
creditNoteDto_cashAccount	string		☐	Financial details tab > The payment information section > Cash account > The cash account associated with the payment method.
creditNoteDto_cashDiscount	double		☐	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.
creditNoteDto_cashDiscountInCurrency	double		☐	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.
creditNoteDto_closedFinancialPeriod	string		☐	Format YYYYMM.
creditNoteDto_contact_id	int32		☐	Click the magnifier > The identifier
creditNoteDto_contact_name	string		☐	Click the magnifier > The displayed name
creditNoteDto_createdDateTime	datetime		☐	The Attachments tab > Creation time > The date the attachment was created.
creditNoteDto_currencyId	string		☐	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.
creditNoteDto_customer_name	string		☐	Click the magnifier. > The name.
creditNoteDto_customer_number	string		☐
creditNoteDto_customerProject	string		☐	The top part > Customer project no. > The customer project no. used in AutoInvoice.
creditNoteDto_customerRefNumber	string		☐	The top part > External reference > The external reference used in AutoInvoice.
creditNoteDto_detailTotal	double		☐	The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.
creditNoteDto_detailTotalInCurrency	double		☐	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.
creditNoteDto_discountTotal	double		☐	The top part > Discount total > The document discount total.
creditNoteDto_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.
creditNoteDto_documentDate	datetime		☐	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.
creditNoteDto_documentType	string		☐	The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off
creditNoteDto_dontEmail	boolean		☐
creditNoteDto_dontPrint	boolean		☐
creditNoteDto_errorInfo	string		☐
creditNoteDto_externalReference	string		☐
creditNoteDto_financialPeriod	string		☐	The financial period to which the transactions recorded in the document should be posted. Format YYYYMM.
creditNoteDto_hold	boolean		☐	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.
creditNoteDto_invoiceAddress_addressId	int32		☐
creditNoteDto_invoiceAddress_addressLine1	string		☐	Address 1 > The first line of the customer's contact address.
creditNoteDto_invoiceAddress_addressLine2	string		☐	Address 2 > The second line of the address.
creditNoteDto_invoiceAddress_addressLine3	string		☐	Address 3 > The third line of the address.
creditNoteDto_invoiceAddress_city	string		☐	City > The city.
creditNoteDto_invoiceAddress_country_errorInfo	string		☐
creditNoteDto_invoiceAddress_country_id	string		☐	Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166.
creditNoteDto_invoiceAddress_country_metadata_maxPageSize	int64		☐
creditNoteDto_invoiceAddress_country_metadata_totalCount	int64		☐
creditNoteDto_invoiceAddress_country_name	string		☐	Mandatory field: Country name* > The complete name of the country.
creditNoteDto_invoiceAddress_county_id	string		☐	Click the magnifier > The identifier
creditNoteDto_invoiceAddress_county_name	string		☐	Click the magnifier > The displayed name
creditNoteDto_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.
creditNoteDto_invoiceAddress_postalCode	string		☐	Postcode > The postcode.
creditNoteDto_invoiceContact_attention	string		☐
creditNoteDto_invoiceContact_businessName	string		☐
creditNoteDto_invoiceContact_contactId	int32		☐
creditNoteDto_invoiceContact_email	string		☐
creditNoteDto_invoiceContact_overrideContact	boolean		☐
creditNoteDto_invoiceContact_phone1	string		☐
creditNoteDto_invoiceText	string		☐	The top part > Invoice text > Any user-provided description of the customer ledger document.
creditNoteDto_lastModifiedDateTime	datetime		☐	System generated field for last modification date/time of document.
creditNoteDto_location_countryId	string		☐	Location*.
creditNoteDto_location_id	string		☐	Click the magnifier > The identifier
creditNoteDto_location_name	string		☐	Click the magnifier > The displayed name
creditNoteDto_metadata_maxPageSize	int64		☐
creditNoteDto_metadata_totalCount	int64		☐
creditNoteDto_note	string		☐	Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document.
creditNoteDto_origInvoiceDate	datetime		☐	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.
creditNoteDto_paymentMethod_description	string		☐	Click on the magnifier. > The description.
creditNoteDto_paymentMethod_id	string		☐	Click on the magnifier. > The identifier.
creditNoteDto_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..
creditNoteDto_postPeriod	string		☐	The top part > Post period > The period to which the document should be posted. Format YYYYMM.
creditNoteDto_project_description	string		☐	Click on the magnifier. > The description.
creditNoteDto_project_id	string		☐	Click on the magnifier. > The identifier.
creditNoteDto_referenceNumber	string		☐	The Top part > Ref. no. > The reference number of the customer ledger document in the system.
creditNoteDto_salesPerson_description	string		☐	Click on the magnifier. > The description.
creditNoteDto_salesPerson_id	string		☐	Click on the magnifier. > The identifier.
creditNoteDto_salesPersonDescr	string		☐	The field is deprecated for customer document endpoints, please use SalesPerson instead
creditNoteDto_salesPersonID	int32		☐	The field is deprecated for customer document endpoints, please use SalesPerson instead
creditNoteDto_status	string		☐	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.
creditNoteDto_subaccount_active	boolean		☐	Active > The status of the identifier.
creditNoteDto_subaccount_description	string		☐	Description > The description of the identifier.
creditNoteDto_subaccount_errorInfo	string		☐
creditNoteDto_subaccount_lastModifiedDateTime	datetime		☐	System generated information.
creditNoteDto_subaccount_metadata_maxPageSize	int64		☐
creditNoteDto_subaccount_metadata_totalCount	int64		☐
creditNoteDto_subaccount_subaccountId	int32		☐	SubID > The identifier of the subaccount.
creditNoteDto_subaccount_subaccountNumber	string		☐	Mandatory field: Subaccount* > The subaccount number. Format 9-XX.
creditNoteDto_vatExemptTotal	double		☐	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.
creditNoteDto_vatExemptTotalInCurrency	double		☐	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.
creditNoteDto_vatTaxableTotal	double		☐	The top part > VAT taxable total > The document total that is subjected to VAT.
creditNoteDto_vatTaxableTotalInCurrency	double		☐	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.
creditNoteDto_vatTotal	double		☐	The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.
creditNoteDto_vatTotalInCurrency	double		☐	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.
errorInfo	string	Error Message	☐
referenceNumber	string	Reference Number	☐

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