itgendoc001X
xMsg javascript has not been loaded.
Visma.net Financials API Data ModelGet all Customer payment methods for one specific customer. ScreenId=AR303010 and AR303000
Catalog: VismaNet
Schema: CustomerPaymentMethod
The data in this table is partitioned per value of the COMPANY_CODE column.
Retrieve: true
Insert: false
Update: true
Delete: false
Select Visma.net Financials API URL: /controller/api/v1/customerpaymentmethod/{customerId}
Insert Visma.net Financials API URL: /controller/api/v1/customerpaymentmethod/{customerId}
Update Visma.net Financials API URL: /controller/api/v1/customerpaymentmethod/{customerId}
Delete Visma.net Financials API URL: /controller/api/v1/customerpaymentmethod/{customerId}
Field Selection Method: NotRequired
Select Visma.net Financials API Operation: get /controller/api/v1/customerpaymentmethod/{customerId}
Update Visma.net Financials API Operation: put /controller/api/v1/customerpaymentmethod/{customerId}/{customerPaymentMethodId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function CustomerPaymentMethodsByCustomerId. 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 treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `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. |
customerId |
string |
☑ |
|
Identifies the Customer |
pageNumber |
int32 |
☐ |
|
Pagination parameter. Page number. |
pageSize |
int32 |
☐ |
|
Pagination parameter. Number of items to be collected. |
Table Function Columns
The columns of the table function CustomerPaymentMethodsByCustomerId 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 update.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
active |
boolean |
Active |
☐ |
The top part > Active > A check box that indicates (if selected) that the selected customer payment method is active (that is, available for recording payments). |
cardOrAccountNo |
string |
|
☐ |
The top part > Card/account no. > The identifier for the customer's payment method. |
cashAccount_description |
string |
Cash Account Description |
☐ |
Click on the magnifier. > The description. |
cashAccount_id |
string |
|
☐ |
Click on the magnifier. > The identifier. |
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
customer_id |
string |
|
☐ |
|
customer_name |
string |
Customer Name |
☐ |
Click the magnifier > The displayed name |
paymentMethod_description |
string |
Payment Method Description |
☐ |
Click on the magnifier. > The description. |
paymentMethod_id |
string |
Payment Method ID |
☐ |
Click on the magnifier. > The identifier. |
06-04-2021 14:55 Version 20.1.393-BETA+3152
