itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelVoid payment operationPayment is deprecated, please use CustomerPayment instead.The action result dto contains information about the result of running the action
Catalog: VismaNet
Schema: Payment
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/payment/{paymentNumber}/action/void
Insert Visma.net Financials API URL: /controller/api/v1/payment/{paymentNumber}/action/void
Update Visma.net Financials API URL: /controller/api/v1/payment/{paymentNumber}/action/void
Delete Visma.net Financials API URL: /controller/api/v1/payment/{paymentNumber}/action/void
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: post /controller/api/v1/payment/{paymentNumber}/action/void
Table Function Parameters
The following parameters can be used to control the behaviour of the table function PaymentVoidByNumber. 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. |
paymentNumber |
string |
☑ |
|
Reference number of the payment to be released |
voidActionDto |
string |
☑ |
|
Contains the type of the payment |
Table Function Columns
The columns of the table function PaymentVoidByNumber 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. |
errorInfo |
string |
Error Message |
☐ |
|
refNbr |
string |
Reference Number |
☐ |
|
type |
string |
Type |
☐ |
|
voidPayment_applicationDate |
datetime |
|
☐ |
Mandatory field: The top part > Date* > The date when a payment is applied to a document (invoice or note). The field display the current business date for tunapplied or partially applied payments and the latest application date for the closed payment |
voidPayment_applicationPeriod |
string |
|
☐ |
Mandatory field: The top part > Financial period* > The period to which the payment should be applied, which the system fills in based on the date. |
voidPayment_appliedToDocuments |
double |
|
☐ |
The top part > Applied to documents > The total of the documents to which payment is to be applied. |
voidPayment_appliedToOrders |
double |
|
☐ |
The top part > Applied to orders > The total of the orders for which payment is reserved, minus the amount transferred to invoice. |
voidPayment_availableBalance |
double |
|
☐ |
The top part > Available balance > The amount that has not been applied. |
voidPayment_branch |
string |
|
☐ |
|
voidPayment_cashAccount |
string |
|
☐ |
Mandatory field: The top part > Cash account* > The default cash account associated with the payment method; this field is not available for credit notes. |
voidPayment_currency |
string |
|
☐ |
The top part > Currency > The currency of the payment document. |
voidPayment_customer_name |
string |
|
☐ |
Click the magnifier. > The name. |
voidPayment_customer_number |
string |
|
☐ |
|
voidPayment_deductedCharges |
double |
|
☐ |
The top part > Deducted charges > The total amount of bank charges deducted by bank from the payment amount on your cash account (bank account). |
voidPayment_errorInfo |
string |
|
☐ |
|
voidPayment_financeCharges |
double |
|
☐ |
The top part > Finance charges > The total on all finance charges applied to this document. |
voidPayment_hold |
boolean |
|
☐ |
The top part > Hold > A check box that indicates (if selected) that the document is a draft with the On hold status. This check box is unavailable for debit adjustments. |
voidPayment_invoiceText |
string |
|
☐ |
The top part > Invoice text > A user-defined description of the payment. 50 alphanumeric characters. |
voidPayment_lastModifiedDateTime |
datetime |
|
☐ |
Systemgenerated information. |
voidPayment_location_countryId |
string |
|
☐ |
Location*. |
voidPayment_location_id |
string |
|
☐ |
Click the magnifier > The identifier |
voidPayment_location_name |
string |
|
☐ |
Click the magnifier > The displayed name |
voidPayment_metadata_maxPageSize |
int64 |
|
☐ |
|
voidPayment_metadata_totalCount |
int64 |
|
☐ |
|
voidPayment_paymentAmount |
double |
|
☐ |
The top part > Payment amount > The total of the payment that is entered manually. |
voidPayment_paymentMethod_description |
string |
|
☐ |
Click on the magnifier. > The description. |
voidPayment_paymentMethod_id |
string |
|
☐ |
Click on the magnifier. > The identifier. |
voidPayment_paymentRef |
string |
|
☐ |
Mandatory field: The top part > Payment ref.* > A secondary payment reference identifier, which can be a system-generated number or an external reference number entered manually. |
voidPayment_refNbr |
string |
|
☐ |
The top part > Ref.no > The unique identifier for the payment. This number is automatically generated by the system for a new payment document, based on the number seriesin the AR101000 window. |
voidPayment_status |
string |
|
☐ |
The top part > Status > The status of the customer payment, which for a new document is either Balanced or On hold. [On hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email, Credit hold, CcHold, Reserved] |
voidPayment_type |
string |
|
☐ |
The top part > Type > The type of a document. The following types are available: Payment, CreditNote, Prepayment, Customer refund, Void payment, Balance write-off |
voidPayment_writeOffAmount |
double |
|
☐ |
The top part > Write-off amount > The amount that has been written off. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
