Schemas

Download schema

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente.

object[]

Lista de telefones do cliente.

created_at

string · date-time

Data e hora de criacao do cliente.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente.

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.

DebtGroup

id

integer

Identificador unico do grupo de divida.

business_unit_id

integer

ID da unidade de negocio do grupo de divida.

name

string

Nome do grupo de divida.

created_at

string · date-time

Data e hora de criacao do grupo de divida.

updated_at

string · date-time

Data e hora da ultima atualizacao do grupo de divida.

RevokedTokenError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

ExpiredTokenError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

AuthError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

NotFoundError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

WebhookEvent

Estrutura base de todos os eventos de webhook

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

data

object · required

Dados específicos do evento

WebhookEventDebtCreated

Evento disparado quando uma dívida é criada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtHeld

Evento disparado quando a cobrança de uma dívida é pausada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtArchived

Evento disparado quando uma dívida é arquivada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtUnarchived

Evento disparado quando uma dívida é desarquivada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtReactivated

Evento disparado quando a cobrança de uma dívida é reativada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventCustomerCreated

Evento disparado quando um novo cliente é criado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractCreated

Evento disparado quando um novo acordo é criado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractTerminated

Evento disparado quando um acordo é quebrado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractSettled

Evento disparado quando um acordo é liquidado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractInstallmentPaid

Evento disparado quando uma parcela de um acordo é paga no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

Quyta

Schemas

Download schema

Customer

id

integer

Identificador unico do cliente.

business_unit_id

integer

ID da unidade de negocio do cliente.

name

string

Nome completo do cliente.

document

string

Documento do cliente (CPF/CNPJ).

person_type

string · enum

Tipo de pessoa do cliente: F (Pessoa fisica) ou J (Pessoa juridica).

Enum values:

object[]

Lista de emails do cliente.

object[]

Lista de telefones do cliente.

created_at

string · date-time

Data e hora de criacao do cliente.

updated_at

string · date-time

Data e hora da ultima atualizacao do cliente.

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.

DebtGroup

id

integer

Identificador unico do grupo de divida.

business_unit_id

integer

ID da unidade de negocio do grupo de divida.

name

string

Nome do grupo de divida.

created_at

string · date-time

Data e hora de criacao do grupo de divida.

updated_at

string · date-time

Data e hora da ultima atualizacao do grupo de divida.

RevokedTokenError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

ExpiredTokenError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

AuthError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

NotFoundError

message

string

Mensagem de erro legivel.

error_code

string

Codigo interno do erro.

status_code

integer

Codigo HTTP do erro.

WebhookEvent

Estrutura base de todos os eventos de webhook

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

data

object · required

Dados específicos do evento

WebhookEventDebtCreated

Evento disparado quando uma dívida é criada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtHeld

Evento disparado quando a cobrança de uma dívida é pausada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtArchived

Evento disparado quando uma dívida é arquivada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtUnarchived

Evento disparado quando uma dívida é desarquivada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventDebtReactivated

Evento disparado quando a cobrança de uma dívida é reativada no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventCustomerCreated

Evento disparado quando um novo cliente é criado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractCreated

Evento disparado quando um novo acordo é criado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractTerminated

Evento disparado quando um acordo é quebrado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractSettled

Evento disparado quando um acordo é liquidado no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento

WebhookEventContractInstallmentPaid

Evento disparado quando uma parcela de um acordo é paga no sistema.

id

string · uuid · required

ID único do evento

type

string · required

Tipo do evento

version

string · required

Versão do formato do evento

created_at

string · date-time · required

Data e hora do evento em ISO 8601

object · required

Dados específicos do evento