# Filter sales

Returns a list of sales.

Endpoint: POST /sales/filter
Version: 1.0

## Header parameters:

  - `x-api-key` (string, required)
    Api key provided on integrations tab in Easyflow platform.

  - `x-api-secret` (string, required)
    Api Secret provided on integrations tab in Easyflow platform.

  - `business-id` (string, required)
    Business Identifier

## Query parameters:

  - `page` (string, required)
    Page number to access

  - `limit` (string, required)
    Number of items to be loaded per page

## Request fields (application/json):

  - `codes` (array)

  - `email` (string)

  - `name` (string)

  - `cpf` (string)

  - `initialDate` (string)

  - `endDate` (string)

  - `productName` (string)

  - `status` (array)
    Filter by the specified status, such as: pending, paid, canceled, reversed, refunded, charged-back, partially-paid

  - `initialValue` (integer)

  - `endValue` (integer)

  - `types` (array)
    Filter by the specified types, such as: credit-card, pix, bank-billet, crypto, debit-card

  - `productIds` (array)

  - `field` (string)

  - `orderBy` (object)

  - `orderBy.orderByField` (string)
    Filter by the specified field, such as: email, product, createdAt

  - `orderBy.orderDirection` (string)
    ASC or DESC

## Response 200 fields (application/json):

  - `statusCode` (integer)
    Example: 200

  - `data` (object)

  - `data.sales` (object)

  - `data.sales.docs` (array)

  - `data.sales.docs.buyer` (object)

  - `data.sales.docs.buyer.name` (string)

  - `data.sales.docs.buyer.email` (string)

  - `data.sales.docs.buyer.phone` (object)

  - `data.sales.docs.buyer.phone.areaCode` (string)

  - `data.sales.docs.buyer.phone.ddd` (string)

  - `data.sales.docs.buyer.phone.number` (string)

  - `data.sales.docs.buyer.phone.isMobile` (boolean)

  - `data.sales.docs.buyer.address` (object)

  - `data.sales.docs.buyer.address.zipCode` (string)

  - `data.sales.docs.buyer.address.street` (string)

  - `data.sales.docs.buyer.address.complement` (string)

  - `data.sales.docs.buyer.address.neighborhood` (string)

  - `data.sales.docs.buyer.address.city` (string)

  - `data.sales.docs.buyer.address.state` (string)

  - `data.sales.docs.buyer.document` (object)

  - `data.sales.docs.buyer.document.type` (string)

  - `data.sales.docs.buyer.deliveryAddress` (object)

  - `data.sales.docs.buyer.userId` (string)

  - `data.sales.docs.orderId` (string)

  - `data.sales.docs.status` (string)
    status returning: pending, paid, canceled, reversed, refunded, charged-back, partially-paid

  - `data.sales.docs.totalValueInCents` (integer)

  - `data.sales.docs.paymentMethod` (array)

  - `data.sales.docs.createdAt` (string)

  - `data.sales.docs.totalFineValueInCents` (integer)

  - `data.sales.docs.totalInterestValueInCents` (integer)

  - `data.sales.docs.products` (array)

  - `data.sales.docs.products.productId` (string)

  - `data.sales.docs.products.offerItemType` (string)

  - `data.sales.docs.receivers` (array)

  - `data.sales.docs.receivers.businessId` (string)

  - `data.sales.docs.receivers.commissionValueInCents` (integer)

  - `data.sales.docs.receivers.taxValueInCents` (integer)

  - `data.sales.currentPage` (integer)

  - `data.sales.hasNext` (boolean)

  - `data.sales.limit` (integer)

  - `data.sales.nextPage` (integer)

  - `data.sales.totalDocs` (integer)

  - `data.sales.totalPages` (integer)

  - `data.ticketsCount` (integer)

  - `data.totalTransactionValue` (integer)

  - `data.totalCommissions` (integer)

## Response 400 fields (application/json):

  - `message` (string)
    Invalid param: []
    Example: "Invalid param: []"

  - `error` (string)
    Bad Request
    Example: "Bad Request"

  - `statusCode` (integer)
    400
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Invalid field
    Example: "Unauthorized"

  - `error` (string)
    Unauthorized
    Example: "Unauthorized"

  - `statusCode` (integer)
    401
    Example: 401

## Response 403 fields (application/json):

  - `message` (string)
    Forbidden resource
    Example: "Forbidden resource"

  - `error` (string)
    Forbidden
    Example: "Forbidden"

  - `statusCode` (integer)
    403
    Example: 403

## Response 500 fields (application/json):

  - `message` (string)
    Internal server error
    Example: "Internal server error"

  - `error` (string)
    Internal Server Error
    Example: "Internal Server Error"

  - `statusCode` (integer)
    500
    Example: 500