# List commissions

Returns a list of commissions.

Endpoint: GET /commissions/list
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

  - `initialDate` (string)
    Filters results from this date onward (YYYY-MM-DD)

  - `endDate ` (string)
    Filters results up to this date (YYYY-MM-DD)

  - `status` (string)
    Filters results by commission status. Accepts a single value or an array (status=paid&status=canceled). permitted status: pending, paid, released, canceled, reversed, refunded, charged-back. If no status is passed the default is paid

## Response 200 fields (application/json):

  - `statusCode` (integer)
    Example: 200

  - `data` (object)

  - `data.docs` (array)

  - `data.docs.id` (string)

  - `data.docs.grossValueInCents` (integer)

  - `data.docs.netValueInCents` (integer)

  - `data.docs.taxInCents` (integer)

  - `data.docs.receiverRole` (string)

  - `data.docs.settlementDate` (string)

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

  - `data.docs.interestValueInCents` (integer)

  - `data.docs.installment` (integer)

  - `data.docs.planDetails` (object)

  - `data.docs.planDetails.description` (string)

  - `data.docs.planDetails.planName` (string)

  - `data.docs.payment` (object)

  - `data.docs.payment.status` (string)

  - `data.docs.payment.valuePaidInCents` (integer)

  - `data.docs.payment.fineValueInCents` (integer)

  - `data.docs.payment.installments` (integer)

  - `data.docs.payment.paymentMethod` (string)

  - `data.docs.payment.valueInCents` (integer)

  - `data.docs.payment.bankBillet` (object)

  - `data.docs.payment.bankBillet.expireAt` (string)

  - `data.docs.payment.bankBillet.barCode` (string,null)

  - `data.docs.payment.bankBillet.link` (string,null)

  - `data.docs.payment.bankBillet.line` (string,null)

  - `data.docs.payment.pix` (object)

  - `data.docs.payment.pix.copyAndPasteCode` (string,null)

  - `data.docs.payment.pix.qrCode` (string,null)

  - `data.docs.payment.creditCard` (object)

  - `data.docs.payment.creditCard.nickname` (string)

  - `data.docs.payment.creditCard.last4Numbers` (string)

  - `data.docs.payment.creditCard.holderName` (string)

  - `data.docs.payment.creditCard.expiresAtMonth` (integer)

  - `data.docs.payment.creditCard.expiresAtYear` (integer)

  - `data.docs.payment.creditCard.flag` (string)

  - `data.limit` (integer)

  - `data.currentPage` (integer)

  - `data.nextPage` (integer)

  - `data.totalPages` (integer)

  - `data.totalDocs` (integer)

  - `data.hasNext` (boolean)

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