Skip to main content
GET
/
v1
/
collections
/
duedate
List Dynamic Charges with Due Date
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/collections/duedate \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Account-Id: <x-account-id>'
{
  "items": [
    {
      "additionalInfo": {
        "customerId": "67890",
        "orderId": "12345"
      },
      "amount": {
        "original": "100.00",
        "abatement": {
          "modality": "PERCENT",
          "value": "3.00"
        },
        "discount": {
          "modality": "AMOUNT_ADVANCE_BUSINESS_DAY",
          "discountDateFixed": [
            {
              "date": "2024-12-25",
              "value": "10.00"
            }
          ],
          "value": "5.00"
        },
        "fine": {
          "modality": "PERCENT",
          "value": "2.00"
        },
        "interest": {
          "modality": "PERCENTAGE_PER_MONTH_CALENDAR_DAYS",
          "value": "1.00"
        }
      },
      "createdAt": "2024-01-15T10:30:00Z",
      "debtor": {
        "address": "Rua das Flores, 123",
        "city": "São Paulo",
        "document": "12345678901",
        "email": "joao@example.com",
        "name": "João da Silva",
        "state": "SP",
        "zipCode": "01310-100"
      },
      "deletedAt": "2024-01-25T10:30:00Z",
      "description": "Payment for order #12345",
      "dueDate": "2024-12-31",
      "emv": "00020126580014br.gov.bcb.pix...",
      "id": "550e8400-e29b-41d4-a716-446655440010",
      "locationUrl": "https://api.example.com/qr/550e8400",
      "metadata": {},
      "receiver": {
        "address": "Rua das Flores, 123",
        "city": "São Paulo",
        "document": "12345678901",
        "name": "João da Silva",
        "state": "SP",
        "tradeName": "Company Name",
        "zipCode": "01310-100"
      },
      "receiverKey": "+5511999999999",
      "review": 0,
      "status": "ACTIVE",
      "tags": [
        "ecommerce",
        "subscription"
      ],
      "txId": "TXabcdefghijklmno123456789",
      "updatedAt": "2024-01-20T14:45:00Z",
      "validAfterDue": 5
    }
  ],
  "limit": 20,
  "page": 1,
  "total": 150
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Account-Id
string
required

Account ID (UUID format)

Query Parameters

limit
integer

Maximum number of collections per page (1-100)

page
integer

Page number for pagination (starting at 1)

status
string

Status filter

tags
string

Tags filter

Response

OK

items
object[]

Items is the array of collection results

limit
integer

Limit is the maximum number of results returned

Example:

20

page
integer

Page is the current page number

Example:

1

total
integer

Total is the total number of collections matching the filters

Example:

150