# SearchedCustomers: Minox Searched Customers Search for customers based on a search query. - Catalog: `Minox` - Schema: `MasterDataCustomer` - Label: Searched Customers The data in this table is partitioned per value of the `administration_code` column. This is a read-only table function. The Minox API may not support changing the data or the Invantive UniversalSQL driver for Minox does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Minox API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `SearchedCustomers`. 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 | |---|:---:|:---:|:---:|---| | `administration_code` | `` | ☐ | | Partition to retrieve data from. | | `next` | `` | ☐ | | A single request returns a maximum of 400 customers. In case more customers have been found, a token will be provided. The next page can be accessed by providing this token to the next request. An example: GET .../customer?next=[token] where [token] is the provided token | | `search` | `` | ☐ | | Search and filter customers based on a keyword. The search term will be matched against the identifying number, vat number, name, IBAN, chamber of commerce number, postal code and postal address of the customer | ## Columns of Table Function The columns of the table function `SearchedCustomers` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `aggregation_aggregation_level` | `int64` | Aggregation Level | ☐ | The level of the aggregation | | `aggregation_description` | `varchar2` | Aggregation Description | ☐ | The description of the aggregation. | | `bank_bic` | `varchar2` | Bank BIC | ☐ | The Business Identifier Code (BIC). Go to https://en.wikipedia.org/wiki/ISO_9362 for more information. | | `bank_city` | `varchar2` | Bank City | ☐ | The city the bank branch office is located in. | | `bank_iban` | `varchar2` | Bank IBAN | ☐ | The International Bank Account Number. Go to https://en.wikipedia.org/wiki/International_Bank_Account_Number for more information. | | `bank_name` | `varchar2` | Bank Name | ☐ | The name of the bank. | | `block_collection` | `char` | Block Collection | ☐ | Specifies whether debt collection (Dutch: 'incasso') is blocked for the customer. | | `block_sending_reminders` | `char` | Block Sending Reminders | ☐ | Specifies whether reminders are blocked for the customer. | | `blocked_active` | `char` | Blocked Active | ☐ | Indicates whether the customer is blocked. | | `blocked_reason` | `varchar2` | Blocked Reason | ☐ | The reason the customer is blocked. | | `chamber_of_commerce` | `varchar2` | Chamber Of Commerce | ☐ | The chamber of commerce (Dutch: 'KvK') number. | | `currency_description` | `varchar2` | Currency Description | ☐ | | | `currency_exchange_rate` | `decimal` | Currency Exchange Rate | ☐ | | | `currency_id` | `varchar2` | Currency ID | ☐ | | | `externalid` | `varchar2` | External ID | ☐ | The external identification that has been linked to the customer via third-party software. | | `id_2` | `int64` | | ☐ | The identifying number for a customer. Must fall within the range of one of the sales journals | | `id` | `varchar2` | ID | ☐ | The identification of a search key. This value can either be 'key1', 'key2' or 'key3' | | `is_one_time` | `char` | Is One-Time | ☐ | Specifies if a customer is used for one-time sales. | | `language` | `varchar2` | Language | ☐ | The language of the customer. Represented as an ISO-639-1 language code. | | `memo_active` | `char` | Memo Active | ☐ | Whether the memo is shown in the UI when this account is used. | | `memo_text` | `varchar2` | Memo Text | ☐ | The content of the memo. | | `payment_term_days` | `decimal` | Payment Term Days | ☐ | | | `payment_term_description` | `varchar2` | Payment Term Description | ☐ | | | `payment_term_id` | `int64` | Payment Term ID | ☐ | | | `payment_term_mandate` | `varchar2` | Payment Term Mandate | ☐ | | | `payment_term_start` | `varchar2` | Payment Term Start | ☐ | | | `sales_credit_limit` | `decimal` | Sales Credit Limit | ☐ | The credit limit. | | `sales_g_rekening_percentage` | `decimal` | Sales G-Account Percentage | ☐ | A 'G-rekening' is a frozen account that you can use solely to make payroll taxes or VAT payments to the Tax and Customs Administration. The recipient deposits the estimated amount of payroll taxes or VAT payments into your g account. You can use this amount solely to pay payroll taxes or VAT. In case there is a 'G-rekening', by default the percentage from the administration will be used. In case a customer has a custom percentage, this can be defined here. | | `sales_invoice_discount_percentage` | `decimal` | Sales Invoice Discount Percentage | ☐ | The discount percentage on an invoice. | | `sales_pricecode` | `int64` | Sales Price Code | ☐ | The type of selling price. If it is different than the normal selling price, a code between 1 and 9 will be returned. | | `sales_revenue_category` | `int64` | Sales Revenue Category | ☐ | The revenue category. *This can be one of the following values:* - 1 | NL - 2 | EU - 3 | non-EU - 4 | shifted (free1) - 5 | free2 - 6 | free3 - 7 | free4 - 8 | free5 | | `sales_statistics_code` | `varchar2` | Sales Statistics Code | ☐ | Together with the statistics code of the selling item, it can be decided how the revenue statistics are printed. *Possible values:* - C | Article code, the revenue will be split per customer per article code - G | Article group, the revenue will be split per customer per article group - N | Not split, the revenue will not be split per customer If the given value is not equal to one of those, the statistics code will be set to 'C'. | | `sales_track_sales_history` | `char` | Sales Track Sales History | ☐ | Specifies whether or not to track the sales history for the customer. | | `sales_vat_inclusive` | `char` | Sales VAT Inclusive | ☐ | Whether the selling price is VAT inclusive. | | `value` | `varchar2` | Value | ☐ | The search term that corresponds to the search key. | | `vat_active` | `char` | VAT Active | ☐ | Whether an automatic VAT proposition will be made for the customer. | | `vat_suggested_gl_account` | `int64` | VAT Suggested GL Account | ☐ | The suggested GL account (Dutch: 'tegenrekening') that will be used when an automatic VAT proposition will be made. | | `vat_suggested_vat_id` | `int64` | VAT Suggested VAT ID | ☐ | The suggested VAT identification that will be used when an automatic VAT proposition will be made. | | `vat_vat_in_europe_gl_account` | `int64` | VAT In Europe GL Account | ☐ | The suggested GL account (Dutch: 'tegenrekening') that will be used when dealing with sales inside Europe. | | `vat_vat_registration_number` | `varchar2` | VAT Registration Number | ☐ | The identifying number of a VAT registration. This number is also used for sales tax. |