# List Suppliers

Get all your suppliers.

Endpoint: POST /api/v1/supplier/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)
    Unique identifier of the entity
    Example: 1

  - `data.code` (integer, required)
    Supplier numeric code. Unique per company.
    Example: 20001

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

  - `data.commercialName` (string, required)
    Commercial name of the supplier.
    Example: "Supplier Corp"

  - `data.name` (string)
    Legal name of the supplier.
    Example: "Supplier Corporation S.L."

  - `data.address` (string)
    Postal address.
    Example: "Calle Mayor, 10"

  - `data.country` (string)
    Country code.
    Example: "ES"

  - `data.state` (string)
    State code.
    Example: "MAD"

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

  - `data.city` (string)
    Supplier city.
    Example: "Madrid"

  - `data.phone1` (string)
    First phone number.
    Example: "+34911222333"

  - `data.phone2` (string)
    Second phone number.
    Example: "+34911444555"

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

  - `data.currencyNomenclature` (string)
    Currency nomenclature.
    Example: "Euro"

  - `data.currencyChangeValue` (number)
    Currency exchange rate value.
    Example: 1

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

  - `data.email` (string)
    Contact email address.
    Example: "contact@suppliercorp.com"

  - `data.shippingTerm` (integer)
    Shipping term in days.
    Example: 15

  - `data.tags` (array)
    List of supplier tags.
    Example: ["PREMIUM","INTERNATIONAL"]

  - `data.vatDescription` (string)
    VAT type description.
    Example: "IVA General 21%"

  - `data.discount1` (number)
    First discount rate (percentage).
    Example: 3.5

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

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

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

  - `data.creationDate` (string)
    Date of supplier creation. Format: yyyy-MM-dd
    Example: "2021-03-15"

  - `data.inactiveDate` (string)
    Date when supplier became inactive. Format: yyyy-MM-dd
    Example: "2024-10-01"

  - `data.countryDescription` (string)
    Country full description.
    Example: "España"

  - `data.stateDescription` (string)
    State full description.
    Example: "Madrid"

  - `data.bankName` (string)
    Bank name for the supplier.
    Example: "BBVA"

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

  - `data.picture` (string)
    Picture or logo for the supplier.
    Example: "https://www.suppliercorp.com/logo.png"

  - `data.pictureToken` (string)
    Token for accessing the picture.
    Example: "a1b2c3d4e5f6"

  - `data.modifiedOn` (string)
    Last modification date and time. Format: yyyy-MM-dd'T'HH:mm:ssXXX
    Example: "2024-12-10T14:30:00+01:00"

  - `data.web` (string)
    Supplier web site.
    Example: "https://www.suppliercorp.com"

  - `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