ContaAzul

Adicionando o conector

Requisitos

  • Utilizar um login de ADMINISTRADOR

Instruções

  1. Faça login na Kondado > clique em CRIAR + > Conector > Escolha o conector do Conta Azul
  2. Clique em Autenticar
  3. Faça login em sua conta do Conta Azul
  4. Caso requisitado, informe o token de seu aplicativo de autenticação
  5. Você será direcionado de volta para a Kondado - basta salvar

Integrações

Índice

Gráfico de relacionamento

Clique para ampliar

Cadastro de pessoas

Tipo de replicacao: Integral

Dados de cadastro de pessoas no ContaAzul v2

Campo Tipo

uuid

text

[pt] Identificador único da pessoa no sistema (UUID).

ativo

boolean

[pt] Indica se o cadastro está ativo e disponível no sistema.

documento

text

[pt] Número do CPF ou CNPJ da pessoa ou empresa.

email

text

[pt] Endereço de e-mail principal da pessoa ou empresa cadastrada.

endereco_bairro

text

[pt] Bairro ou distrito do endereço.

endereco_cep

text

[pt] Código de Endereçamento Postal (CEP) do endereço.

endereco_cidade

text

[pt] Nome da cidade do endereço.

endereco_complemento

text

[pt] Informações complementares ao endereço, como bloco ou sala.

endereco_estado

text

[pt] Sigla do estado (UF) do endereço.

endereco_id_cidade

text

[pt] Identificador da cidade associado ao endereço.

endereco_logradouro

text

[pt] Nome da rua, avenida ou via do endereço.

endereco_numero

text

[pt] Número do imóvel no endereço.

endereco_pais

text

[pt] Nome do país do endereço.

endereco_uuid

text

[pt] Identificador único do endereço cadastrado (UUID).

id_legado

text

[pt] Identificador herdado de um sistema anterior ou externo.

inscricao_estadual

text

[pt] Número da inscrição estadual, caso aplicável (uso em empresas).

nome

text

[pt] Nome da pessoa ou razão social da empresa.

perfis

text

[pt] Lista de perfis atribuídos à pessoa (ex: Cliente, Fornecedor, Colaborador).

telefone

text

[pt] Número de telefone principal para contato.

tipo_pessoa

text

[pt] Tipo da pessoa cadastrada: JURIDICA ou FISICA.

uuid_legado

text

[pt] Identificador único da pessoa no sistema legado (UUID).

Categorias financeiras

Tipo de replicacao: Integral

Dados de categorias no ContaAzul v2

Campo Tipo

id

text

[pt] Identificador único da categoria financeira.

categoria_pai

text

[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica.

considera_custo_dre

boolean

[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE.

entrada_dre

text

[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence.

nome

text

[pt] Nome da categoria financeira, como será exibida nos relatórios.

tipo

text

[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA.

versao

text

[pt] Versão da categoria, usada para controle de alterações.

Centros de custo

Tipo de replicacao: Integral

Dados de centros de custo no ContaAzul v2

Campo Tipo

id

text

[pt] Identificador único do centro de custo.

ativo

boolean

[pt] Indica se o centro de custo está ativo no sistema e disponível para uso em lançamentos.

codigo

text

[pt] Código personalizado do centro de custo, utilizado para organização interna. Pode ser nulo.

nome

text

[pt] Nome do centro de custo, usado para controle e classificação financeira.

Contas a pagar

Tipo de replicacao: Incremental ou Integral (configuravel pelo usuario)

Parametros:

  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Objeto principal

Contas a pagar do Conta Azul v2, contendo informações sobre obrigações financeiras, parcelas, datas de vencimento e pagamentos realizados.

Campo Tipo

id

text

[pt] Identificador único da conta a pagar.

parcela_id

text

[pt] Identificador único da parcela financeira.

baixa_agendada

boolean

[pt] Indica se há uma baixa de pagamento agendada para esta parcela.

conciliado

boolean

[pt] Indica se a parcela foi conciliada com um lançamento bancário.

conta_financeira_agencia

text

[pt] Número da agência da conta bancária.

conta_financeira_ativo

boolean

[pt] Indica se a conta financeira está ativa no sistema.

conta_financeira_banco

text

[pt] Nome do banco associado à conta financeira.

conta_financeira_codigo_banco

text

[pt] Código do banco no sistema financeiro nacional (ex: 756 para SICOOB).

conta_financeira_conta_padrao

boolean

[pt] Indica se essa conta é definida como padrão para lançamentos financeiros.

conta_financeira_id

text

[pt] Identificador único da conta financeira utilizada para movimentação da parcela.

    Contas financeiras > > id

conta_financeira_nome

text

[pt] Nome da conta financeira usada na movimentação.

conta_financeira_numero

text

[pt] Número da conta bancária.

conta_financeira_possui_config_boleto

boolean

[pt] Indica se a conta possui configuração para emissão de boletos bancários.

conta_financeira_tipo

text

[pt] Tipo da conta financeira (ex: CONTA_CORRENTE, APLICACAO, POUPANCA).

data_pagamento_previsto

date

[pt] Data prevista para o pagamento da parcela.

parcela_fatura_numero

float

parcela_fatura_rps

float

parcela_fatura_tipo_fatura

text

id_boleto_autorizado

text

[pt] Identificador do boleto bancário autorizado associado à parcela.

id_ultima_solicitacao_pagamento

text

[pt] Identificador da última solicitação de pagamento gerada para a parcela.

id_ultimo_solicitacao_cobranca

text

[pt] Identificador da última solicitação de cobrança vinculada à parcela.

indice

float

[pt] Número sequencial da parcela dentro da condição de pagamento.

metodo_pagamento

text

[pt] Método de pagamento utilizado para a quitação da parcela (ex: BOLETO, PIX, OUTRO).

evento_agendado

boolean

evento_condicao_pagamento_montante_fixo

boolean

evento_condicao_pagamento_quantidade_parcelas

float

evento_data_competencia

date

evento_referencia_id

text

evento_referencia_origem

text

evento_referencia_revisao

float

evento_tipo

text

nota

text

[pt] Observação adicional ou nota complementar associada à parcela.

nsu

text

[pt] Número sequencial único da transação (NSU), utilizado para controle bancário.

perda_data

date

[pt] Data em que a perda financeira foi registrada.

perda_valor

float

[pt] Valor considerado como perda nesta parcela.

referencia

text

[pt] Campo de referência externa associado à parcela.

valor_composicao_desconto

float

[pt] Valor de desconto concedido na parcela.

valor_composicao_juros

float

[pt] Valor de juros aplicado sobre o valor original da parcela.

valor_composicao_multa

float

[pt] Valor da multa aplicado à parcela.

valor_composicao_taxa

float

[pt] Valor de taxa aplicada à parcela.

valor_composicao_valor_bruto

float

[pt] Valor original da parcela, antes de descontos e acréscimos.

valor_composicao_valor_liquido

float

[pt] Valor líquido final da parcela após descontos e acréscimos.

valor_pago

float

[pt] Valor efetivamente pago nesta parcela.

valor_total_liquido

float

[pt] Valor total líquido da parcela, considerando todos os ajustes financeiros.

versao

text

[pt] Versão da parcela, usada para controle de alterações.

data_alteracao

timestamp

[pt] Data e hora da última modificação da conta a pagar.

data_criacao

timestamp

[pt] Data e hora de criação da conta a pagar.

data_vencimento

date

[pt] Data de vencimento da conta a pagar.

descricao

text

[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal.

fornecedor_id

text

[en] Identificador único do fornecedor associado àquela conta a pagar.

fornecedor_nome

text

[pt] Nome do fornecedor associado àquela conta a pagar

nao_pago

float

[pt] Valor que ainda não foi pago desta conta.

pago

float

[pt] Valor que já foi pago desta conta.

status

text

[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida).

total

float

[pt] Valor total da conta a pagar.

contaazul_contas_a_pagar_parcela_anexos

Anexos associados às parcelas de contas a pagar do Conta Azul v2, incluindo notas fiscais e outros documentos comprobatórios.

Campo Tipo

contas_a_pagar_id

text

[pt] Identificador único da conta a pagar.

parcela_id

text

[pt] Identificador único da parcela financeira.

anexos_descricao

text

[pt] Descrição do conteúdo ou finalidade do anexo vinculado à parcela.

anexos_id

text

[pt] Identificador único do anexo da parcela.

anexos_id_parcela

text

[pt] Identificador da parcela à qual o anexo está vinculado.

anexos_nome

text

[pt] Nome do anexo, geralmente usado como título do documento.

anexos_referencia

text

[pt] Referência associada ao anexo para fins de rastreamento ou integração externa.

anexos_tipo_anexo

text

[pt] Tipo do anexo vinculado à parcela, como BOLETO_BANCARIO ou RECIBO_DIGITAL.

anexos_tipo_conteudo

text

[pt] Formato do conteúdo do anexo, como FILE (arquivo) ou URL (link).

anexos_url

text

[pt] Endereço URL para acesso ou download do anexo.

anexos_versao

text

[pt] Número da versão do anexo, utilizado para controle de alterações.

contaazul_contas_a_pagar_parcela_baixas

Baixas (pagamentos efetivados) das parcelas de contas a pagar do Conta Azul v2, registrando datas, valores e formas de pagamento.

Campo Tipo

contas_a_pagar_id

text

[pt] Identificador único da conta a pagar.

parcela_id

text

[pt] Identificador único da parcela financeira.

baixas_atualizado_em

timestamp

[pt] Data e hora da última atualização da baixa.

baixas_conta_financeira_agencia

text

[pt] Número da agência da conta utilizada na baixa.

baixas_conta_financeira_ativo

boolean

[pt] Indica se a conta financeira da baixa está ativa.

baixas_conta_financeira_banco

text

[pt] Nome do banco da conta financeira usada na baixa.

baixas_conta_financeira_codigo_banco

text

[pt] Código do banco no sistema bancário nacional.

baixas_conta_financeira_conta_padrao

boolean

[pt] Indica se a conta é marcada como padrão no sistema.

baixas_conta_financeira_id

text

[pt] Identificador da conta financeira usada na baixa.

    Contas financeiras > > id

baixas_conta_financeira_nome

text

[pt] Nome da conta financeira utilizada na baixa.

baixas_conta_financeira_numero

text

[pt] Número da conta bancária utilizada na baixa.

baixas_conta_financeira_possui_config_boleto_bancar

boolean

[pt] Indica se a conta possui configuração para boletos bancários.

baixas_conta_financeira_tipo

text

[pt] Tipo da conta utilizada (ex: CONTA_CORRENTE).

baixas_data_pagamento

date

[pt] Data em que o pagamento da baixa foi realizado.

baixas_id

text

[pt] Identificador único da baixa registrada para a parcela.

baixas_id_parcela

text

[pt] Identificador da parcela à qual esta baixa está vinculada.

baixas_id_recibo_digital

text

[pt] Identificador do recibo digital gerado para esta baixa.

baixas_id_reconciliacao

text

[pt] Identificador da conciliação bancária associada à baixa.

baixas_id_referencia

text

[pt] Identificador de referência externa associado à baixa.

baixas_id_solicitacao_cobranca

text

[pt] Identificador da solicitação de cobrança relacionada à baixa.

baixas_metodo_pagamento

text

[pt] Método utilizado no pagamento da baixa (ex: PIX, BOLETO, OUTRO).

baixas_nsu

text

[pt] Número sequencial único da transação de baixa (NSU).

baixas_observacao

text

[pt] Observações adicionais relacionadas à baixa.

baixas_origem

text

[pt] Origem da baixa no sistema, como LANCAMENTO_FINANCEIRO.

baixas_tipo_evento_financeiro

text

[pt] Tipo de evento da baixa (ex: RECEITA ou DESPESA).

baixas_valor_composicao_desconto

float

[pt] Desconto concedido no momento da baixa.

baixas_valor_composicao_juros

float

[pt] Valor de juros aplicado na baixa.

baixas_valor_composicao_multa

float

[pt] Valor de multa aplicado na baixa.

baixas_valor_composicao_taxa

float

[pt] Taxas aplicadas na baixa da parcela.

baixas_valor_composicao_valor_bruto

float

[pt] Valor bruto pago na baixa, antes de descontos e taxas.

baixas_valor_composicao_valor_liquido

float

[pt] Valor líquido efetivamente recebido na baixa.

baixas_versao

text

[pt] Versão da baixa, utilizada para controle de alterações.

contaazul_contas_a_pagar_parcela_baixas_anexos

Anexos associados às baixas (pagamentos) de parcelas de contas a pagar do Conta Azul v2, incluindo comprovantes de pagamento.

Campo Tipo

contas_a_pagar_id

text

[pt] Identificador único da conta a pagar.

parcela_id

text

[pt] Identificador único da parcela financeira.

baixas_anexos_descricao

text

[pt] Descrição do conteúdo do anexo da baixa.

baixas_anexos_id

text

[pt] Identificador único do anexo da baixa.

baixas_anexos_nome

text

[pt] Nome do documento anexo à baixa.

baixas_anexos_referencia

text

[pt] Código de referência associado ao anexo da baixa.

baixas_anexos_tipo

text

[pt] Tipo do anexo (ex: RECIBO_DIGITAL).

baixas_anexos_tipo_conteudo

text

[pt] Formato do conteúdo do anexo, como FILE ou URL.

baixas_anexos_url

text

[pt] Endereço URL para acesso ao anexo da baixa.

Contas a pagar: categorias

Tipo de replicacao: Incremental ou Integral (configuravel pelo usuario)

Parametros:

  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Dados de contas a pagar categorias no ContaAzul v2

Campo Tipo

contas_a_pagar_id

text

[pt] Identificador único da conta a pagar.

    Contas a pagar > > id

categoria_id

text

[pt] Identificador único da categoria financeira.

    Categorias financeiras > > id

contas_a_pagar_data_alteracao

timestamp

[pt] Data e hora da última modificação da conta a pagar.

contas_a_pagar_data_criacao

timestamp

[pt] Data e hora de criação da conta a pagar.

contas_a_pagar_data_vencimento

date

[pt] Data de vencimento da conta a pagar.

contas_a_pagar_descricao

text

[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal.

contas_a_pagar_nao_pago

float

[pt] Valor que ainda não foi pago desta conta.

contas_a_pagar_pago

float

[pt] Valor que já foi pago desta conta.

contas_a_pagar_status

text

[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida).

contas_a_pagar_total

float

[pt] Valor total da conta a pagar.

categoria_pai

text

[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica.

categoria_considera_custo_dre

boolean

[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE.

categoria_entrada_dre

text

[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence.

categoria_tipo

text

[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA.

categoria_versao

text

[pt] Versão da categoria, usada para controle de alterações.

categoria_nome

text

[pt] O nome da categoria.

rateio_valor_categoria

float

[pt] O valor do rateio.

rateio_valor_bruto

float

[pt] O valor bruto do rateio.

Contas a pagar: centros de custo

Tipo de replicacao: Incremental ou Integral (configuravel pelo usuario)

Parametros:

  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Dados de contas a pagar centros de custo no ContaAzul v2

Campo Tipo

contas_a_pagar_id

text

[pt] Identificador único da conta a pagar.

    Contas a pagar > > id

categoria_id

text

[pt] Identificador único da categoria financeira.

    Categorias financeiras > > id

centro_de_custo_id

text

[pt] Identificador único da categoria financeira.

    Centros de custo > > id

contas_a_pagar_data_alteracao

timestamp

[pt] Data e hora da última modificação da conta a pagar.

contas_a_pagar_data_criacao

timestamp

[pt] Data e hora de criação da conta a pagar.

contas_a_pagar_data_vencimento

date

[pt] Data de vencimento da conta a pagar.

contas_a_pagar_descricao

text

[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal.

contas_a_pagar_nao_pago

float

[pt] Valor que ainda não foi pago desta conta.

contas_a_pagar_pago

float

[pt] Valor que já foi pago desta conta.

contas_a_pagar_status

text

[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida).

contas_a_pagar_total

float

[pt] Valor total da conta a pagar.

categoria_pai

text

[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica.

categoria_considera_custo_dre

boolean

[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE.

categoria_entrada_dre

text

[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence.

categoria_tipo

text

[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA.

categoria_versao

text

[pt] Versão da categoria, usada para controle de alterações.

categoria_nome

text

[pt] O nome da categoria.

centro_de_custo_nome

text

[pt] Nome do centro de custo, usado para controle e classificação financeira.

centro_de_custo_ativo

boolean

[pt] Indica se o centro de custo está ativo no sistema e disponível para uso em lançamentos.

centro_de_custo_codigo

text

[pt] Código personalizado do centro de custo, utilizado para organização interna. Pode ser nulo.

rateio_valor_categoria

float

[pt] O valor do rateio (nível categoria).

rateio_valor_bruto_categoria

float

[pt] O valor bruto do rateio (nível categoria).

rateio_valor_centro_de_custo

float

[pt] O valor do rateio (nível centro de custo).

Contas a receber

Tipo de replicacao: Incremental ou Integral (configuravel pelo usuario)

Parametros:

  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Objeto principal

Contas a receber do Conta Azul v2, contendo informações sobre valores a receber, parcelas, datas de vencimento e recebimentos realizados.

Campo Tipo

id

text

[pt] Identificador único da conta a receber.

parcela_id

text

[pt] Identificador único da parcela financeira.

baixa_agendada

boolean

[pt] Indica se há uma baixa de pagamento agendada para esta parcela.

conciliado

boolean

[pt] Indica se a parcela foi conciliada com um lançamento bancário.

conta_financeira_agencia

text

[pt] Número da agência da conta bancária.

conta_financeira_ativo

boolean

[pt] Indica se a conta financeira está ativa no sistema.

conta_financeira_banco

text

[pt] Nome do banco associado à conta financeira.

conta_financeira_codigo_banco

text

[pt] Código do banco no sistema financeiro nacional (ex: 756 para SICOOB).

evento_agendado

boolean

evento_condicao_pagamento_montante_fixo

boolean

evento_condicao_pagamento_quantidade_parcelas

float

evento_data_competencia

date

evento_referencia_id

text

evento_referencia_origem

text

evento_referencia_revisao

float

evento_tipo

text

conta_financeira_conta_padrao

boolean

[pt] Indica se essa conta é definida como padrão para lançamentos financeiros.

conta_financeira_id

text

[pt] Identificador único da conta financeira utilizada para movimentação da parcela.

    Contas financeiras > > id

conta_financeira_nome

text

[pt] Nome da conta financeira usada na movimentação.

conta_financeira_numero

text

[pt] Número da conta bancária.

conta_financeira_possui_config_boleto

boolean

[pt] Indica se a conta possui configuração para emissão de boletos bancários.

conta_financeira_tipo

text

[pt] Tipo da conta financeira (ex: CONTA_CORRENTE, APLICACAO, POUPANCA).

data_pagamento_previsto

date

[pt] Data prevista para o pagamento da parcela.

data_vencimento

date

[pt] Data de vencimento da parcela.

id_boleto_autorizado

text

[pt] Identificador do boleto bancário autorizado associado à parcela.

id_ultima_solicitacao_pagamento

text

[pt] Identificador da última solicitação de pagamento gerada para a parcela.

id_ultimo_solicitacao_cobranca

text

[pt] Identificador da última solicitação de cobrança vinculada à parcela.

indice

float

[pt] Número sequencial da parcela dentro da condição de pagamento.

metodo_pagamento

text

[pt] Método de pagamento utilizado para a quitação da parcela (ex: BOLETO, PIX, OUTRO).

nota

text

[pt] Observação adicional ou nota complementar associada à parcela.

nsu

text

[pt] Número sequencial único da transação (NSU), utilizado para controle bancário.

perda_data

date

[pt] Data em que a perda financeira foi registrada.

perda_valor

float

[pt] Valor considerado como perda nesta parcela.

referencia

text

[pt] Campo de referência externa associado à parcela.

valor_composicao_desconto

float

[pt] Valor de desconto concedido na parcela.

valor_composicao_juros

float

[pt] Valor de juros aplicado sobre o valor original da parcela.

valor_composicao_multa

float

[pt] Valor da multa aplicado à parcela.

valor_composicao_taxa

float

[pt] Valor de taxa aplicada à parcela.

valor_composicao_valor_bruto

float

[pt] Valor original da parcela, antes de descontos e acréscimos.

valor_composicao_valor_liquido

float

[pt] Valor líquido final da parcela após descontos e acréscimos.

valor_pago

float

[pt] Valor efetivamente pago nesta parcela.

valor_total_liquido

float

[pt] Valor total líquido da parcela, considerando todos os ajustes financeiros.

versao

text

[pt] Versão da parcela, usada para controle de alterações.

parcela_fatura_numero

float

parcela_fatura_rps

float

parcela_fatura_tipo_fatura

text

data_alteracao

timestamp

[pt] Data e hora da última modificação da conta a receber.

data_criacao

timestamp

[pt] Data e hora de criação da conta a receber.

descricao

text

[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal.

nao_pago

float

[pt] Valor que ainda não foi pago desta conta.

cliente_id

text

[en] Identificador único do cliente associado àquela conta a receber.

cliente_nome

text

[pt] Nome do cliente associado àquela conta a receber

pago

float

[pt] Valor que já foi pago desta conta.

status

text

[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida).

total

float

[pt] Valor total da conta a receber.

contaazul_contas_a_receber_parcela_baixas

Baixas (recebimentos efetivados) das parcelas de contas a receber do Conta Azul v2, registrando datas, valores e formas de recebimento.

Campo Tipo

contas_a_receber_id

text

[pt] Identificador único da conta a receber.

parcela_id

text

[pt] Identificador da parcela à qual esta baixa está vinculada.

atualizado_em

timestamp

[pt] Data e hora da última atualização da baixa.

conta_financeira_agencia

text

[pt] Número da agência da conta utilizada na baixa.

conta_financeira_ativo

boolean

[pt] Indica se a conta financeira da baixa está ativa.

conta_financeira_banco

text

[pt] Nome do banco da conta financeira usada na baixa.

conta_financeira_codigo_banco

text

[pt] Código do banco no sistema bancário nacional.

conta_financeira_conta_padrao

boolean

[pt] Indica se a conta é marcada como padrão no sistema.

conta_financeira_id

text

[pt] Identificador da conta financeira usada na baixa.

    Contas financeiras > > id

conta_financeira_nome

text

[pt] Nome da conta financeira utilizada na baixa.

conta_financeira_numero

text

[pt] Número da conta bancária utilizada na baixa.

conta_financeira_possui_cfg_boleto

boolean

[pt] Indica se a conta possui configuração para boletos bancários.

conta_financeira_tipo

text

[pt] Tipo da conta utilizada (ex: CONTA_CORRENTE).

data_pagamento

date

[pt] Data em que o pagamento da baixa foi realizado.

baixas_id

text

[pt] Identificador único da baixa registrada para a parcela.

id_recibo_digital

text

[pt] Identificador do recibo digital gerado para esta baixa.

id_reconciliacao

text

[pt] Identificador da conciliação bancária associada à baixa.

id_referencia

text

[pt] Identificador de referência externa associado à baixa.

id_solicitacao_cobranca

text

[pt] Identificador da solicitação de cobrança relacionada à baixa.

metodo_pagamento

text

[pt] Método utilizado no pagamento da baixa (ex: PIX, BOLETO, OUTRO).

nsu

text

[pt] Número sequencial único da transação de baixa (NSU).

observacao

text

[pt] Observações adicionais relacionadas à baixa.

origem

text

[pt] Origem da baixa no sistema, como LANCAMENTO_FINANCEIRO.

tipo_evento_financeiro

text

[pt] Tipo de evento da baixa (ex: RECEITA ou DESPESA).

valor_composicao_desconto

float

[pt] Desconto concedido no momento da baixa.

valor_composicao_juros

float

[pt] Valor de juros aplicado na baixa.

valor_composicao_multa

float

[pt] Valor de multa aplicado na baixa.

valor_composicao_taxa

float

[pt] Taxas aplicadas na baixa da parcela.

valor_composicao_valor_bruto

float

[pt] Valor bruto pago na baixa, antes de descontos e taxas.

valor_composicao_valor_liquido

float

[pt] Valor líquido efetivamente recebido na baixa.

versao

text

[pt] Versão da baixa, utilizada para controle de alterações.

contaazul_contas_a_receber_parcela_anexos

Anexos associados às parcelas de contas a receber do Conta Azul v2, incluindo notas fiscais e outros documentos.

Campo Tipo

contas_a_receber_id

text

[pt] Identificador único da conta a receber.

parcela_id

text

[pt] Identificador único da parcela financeira.

anexos_descricao

text

[pt] Descrição do conteúdo ou finalidade do anexo vinculado à parcela.

anexos_id

text

[pt] Identificador único do anexo da parcela.

anexos_id_parcela

text

[pt] Identificador da parcela à qual o anexo está vinculado.

anexos_nome

text

[pt] Nome do anexo, geralmente usado como título do documento.

anexos_referencia

text

[pt] Referência associada ao anexo para fins de rastreamento ou integração externa.

anexos_tipo_anexo

text

[pt] Tipo do anexo vinculado à parcela, como BOLETO_BANCARIO ou RECIBO_DIGITAL.

anexos_tipo_conteudo

text

[pt] Formato do conteúdo do anexo, como FILE (arquivo) ou URL (link).

anexos_url

text

[pt] Endereço URL para acesso ou download do anexo.

anexos_versao

text

[pt] Número da versão do anexo, utilizado para controle de alterações.

contaazul_contas_a_receber_parcela_baixas_anexos

Anexos associados às baixas (recebimentos) de parcelas de contas a receber do Conta Azul v2, incluindo comprovantes de recebimento.

Campo Tipo

contas_a_receber_id

text

[pt] Identificador único da conta a receber.

parcela_id

text

[pt] Identificador único da parcela financeira.

baixas_anexos_descricao

text

[pt] Descrição do conteúdo do anexo da baixa.

baixas_anexos_id

text

[pt] Identificador único do anexo da baixa.

baixas_anexos_nome

text

[pt] Nome do documento anexo à baixa.

baixas_anexos_referencia

text

[pt] Código de referência associado ao anexo da baixa.

baixas_anexos_tipo

text

[pt] Tipo do anexo (ex: RECIBO_DIGITAL).

baixas_anexos_tipo_conteudo

text

[pt] Formato do conteúdo do anexo, como FILE ou URL.

baixas_anexos_url

text

[pt] Endereço URL para acesso ao anexo da baixa.

Contas a receber: categorias

Tipo de replicacao: Incremental ou Integral (configuravel pelo usuario)

Parametros:

  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Dados de contas a receber categorias no ContaAzul v2

Campo Tipo

contas_a_receber_id

text

[pt] Identificador único da conta a receber.

    Contas a receber > > id

categoria_id

text

[pt] Identificador único da categoria financeira.

    Categorias financeiras > > id

contas_a_receber_data_alteracao

timestamp

[pt] Data e hora da última modificação da conta a receber.

contas_a_receber_data_criacao

timestamp

[pt] Data e hora de criação da conta a receber.

contas_a_receber_data_vencimento

date

[pt] Data de vencimento da conta a receber.

contas_a_receber_descricao

text

[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal.

contas_a_receber_nao_pago

float

[pt] Valor que ainda não foi pago desta conta.

contas_a_receber_pago

float

[pt] Valor que já foi pago desta conta.

contas_a_receber_status

text

[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida).

contas_a_receber_total

float

[pt] Valor total da conta a receber.

categoria_pai

text

[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica.

categoria_considera_custo_dre

boolean

[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE.

categoria_entrada_dre

text

[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence.

categoria_tipo

text

[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA.

categoria_versao

text

[pt] Versão da categoria, usada para controle de alterações.

categoria_nome

text

[pt] O nome da categoria.

rateio_valor_categoria

float

[pt] O valor do rateio.

rateio_valor_bruto

float

[pt] O valor bruto do rateio.

Contas a receber: centros de custo

Tipo de replicacao: Incremental ou Integral (configuravel pelo usuario)

Parametros:

  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Dados de contas a receber centros de custo no ContaAzul v2

Campo Tipo

contas_a_receber_id

text

[pt] Identificador único da conta a receber.

    Contas a receber > > id

categoria_id

text

[pt] Identificador único da categoria financeira.

    Categorias financeiras > > id

centro_de_custo_id

text

[pt] Identificador único da categoria financeira.

    Centros de custo > > id

contas_a_receber_data_alteracao

timestamp

[pt] Data e hora da última modificação da conta a receber.

contas_a_receber_data_criacao

timestamp

[pt] Data e hora de criação da conta a receber.

contas_a_receber_data_vencimento

date

[pt] Data de vencimento da conta a receber.

contas_a_receber_descricao

text

[pt] Descrição da conta, geralmente relacionada a uma venda ou nota fiscal.

contas_a_receber_nao_pago

float

[pt] Valor que ainda não foi pago desta conta.

contas_a_receber_pago

float

[pt] Valor que já foi pago desta conta.

contas_a_receber_status

text

[pt] Status atual da conta, como ACQUITTED (quitada), OPEN (aberta), OVERDUE (vencida).

contas_a_receber_total

float

[pt] Valor total da conta a receber.

categoria_pai

text

[pt] Identificador da categoria pai, caso esta categoria esteja em uma estrutura hierárquica.

categoria_considera_custo_dre

boolean

[pt] Indica se os valores dessa categoria devem ser considerados como custo no DRE.

categoria_entrada_dre

text

[pt] Grupo de entrada no Demonstrativo de Resultados (DRE) ao qual esta categoria pertence.

categoria_tipo

text

[pt] Tipo da categoria, podendo ser RECEITA ou DESPESA.

categoria_versao

text

[pt] Versão da categoria, usada para controle de alterações.

categoria_nome

text

[pt] O nome da categoria.

centro_de_custo_nome

text

[pt] Nome do centro de custo, usado para controle e classificação financeira.

centro_de_custo_ativo

boolean

[pt] Indica se o centro de custo está ativo no sistema e disponível para uso em lançamentos.

centro_de_custo_codigo

text

[pt] Código personalizado do centro de custo, utilizado para organização interna. Pode ser nulo.

rateio_valor_categoria

float

[pt] O valor do rateio (nível categoria).

rateio_valor_bruto_categoria

float

[pt] O valor bruto do rateio (nível categoria).

rateio_valor_centro_de_custo

float

[pt] O valor do rateio (nível centro de custo).

Contas a receber: cobranças

Tipo de replicacao: Incremental ou Integral (configuravel pelo usuario)

Parametros:

  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Objeto principal

Cobranças associadas às contas a receber do Conta Azul v2, contendo informações sobre solicitações de cobrança e notificações enviadas.

Campo Tipo

contas_a_receber_id

text

[pt] Identificador único da conta a receber.

    Contas a receber > > id

cobranca_id

text

[pt] Identificador único da solicitação de cobrança.

atributos_personalizados

text

[pt] Dados personalizados fornecidos pelo usuário para integração ou controle adicional.

combinado

boolean

[pt] Indica se a solicitação está combinada com outras cobranças ou ciclos.

confirmado_em

date

[pt] Data em que a solicitação de cobrança foi confirmada.

conta_financeira_agencia

text

[pt] Número da agência bancária vinculada à conta.

conta_financeira_ativo

boolean

[pt] Indica se a conta está ativa no sistema.

conta_financeira_banco

text

[pt] Nome do banco associado à conta financeira utilizada na cobrança.

conta_financeira_codigo_banco

text

[pt] Código bancário da instituição da conta usada.

conta_financeira_conta_padrao

boolean

[pt] Indica se a conta é marcada como padrão.

conta_financeira_id

text

[pt] Identificador único da conta financeira utilizada para gerar a cobrança.

    Contas financeiras > > id

conta_financeira_nome

text

[pt] Nome da conta financeira utilizada.

conta_financeira_numero

text

[pt] Número da conta bancária.

conta_financeira_possui_config_boleto_bancario

boolean

[pt] Indica se a conta permite configuração de boletos bancários.

conta_financeira_tipo

text

[pt] Tipo da conta (ex: CONTA_CORRENTE, APLICACAO, COBRANCAS_CONTA_AZUL).

data_quitacao

date

[pt] Data em que a cobrança foi quitada.

data_vencimento

date

[pt] Data de vencimento da solicitação de cobrança.

datalhe_erro

text

[pt] Detalhes de erro caso a solicitação de cobrança tenha falhado.

descricao

text

[pt] Descrição associada à solicitação, geralmente relacionada à venda ou nota fiscal.

id_cliente

text

[pt] Identificador do cliente ao qual a cobrança está vinculada.

    Cadastro de pessoas > > uuid

id_referencia

text

[pt] Referência utilizada para integrar a cobrança a um evento externo ou sistema de origem.

notif_cobranca_aberto_em

date

[pt] Data em que o cliente abriu a notificação.

notif_cobranca_agendado

boolean

[pt] Indica se o envio da notificação foi agendado.

notif_cobranca_assunto

text

[pt] Assunto da mensagem enviada na notificação.

notif_cobranca_auto_notif

boolean

[pt] Indica se a notificação foi gerada automaticamente pelo sistema.

notificao_cobranca_corpo

text

[pt] Corpo da mensagem da notificação enviada ao cliente.

notificao_cobranca_enviado_em

date

[pt] Data em que a notificação foi enviada ao cliente.

notificao_cobranca_envio_instantaneo

boolean

[pt] Indica se a notificação foi enviada imediatamente após criação.

notificao_cobranca_id

text

[pt] Identificador da notificação de cobrança enviada ao cliente.

notificao_cobranca_respondido_para

text

[pt] Endereço para o qual o cliente pode responder a notificação.

notificao_cobranca_solicitacao_cobranca_ids

text

[pt] Lista de identificadores das solicitações de cobrança notificadas.

notificao_cobranca_versao

float

[pt] Versão da notificação de cobrança.

recuperado

boolean

[pt] Indica se a solicitação foi recuperada após falha.

referencia_externa

text

[pt] Referência externa para controle ou rastreamento da solicitação.

status_solicitacao_cobranca

text

[pt] Status atual da solicitação de cobrança (ex: AGUARDANDO_CONFIRMACAO, CANCELADO, CONFIRMADO).

tipo_solicitacao_cobranca

text

[pt] Tipo da solicitação de cobrança (ex: BOLETO, PIX, CARTAO_CREDITO).

url

text

[pt] URL para visualização da fatura no ambiente da Conta Azul.

valor_composicao_desconto

float

[pt] Desconto aplicado à cobrança, se houver.

valor_composicao_juros

float

[pt] Valor dos juros aplicados à cobrança.

valor_composicao_multa

float

[pt] Valor da multa aplicada à solicitação de cobrança.

valor_composicao_taxa

float

[pt] Taxa financeira associada à cobrança.

valor_composicao_valor_bruto

float

[pt] Valor bruto original da cobrança antes de descontos e taxas.

valor_composicao_valor_liquido

float

[pt] Valor líquido a ser cobrado, após aplicação de multa, juros, descontos e taxas.

versao

float

[pt] Versão da solicitação, usada para controle de alterações.

contaazul_contas_a_receber_cobrancas_notif_cobranca_itens_notif_cobranca

Itens de notificação de cobrança do Conta Azul v2, detalhando as parcelas e valores incluídos em cada notificação de cobrança enviada.

Campo Tipo

contas_a_receber_id

text

[pt] Identificador único da conta a receber.

    Contas a receber > > id

cobranca_id

text

[pt] Identificador único da solicitação de cobrança.

notif_cobranca_itens_notif_cobranca_email

text

[pt] Endereço de e-mail usado na notificação de cobrança.

notif_cobranca_itens_notif_cobranca_id

text

[pt] Identificador do item de notificação enviado por canal (email, sms, etc).

notif_cobranca_itens_notif_cobranca_sms

text

[pt] Conteúdo da notificação enviada via SMS.

notif_cobranca_itens_notif_cobranca_status_entrega

text

[pt] Status da entrega da notificação (ex: ENVIADO, ERRO, ABERTO).

notif_cobranca_itens_notif_cobranca_versao

float

[pt] Versão do item de notificação individual.

notif_cobranca_itens_notif_cobranca_whatsapp

text

[pt] Conteúdo da notificação enviada via WhatsApp.

Contas financeiras

Tipo de replicacao: Integral

Dados de contas financeiras no ContaAzul v2

Campo Tipo

id

text

[pt] Identificador único da conta financeira.

agencia

text

[pt] Número da agência bancária vinculada à conta.

ativo

boolean

[pt] Indica se a conta financeira está ativa e disponível para lançamentos.

banco

text

[pt] Nome do banco ao qual a conta está vinculada.

codigo_banco

text

[pt] Código numérico do banco no sistema financeiro nacional (ex: 237 para BRADESCO).

conta_padrao

boolean

[pt] Indica se esta conta é marcada como padrão no sistema.

nome

text

[pt] Nome descritivo da conta financeira, definido pelo usuário.

numero

text

[pt] Número da conta bancária.

possui_config_boleto_bancario

boolean

[pt] Indica se a conta possui configuração para emissão de boletos bancários.

tipo

text

[pt] Tipo da conta, como CONTA_CORRENTE, POUPANCA ou APLICACAO.

Serviços

Tipo de replicacao: Integral

Serviços cadastrados no Conta Azul v2, incluindo descrições, preços e categorias de serviços oferecidos pela empresa.

Campo Tipo

id

text

[pt] Identificador único do serviço cadastrado no sistema.

codigo

text

[pt] Código interno utilizado para referência ao serviço. Pode ser nulo.

custo

float

[pt] Custo associado à execução do serviço. Pode ser nulo se não informado.

descricao

text

[pt] Descrição detalhada do serviço prestado.

id_servico

text

[pt] Identificador do serviço no sistema legado ou plataforma externa.

nome

text

[pt] Nome do serviço prestado. Pode ser nulo se não informado.

preco

float

[pt] Preço de venda do serviço. Pode ser nulo se ainda não definido.

status

text

[pt] Status atual do serviço no sistema (ex: ATIVO, INATIVO).

tipo_servico

text

[pt] Categoria ou tipo do serviço (ex: CONSULTORIA, MANUTENCAO). Pode ser nulo.

Vendas

Tipo de replicacao: Incremental com janela de atualizacao ou Integral (configuravel pelo usuario)

Parametros:

  • Janela de atualização (dias): Quantos dias anteriores ao Savepoint dados continuarão sendo atualizados
  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Dados de vendas no ContaAzul v2

Campo Tipo

id

text

[pt] Identificador único da venda.

cliente_email

text

[pt] Endereço de e-mail do cliente.

cliente_id

text

[pt] Identificador único do cliente vinculado à venda.

    Cadastro de pessoas > > uuid

cliente_nome

text

[pt] Nome do cliente que realizou a compra.

cliente_uuid_legado

text

[pt] Identificador do cliente em um sistema legado ou externo.

condicao_pagamento

boolean

[pt] Indica se há uma condição de pagamento associada à venda (ex: parcelado).

data

date

[pt] Data em que a venda foi registrada ou agendada.

id_legado

text

[pt] Identificador da venda em um sistema anterior ou externo.

itens

text

[pt] Tipo de item vendido, como SERVICE (serviço) ou PRODUCT (produto).

numero

text

[pt] Número sequencial ou identificador interno da venda.

total

float

[pt] Valor total da venda, incluindo impostos e descontos.

criado_em

timestamp

[pt] Data e hora em que a venda foi criada no Conta Azul.

data_alteracao

timestamp

[pt] Data e hora da última alteração da venda.

status_email_enviado_em

timestamp

[pt] Data e hora em que o e-mail da venda foi enviado.

status_email_status

text

[pt] Status do envio de e-mail relacionado à venda (ex: ENVIADO, ERRO).

tipo

text

[pt] Tipo da venda realizada, como SALE (venda imediata) ou SCHEDULED_SALE (venda agendada).

situacao_nome

text

[pt] Nome da situação atual da venda (por exemplo, FATURADO).

situacao_descricao

text

[pt] Descrição legível da situação da venda (por exemplo, Faturado).

versao

text

[pt] Versão do registro da venda, usada para controle de alterações.

Produtos

Tipo de replicacao: Integral

Objeto principal

Produtos cadastrados no Conta Azul v2, incluindo informações de estoque, preços, categorias e variações.

Campo Tipo

produto_id

text

[pt] Identificador único do produto.

id_legado

text

[pt] Identificador legado do produto.

nome

text

[pt] Nome do produto.

codigo

text

[pt] Código interno ou SKU do produto.

ean

text

[pt] Código de barras EAN do produto.

custo_medio

float

[pt] Custo médio do produto.

valor_venda

float

[pt] Valor de venda do produto.

saldo

float

[pt] Saldo disponível do produto.

estoque_minimo

float

[pt] Estoque mínimo definido para o produto.

estoque_maximo

float

[pt] Estoque máximo definido para o produto.

nivel_estoque

text

[pt] Nível de estoque do produto (ex: MINIMO, PADRAO, MAXIMO).

tipo

text

[pt] Tipo do produto.

status

text

[pt] Status do produto (ATIVO ou INATIVO).

integracao_ecommerce_ativada

boolean

[pt] Indica se o produto está integrado ao e-commerce.

movido

boolean

[pt] Indica se o produto foi movido/atualizado.

contagem_agregacao

float

[pt] Contagem de agregação do produto.

ultima_atualizacao

text

[pt] Data da última atualização do produto.

contaazul_produtos_variacoes

Variações de produtos do Conta Azul v2, como tamanhos, cores ou outras características que diferenciam itens de um mesmo produto.

Campo Tipo

produto_id

text

[pt] Identificador único do produto.

variacao_id

text

[pt] Identificador único da variação.

variacao_id_legado

text

[pt] Identificador legado da variação.

id_produto_pai_variacao

text

[pt] Identificador do produto pai desta variação.

variacao_nome

text

[pt] Nome da variação.

variacao_codigo

text

[pt] Código interno ou SKU da variação.

variacao_ean

text

[pt] Código de barras EAN da variação.

variacao_custo_medio

float

[pt] Custo médio da variação.

variacao_valor_venda

float

[pt] Valor de venda da variação.

variacao_saldo

float

[pt] Saldo em estoque da variação.

variacao_estoque_minimo

float

[pt] Estoque mínimo da variação.

variacao_estoque_maximo

float

[pt] Estoque máximo da variação.

variacao_nivel_estoque

text

[pt] Nível de estoque da variação.

variacao_tipo

text

[pt] Tipo da variação.

variacao_status

text

[pt] Status da variação.

variacao_integracao_ecommerce_ativada

boolean

[pt] Indica se a variação está integrada ao e-commerce.

variacao_movido

boolean

[pt] Indica se a variação foi movida/atualizada.

variacao_contagem_agregacao

float

[pt] Contagem de agregação da variação.

Categorias DRE

Objeto principal

Dados de categorias dre no ContaAzul v2

Campo Tipo

id

text

[pt] Identificador único do agrupador ou linha da estrutura DRE retornada pela API da Conta Azul.

codigo

text

[pt] Código estruturado da linha no demonstrativo (por exemplo, "01", "02.1", "05.2").

descricao

text

[pt] Descrição da linha ou agrupador no DRE (por exemplo, "Receitas Operacionais").

posicao

int

[pt] Ordem de apresentação da linha dentro do bloco do DRE.

parent_id

text

[pt] Identificador do pai imediato na hierarquia do DRE; nulo para linhas de topo.

    Categorias DRE > > id

indica_totalizador

boolean

[pt] Indica se a linha é um totalizador dentro do bloco do DRE.

representa_soma_custo_medio

boolean

[pt] Indica se a linha representa soma de custo médio na estrutura do DRE.

contaazul_categorias_dre_categorias_financeiras

Vínculo entre categorias DRE e categorias financeiras do Conta Azul v2, estabelecendo a relação entre linhas do demonstrativo e categorias de receita/despesa.

Campo Tipo

dre_categoria_id

text

[pt] Identificador da linha do DRE à qual a categoria financeira está associada.

    Categorias DRE > > id

categoria_financeira_id

text

[pt] Identificador da categoria financeira vinculada a esta linha do DRE.

    Categorias financeiras > > id

categoria_financeira_codigo

text

[pt] Código configurado na categoria financeira associada a esta linha do DRE.

categoria_financeira_nome

text

[pt] Nome da categoria financeira associada à linha do DRE.

categoria_financeira_ativa

boolean

[pt] Indica se a categoria financeira associada está ativa na Conta Azul.

Cadastro de Pessoas: Detalhes

Tipo de replicacao: Integral

Relacionamentos:

Objeto principal

Dados de cadastro de pessoas detalhes no ContaAzul v2

Campo Tipo

pessoa_id

text

[pt] Identificador único da pessoa no sistema (UUID).

ativo

boolean

[pt] Indica se o cadastro está ativo e disponível no sistema.

atrasos_pagamentos

int

[pt] Quantidade de pagamentos em atraso da pessoa.

atrasos_recebimentos

int

[pt] Quantidade de recebimentos em atraso da pessoa.

codigo

text

[pt] Código de identificação da pessoa definido pelo usuário.

criado_em

date

[pt] Data de criação do cadastro da pessoa.

data_alteracao

date

[pt] Data da última alteração do cadastro da pessoa.

data_nascimento

date

[pt] Data de nascimento da pessoa física.

documento

text

[pt] Número do CPF ou CNPJ da pessoa ou empresa.

email

text

[pt] Endereço de e-mail principal da pessoa ou empresa cadastrada.

lembretes_vencimento

int

[pt] Quantidade de dias de antecedência para lembretes de vencimento.

msg_pgtos_abertos_numero

int

[pt] Número de mensagens de pagamentos em aberto.

msg_pgtos_abertos_total

int

[pt] Total de mensagens de pagamentos em aberto.

nome

text

[pt] Nome da pessoa ou razão social da empresa.

nome_empresa

text

[pt] Nome fantasia da pessoa jurídica.

observacao

text

[pt] Observações gerais sobre a pessoa.

optante_simples_nacional

boolean

[pt] Indica se a pessoa jurídica é optante pelo Simples Nacional.

orgao_publico

boolean

[pt] Indica se a pessoa é um órgão público.

pagamentos_mes_atual

int

[pt] Quantidade de pagamentos realizados no mês atual.

recebimentos_mes_atual

int

[pt] Quantidade de recebimentos realizados no mês atual.

rg

text

[pt] Registro Geral (RG) da pessoa física.

telefone_celular

text

[pt] Número de telefone celular da pessoa.

telefone_comercial

text

[pt] Número de telefone comercial da pessoa.

tipo_pessoa

text

[pt] Tipo da pessoa cadastrada: Jurídica, Física ou Estrangeira.

contaazul_cadastro_de_pessoas_detalhes_enderecos

Endereços detalhados associados à pessoa, incluindo informações completas de localização.

Campo Tipo

pessoa_id

text

[pt] Identificador da pessoa proprietária do endereço (UUID).

    Cadastro de pessoas > > uuid

endereco_id

text

[pt] Identificador único do endereço (UUID).

bairro

text

[pt] Bairro ou distrito do endereço.

cep

text

[pt] Código de Endereçamento Postal (CEP) do endereço.

cidade

text

[pt] Nome da cidade do endereço.

complemento

text

[pt] Informações complementares ao endereço, como bloco ou sala.

estado

text

[pt] Sigla do estado (UF) do endereço.

id_cidade

text

[pt] Identificador da cidade associado ao endereço.

logradouro

text

[pt] Nome da rua, avenida ou via do endereço.

numero

text

[pt] Número do imóvel no endereço.

pais

text

[pt] Nome do país do endereço.

contaazul_cadastro_de_pessoas_detalhes_inscricoes

Inscrições estaduais, municipais e SUFRAMA associadas à pessoa.

Campo Tipo

pessoa_id

text

[pt] Identificador da pessoa proprietária da inscrição (UUID).

inscricao_id

text

[pt] Identificador único da inscrição (UUID).

indicador_inscricao_estadual

text

[pt] Indicador de inscrição estadual (Contribuinte, Isento, Não Contribuinte).

inscricao_estadual

text

[pt] Número da inscrição estadual.

inscricao_municipal

text

[pt] Número da inscrição municipal.

inscricao_suframa

text

[pt] Número da inscrição SUFRAMA (Superintendência da Zona Franca de Manaus).

contaazul_cadastro_de_pessoas_detalhes_outros_contatos

Outros contatos associados à pessoa, como contatos alternativos e informações adicionais de comunicação.

Campo Tipo

pessoa_id

text

[pt] Identificador da pessoa proprietária do contato (UUID).

contato_id

text

[pt] Identificador único do contato (UUID).

tipo

text

[pt] Tipo do contato (Email, Telefone, etc).

nome

text

[pt] Nome da pessoa do contato alternativo.

contato

text

[pt] Informação de contato (email, telefone, etc).

observacao

text

[pt] Observações sobre o contato.

contaazul_cadastro_de_pessoas_detalhes_perfis

Perfis da pessoa (Cliente, Fornecedor, etc).

Campo Tipo

pessoa_id

text

[pt] Identificador da pessoa proprietária do perfil (UUID).

tipo_perfil

text

[pt] Tipo de perfil da pessoa (Cliente, Fornecedor, Colaborador, etc).

contaazul_cadastro_de_pessoas_detalhes_legado

Informações de pessoas legadas (histórico de cadastros anteriores) associadas à pessoa atual.

Campo Tipo

pessoa_id

text

[pt] Identificador da pessoa atual proprietária do cadastro legado (UUID).

legado_uuid

text

[pt] Identificador único da pessoa legada (UUID).

legado_id

text

[pt] ID numérico da pessoa no sistema legado.

legado_perfil

text

[pt] Perfil da pessoa no sistema legado.

Contratos

Dados de contratos no ContaAzul v2

Campo Tipo

contrato_id

text

[pt] ID único do contrato (UUID).

contrato_numero

int

[pt] Número sequencial do contrato.

contrato_data_inicio

date

[pt] Data de início do contrato.

contrato_proximo_vencimento

date

[pt] Data do próximo vencimento do contrato (apenas para contratos ativos).

contrato_status

text

[pt] Status do contrato (ATIVO ou INATIVO).

cliente_id

text

[pt] ID único do cliente associado ao contrato (UUID).

    Cadastro de pessoas > > uuid

cliente_nome

text

[pt] Nome do cliente associado ao contrato.

Vendas - detalhes

Tipo de replicacao: Incremental com janela de atualizacao ou Integral (configuravel pelo usuario)

Parametros:

  • Janela de atualização (dias): Quantos dias anteriores ao Savepoint dados continuarão sendo atualizados
  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Objeto principal

Dados de vendas detalhes no ContaAzul v2

Campo Tipo

venda_id

text

[pt] Identificador único da venda (mesmo ID do pipeline principal de vendas).

    Vendas > > id

venda_id_legado

text

[pt] Identificador da venda em sistema legado ou externo.

venda_status

text

[pt] Status da venda no momento da consulta (por exemplo, VENDA).

venda_tipo_negociacao

text

[pt] Tipo de negociação da venda (ex.: VENDA, ORCAMENTO).

venda_numero

text

[pt] Número da venda no Conta Azul.

venda_id_categoria

text

[pt] Identificador da categoria financeira associada à venda.

venda_id_centro_custo

text

[pt] Identificador do centro de custo associado à venda.

venda_data_compromisso

date

[pt] Data de compromisso prevista para a venda.

venda_tipo_pendencia

text

[pt] Tipo de pendência associada à venda, quando aplicável.

venda_id_natureza_operacao

text

[pt] Identificador da natureza de operação vinculada à venda.

venda_valor_bruto

float

[pt] Valor bruto total da venda.

venda_valor_liquido

float

[pt] Valor líquido da venda após descontos e impostos.

venda_desconto

float

[pt] Valor de desconto aplicado à venda.

venda_impostos

float

[pt] Valor total de impostos incidentes sobre a venda.

venda_frete

float

[pt] Valor de frete associado à venda.

venda_total_itens_contagem_produtos

int

[pt] Quantidade de produtos na venda.

venda_total_itens_contagem_servicos

int

[pt] Quantidade de serviços na venda.

venda_total_itens_contagem_nao_conciliados

int

[pt] Quantidade de itens não conciliados na venda.

cliente_uuid

text

[pt] Identificador único do cliente vinculado à venda (mesmo UUID de cadastro_de_pessoas).

cliente_nome

text

[pt] Nome do cliente associado à venda de detalhes.

cliente_documento

text

[pt] Documento (CPF/CNPJ) do cliente da venda.

cliente_tipo_pessoa

text

[pt] Tipo de pessoa do cliente (Física ou Jurídica).

vendedor_id

text

[pt] Identificador do vendedor associado à venda.

vendedor_nome

text

[pt] Nome do vendedor responsável pela venda.

evento_financeiro_id

text

[pt] Identificador do evento financeiro gerado a partir da venda.

notificacao_status

text

[pt] Status da notificação associada à venda (ex.: ENVIADO, ERRO).

notificacao_aberto_em

timestamp

[pt] Data e hora em que a notificação foi aberta.

notificacao_enviado_em

timestamp

[pt] Data e hora em que a notificação foi enviada.

notificacao_id_referencia

text

[pt] Identificador de referência usado na notificação.

notificacao_enviado_para

text

[pt] Endereço (e-mail ou outro canal) para o qual a notificação foi enviada.

contaazul_vendas_detalhes_parcelas

Parcelas de pagamento de vendas do Conta Azul v2, contendo informações sobre vencimento, valor e descrição de cada parcela.

Campo Tipo

parcela_id

text

[pt] Identificador único da parcela de pagamento.

venda_id

text

[pt] Identificador da venda, usado como chave estrangeira para as parcelas.

parcela_numero

int

[pt] Número sequencial da parcela.

parcela_data_vencimento

date

[pt] Data de vencimento da parcela.

parcela_descricao

text

[pt] Descrição da parcela de pagamento, geralmente incluindo o número da venda e referências fiscais.

parcela_valor

float

[pt] Valor monetário da parcela.

Vendas - itens

Tipo de replicacao: Incremental com janela de atualizacao ou Integral (configuravel pelo usuario)

Parametros:

  • Janela de atualização (dias): Quantos dias anteriores ao Savepoint dados continuarão sendo atualizados
  • Data inicial de leitura (Savepoint): A partir de qual data os registros serão lidos

Relacionamentos:

Dados de vendas itens no ContaAzul v2

Campo Tipo

item_id

text

[pt] Identificador único da linha de item da venda.

venda_id

text

[pt] Identificador único da venda à qual o item pertence (ID do pipeline principal de vendas).

    Vendas > > id

id_item

text

[pt] Identificador do produto ou serviço configurado no Conta Azul.

tipo

text

[pt] Tipo do item, como SERVICO ou PRODUTO.

nome

text

[pt] Nome do produto ou serviço lançado na venda.

descricao

text

[pt] Descrição detalhada do item de venda.

quantidade

float

[pt] Quantidade do item na venda.

valor

float

[pt] Valor unitário do item na venda.

custo

float

[pt] Custo associado ao item (quando informado).

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

  • Parte desta documentacao foi gerada automaticamente por IA e pode conter erros. Recomendamos verificar informacoes críticas