CustomerPaymentLinesByPaymentNumber: Visma.net Financials Customer Payment Lines by Payment Number
read only REST
- Catalog:
VismaNet - Schema:
CustomerPayment - Label: Customer Payment Lines by Payment Number
Get a specific Payment Data for Payment The response headers include an ETag after a successful GET operation.
Can only retrieve data.
Summary
Data for Payment
The response headers include an ETag after a successful GET operation.
API Source
- Endpoint:
/v1/customerPayment/{paymentNumber} - Operation:
get /v1/customerPayment/{paymentNumber}
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 155 |
| Full scan rows per minute | 29,100 |
| Point query rows per minute | 387 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
payment |
`` | Identifies the Payment |
Table Columns
The columns of the table CustomerPaymentLinesByPaymentNumber are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
COMPANY_ |
varchar2 |
Company Code | writable | Partition code, segmenting the data. | |
COMPANY_ |
varchar2 |
Company Name | writable | Name of the partition. | |
amount |
double |
Amount Paid | writable, amount |
Amount paid > The amount to be paid which is displayed in the currency of the document that is selected in the window. | |
application |
datetime |
Application Date | filters on the platform, writable, ::ancestor. |
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 | |
application |
varchar2 |
Application Period | filters on the platform, writable, ::ancestor. |
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. | |
applied |
double |
itgen_vnet_appliedtodocuments | filters on the platform, writable, ::ancestor. |
The top part > Applied to documents > The total of the documents to which payment is to be applied. | |
applied |
double |
itgen_vnet_appliedtoorders | filters on the platform, writable, ::ancestor. |
The top part > Applied to orders > The total of the orders for which payment is reserved, minus the amount transferred to invoice. | |
available |
double |
Available Balance | filters on the platform, writable, ::ancestor. |
The top part > Available balance > The amount that has not been applied. | |
available |
double |
itgen_vnet_availablebalanceincurrency | filters on the platform, writable, ::ancestor. |
Available Balance calculated in your default (base) currency. This field is applicable if the amount is given in another currency than your default. | |
balance |
double |
Balance | writable, balance |
Balance > The balance of the document after the cash discount is taken and the amount is paid. | |
balance |
double |
itgen_vnet_balancewriteoff | writable, balance |
Balance write-off > The amount to be written off. | |
branch |
varchar2 |
Branch | filters on the platform, writable, ::ancestor. |
||
cash |
varchar2 |
Cash Account | filters on the platform, writable, ::ancestor. |
Mandatory field: The top part > Cash account* > The default cash account associated with the payment method; this field is not available for credit notes. | |
cash |
double |
itgen_vnet_cashdiscountbalance | writable, cash |
Cash discount balance > The unused amount of the cash discount, in case of partial payment. | |
cash |
datetime |
Cash Discount Date | writable, cash |
Cash disount date > The date through which the customer can take a cash discount. | |
cash |
double |
itgen_vnet_cashdiscounttaken | writable, cash |
Cash discount taken > The cash discount to be taken. | |
cross |
double |
Cross Rate | writable, cross |
Cross rate > A cross rate that you can optionally specify between the currency of the payment and currency of the original document. | |
currency |
varchar2 |
Currency | writable, currency |
Currency > The currency of the customer ledger document. | |
currency_ |
varchar2 |
itgen_vnet_currency_2 | filters on the platform, writable, ::ancestor. |
The top part > Currency > The currency of the payment document. | |
customer |
varchar2 |
Customer Order | writable, customer |
Customer order > A reference to a document of the customer, such as a purchase order number. | |
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, ::ancestor. |
Click the magnifier. > The name. | |
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, ::ancestor. |
||
date |
datetime |
Date | writable, date |
Date > The creation date of the customer ledger document. | |
deducted |
double |
Deducted Charges | filters on the platform, writable, ::ancestor. |
The top part > Deducted charges > The total amount of bank charges deducted by bank from the payment amount on your cash account (bank account). | |
description |
varchar2 |
Description | writable, description |
Description > A description of the document. | |
document |
varchar2 |
Document Type | writable, document |
Doc. type > The type of document to which the payment is applied. | |
due |
datetime |
Due Date | writable, due |
Due date > The due date of the customer ledger document. | |
error |
varchar2 |
Error Message | filters on the platform, writable, ::ancestor. |
||
finance |
double |
Finance Charges | filters on the platform, writable, ::ancestor. |
The top part > Finance charges > The total on all finance charges applied to this document. | |
financial |
datetime |
itgen_vnet_financialdetails_paymentdate | filters on the platform, writable, ::ancestor. |
Financial Details tab > Payment date | |
hold |
char |
Hold | filters on the platform, writable, ::ancestor. |
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. | |
invoice |
varchar2 |
Invoice Text | filters on the platform, writable, ::ancestor. |
The top part > Invoice text > A user-defined description of the payment. 50 alphanumeric characters. | |
last |
datetime |
Last Modified | filters on the platform, writable, ::ancestor. |
Systemgenerated information. | |
location_ |
varchar2 |
Location Country ID | filters on the platform, writable, ::ancestor. |
Location*. | |
location_ |
varchar2 |
Location ID | filters on the platform, writable, ::ancestor. |
Click the magnifier > The identifier | |
location_ |
varchar2 |
Location Name | filters on the platform, writable, ::ancestor. |
Click the magnifier > The displayed name | |
metadata_ |
int64 |
Metadata Max Pagesize | filters on the platform, writable, ::ancestor. |
||
metadata_ |
int64 |
Total Count | filters on the platform, writable, ::ancestor. |
||
payment |
double |
Payment Amount | filters on the platform, writable, ::ancestor. |
The top part > Payment amount > The total of the payment that is entered manually. | |
payment |
double |
itgen_vnet_paymentamountincurrency | filters on the platform, writable, ::ancestor. |
Payment amount calculated in your default (base) currency. This field is applicable if the amount is given in another currency than your default. | |
payment |
varchar2 |
Payment Method Description | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The description. | |
payment |
varchar2 |
Payment Method ID | filters on the platform, writable, ::ancestor. |
Click on the magnifier. > The identifier. | |
payment |
varchar2 |
Payment Reference | filters on the platform, writable, ::ancestor. |
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. | |
post |
varchar2 |
Post Period | writable, post |
Post period > The financial period to which the transactions recorded in the document should be posted. Format MMYYYY. | |
refNbr |
varchar2 |
Reference Number | writable, refNbr |
Mandatory field: Ref. no.* > The reference number of the invoice or note to which the payment is applied. | |
ref |
varchar2 |
itgen_vnet_refnbr_2 | filters on the platform, writable, ::ancestor. |
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 series in the AR101000 window. | |
status |
varchar2 |
Status | filters on the platform, writable, ::ancestor. |
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] | |
time |
blob |
Timestamp | filters on the platform, writable, ::ancestor. |
Identifier that represents a specific version of the resource. It helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers) | |
type |
varchar2 |
Type | filters on the platform, writable, ::ancestor. |
The top part > Type > The type of a document. The following types are available: Payment, CreditNote, Prepayment, Customer refund, Void payment, Balance write-off | |
write |
double |
Write-off Amount | filters on the platform, writable, ::ancestor. |
The top part > Write-off amount > The amount that has been written off. | |
write |
varchar2 |
itgen_vnet_writeoffreasoncode_description | writable, write |
Click on the magnifier. > The description. | |
write |
varchar2 |
itgen_vnet_writeoffreasoncode_id | writable, write |
Click on the magnifier. > The identifier. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: