Please enable JavaScript to view this site.

Made in EU
Visma.net Financials Forums

Visma.net Financials API Data Model

Navigation: Package: vnt_customerpayment > Procedures

vnt_customerpayment.customerpayment_putbypaymentnumber: Visma.net Financials Package for CustomerPayment operations that could not be mapped to a table.

Response Message has StatusCode NoContent if PUT operation succeed

Parameters of Procedure

The following parameters can be used to control the behaviour of the procedure vnt_customerpayment.customerpayment_putbypaymentnumber. 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 `begin package.procedure(value1, value2, value3); end` on a procedure 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 `begin package.procedure(name1 => value1, name3 => value3); end` on the same procedure 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

p_paymentNumber

string

☑

 

Identifies the Payment to update

p_referenceNumber

string

☐

 

The top part > Ref. no > Reference number for the document. Can be used when manual numbering is enabled.

p_type

string

☐

 

The top part > Type > The type of a document: Payment, Credit note, Prepayment, Customer refund, Void payment, Balance write-off.

p_hold

string

☐

 

The top part > Hold > A check box that indicates (if selected) that the document is a draft with the On hold status.

p_applicationDate

string

☐

 

Mandatory field: The top part > Date* > The date when a payment is applied to a document (invoice or note). The current business date for unapplied or partially applied payments and the latest application date for the closed payment.

p_applicationPeriod

string

☐

 

Mandatory field: The top part > Financial period* > The financial period to which the payment should be applied, which the system fills in based on the date.

p_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.

p_customer

string

☐

 

Mandatory field: The top part > Customer* > The customer who issued the payment.

p_location

string

☐

 

Mandatory field: The top part > Location* > The customer location associated with the sale. Once the customer is selected, this field displays the customer's default location.

p_paymentMethod

string

☐

 

The top part > Payment method > The customer's default payment method.

p_cashAccount

string

☐

 

Mandatory field: The top part > Cash account* > The default cash account associated with the payment method.

p_currency

string

☐

 

The top part > Currency > The currency of the payment document. Once the customer is selected, the system inserts the customer's default currency.

p_paymentAmount

string

☐

 

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

p_invoiceText

string

☐

 

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

p_branch

string

☐

 

 

p_overrideNumberSeries

string

☐

 

 

 

23-06-2025 19:16 Version 24.1.116-BETA+5455

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