Listar configurações de cessão
Lista as configurações de cessão da sua integração. Cada configuração é o acordo com um cessionário: para quem as dívidas são cedidas e quando a cessão automática roda. A assignment_configuration_key devolvida aqui é usada para criar um lote de cessão.
Endpoint
ENDPOINT
/v2/assignment/assignment_configurationsMÉTODO
GETSTATUS
200Autenticação
Requer assinatura da requisição. Veja Troca de chaves.
Parâmetros de consulta
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
purchaser_document_number | string | Não | Filtra pelo CNPJ do cessionário, só dígitos. | 14 |
page | integer | Não | Página desejada. Padrão 1. | — |
page_size | integer | Não | Configurações por página. Padrão 10. | — |
Resposta
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
data | array | Sim | Configurações da página. | — |
data[].assignment_configuration_key | uuid | Sim | Chave da configuração de cessão. | 36 |
data[].is_active | boolean | Sim | true quando a configuração está ativa. | — |
data[].purchaser_document_number | string | Sim | CNPJ do cessionário, só dígitos. | 14 |
data[].purchaser_name | string | Sim | Nome do cessionário. | — |
data[].requester_key | uuid | Sim | Chave da sua integração. | 36 |
data[].requester_name | string | Sim | Nome da sua integração. | — |
data[].next_execution_datetime | string | Não | Data e hora da próxima cessão automática, em ISO 8601. | — |
data[].is_automatic_debt | boolean | Sim | Indica se a configuração opera com débito automático. | — |
pagination | object | Sim | page e page_size usados na consulta. | — |
{
"data": [
{
"assignment_configuration_key": "3571e292-3a83-4011-904d-20ee963022ef",
"is_active": true,
"purchaser_document_number": "12345678000190",
"purchaser_name": "NOME DO CESSIONARIO",
"requester_key": "d3f788fd-0000-0000-0000-000000000000",
"requester_name": "NOME DO ORIGINADOR",
"next_execution_datetime": "2026-09-30T06:00:00",
"is_automatic_debt": false
}
],
"pagination": {
"page": 1,
"page_size": 10
}
}
Erros
| Status | Código | Descrição |
|---|---|---|
| 403 | QIT000005 | A consulta pediu configurações de outra integração. |