Schemas

Identificador unico do cliente.

ID da unidade de negocio do cliente.

Nome completo do cliente.

Documento do cliente (CPF/CNPJ).

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

Lista de emails do cliente. Vazia quando o cliente nao tem nenhum.

Lista de telefones do cliente. Vazia quando o cliente nao tem nenhum.

Data e hora de criacao do cliente, em UTC.

Data e hora da ultima atualizacao do cliente, em UTC.

Identificador unico da divida.

ID do cliente associado a divida.

ID do grupo de divida associado.

ID da unidade de negocio da divida.

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)

Indica se a divida esta apta para cobranca.

Indica se a divida pode ser incluida em acordo.

Valor original da divida.

Valor atualizado da divida na data atual.

Dia de vencimento da divida.

Dia de origem da divida. Nula quando a divida foi criada sem ela.

Identificador externo da divida no sistema de origem. Nulo quando a divida foi criada sem ele.

Codigo do contrato ou acordo original no sistema de origem.

Data e hora de criacao da divida, em UTC.

Data e hora da ultima atualizacao da divida, em UTC.

Identificador unico do grupo de divida.

ID da unidade de negocio do grupo de divida.

Nome do grupo de divida.

Indica se o grupo exige confissao de divida para fechar acordo.

Regras de encargo da regua do grupo, aplicadas por faixa de atraso. Vazia quando o grupo nao tem regra.

Data e hora de criacao do grupo de divida, em UTC.

Data e hora da ultima atualizacao do grupo de divida, em UTC.

Identificador unico da regra.

Multa aplicada, em percentual.

Juros ao mes, em percentual.

Dias de atraso a partir dos quais a regra vale.

Data e hora de criacao da regra, em UTC.

Data e hora da ultima atualizacao da regra, em UTC.

Identificador unico da meta.

ID da unidade de negocio da meta.

Nome da meta.

O que a meta mede: VALUE (valor negociado em R$) ou CONTRACTS (quantidade de acordos).

Alvo a ser atingido. Em VALUE é um valor em reais; em CONTRACTS é a quantidade de acordos (inteiro).

Realizado no período da meta, na mesma unidade do alvo. Meta agendada retorna 0.

ID do coletor responsável. Nulo quando a meta vale para toda a equipe.

ID do grupo de dívidas. Nulo quando a meta vale para todos os grupos.

Início do período de apuração.

Fim do período de apuração.

Instante do encerramento, em UTC. Nulo enquanto a meta estiver aberta. No encerramento por prazo e o fim do ultimo dia do periodo, que em UTC cai no dia seguinte ao end_date.

Situação da meta: SCHEDULED (período ainda não começou), ACTIVE (em andamento) ou CLOSED (encerrada). Encerrar é irreversível. O prazo vencido também encerra a meta.

Por que a meta foi encerrada: MANUALLY_CLOSED (alguém clicou) ou DEADLINE_REACHED (o período acabou). Nulo enquanto estiver aberta.

Indica se a composição de acordos foi congelada (ao encerrar).

Série recorrente da qual a meta faz parte. Nulo em meta avulsa.

Diagnóstico da meta agora. Nulo se ainda estiver agendada.

Data e hora de criacao da meta, em UTC.

Data e hora da ultima atualizacao da meta, em UTC.

Identificador da série recorrente.

Duração de cada meta da série, em dias. A próxima meta começa no dia seguinte ao fim da anterior, então as datas não acompanham o mês de calendário.

Posição da meta na série, começando em 0.

Falso depois que a recorrência é interrompida: nenhuma meta nova é criada.

Indica se esta meta é a meta-modelo da série: as próximas metas copiam dela nome, tipo, alvo e escopo. Na criação, a meta-modelo é a primeira da série.

Situação frente ao alvo: ACHIEVED (atingida), ON_TRACK (no ritmo), ATTENTION (atenção), AT_RISK (em risco) ou NOT_ACHIEVED (não atingida).

Até que dia o realizado vale. Em meta ativa é hoje; em meta encerrada é o fim efetivo da apuração.

Dias de start_date a end_date, inclusive.

Quantos dias do período já passaram na apuração.

Dias que ainda faltam no prazo. Zero se a meta já encerrou.

Percentual do alvo já feito (0 a 100).

Percentual do tempo já passado (0 a 100), ritmo linear.

Quanto falta para bater o alvo, na unidade do tipo da meta. Em CONTRACTS é inteiro.

Chute do total no fim do período se o ritmo atual se mantiver, arredondado em duas casas. Nulo se a meta já encerrou ou o prazo passou.

Valor do campo daily pace.

Identificador unico da meta.

ID da unidade de negocio da meta.

Nome da meta.

O que a meta mede: VALUE (valor negociado em R$) ou CONTRACTS (quantidade de acordos).

Alvo a ser atingido. Em VALUE é um valor em reais; em CONTRACTS é a quantidade de acordos (inteiro).

Realizado no período da meta, na mesma unidade do alvo. Meta agendada retorna 0.

ID do coletor responsável. Nulo quando a meta vale para toda a equipe.

ID do grupo de dívidas. Nulo quando a meta vale para todos os grupos.

Início do período de apuração.

Fim do período de apuração.

Instante do encerramento, em UTC. Nulo enquanto a meta estiver aberta. No encerramento por prazo e o fim do ultimo dia do periodo, que em UTC cai no dia seguinte ao end_date.

Situação da meta: SCHEDULED (período ainda não começou), ACTIVE (em andamento) ou CLOSED (encerrada). Encerrar é irreversível. O prazo vencido também encerra a meta.

Por que a meta foi encerrada: MANUALLY_CLOSED (alguém clicou) ou DEADLINE_REACHED (o período acabou). Nulo enquanto estiver aberta.

Indica se a composição de acordos foi congelada (ao encerrar).

Série recorrente da qual a meta faz parte. Nulo em meta avulsa.

Diagnóstico da meta agora. Nulo se ainda estiver agendada.

Data e hora de criacao da meta, em UTC.

Data e hora da ultima atualizacao da meta, em UTC.

Realizado de cada dia de start_date até o fim da apuração (measured_until limitado ao end_date). Dias sem acordo vêm com amount 0, e a soma fecha com realized. Vazio em meta agendada.

Acordos congelados na composição da meta. Vazio enquanto a composição não estiver congelada — como na meta ativa deste exemplo. Cada acordo tem os campos de GoalContractSnapshot.

ID do acordo.

ID do cliente titular do acordo. Nulo se o cliente foi removido.

Nome atual do cliente. Nulo se o cliente foi removido.

Valor do acordo na composição congelada.

Data em que o acordo foi negociado.

Status do acordo quando a composição foi congelada.

Nome da meta.

O que a meta mede: VALUE (valor negociado em R$) ou CONTRACTS (quantidade de acordos).

Alvo a ser atingido. Maior que zero. Em CONTRACTS deve ser inteiro.

Início do período de apuração.

Fim do período de apuração. Igual ou posterior ao início. O período não pode passar de 730 dias. Em meta recorrente, não pode ser alterado na atualização.

ID do coletor da unidade. Omita ou envie nulo para meta geral (toda a equipe).

ID do grupo de dívidas da unidade. Omita ou envie nulo para todos os grupos.

Só na criação; ignorado na atualização. true torna a meta recorrente: quando o período termina, uma nova meta com a mesma duração (em dias, de start_date a end_date) começa no dia seguinte. Veja POST /goals.

Só na atualização de meta de uma série ativa. Verdadeiro aplica a alteração também à meta agendada seguinte e torna esta meta a meta-modelo da série. Falso (padrão) altera só esta meta. Editar a própria meta-modelo sempre vale para as próximas.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

Identificador unico do acordo.

ID do cliente titular do acordo.

ID da unidade de negocio do acordo.

Status do acordo. Valores possíveis: ACTIVE (Ativo - acordo em andamento), DEBT_CONFESSION_PENDING (Confissão Pendente - aguardando assinatura da confissão de dívida), OVERDUE (Atrasado - acordo com parcelas em atraso), TERMINATED (Quebrado - acordo cancelado), SETTLED (Liquidado - todas as parcelas foram pagas)

Descricao do acordo.

Valor total do acordo, ja com os descontos aplicados.

Desconto total concedido no acordo.

Parcelas do acordo, da mais antiga para a mais recente.

Dividas incluidas no acordo.

Data e hora da liquidacao do acordo, em UTC. Nulo enquanto o acordo nao for liquidado.

Data e hora de criacao do acordo, em UTC.

Data e hora da ultima atualizacao do acordo, em UTC.

Identificador unico da parcela.

Status da parcela. Valores possíveis: PENDING (Pendente - parcela aguardando pagamento), PAID (Pago - parcela foi paga), OVERDUE (Atrasado - parcela vencida e não paga), SETTLED (Liquidado - parcela liquidada), CANCELLED (Cancelado - parcela cancelada), IN_ANALYSIS (Pagamento em análise - pagamento com cartão em análise de risco no gateway; volta para PENDING ou OVERDUE se reprovado, ou vira PAID se aprovado)

Valor da parcela.

Data de vencimento da parcela.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

Mensagem de erro legivel.

Codigo interno do erro.

Codigo HTTP do erro.

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento

ID único do evento

Tipo do evento

Versão do formato do evento

Data e hora do evento, em UTC.

Dados específicos do evento