Please enable JavaScript to view this site.

Visma.net Financials API Data Model Visma.net Financials Forums

Navigation: Schema: Payment > Tables

PaymentByNumber: Visma.net Financials Payment by Number

Get a specific PaymentPayment is deprecated, please use CustomerPayment instead.

Catalog: VismaNet

Schema: Payment

Label: Payment by Number

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.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function PaymentByNumber. 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 evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `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.

erp-api-background

string

☐

 

If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.

paymentNumber

string

☑

 

Identifies the Payment

 

Columns of Table Function

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

Name

Data Type

Label

Required

Documentation

applicationDate

datetime

Application Date

☐

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

applicationPeriod

string

Application Period

☐

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.

appliedToDocuments

double

 

☐

The top part > Applied to documents > The total of the documents to which payment is to be applied.

appliedToOrders

double

 

☐

The top part > Applied to orders > The total of the orders for which payment is reserved, minus the amount transferred to invoice.

availableBalance

double

Available Balance

☐

The top part > Available balance > The amount that has not been applied.

branch

string

Branch

☐

 

cashAccount

string

Cash Account

☐

Mandatory field: The top part > Cash account* > The default cash account associated with the payment method; this field is not available for credit notes.

COMPANY_CODE

string(30)

Company Code

☑

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

☑

Name of the partition.

currency

string

Currency

☐

The top part > Currency > The currency of the payment document.

customer_name

string

Customer Name

☐

Click the magnifier. > The name.

customer_number

string

Customer Number

☐

 

deductedCharges

double

Deducted Charges

☐

The top part > Deducted charges > The total amount of bank charges deducted by bank from the payment amount on your cash account (bank account).

errorInfo

string

Error Message

☐

 

financeCharges

double

Finance Charges

☐

The top part > Finance charges > The total on all finance charges applied to this document.

financialDetails_paymentDate

datetime

 

☐

Financial Details tab > Payment date

hold

boolean

Hold

☐

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.

invoiceText

string

Invoice Text

☐

The top part > Invoice text > A user-defined description of the payment. 50 alphanumeric characters.

lastModifiedDateTime

datetime

Last Modified

☐

Systemgenerated 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

int64

 

☐

 

metadata_totalCount

int64

Total Count

☐

 

paymentAmount

double

Payment Amount

☐

The top part > Payment amount > The total of the payment that is entered manually.

paymentMethod_description

string

Payment Method Description

☐

Click on the magnifier. > The description.

paymentMethod_id

string

Payment Method ID

☐

Click on the magnifier. > The identifier.

paymentRef

string

Payment Reference

☐

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.

refNbr

string

Reference Number

☐

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.

status

string

Status

☐

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]

type

string

Type

☐

The top part > Type > The type of a document. The following types are available: Payment, CreditNote, Prepayment, Customer refund, Void payment, Balance write-off

writeOffAmount

double

Write-off Amount

☐

The top part > Write-off amount > The amount that has been written off.

 

22-12-2022 21:03 Version 22.1.101-BETA+3681

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer