
Tools do Conta Azul
As 13 operações do Conta Azul que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar pessoasGETLista as pessoas da empresa, que são seus clientes, fornecedores e transportadoras, com filtro opcional por texto, perfil ou tipo. A resposta traz items e totalItems; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Obter pessoaGETRetorna uma pessoa, com tipo, documento, email, telefones, endereços, perfis e os valores em atraso a pagar e a receber.
- Criar pessoaPOSTCria uma pessoa, que é cliente, fornecedor ou transportadora conforme perfis. nome e tipo_pessoa são obrigatórios; envie cpf para pessoa física e cnpj para empresa. A resposta traz o id da pessoa.
- Atualizar pessoaPATCHAtualiza parte de uma pessoa: só os campos enviados mudam. Para alterar um endereço existente, envie o id dele obtido em Obter pessoa.
- Listar contas a receberGETLista as parcelas a receber (contas a receber) com vencimento em um período, com cliente, categorias, valores pagos e em aberto e status, além dos totais do período em totais. A resposta traz itens e itens_totais; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Listar contas a pagarGETLista as parcelas a pagar (contas a pagar) com vencimento em um período, com fornecedor, categorias, valores pagos e em aberto e status, além dos totais do período em totais. A resposta traz itens e itens_totais; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Obter parcelaGETRetorna uma parcela de uma conta a receber ou a pagar, com vencimento, composição do valor, pagamentos (baixas), cobranças e versao, que Atualizar parcela exige.
- Atualizar parcelaPATCHAtualiza parte de uma parcela de conta a receber ou a pagar, como o vencimento, o valor ou a forma de pagamento. Envie a versao retornada por Obter parcela: a atualização é recusada se ela faltar ou estiver desatualizada.
- Criar conta a receberPOSTCria uma conta a receber para um cliente: valor é dividido entre categorias em rateio e entre vencimentos em condicao_pagamento.parcelas. A resposta traz o id do evento financeiro, e suas parcelas aparecem em Listar contas a receber.
- Criar conta a pagarPOSTCria uma conta a pagar a um fornecedor: valor é dividido entre categorias em rateio e entre vencimentos em condicao_pagamento.parcelas. A resposta traz o id do evento financeiro, e suas parcelas aparecem em Listar contas a pagar.
- Listar vendasGETLista as vendas emitidas em um período, com número, cliente, total e situação, além de totais e quantidades das vendas aprovadas, canceladas e aguardando. A resposta traz itens e total_itens; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Listar categoriasGETLista as categorias financeiras, com id, nome e tipo (RECEITA ou DESPESA). O id vai em rateio.id_categoria de Criar conta a receber e Criar conta a pagar. Pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Listar contas financeirasGETLista as contas financeiras da empresa, como contas bancárias, caixa e cartões de crédito, com id, nome, banco e se é a conta padrão. O id vai em conta_financeira de Criar conta a receber e Criar conta a pagar. Pagine com pagina, e uma página menor que tamanho_pagina é a última.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
