Dívidas

Download schema

Os títulos em aberto que a Quyta cobra. É o recurso central da API: toda a régua de cobrança e os acordos são construídos a partir das dívidas enviadas aqui.

Listar dívidas

GET

https://app.quyta.com.br/api/v1

/debts

Retorna uma lista paginada de dívidas.

Listar dívidas › query Parameters

is_collectable

boolean

Filtrar por dívidas coletáveis

is_contractable

boolean

Filtrar por dívidas contratáveis

customer_id

integer

Filtrar por cliente

status

string · enum

Filtrar por status

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

document

string

Filtrar por documento do cliente

external_id

string

Filtrar por external_id

page

integer

Número da página

Default: 1

per_page

integer

Número de itens por página

Default: 15

Listar dívidas › Responses

Lista de dívidas

Debt[]

Dados do item.

object

Metadados da paginacao.

Criar dívida

POST

https://app.quyta.com.br/api/v1

/debts

Cria uma nova dívida

Criar dívida › Request Body

customer_id

integer · required

ID do cliente associado.

debt_group_id

integer · required

ID do grupo de divida associado.

original_value

number · decimal · required

Valor original.

due_date

string · date · required

Data de vencimento.

description

string · maxLength: 255 · required

Descricao do item.

external_id

string · maxLength: 255

Identificador externo da divida no sistema de origem.

origin_contract_id

string · maxLength: 255

Codigo do contrato ou acordo original no sistema de origem.

origin_date

string · date

Data de origem.

Criar dívida › Responses

Dívida criada com sucesso

Debt

id

integer

Identificador unico da divida.

customer_id

integer

ID do cliente associado a divida.

debt_group_id

integer

ID do grupo de divida associado.

business_unit_id

integer

ID da unidade de negocio da divida.

status

string · enum

Status da dívida. Valores possíveis: PENDING (Pendente - dívida aguardando cobrança), SETTLED (Liquidada - dívida foi paga), ON_HOLD (Cobrança pausada - cobrança temporariamente suspensa), ARCHIVED (Arquivada - dívida arquivada para fins históricos e fora do fluxo de cobrança), UNDER_CONTRACT (Em acordo - dívida está incluída em um acordo)

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

is_collectable

boolean

Indica se a divida esta apta para cobranca.

is_contractable

boolean

Indica se a divida pode ser incluida em acordo.

original_value

number · decimal

Valor original da divida.

today_value

number · decimal

Valor atualizado da divida na data atual.

due_date

string · date

Data de vencimento da divida.

origin_date

string · date

Data de origem da divida.

external_id

string

Identificador externo da divida no sistema de origem.

origin_contract_id

string

Codigo do contrato ou acordo original no sistema de origem.

created_at

string · date-time

Data e hora de criacao da divida.

updated_at

string · date-time

Data e hora da ultima atualizacao da divida.

POST/debts

curl https://app.quyta.com.br/api/v1/debts \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "customer_id": 1,
  "debt_group_id": 1,
  "original_value": 1000,
  "due_date": "2024-01-15",
  "description": "Parcela vencida",
  "external_id": "EXT123",
  "origin_contract_id": "767",
  "origin_date": "2024-01-15"
}'

Example Request Body

{
  "customer_id": 1,
  "debt_group_id": 1,
  "original_value": 1000,
  "due_date": "2024-01-15",
  "description": "Parcela vencida",
  "external_id": "EXT123",
  "origin_contract_id": "767",
  "origin_date": "2024-01-15"
}

json

Example Responses

{
  "id": 1,
  "customer_id": 1,
  "debt_group_id": 1,
  "business_unit_id": 1,
  "status": "PENDING",
  "is_collectable": true,
  "is_contractable": true,
  "original_value": 1000,
  "today_value": 1100,
  "due_date": "2024-01-15",
  "origin_date": "2024-01-15",
  "external_id": "EXT123",
  "origin_contract_id": "767",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Obter dívida

GET

https://app.quyta.com.br/api/v1

/debts/{id}

Retorna os detalhes de uma dívida específica

Obter dívida › path Parameters

id

integer · required

ID da dívida

Obter dívida › Responses

Detalhes da dívida

Debt

id

integer

Identificador unico da divida.

customer_id

integer

ID do cliente associado a divida.

debt_group_id

integer

ID do grupo de divida associado.

business_unit_id

integer

ID da unidade de negocio da divida.

status

string · enum

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

is_collectable

boolean

Indica se a divida esta apta para cobranca.

is_contractable

boolean

Indica se a divida pode ser incluida em acordo.

original_value

number · decimal

Valor original da divida.

today_value

number · decimal

Valor atualizado da divida na data atual.

due_date

string · date

Data de vencimento da divida.

origin_date

string · date

Data de origem da divida.

external_id

string

Identificador externo da divida no sistema de origem.

origin_contract_id

string

Codigo do contrato ou acordo original no sistema de origem.

created_at

string · date-time

Data e hora de criacao da divida.

updated_at

string · date-time

Data e hora da ultima atualizacao da divida.

Atualizar dívida

PUT

https://app.quyta.com.br/api/v1

/debts/{id}

Atualiza os dados de uma dívida existente. Apenas dívidas com status PENDING, ON_HOLD ou ARCHIVED podem ser atualizadas.

Atualizar dívida › path Parameters

id

integer · required

ID da dívida

Atualizar dívida › Request Body

debt_group_id

integer

ID do grupo de divida associado.

original_value

number · decimal

Valor original.

due_date

string · date

Data de vencimento.

description

string · maxLength: 255

Descricao do item.

external_id

string · maxLength: 255

Identificador externo da divida no sistema de origem.

origin_date

string · date

Data de origem.

Atualizar dívida › Responses

Dívida atualizada com sucesso

Debt

id

integer

Identificador unico da divida.

customer_id

integer

ID do cliente associado a divida.

debt_group_id

integer

ID do grupo de divida associado.

business_unit_id

integer

ID da unidade de negocio da divida.

status

string · enum

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

is_collectable

boolean

Indica se a divida esta apta para cobranca.

is_contractable

boolean

Indica se a divida pode ser incluida em acordo.

original_value

number · decimal

Valor original da divida.

today_value

number · decimal

Valor atualizado da divida na data atual.

due_date

string · date

Data de vencimento da divida.

origin_date

string · date

Data de origem da divida.

external_id

string

Identificador externo da divida no sistema de origem.

origin_contract_id

string

Codigo do contrato ou acordo original no sistema de origem.

created_at

string · date-time

Data e hora de criacao da divida.

updated_at

string · date-time

Data e hora da ultima atualizacao da divida.

PUT/debts/{id}

curl https://app.quyta.com.br/api/v1/debts/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "debt_group_id": 1,
  "original_value": 1000,
  "due_date": "2024-01-15",
  "description": "Parcela vencida",
  "external_id": "EXT123",
  "origin_date": "2024-01-15"
}'

Example Request Body

{
  "debt_group_id": 1,
  "original_value": 1000,
  "due_date": "2024-01-15",
  "description": "Parcela vencida",
  "external_id": "EXT123",
  "origin_date": "2024-01-15"
}

json

Example Responses

{
  "id": 1,
  "customer_id": 1,
  "debt_group_id": 1,
  "business_unit_id": 1,
  "status": "PENDING",
  "is_collectable": true,
  "is_contractable": true,
  "original_value": 1000,
  "today_value": 1100,
  "due_date": "2024-01-15",
  "origin_date": "2024-01-15",
  "external_id": "EXT123",
  "origin_contract_id": "767",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Grupos de Dívidas

Listar dívidas

GET

https://app.quyta.com.br/api/v1

/debts

Retorna uma lista paginada de dívidas.

Listar dívidas › query Parameters

is_collectable

boolean

Filtrar por dívidas coletáveis

is_contractable

boolean

Filtrar por dívidas contratáveis

customer_id

integer

Filtrar por cliente

status

string · enum

Filtrar por status

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

document

string

Filtrar por documento do cliente

external_id

string

Filtrar por external_id

page

integer

Número da página

Default: 1

per_page

integer

Número de itens por página

Default: 15

Listar dívidas › Responses

Lista de dívidas

Debt[]

Dados do item.

object

Metadados da paginacao.

Criar dívida

POST

https://app.quyta.com.br/api/v1

/debts

Cria uma nova dívida

Criar dívida › Request Body

customer_id

integer · required

ID do cliente associado.

debt_group_id

integer · required

ID do grupo de divida associado.

original_value

number · decimal · required

Valor original.

due_date

string · date · required

Data de vencimento.

description

string · maxLength: 255 · required

Descricao do item.

external_id

string · maxLength: 255

Identificador externo da divida no sistema de origem.

origin_contract_id

string · maxLength: 255

Codigo do contrato ou acordo original no sistema de origem.

origin_date

string · date

Data de origem.

Criar dívida › Responses

Dívida criada com sucesso

Debt

id

integer

Identificador unico da divida.

customer_id

integer

ID do cliente associado a divida.

debt_group_id

integer

ID do grupo de divida associado.

business_unit_id

integer

ID da unidade de negocio da divida.

status

string · enum

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

is_collectable

boolean

Indica se a divida esta apta para cobranca.

is_contractable

boolean

Indica se a divida pode ser incluida em acordo.

original_value

number · decimal

Valor original da divida.

today_value

number · decimal

Valor atualizado da divida na data atual.

due_date

string · date

Data de vencimento da divida.

origin_date

string · date

Data de origem da divida.

external_id

string

Identificador externo da divida no sistema de origem.

origin_contract_id

string

Codigo do contrato ou acordo original no sistema de origem.

created_at

string · date-time

Data e hora de criacao da divida.

updated_at

string · date-time

Data e hora da ultima atualizacao da divida.

Obter dívida

GET

https://app.quyta.com.br/api/v1

/debts/{id}

Retorna os detalhes de uma dívida específica

Obter dívida › path Parameters

id

integer · required

ID da dívida

Obter dívida › Responses

Detalhes da dívida

Debt

id

integer

Identificador unico da divida.

customer_id

integer

ID do cliente associado a divida.

debt_group_id

integer

ID do grupo de divida associado.

business_unit_id

integer

ID da unidade de negocio da divida.

status

string · enum

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

is_collectable

boolean

Indica se a divida esta apta para cobranca.

is_contractable

boolean

Indica se a divida pode ser incluida em acordo.

original_value

number · decimal

Valor original da divida.

today_value

number · decimal

Valor atualizado da divida na data atual.

due_date

string · date

Data de vencimento da divida.

origin_date

string · date

Data de origem da divida.

external_id

string

Identificador externo da divida no sistema de origem.

origin_contract_id

string

Codigo do contrato ou acordo original no sistema de origem.

created_at

string · date-time

Data e hora de criacao da divida.

updated_at

string · date-time

Data e hora da ultima atualizacao da divida.

Atualizar dívida

PUT

https://app.quyta.com.br/api/v1

/debts/{id}

Atualiza os dados de uma dívida existente. Apenas dívidas com status PENDING, ON_HOLD ou ARCHIVED podem ser atualizadas.

Atualizar dívida › path Parameters

id

integer · required

ID da dívida

Atualizar dívida › Request Body

debt_group_id

integer

ID do grupo de divida associado.

original_value

number · decimal

Valor original.

due_date

string · date

Data de vencimento.

description

string · maxLength: 255

Descricao do item.

external_id

string · maxLength: 255

Identificador externo da divida no sistema de origem.

origin_date

string · date

Data de origem.

Atualizar dívida › Responses

Dívida atualizada com sucesso

Debt

id

integer

Identificador unico da divida.

customer_id

integer

ID do cliente associado a divida.

debt_group_id

integer

ID do grupo de divida associado.

business_unit_id

integer

ID da unidade de negocio da divida.

status

string · enum

Enum values:

PENDING

SETTLED

ON_HOLD

ARCHIVED

UNDER_CONTRACT

is_collectable

boolean

Indica se a divida esta apta para cobranca.

is_contractable

boolean

Indica se a divida pode ser incluida em acordo.

original_value

number · decimal

Valor original da divida.

today_value

number · decimal

Valor atualizado da divida na data atual.

due_date

string · date

Data de vencimento da divida.

origin_date

string · date

Data de origem da divida.

external_id

string

Identificador externo da divida no sistema de origem.

origin_contract_id

string

Codigo do contrato ou acordo original no sistema de origem.

created_at

string · date-time

Data e hora de criacao da divida.

updated_at

string · date-time

Data e hora da ultima atualizacao da divida.