Adicionando o conector
Requisitos
- Utilizar um login de ADMINISTRADOR
Instruções
- Faça login na Kondado > clique em CRIAR + > Conector > Escolha o conector do Conta Azul
- Clique em Autenticar
- Faça login em sua conta do Conta Azul
- Caso requisitado, informe o token de seu aplicativo de autenticação
- Você será direcionado de volta para a Kondado - basta salvar
Integrações
Índice
Gráfico de relacionamento
Clique para ampliar
Cadastro de pessoas
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da pessoa no sistema (UUID). |
|
boolean |
[pt] Indica se o cadastro está ativo e disponível no sistema. |
|
text |
[pt] Número do CPF ou CNPJ da pessoa ou empresa. |
|
text |
[pt] Endereço de e-mail principal da pessoa ou empresa cadastrada. |
|
text |
[pt] Bairro ou distrito do endereço. |
|
text |
[pt] Código de Endereçamento Postal (CEP) do endereço. |
|
text |
[pt] Nome da cidade do endereço. |
|
text |
[pt] Informações complementares ao endereço, como bloco ou sala. |
|
text |
[pt] Sigla do estado (UF) do endereço. |
|
text |
[pt] Identificador da cidade associado ao endereço. |
|
text |
[pt] Nome da rua, avenida ou via do endereço. |
|
text |
[pt] Número do imóvel no endereço. |
|
text |
[pt] Nome do país do endereço. |
|
text |
[pt] Identificador único do endereço cadastrado (UUID). |
|
text |
[pt] Identificador herdado de um sistema anterior ou externo. |
|
text |
[pt] Número da inscrição estadual, caso aplicável (uso em empresas). |
|
text |
[pt] Nome da pessoa ou razão social da empresa. |
|
text |
[pt] Lista de perfis atribuídos à pessoa (ex: Cliente, Fornecedor, Colaborador). |
|
text |
[pt] Número de telefone principal para contato. |
|
text |
[pt] Tipo da pessoa cadastrada: JURIDICA ou FISICA. |
|
text |
[pt] Identificador único da pessoa no sistema legado (UUID). |
Categorias
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da categoria financeira. |
|
text |
[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica. |
|
boolean |
[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE. |
|
text |
[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence. |
|
text |
[pt] Nome da categoria financeira, como será exibida nos relatórios. |
|
text |
[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA. |
|
text |
[pt] Versão da categoria, usada para controle de alterações. |
Centros de custo
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do centro de custo. |
|
boolean |
[pt] Indica se o centro de custo está ativo no sistema e disponível para uso em lançamentos. |
|
text |
[pt] Código personalizado do centro de custo, utilizado para organização interna. Pode ser nulo. |
|
text |
[pt] Nome do centro de custo, usado para controle e classificação financeira. |
Contas a pagar
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a pagar. |
|
text |
[pt] Identificador único da parcela financeira. |
|
boolean |
[pt] Indica se há uma baixa de pagamento agendada para esta parcela. |
|
boolean |
[pt] Indica se a parcela foi conciliada com um lançamento bancário. |
|
text |
[pt] Número da agência da conta bancária. |
|
boolean |
[pt] Indica se a conta financeira está ativa no sistema. |
|
text |
[pt] Nome do banco associado à conta financeira. |
|
text |
[pt] Código do banco no sistema financeiro nacional (ex: 756 para SICOOB). |
|
boolean |
[pt] Indica se essa conta é definida como padrão para lançamentos financeiros. |
|
text |
[pt] Identificador único da conta financeira utilizada para movimentação da parcela. |
|
text |
[pt] Nome da conta financeira usada na movimentação. |
|
text |
[pt] Número da conta bancária. |
|
boolean |
[pt] Indica se a conta possui configuração para emissão de boletos bancários. |
|
text |
[pt] Tipo da conta financeira (ex: CONTA_CORRENTE, APLICACAO, POUPANCA). |
|
date |
[pt] Data prevista para o pagamento da parcela. |
|
float |
||
float |
||
text |
||
text |
[pt] Identificador do boleto bancário autorizado associado à parcela. |
|
text |
[pt] Identificador da última solicitação de pagamento gerada para a parcela. |
|
text |
[pt] Identificador da última solicitação de cobrança vinculada à parcela. |
|
float |
[pt] Número sequencial da parcela dentro da condição de pagamento. |
|
text |
[pt] Método de pagamento utilizado para a quitação da parcela (ex: BOLETO, PIX, OUTRO). |
|
boolean |
||
boolean |
||
float |
||
text |
||
text |
||
text |
||
float |
||
text |
||
text |
[pt] Observação adicional ou nota complementar associada à parcela. |
|
text |
[pt] Número sequencial único da transação (NSU), utilizado para controle bancário. |
|
date |
[pt] Data em que a perda financeira foi registrada. |
|
float |
[pt] Valor considerado como perda nesta parcela. |
|
text |
[pt] Campo de referência externa associado à parcela. |
|
float |
[pt] Valor de desconto concedido na parcela. |
|
float |
[pt] Valor de juros aplicado sobre o valor original da parcela. |
|
float |
[pt] Valor da multa aplicado à parcela. |
|
float |
[pt] Valor de taxa aplicada à parcela. |
|
float |
[pt] Valor original da parcela, antes de descontos e acréscimos. |
|
float |
[pt] Valor líquido final da parcela após descontos e acréscimos. |
|
float |
[pt] Valor efetivamente pago nesta parcela. |
|
float |
[pt] Valor total líquido da parcela, considerando todos os ajustes financeiros. |
|
text |
[pt] Versão da parcela, usada para controle de alterações. |
|
timestamp |
[pt] Data e hora da última modificação da conta a pagar. |
|
timestamp |
[pt] Data e hora de criação da conta a pagar. |
|
date |
[pt] Data de vencimento da conta a pagar. |
|
text |
[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal. |
|
float |
[pt] Valor que ainda não foi pago desta conta. |
|
float |
[pt] Valor que já foi pago desta conta. |
|
text |
[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida). |
|
float |
[pt] Valor total da conta a pagar. |
contaazul_contas_a_pagar_parcela_anexos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a pagar. |
|
text |
[pt] Identificador único da parcela financeira. |
|
text |
[pt] Descrição do conteúdo ou finalidade do anexo vinculado à parcela. |
|
text |
[pt] Identificador único do anexo da parcela. |
|
text |
[pt] Identificador da parcela à qual o anexo está vinculado. |
|
text |
[pt] Nome do anexo, geralmente usado como título do documento. |
|
text |
[pt] Referência associada ao anexo para fins de rastreamento ou integração externa. |
|
text |
[pt] Tipo do anexo vinculado à parcela, como BOLETO_BANCARIO ou RECIBO_DIGITAL. |
|
text |
[pt] Formato do conteúdo do anexo, como FILE (arquivo) ou URL (link). |
|
text |
[pt] Endereço URL para acesso ou download do anexo. |
|
text |
[pt] Número da versão do anexo, utilizado para controle de alterações. |
contaazul_contas_a_pagar_parcela_baixas
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a pagar. |
|
text |
[pt] Identificador único da parcela financeira. |
|
timestamp |
[pt] Data e hora da última atualização da baixa. |
|
text |
[pt] Número da agência da conta utilizada na baixa. |
|
boolean |
[pt] Indica se a conta financeira da baixa está ativa. |
|
text |
[pt] Nome do banco da conta financeira usada na baixa. |
|
text |
[pt] Código do banco no sistema bancário nacional. |
|
boolean |
[pt] Indica se a conta é marcada como padrão no sistema. |
|
text |
[pt] Identificador da conta financeira usada na baixa. |
|
text |
[pt] Nome da conta financeira utilizada na baixa. |
|
text |
[pt] Número da conta bancária utilizada na baixa. |
|
boolean |
[pt] Indica se a conta possui configuração para boletos bancários. |
|
text |
[pt] Tipo da conta utilizada (ex: CONTA_CORRENTE). |
|
date |
[pt] Data em que o pagamento da baixa foi realizado. |
|
text |
[pt] Identificador único da baixa registrada para a parcela. |
|
text |
[pt] Identificador da parcela à qual esta baixa está vinculada. |
|
text |
[pt] Identificador do recibo digital gerado para esta baixa. |
|
text |
[pt] Identificador da conciliação bancária associada à baixa. |
|
text |
[pt] Identificador de referência externa associado à baixa. |
|
text |
[pt] Identificador da solicitação de cobrança relacionada à baixa. |
|
text |
[pt] Método utilizado no pagamento da baixa (ex: PIX, BOLETO, OUTRO). |
|
text |
[pt] Número sequencial único da transação de baixa (NSU). |
|
text |
[pt] Observações adicionais relacionadas à baixa. |
|
text |
[pt] Origem da baixa no sistema, como LANCAMENTO_FINANCEIRO. |
|
text |
[pt] Tipo de evento da baixa (ex: RECEITA ou DESPESA). |
|
float |
[pt] Desconto concedido no momento da baixa. |
|
float |
[pt] Valor de juros aplicado na baixa. |
|
float |
[pt] Valor de multa aplicado na baixa. |
|
float |
[pt] Taxas aplicadas na baixa da parcela. |
|
float |
[pt] Valor bruto pago na baixa, antes de descontos e taxas. |
|
float |
[pt] Valor líquido efetivamente recebido na baixa. |
|
text |
[pt] Versão da baixa, utilizada para controle de alterações. |
contaazul_contas_a_pagar_parcela_baixas_anexos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a pagar. |
|
text |
[pt] Identificador único da parcela financeira. |
|
text |
[pt] Descrição do conteúdo do anexo da baixa. |
|
text |
[pt] Identificador único do anexo da baixa. |
|
text |
[pt] Nome do documento anexo à baixa. |
|
text |
[pt] Código de referência associado ao anexo da baixa. |
|
text |
[pt] Tipo do anexo (ex: RECIBO_DIGITAL). |
|
text |
[pt] Formato do conteúdo do anexo, como FILE ou URL. |
|
text |
[pt] Endereço URL para acesso ao anexo da baixa. |
Contas a pagar: categorias
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a pagar. |
|
text |
[pt] Identificador único da categoria financeira. |
|
timestamp |
[pt] Data e hora da última modificação da conta a pagar. |
|
timestamp |
[pt] Data e hora de criação da conta a pagar. |
|
date |
[pt] Data de vencimento da conta a pagar. |
|
text |
[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal. |
|
float |
[pt] Valor que ainda não foi pago desta conta. |
|
float |
[pt] Valor que já foi pago desta conta. |
|
text |
[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida). |
|
float |
[pt] Valor total da conta a pagar. |
|
text |
[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica. |
|
boolean |
[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE. |
|
text |
[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence. |
|
text |
[pt] Nome da categoria financeira, como será exibida nos relatórios. |
|
text |
[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA. |
|
float |
[pt] Versão da categoria, usada para controle de alterações. |
Contas a pagar: centros de custo
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a pagar. |
|
text |
[pt] Identificador único do centro de custo. |
|
boolean |
[pt] Indica se o centro de custo está ativo e disponível para uso. |
|
text |
[pt] Código atribuído pelo usuário para identificar o centro de custo. |
|
text |
[pt] Nome do centro de custo, usado para organização e controle financeiro. |
|
timestamp |
[pt] Data e hora da última modificação da conta a pagar. |
|
timestamp |
[pt] Data e hora de criação da conta a pagar. |
|
date |
[pt] Data de vencimento da conta a pagar. |
|
text |
[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal. |
|
float |
[pt] Valor que ainda não foi pago desta conta. |
|
float |
[pt] Valor que já foi pago desta conta. |
|
text |
[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida). |
|
float |
[pt] Valor total da conta a pagar. |
Contas a receber
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador único da parcela financeira. |
|
boolean |
[pt] Indica se há uma baixa de pagamento agendada para esta parcela. |
|
boolean |
[pt] Indica se a parcela foi conciliada com um lançamento bancário. |
|
text |
[pt] Número da agência da conta bancária. |
|
boolean |
[pt] Indica se a conta financeira está ativa no sistema. |
|
text |
[pt] Nome do banco associado à conta financeira. |
|
text |
[pt] Código do banco no sistema financeiro nacional (ex: 756 para SICOOB). |
|
boolean |
||
boolean |
||
float |
||
text |
||
text |
||
text |
||
float |
||
text |
||
boolean |
[pt] Indica se essa conta é definida como padrão para lançamentos financeiros. |
|
text |
[pt] Identificador único da conta financeira utilizada para movimentação da parcela. |
|
text |
[pt] Nome da conta financeira usada na movimentação. |
|
text |
[pt] Número da conta bancária. |
|
boolean |
[pt] Indica se a conta possui configuração para emissão de boletos bancários. |
|
text |
[pt] Tipo da conta financeira (ex: CONTA_CORRENTE, APLICACAO, POUPANCA). |
|
date |
[pt] Data prevista para o pagamento da parcela. |
|
date |
[pt] Data de vencimento da parcela. |
|
text |
[pt] Identificador do boleto bancário autorizado associado à parcela. |
|
text |
[pt] Identificador da última solicitação de pagamento gerada para a parcela. |
|
text |
[pt] Identificador da última solicitação de cobrança vinculada à parcela. |
|
float |
[pt] Número sequencial da parcela dentro da condição de pagamento. |
|
text |
[pt] Método de pagamento utilizado para a quitação da parcela (ex: BOLETO, PIX, OUTRO). |
|
text |
[pt] Observação adicional ou nota complementar associada à parcela. |
|
text |
[pt] Número sequencial único da transação (NSU), utilizado para controle bancário. |
|
date |
[pt] Data em que a perda financeira foi registrada. |
|
float |
[pt] Valor considerado como perda nesta parcela. |
|
text |
[pt] Campo de referência externa associado à parcela. |
|
float |
[pt] Valor de desconto concedido na parcela. |
|
float |
[pt] Valor de juros aplicado sobre o valor original da parcela. |
|
float |
[pt] Valor da multa aplicado à parcela. |
|
float |
[pt] Valor de taxa aplicada à parcela. |
|
float |
[pt] Valor original da parcela, antes de descontos e acréscimos. |
|
float |
[pt] Valor líquido final da parcela após descontos e acréscimos. |
|
float |
[pt] Valor efetivamente pago nesta parcela. |
|
float |
[pt] Valor total líquido da parcela, considerando todos os ajustes financeiros. |
|
text |
[pt] Versão da parcela, usada para controle de alterações. |
|
float |
||
float |
||
text |
||
timestamp |
[pt] Data e hora da última modificação da conta a receber. |
|
timestamp |
[pt] Data e hora de criação da conta a receber. |
|
text |
[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal. |
|
float |
[pt] Valor que ainda não foi pago desta conta. |
|
float |
[pt] Valor que já foi pago desta conta. |
|
text |
[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida). |
|
float |
[pt] Valor total da conta a receber. |
contaazul_contas_a_receber_parcela_baixas
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador da parcela à qual esta baixa está vinculada. |
|
timestamp |
[pt] Data e hora da última atualização da baixa. |
|
text |
[pt] Número da agência da conta utilizada na baixa. |
|
boolean |
[pt] Indica se a conta financeira da baixa está ativa. |
|
text |
[pt] Nome do banco da conta financeira usada na baixa. |
|
text |
[pt] Código do banco no sistema bancário nacional. |
|
boolean |
[pt] Indica se a conta é marcada como padrão no sistema. |
|
text |
[pt] Identificador da conta financeira usada na baixa. |
|
text |
[pt] Nome da conta financeira utilizada na baixa. |
|
text |
[pt] Número da conta bancária utilizada na baixa. |
|
boolean |
[pt] Indica se a conta possui configuração para boletos bancários. |
|
text |
[pt] Tipo da conta utilizada (ex: CONTA_CORRENTE). |
|
date |
[pt] Data em que o pagamento da baixa foi realizado. |
|
text |
[pt] Identificador único da baixa registrada para a parcela. |
|
text |
[pt] Identificador do recibo digital gerado para esta baixa. |
|
text |
[pt] Identificador da conciliação bancária associada à baixa. |
|
text |
[pt] Identificador de referência externa associado à baixa. |
|
text |
[pt] Identificador da solicitação de cobrança relacionada à baixa. |
|
text |
[pt] Método utilizado no pagamento da baixa (ex: PIX, BOLETO, OUTRO). |
|
text |
[pt] Número sequencial único da transação de baixa (NSU). |
|
text |
[pt] Observações adicionais relacionadas à baixa. |
|
text |
[pt] Origem da baixa no sistema, como LANCAMENTO_FINANCEIRO. |
|
text |
[pt] Tipo de evento da baixa (ex: RECEITA ou DESPESA). |
|
float |
[pt] Desconto concedido no momento da baixa. |
|
float |
[pt] Valor de juros aplicado na baixa. |
|
float |
[pt] Valor de multa aplicado na baixa. |
|
float |
[pt] Taxas aplicadas na baixa da parcela. |
|
float |
[pt] Valor bruto pago na baixa, antes de descontos e taxas. |
|
float |
[pt] Valor líquido efetivamente recebido na baixa. |
|
text |
[pt] Versão da baixa, utilizada para controle de alterações. |
contaazul_contas_a_receber_parcela_anexos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador único da parcela financeira. |
|
text |
[pt] Descrição do conteúdo ou finalidade do anexo vinculado à parcela. |
|
text |
[pt] Identificador único do anexo da parcela. |
|
text |
[pt] Identificador da parcela à qual o anexo está vinculado. |
|
text |
[pt] Nome do anexo, geralmente usado como título do documento. |
|
text |
[pt] Referência associada ao anexo para fins de rastreamento ou integração externa. |
|
text |
[pt] Tipo do anexo vinculado à parcela, como BOLETO_BANCARIO ou RECIBO_DIGITAL. |
|
text |
[pt] Formato do conteúdo do anexo, como FILE (arquivo) ou URL (link). |
|
text |
[pt] Endereço URL para acesso ou download do anexo. |
|
text |
[pt] Número da versão do anexo, utilizado para controle de alterações. |
contaazul_contas_a_receber_parcela_baixas_anexos
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador único da parcela financeira. |
|
text |
[pt] Descrição do conteúdo do anexo da baixa. |
|
text |
[pt] Identificador único do anexo da baixa. |
|
text |
[pt] Nome do documento anexo à baixa. |
|
text |
[pt] Código de referência associado ao anexo da baixa. |
|
text |
[pt] Tipo do anexo (ex: RECIBO_DIGITAL). |
|
text |
[pt] Formato do conteúdo do anexo, como FILE ou URL. |
|
text |
[pt] Endereço URL para acesso ao anexo da baixa. |
Contas a receber: categorias
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador único da categoria financeira. |
|
timestamp |
[pt] Data e hora da última modificação da conta a receber. |
|
timestamp |
[pt] Data e hora de criação da conta a receber. |
|
date |
[pt] Data de vencimento da conta a receber. |
|
text |
[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal. |
|
float |
[pt] Valor que ainda não foi pago desta conta. |
|
float |
[pt] Valor que já foi pago desta conta. |
|
text |
[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida). |
|
float |
[pt] Valor total da conta a receber. |
|
text |
[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica. |
|
boolean |
[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE. |
|
text |
[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence. |
|
text |
[pt] Nome da categoria financeira, como será exibida nos relatórios. |
|
text |
[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA. |
|
float |
[pt] Versão da categoria, usada para controle de alterações. |
Contas a receber: centros de custo
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador único do centro de custo. |
|
boolean |
[pt] Indica se o centro de custo está ativo e disponível para uso. |
|
text |
[pt] Código atribuído pelo usuário para identificar o centro de custo. |
|
text |
[pt] Nome do centro de custo, usado para organização e controle financeiro. |
|
timestamp |
[pt] Data e hora da última modificação da conta a receber. |
|
timestamp |
[pt] Data e hora de criação da conta a receber. |
|
date |
[pt] Data de vencimento da conta a receber. |
|
text |
[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal. |
|
float |
[pt] Valor que ainda não foi pago desta conta. |
|
float |
[pt] Valor que já foi pago desta conta. |
|
text |
[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida). |
|
float |
[pt] Valor total da conta a receber. |
Contas a receber: cobranças
Objeto principal
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador único da solicitação de cobrança. |
|
text |
[pt] Dados personalizados fornecidos pelo usuário para integração ou controle adicional. |
|
boolean |
[pt] Indica se a solicitação está combinada com outras cobranças ou ciclos. |
|
date |
[pt] Data em que a solicitação de cobrança foi confirmada. |
|
text |
[pt] Número da agência bancária vinculada à conta. |
|
boolean |
[pt] Indica se a conta está ativa no sistema. |
|
text |
[pt] Nome do banco associado à conta financeira utilizada na cobrança. |
|
text |
[pt] Código bancário da instituição da conta usada. |
|
boolean |
[pt] Indica se a conta é marcada como padrão. |
|
text |
[pt] Identificador único da conta financeira utilizada para gerar a cobrança. |
|
text |
[pt] Nome da conta financeira utilizada. |
|
text |
[pt] Número da conta bancária. |
|
boolean |
[pt] Indica se a conta permite configuração de boletos bancários. |
|
text |
[pt] Tipo da conta (ex: CONTA_CORRENTE, APLICACAO, COBRANCAS_CONTA_AZUL). |
|
date |
[pt] Data em que a cobrança foi quitada. |
|
date |
[pt] Data de vencimento da solicitação de cobrança. |
|
text |
[pt] Detalhes de erro caso a solicitação de cobrança tenha falhado. |
|
text |
[pt] Descrição associada à solicitação, geralmente relacionada à venda ou nota fiscal. |
|
text |
[pt] Identificador do cliente ao qual a cobrança está vinculada. |
|
text |
[pt] Referência utilizada para integrar a cobrança a um evento externo ou sistema de origem. |
|
date |
[pt] Data em que o cliente abriu a notificação. |
|
boolean |
[pt] Indica se o envio da notificação foi agendado. |
|
text |
[pt] Assunto da mensagem enviada na notificação. |
|
boolean |
[pt] Indica se a notificação foi gerada automaticamente pelo sistema. |
|
text |
[pt] Corpo da mensagem da notificação enviada ao cliente. |
|
date |
[pt] Data em que a notificação foi enviada ao cliente. |
|
boolean |
[pt] Indica se a notificação foi enviada imediatamente após criação. |
|
text |
[pt] Identificador da notificação de cobrança enviada ao cliente. |
|
text |
[pt] Endereço para o qual o cliente pode responder a notificação. |
|
text |
[pt] Lista de identificadores das solicitações de cobrança notificadas. |
|
float |
[pt] Versão da notificação de cobrança. |
|
boolean |
[pt] Indica se a solicitação foi recuperada após falha. |
|
text |
[pt] Referência externa para controle ou rastreamento da solicitação. |
|
text |
[pt] Status atual da solicitação de cobrança (ex: AGUARDANDO_CONFIRMACAO, CANCELADO, CONFIRMADO). |
|
text |
[pt] Tipo da solicitação de cobrança (ex: BOLETO, PIX, CARTAO_CREDITO). |
|
text |
[pt] URL para visualização da fatura no ambiente da Conta Azul. |
|
float |
[pt] Desconto aplicado à cobrança, se houver. |
|
float |
[pt] Valor dos juros aplicados à cobrança. |
|
float |
[pt] Valor da multa aplicada à solicitação de cobrança. |
|
float |
[pt] Taxa financeira associada à cobrança. |
|
float |
[pt] Valor bruto original da cobrança antes de descontos e taxas. |
|
float |
[pt] Valor líquido a ser cobrado, após aplicação de multa, juros, descontos e taxas. |
|
float |
[pt] Versão da solicitação, usada para controle de alterações. |
contaazul_contas_a_receber_cobrancas_notif_cobranca_itens_notif_cobranca
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta a receber. |
|
text |
[pt] Identificador único da solicitação de cobrança. |
|
text |
[pt] Endereço de e-mail usado na notificação de cobrança. |
|
text |
[pt] Identificador do item de notificação enviado por canal (email, sms, etc). |
|
text |
[pt] Conteúdo da notificação enviada via SMS. |
|
text |
[pt] Status da entrega da notificação (ex: ENVIADO, ERRO, ABERTO). |
|
float |
[pt] Versão do item de notificação individual. |
|
text |
[pt] Conteúdo da notificação enviada via WhatsApp. |
Contas financeiras
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da conta financeira. |
|
text |
[pt] Número da agência bancária vinculada à conta. |
|
boolean |
[pt] Indica se a conta financeira está ativa e disponível para lançamentos. |
|
text |
[pt] Nome do banco ao qual a conta está vinculada. |
|
text |
[pt] Código numérico do banco no sistema financeiro nacional (ex: 237 para BRADESCO). |
|
boolean |
[pt] Indica se esta conta é marcada como padrão no sistema. |
|
text |
[pt] Nome descritivo da conta financeira, definido pelo usuário. |
|
text |
[pt] Número da conta bancária. |
|
boolean |
[pt] Indica se a conta possui configuração para emissão de boletos bancários. |
|
text |
[pt] Tipo da conta, como CONTA_CORRENTE, POUPANCA ou APLICACAO. |
Serviços
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único do serviço cadastrado no sistema. |
|
text |
[pt] Código interno utilizado para referência ao serviço. Pode ser nulo. |
|
float |
[pt] Custo associado à execução do serviço. Pode ser nulo se não informado. |
|
text |
[pt] Descrição detalhada do serviço prestado. |
|
text |
[pt] Identificador do serviço no sistema legado ou plataforma externa. |
|
text |
[pt] Nome do serviço prestado. Pode ser nulo se não informado. |
|
float |
[pt] Preço de venda do serviço. Pode ser nulo se ainda não definido. |
|
text |
[pt] Status atual do serviço no sistema (ex: ATIVO, INATIVO). |
|
text |
[pt] Categoria ou tipo do serviço (ex: CONSULTORIA, MANUTENCAO). Pode ser nulo. |
Vendas
Campo | Tipo | |
---|---|---|
text |
[pt] Identificador único da venda. |
|
text |
[pt] Endereço de e-mail do cliente. |
|
text |
[pt] Identificador único do cliente vinculado à venda. |
|
text |
[pt] Nome do cliente que realizou a compra. |
|
text |
[pt] Identificador do cliente em um sistema legado ou externo. |
|
boolean |
[pt] Indica se há uma condição de pagamento associada à venda (ex: parcelado). |
|
date |
[pt] Data em que a venda foi registrada ou agendada. |
|
text |
[pt] Identificador da venda em um sistema anterior ou externo. |
|
text |
[pt] Tipo de item vendido, como SERVICE (serviço) ou PRODUCT (produto). |
|
text |
[pt] Número sequencial ou identificador interno da venda. |
|
timestamp |
[pt] Data e hora em que o e-mail da venda foi enviado. |
|
text |
[pt] Status do envio de e-mail relacionado à venda (ex: ENVIADO, ERRO). |
|
text |
[pt] Tipo da venda realizada, como SCHEDULED_SALE (venda agendada). |
|
text |
[pt] Versão do registro da venda, usada para controle de alterações. |
Notas
Descrição dos campos
Devido à ausência de descrição dos campos na documentação da API, grande parte das descrições foi gerada com inteligência artificial com exemplos dos valores retornados