List commissions

GET/commissions/list

Returns a list of commissions.

Without status, only paid commissions are returned.
To filter by status, repeat the parameter for each status (status=paid&status=canceled) or use brackets (status[]=paid&status[]=canceled). A single status=paid without brackets returns 400 with Invalid param: [status].

Request

curl --request GET \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/commissions/list?page=1&limit=10' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID'

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/commissions/list?page=1&limit=10', {
  method: 'GET',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
  },
});

const data = await response.json();
console.log(data);

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/commissions/list?page=1&limit=10"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "statusCode": 200,
  "data": {
    "docs": [
      {
        "id": "0f2b4d6f-8b0d-4f4b-8d8f-0b2d4f6b0028",
        "grossValueInCents": 1000,
        "netValueInCents": 680,
        "taxInCents": 320,
        "receiverRole": "producer",
        "settlementDate": "2025-02-27",
        "status": "paid",
        "interestValueInCents": 0,
        "installment": 1,
        "planDetails": {
          "description": "6.99% + R$2.5",
          "planName": "D30"
        }
      }
    ],
    "limit": 10,
    "currentPage": 1,
    "nextPage": 2,
    "totalPages": 3,
    "totalDocs": 29,
    "hasNext": true
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier

Query parameters

pageintegerrequired
Page number to access

Example:1
limitintegerrequired
Number of items to be loaded per page

Example:10
initialDatestring
Filters results from this date onward (YYYY-MM-DD)
endDatestring
Filters results up to this date (YYYY-MM-DD)
statusarray of strings
Filters results by commission status. Repeat the parameter for each status, such as status=paid&status=canceled. To filter by one status, send it with brackets, such as status[]=canceled. A single status=paid without brackets returns 400 with Invalid param: [status]. Without status, only paid commissions are returned.

Possible values:pendingpaidreleasedcanceledreversedrefundedcharged-backpartialy-released