Please enable JavaScript to view this site.

Made in EU
Visma.net Financials Forums

Navigation: Schema: SupplierPayment > Tables

SupplierPayments: Visma.net Financials Supplier Payments

Get all SupplierPayments.Request page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page sizeScreenId=AP302000

Catalog: VismaNet

Schema: SupplierPayment

Label: Supplier Payments

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

greaterThanValue

string

 

Enter the from-value for Ref. no.

invoiceRefNbr

string

 

 

lastModifiedDateTime

string

 

System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.

lastModifiedDateTimeCondition

string

 

System retrieved information for state/condition.

pageNumber

int32

 

Pagination parameter. Page number.

pageSize

int32

 

Pagination parameter. Number of items to be collected.Please use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page size.

supplier

string

 

Filter by Supplier

 

Columns of Table Function

The columns of the table function SupplierPayments 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 the payment is applied. The default value is the current business date.

applicationPeriod

string

Application Period

MAndatory field: The top part > Financial period* > The financial period of payment application.

appliedAmount

double

 

The top part > Amount > The amount to be applied on the application date.

branch

string

Branch

 

cashAccount

string

Cash Account

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

COMPANY_CODE

string(30)

Company Code

Partition code, segmenting the data.

COMPANY_NAME

string(240)

Company Name

Name of the partition.

currency_decimalPrecision

int32

 

Decimal precision.

currency_description

string

Currency Description

Currency description.

currency_id

string

Currency ID

Currency Id.

currency_isBaseCurrency

boolean

 

Identify if the currency is the base currency.

currency_isUsedForAccounting

boolean

 

Identify if is used for accounting.

currency_symbol

string

 

Currency symbol.

description

string

Description

The top part > Description > A description for the payment. You may use up to 50 alphanumeric characters.

documentType

string

Document Type

The top part > Voucher no. > The unique identifier of the supplier ledger document.

errorInfo

string

Error Message

 

financeCharges

double

Finance Charges

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

hold

boolean

Hold

The top part > Hold > A check box that means (if selected) that the status of the document is On hold.

lastModifiedDateTime

datetime

Last Modified

Background information: The date and time when the document has been last modified.

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 payment amount that should be applied to the documents.

paymentMethod

string

 

Mandatory field: The top part > Payment method* > The payment method associated with the supplier.

paymentRef

string

Payment Reference

The top part > Payment ref. > A payment reference number.

refNbr

string

Reference Number

The top part > Voucher no. > The unique identifier of the supplier ledger document.

released

boolean

Released

Background information: if this check box is selected, the document has been released.

status

string

Status

The top part > Status > The status of the supplier ledger document, which can be one of the following: On Hold, Printed, Open, Reserved, Closed, Voided, Released.

supplier_internalId

int32

Supplier Internal ID

 

supplier_name

string

Supplier Name

The name of the particular destination of the selected type.

supplier_number

string

Supplier Number

The identifier of the particular destination of the selected type.

type

string

Type

The top part > Type >The type of supplier ledger payment document. The following types are available: Payment, PUrchase credit note, Prepayment, Supplier refund, Voided payment.

unappliedBalance

double

 

The top part > Unapplied balance > The balance that has not been applied. This will be a non-zero value if the payment amount is not equal to a document's total amount. Checks shall always have a zero unapplied balance.

 

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