Receivables
Receivables - Analytics
Métricas e agregados sobre recebíveis (totais, tendências, conforme campos expostos pela API).
Métricas e agregados sobre recebíveis (totais, tendências, conforme campos expostos pela API).
Authorization
SelectKeyAuth selectkey<token>
API key for all authenticated requests. Send your key in the selectkey header (e.g. sandbox sl_test_…, production sl_live_…).
In: header
Query Parameters
sort?string
Sort order
limit?number
Page size
offset?number
Pagination offset
released?string
Filter by release status
status?string
Filter by receivable status
id?string
Filter by receivable ID
initdate*string
Start date for analytics period
enddate*string
End date for analytics period
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/receivables/analytics?sort=descending&limit=50&offset=0&released=yes&status=pending&id=rec_abc123&initdate=2026-01-01T00%3A00%3A00Z&enddate=2026-01-31T23%3A59%3A59Z"{
"list": [
{
"id": "rec_01hqzvabc",
"status": "pending",
"currency": "BRL",
"amount": 4850,
"grossAmount": 5000,
"anticipationFee": 0,
"liable": true,
"chargeProcessingFee": true,
"expectedOn": "2026-04-20T00:00:00.000Z",
"updatedAt": "2026-04-12T17:56:33.000Z",
"createdAt": "2026-04-12T17:56:33.000Z"
}
],
"merchant": {
"name": "Seller Name",
"merchantId": "bus_1234567890",
"isSubAccount": false
},
"_links": {
"self": {
"href": "https://api.selectwin.io/v1/receivables/analytics",
"method": "GET"
},
"list": {
"href": "https://api.selectwin.io/v1/receivables/list",
"method": "GET"
}
}
}{
"error": {
"status": "Bad Request",
"statusCode": 400,
"category": "validation",
"message": "Validation errors occurred",
"details": "One or more parameters are invalid or out of range. Please check the parameters and try again.",
"params": [
{
"payment[currency]": "currency must be one of [BRL]"
},
{
"amount": "amount is required"
}
],
"code": "invalidParameters",
"resource": "client"
}
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"message": "Unauthorized",
"details": "Authentication failed. The provided API key is invalid or does not have permission to operate.",
"code": "unauthorized"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"message": "Forbidden",
"details": "Access denied. This may be due to IP blocks, domain restrictions, or insufficient permissions.",
"code": "forbidden"
}
}{
"error": {
"status": "Not Found",
"statusCode": 404,
"category": "client",
"message": "Not Found",
"details": "The requested resource was not found on the server.",
"code": "notFound"
}
}{
"error": {
"status": "Unprocessable Entity",
"statusCode": 422,
"category": "validation",
"message": "Unprocessable Entity",
"details": "The request was understood, but contains invalid data that could not be processed.",
"code": "unprocessableEntity"
}
}{
"error": {
"status": "Too Many Requests",
"statusCode": 429,
"category": "rate_limit",
"message": "Too Many Requests",
"details": "The number of requests exceeded the limit allowed for the IP or user.",
"retryAfterMinutes": 60,
"code": "tooManyRequests"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"message": "Server error.",
"details": "An internal server error occurred. Please try again later.",
"code": "serverError",
"resource": "server"
}
}