Reverse a Cash Transaction- ScreenID=CA304000The action result dto contains information about the result of running the action
Catalog: VismaNet
Schema: CashTransaction
The data in this table is partitioned per value of the COMPANY_CODE column.
This is a read-only table function. The Visma.net API may not support changing the data or the Invantive SQL driver for Visma.net does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net API.
Select Visma.net API URL: /controller/api/v1/cashTransaction/{referenceNbr}/action/reverse
Insert Visma.net API URL: /controller/api/v1/cashTransaction/{referenceNbr}/action/reverse
Update Visma.net API URL: /controller/api/v1/cashTransaction/{referenceNbr}/action/reverse
Delete Visma.net API URL: /controller/api/v1/cashTransaction/{referenceNbr}/action/reverse
Field Selection Method: NotRequired
Select Visma.net API Operation: post /controller/api/v1/cashTransaction/{referenceNbr}/action/reverse
Table Function Parameters
The following parameters can be used to control the behaviour of the table function CashTransaction_ReverseByReferenceNumber. 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. |
referenceNbr |
string |
☑ |
|
Reference number of the cash transaction to be reversed. |
reverseActionDto |
string |
☑ |
|
The action dto use to condition the action |
Table Function Columns
The columns of the table function CashTransaction_ReverseByReferenceNumber are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
actionId |
string |
Action ID |
☐ |
|
actionResult |
string |
Action Result |
☐ |
|
cashTransaction_amount |
double |
Amount |
☐ |
The top part > Amount > The amount of the transaction. |
cashTransaction_cashAccount_description |
string |
Cash Account Description |
☐ |
Name of item/description |
cashTransaction_cashAccount_number |
string |
Cash Account Number |
☐ |
Number of item |
cashTransaction_cashAccount_type |
string |
Cash Account Type |
☐ |
|
cashTransaction_controlTotal |
double |
|
☐ |
Mandatory field: The top part > Control total > The control total of the transaction. |
cashTransaction_currency |
string |
Currency |
☐ |
The top part > Currency > The currency of the cash account. |
cashTransaction_description |
string |
Description |
☐ |
The top part > Description > A detailed description of the transaction. |
cashTransaction_disbReceipt |
string |
|
☐ |
The top part > Disb./receipt > The basic type of the transaction. |
cashTransaction_documentRef |
string |
Document Reference |
☐ |
The top part > Document ref. > The external document reference number. |
cashTransaction_entryType_description |
string |
Entry Type Description |
☐ |
Click on the magnifier. > The description. |
cashTransaction_entryType_id |
string |
Entry Type ID |
☐ |
Click on the magnifier. > The identifier. |
cashTransaction_financialPeriod |
string |
Financial Period |
☐ |
Mandatory field: The top part > Period* > The financial period to which the transaction should be posted. |
cashTransaction_financialsDetail_batchNumber |
string |
Batch Number |
☐ |
Link to general ledger section > Batch number > The number of the batch generated to implement the cash transaction. |
cashTransaction_financialsDetail_branch_name |
string |
Branch Name |
☐ |
Click the magnifier. > The name. |
cashTransaction_financialsDetail_branch_number |
string |
Branch Number |
☐ |
Click the magnifier. > The identifier. |
cashTransaction_financialsDetail_clearDate |
datetime |
Clear Date |
☐ |
Link to general ledger section > Clear date > The date when the transaction was cleared. |
cashTransaction_financialsDetail_cleared |
boolean |
Cleared? |
☐ |
Link to general ledger section > Cleared > A check box that indicates (if selected) that the transaction was cleared. |
cashTransaction_financialsDetail_taxCalcMode |
string |
Tax Calculation Mode |
☐ |
VAT settings section > VAT calculation > The VAT calculation mode, which defines which amounts (VAT-inclusive or VAT-exclusive) should be entered in the detail lines of a document. |
cashTransaction_financialsDetail_taxZone_defaultTaxCategory_description |
string |
Tax Zone Default Tax Category Description |
☐ |
Name of item/description |
cashTransaction_financialsDetail_taxZone_defaultTaxCategory_number |
string |
Tax Zone Default Tax Category Number |
☐ |
Number of item |
cashTransaction_financialsDetail_taxZone_defaultVatCategory |
string |
Tax Zone Default VAT Category |
☐ |
Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window. |
cashTransaction_financialsDetail_taxZone_description |
string |
Tax Zone Description |
☐ |
Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window. |
cashTransaction_financialsDetail_taxZone_errorInfo |
string |
|
☐ |
|
cashTransaction_financialsDetail_taxZone_id |
string |
Tax Zone ID |
☐ |
Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window. |
cashTransaction_financialsDetail_taxZone_metadata_maxPageSize |
int64 |
|
☐ |
|
cashTransaction_financialsDetail_taxZone_metadata_totalCount |
int64 |
|
☐ |
|
cashTransaction_finPeriod |
string |
Financial Period |
☐ |
The property is now considered obsolete. Use Financial Period instead |
cashTransaction_hold |
boolean |
Hold? |
☐ |
The top part > Hold > A check box that, if selected, indicates that the transaction is on hold, which means it may be edited but cannot be released. |
cashTransaction_lastModifiedDateTime |
datetime |
Last Modified |
☐ |
System generated information. |
cashTransaction_owner_internalId |
string |
Owner Internal ID |
☐ |
|
cashTransaction_owner_name |
string |
Owner Name |
☐ |
The name of the particular destination of the selected type. |
cashTransaction_owner_number |
string |
Owner Number |
☐ |
The identifier of the particular destination of the selected type. |
cashTransaction_referenceNbr |
string |
Reference Number |
☐ |
The top part > Ref. no. > The unique identifier assigned to the cash transaction in accordance with the numbering sequence. |
cashTransaction_status |
string |
Status |
☐ |
The top part > Status > The status of the transaction, which is automatically assigned by the system. |
cashTransaction_taxAmount |
double |
Tax Amount |
☐ |
The top part > VAT amount > The VAT amount to be paid for the document. A user enters this amount manually. |
cashTransaction_taxTotal |
double |
Tax Total |
☐ |
The top part > VAT total > The total amount of tax paid in the document. |
cashTransaction_tranDate |
datetime |
Transaction Date |
☐ |
Mandatory field: The top part > Trans. date* > The date of the transaction. |
cashTransaction_tranType |
string |
Transaction Type |
☐ |
The top part > Trans type > The type of cash transaction. |
cashTransaction_vatExemptTotal |
double |
VAT Exempt Total |
☐ |
The top part > VAT exempt total > The document total that is exempt from VAT. |
cashTransaction_vatTaxableTotal |
double |
VAT Taxable Total |
☐ |
The top part > VAT taxable total > The document total that is subjected to VAT. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
errorInfo |
string |
Error Message |
☐ |
|
referenceNbr |
string |
Reference Number |
☐ |
|
12-12-2020 18:42 Version 20.1.301-BETA+3023
