CustomerPayments: Visma.net Financials Customer Payments
popular insert REST
- Catalog:
VismaNet - Schema:
CustomerPayment - Label: Customer Payments
Get a range of Payments. - SceenId=AR302000 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 size
Can retrieve data and change data using insert.
API Source
- Endpoint:
/v1/customerPayment - Operation:
get /v1/customerPayment
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 |
|---|---|---|---|---|
branch |
`` | Filter by Branch | ||
customer |
`` | Enter Customer | ||
doc |
`` | This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future. Accepted format: * yyyy- * yyyy- * yyyy- * yyyy- * yyyy- Note: DocDate and DocDateCondition are mutually inclusive. |
||
doc |
`` | This value represents the condition to be applied to the Document Date when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: DocDate and DocDateCondition are mutually inclusive. | ||
financial |
`` | Filter by financial period, format YYYYPP | ||
greater |
`` | Enter the from-value for Ref. no. | ||
invoice |
`` | Enter Invoice Ref Nbr | ||
last |
`` | This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present. Accepted format: * yyyy- * yyyy- * yyyy- * yyyy- * yyyy- Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive. |
||
last |
`` | This value represents the condition to be applied when retrieving records. Accepted values (without the single quotes): * '>' for greater than * '<' for less than * '>=' for greater than or equal * '<=' for less than or equal Note: LastModifiedDateTime and LastModifiedDateTimeCondition are mutually inclusive. | ||
payment |
`` | Payment number | ||
payment |
`` | Select Type (Values: Payment, CreditNote, Prepayment, Refund, VoidPayment, SmallBalanceWo, VoidRefund, Undefined) | ||
status |
`` | The status of the document. Use the dropdown to select status. (Values: Hold, Balanced, Voided, Scheduled, Open, Closed, PendingPrint, PendingEmail, CreditHold, CcHold, Reserved) |
Table Columns
The columns of the table CustomerPayments 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. | |
application |
datetime |
Application Date | filters on the platform, writable, application |
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, application |
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, applied |
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, applied |
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, available |
The top part > Available balance > The amount that has not been applied. | |
available |
double |
itgen_vnet_availablebalanceincurrency | filters on the platform, writable, available |
Available Balance calculated in your default (base) currency. This field is applicable if the amount is given in another currency than your default. | |
branch |
varchar2 |
Branch | filters on the platform, writable, branch |
||
cash |
varchar2 |
Cash Account | filters on the platform, writable, cash |
Mandatory field: The top part > Cash account* > The default cash account associated with the payment method; this field is not available for credit notes. | |
currency |
varchar2 |
Currency | filters on the platform, writable, currency |
The top part > Currency > The currency of the payment document. | |
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, customer. |
Click the magnifier. > The name. | |
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, customer. |
||
deducted |
double |
Deducted Charges | filters on the platform, writable, deducted |
The top part > Deducted charges > The total amount of bank charges deducted by bank from the payment amount on your cash account (bank account). | |
error |
varchar2 |
Error Message | filters on the platform, writable, error |
||
finance |
double |
Finance Charges | filters on the platform, writable, finance |
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, financial |
Financial Details tab > Payment date | |
hold |
char |
Hold | filters on the platform, writable, 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. | |
invoice |
varchar2 |
Invoice Text | filters on the platform, writable, invoice |
The top part > Invoice text > A user-defined description of the payment. 50 alphanumeric characters. | |
last |
datetime |
Last Modified | filters on the platform, writable, last |
Systemgenerated information. | |
location_ |
varchar2 |
Location Country ID | filters on the platform, writable, location. |
Location*. | |
location_ |
varchar2 |
Location ID | filters on the platform, writable, location. |
Click the magnifier > The identifier | |
location_ |
varchar2 |
Location Name | filters on the platform, writable, location. |
Click the magnifier > The displayed name | |
metadata_ |
int64 |
Metadata Max Pagesize | filters on the platform, writable, metadata. |
||
metadata_ |
int64 |
Total Count | filters on the platform, writable, metadata. |
||
payment |
double |
Payment Amount | filters on the platform, writable, payment |
The top part > Payment amount > The total of the payment that is entered manually. | |
payment |
double |
itgen_vnet_paymentamountincurrency | filters on the platform, writable, payment |
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, payment |
Click on the magnifier. > The description. | |
payment |
varchar2 |
Payment Method ID | filters on the platform, writable, payment |
Click on the magnifier. > The identifier. | |
payment |
varchar2 |
Payment Reference | filters on the platform, writable, payment |
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 |
varchar2 |
Reference Number | filters on the platform, writable, refNbr |
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, 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] | |
time |
blob |
Timestamp | filters on the platform, writable, time |
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, 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 | |
write |
double |
Write-off Amount | filters on the platform, writable, write |
The top part > Write-off amount > The amount that has been written off. |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Customer |
customer_ |
Customers. |
Key | |
Customer |
location_ |
Countries.id |
Key | |
Customer |
payment |
PaymentMethods. |
Key |
Referenced By
- CustomerPaymentOrdersToApply
refNbr(Key)
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: