# List Customers

Get all your customers.

Endpoint: POST /api/v1/customer/search
Version: 1.0

## Request fields (application/json):

  - `condition` (object)
    Condition to filter results

  - `condition.field` (string)
    Field name to apply the condition to
    Example: "name"

  - `condition.value` (object)
    Value to compare against the field
    Example: "Example Value"

  - `condition.type` (string)
    Relational operator for the condition
    Enum: "BETWEEN", "EQ", "LT", "LTE", "GT", "GTE", "NE", "LIKE", "START", "FINISH", "IN", "NIN", "NLIKE", "LENGTH"

  - `condition.endValue` (object)
    End value for range conditions
    Example: 100

  - `condition.innerConditions` (array)
    Nested conditions for complex queries

  - `condition.conditionType` (string)
    Type of condition for combining multiple conditions
    Enum: "AND", "OR"

  - `condition.empty` (boolean)
    Indicates if the condition is empty

  - `condition.compareFields` (boolean)
    Indicates if comparing between fields

  - `sortCriteria` (array)
    List of sorting criteria to apply

  - `sortCriteria.sortField` (string)
    Field name to sort by
    Example: "name"

  - `sortCriteria.sortDirection` (string)
    Sort direction (ascending or descending)
    Enum: "ASC", "DESC"

  - `pageNumber` (integer, required)
    Page number to retrieve (0-based)

  - `pageSize` (integer, required)
    Number of items per page
    Example: 20

## Response 200 fields (application/json):

  - `data` (array, required)
    List of data items for the current page

  - `data.id` (integer, required)
    Customer unique identifier.
    Example: 10001

  - `data.code` (integer, required)
    Customer numeric code.
    Example: 10001

  - `data.name` (string)
    Legal name of the customer.
    Example: "Acme S.A."

  - `data.commercialName` (string, required)
    Commercial name of the customer.
    Example: "Acme España"

  - `data.cif` (string)
    Tax identification code (CIF/NIF).
    Example: "B12345678"

  - `data.address` (string)
    Postal address of the customer.
    Example: "Av. de la Estación, 5"

  - `data.firstPhoneNumber` (string)
    First phone number.
    Example: "+34600111222"

  - `data.secondPhoneNumber` (string)
    Second phone number.
    Example: "+34600333444"

  - `data.postalCode` (string)
    Postal code.
    Example: "03001"

  - `data.countryDescription` (string, required)
    Country name or description.
    Example: "Spain"

  - `data.stateDescription` (string)
    State name or description.
    Example: "Alicante"

  - `data.email` (string)
    Email address.
    Example: "info@acme.es"

  - `data.city` (string, required)
    City name.
    Example: "Alicante"

  - `data.activity` (string)
    Activity description.
    Example: "Wholesale Trade"

  - `data.brand` (string)
    Brand description.
    Example: "Acme"

  - `data.brandId` (integer)
    Brand identifier.
    Example: 100

  - `data.creationDate` (string, required)
    Date of customer creation. Format: yyyy-MM-dd
    Example: "2020-01-01"

  - `data.isActive` (boolean)
    True if the customer is active.
    Example: true

  - `data.inactiveDate` (string)
    Date when customer became inactive. Format: yyyy-MM-dd
    Example: "2023-08-07"

  - `data.paymentMethodId` (integer)
    Payment method identifier.
    Example: 1

  - `data.paymentMethod` (string)
    Payment method description.
    Example: "Bank Transfer"

  - `data.paymentMethodServeFullPrePaid` (boolean)
    If true, payment method requires all amount prepaid.

  - `data.rateCode` (string)
    Rate code used for customer.
    Example: "RATE-001"

  - `data.account` (string)
    Bank account number.
    Example: "ES9820385778983000760236"

  - `data.vatDescription` (string)
    Tax regime description (VAT).
    Example: "General"

  - `data.discount1` (number)
    First discount rate (percent).
    Example: 5

  - `data.currencyCode` (string)
    Currency code.
    Example: "EUR"

  - `data.currencyDescription` (string)
    Currency description.
    Example: "Euro"

  - `data.modifiedOn` (string)
    When information was last updated. Format: yyyy-MM-dd'T'HH:mm:ss
    Example: "2024-08-07T12:30:00"

  - `data.bankName` (string)
    Name of the customer's bank.
    Example: "Santander"

  - `data.contactPerson` (string)
    Main contact person.
    Example: "Juan Pérez"

  - `data.web` (string)
    Web URL.
    Example: "https://www.acme.es"

  - `data.picture` (string)
    Picture or logo (URL or base64).
    Example: "https://www.acme.es/logo.png"

  - `data.pictureToken` (string)
    Authentication token for the picture file.
    Example: "xyz-token-241235"

  - `data.tags` (array)
    List of assigned customer tags.
    Example: ["VIP","EXPORT"]

  - `page` (integer, required)
    Current page number (0-based)

  - `total` (integer, required)
    Total number of items across all pages
    Example: 150

  - `pages` (integer, required)
    Last page number (0-based)
    Example: 14

  - `size` (integer, required)
    Number of items per page
    Example: 10