> For the complete documentation index, see [llms.txt](https://changelog.maino.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://changelog.maino.com.br/api-reference-maino/05.-recebimentos.md). # 05. 💰 Recebimentos **Gestão completa de recebimentos** Controle de contas a receber, geração de boletos e análise de inadimplência. **Recursos disponíveis:** * Gestão de contas a receber * Geração automática de boletos * Conciliação bancária * Controle de inadimplência * Relatórios de aging ## Lista recebimentos > Retorna lista de recebimentos com filtros ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"05. 💰 Recebimentos","description":"**Gestão completa de recebimentos**\nControle de contas a receber, geração de boletos e análise de inadimplência.\n**Recursos disponíveis:**\n- Gestão de contas a receber\n- Geração automática de boletos\n- Conciliação bancária\n- Controle de inadimplência\n- Relatórios de aging"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_a_recebers":{"get":{"summary":"Lista recebimentos","tags":["05. 💰 Recebimentos"],"description":"Retorna lista de recebimentos com filtros","parameters":[{"name":"numero_da_nota_fiscal","in":"query","description":"Número da nota fiscal","required":false,"schema":{"type":"string"}},{"name":"cpf_cnpj_cliente","in":"query","description":"CPF/CNPJ do cliente","required":false,"schema":{"type":"string"}},{"name":"codigo_conta_corrente","in":"query","description":"Código da conta corrente","required":false,"schema":{"type":"string"}},{"name":"data_vencimento_inicio","in":"query","schema":{"type":"string","format":"date"},"description":"Data de vencimento início","required":false},{"name":"data_vencimento_fim","in":"query","schema":{"type":"string","format":"date"},"description":"Data de vencimento fim","required":false},{"name":"data_emissao_inicio","in":"query","schema":{"type":"string","format":"date"},"description":"Data de emissão início","required":false},{"name":"data_emissao_fim","in":"query","schema":{"type":"string","format":"date"},"description":"Data de emissão fim","required":false},{"name":"tags","in":"query","schema":{"type":"array","items":{"type":"string"}},"description":"Tags para filtrar","required":false},{"name":"status","in":"query","schema":{"type":"string","enum":["em_aberto","pago","vencido"]},"description":"Status da conta","required":false},{"name":"page","in":"query","schema":{"type":"integer","minimum":1},"description":"Número da página para paginação (padrão: 1)","required":false},{"name":"per_page","in":"query","schema":{"type":"integer","minimum":1,"maximum":100},"description":"Quantidade de itens por página (padrão: 20, máximo: 100)","required":false}],"responses":{"200":{"description":"Lista de recebimentos","content":{"application/json":{"schema":{"type":"object","properties":{"contas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID do recebimento"},"usuario":{"type":"string","description":"Email do usuário","nullable":true},"descricao":{"type":"string","description":"Descrição","nullable":true},"observacao":{"type":"string","description":"Observação","nullable":true},"numero_documento":{"type":"string","description":"Número do documento","nullable":true},"numero_titulo":{"type":"string","description":"Número do título","nullable":true},"numero_fatura":{"type":"string","description":"Número da fatura","nullable":true},"link_boleto":{"type":"string","description":"Link do boleto","nullable":true},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento","nullable":true},"data_prevista":{"type":"string","format":"date","description":"Data prevista"},"data_competencia":{"type":"string","format":"date","description":"Data de competência","nullable":true},"data_pagamento":{"type":"string","format":"date","description":"Data de pagamento","nullable":true},"data_credito":{"type":"string","format":"date","description":"Data de crédito","nullable":true},"valor":{"type":"string","description":"Valor","nullable":true},"valor_pago":{"type":"string","description":"Valor pago","nullable":true},"status_conciliacao":{"type":"string","description":"Status de conciliação","nullable":true},"juros":{"type":"string","description":"Juros","nullable":true},"valor_multa":{"type":"string","description":"Valor da multa","nullable":true},"desconto":{"type":"string","description":"Desconto","nullable":true},"valor_liquido":{"type":"string","description":"Valor líquido","nullable":true},"plano_de_conta_id":{"type":"integer","description":"ID do plano de conta","nullable":true},"conta_corrente_id":{"type":"integer","description":"ID da conta corrente","nullable":true},"centro_de_custo_id":{"type":"integer","description":"ID do centro de custo","nullable":true},"cliente_id":{"type":"integer","description":"ID do cliente","nullable":true},"documento_id":{"type":"integer","description":"ID do documento","nullable":true},"moeda_id":{"type":"integer","description":"ID da moeda","nullable":true},"taxa_cambio":{"type":"string","description":"Taxa de câmbio","nullable":true},"vendedor_pessoa_id":{"type":"integer","description":"ID do vendedor","nullable":true},"processo_id":{"type":"integer","description":"ID do processo","nullable":true},"plano_de_conta":{"type":"string","description":"Descrição do plano de conta","nullable":true},"codigo_plano_de_conta":{"type":"string","description":"Código do plano de conta","nullable":true},"cliente":{"type":"object","properties":{"numero_do_documento":{"type":"string","nullable":true},"razao_social":{"type":"string","nullable":true},"nome_fantasia":{"type":"string","nullable":true}}},"nota_fiscal":{"type":"object","properties":{"id":{"type":"integer","nullable":true},"numero_nfe":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"dthr_emissao":{"type":"string","nullable":true}}},"forma_pagamento":{"type":"object","properties":{"descricao":{"type":"string","nullable":true}},"nullable":true},"conta_corrente":{"type":"object","properties":{"codigo_conta_corrente":{"type":"string","nullable":true},"numero_banco":{"type":"string","nullable":true},"nome_banco":{"type":"string","nullable":true},"agencia":{"type":"string","nullable":true},"conta_corrente":{"type":"string","nullable":true}}},"centro_de_custo":{"type":"object","properties":{"id":{"type":"integer"},"descricao":{"type":"string"},"ativo":{"type":"boolean"}},"nullable":true},"processo":{"type":"object","properties":{"id":{"type":"integer"},"codigo":{"type":"string"},"descricao":{"type":"string"}},"nullable":true},"moeda":{"type":"object","properties":{"id":{"type":"integer"},"codigo_iso":{"type":"string"},"simbolo":{"type":"string"},"taxa_cambio":{"type":"string"}},"nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"nome":{"type":"string"}}}},"anexos":{"type":"array","nullable":true,"description":"Lista de anexos","items":{"type":"object","properties":{"id":{"type":"integer"},"nome":{"type":"string"},"url":{"type":"string","description":"URL para download do anexo"}}}}}}},"pagination":{"type":"object","properties":{"total":{"type":"integer"},"previous_page":{"type":"string","nullable":true},"next_page":{"type":"string","nullable":true}}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}} ``` ## Cria recebimento > \*\*Criar um novo recebimento\*\*\ > \ > Endpoint utilizado para criar um novo recebimento no sistema.\ > Permite registrar valores a receber de clientes com informações completas\ > de vencimento, forma de recebimento e relacionamentos com notas fiscais.\ > \ > \*\*Campos obrigatórios:\*\*\ > \- valor\_a\_receber: Valor total a receber\ > \- data\_prevista: Data prevista de recebimento\ > \- descricao: Descrição da conta\ > \ > \*\*Funcionalidades:\*\*\ > \- Associação com clientes\ > \- Vinculação com notas fiscais\ > \- Sistema de tags para categorização\ > \- Definição de plano de contas\ > \- Configuração de forma de recebimento ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"05. 💰 Recebimentos","description":"**Gestão completa de recebimentos**\nControle de contas a receber, geração de boletos e análise de inadimplência.\n**Recursos disponíveis:**\n- Gestão de contas a receber\n- Geração automática de boletos\n- Conciliação bancária\n- Controle de inadimplência\n- Relatórios de aging"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_a_recebers":{"post":{"summary":"Cria recebimento","tags":["05. 💰 Recebimentos"],"description":"**Criar um novo recebimento**\n\nEndpoint utilizado para criar um novo recebimento no sistema.\nPermite registrar valores a receber de clientes com informações completas\nde vencimento, forma de recebimento e relacionamentos com notas fiscais.\n\n**Campos obrigatórios:**\n- valor_a_receber: Valor total a receber\n- data_prevista: Data prevista de recebimento\n- descricao: Descrição da conta\n\n**Funcionalidades:**\n- Associação com clientes\n- Vinculação com notas fiscais\n- Sistema de tags para categorização\n- Definição de plano de contas\n- Configuração de forma de recebimento","parameters":[],"responses":{"200":{"description":"Recebimento criado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"usuario":{"type":"string","nullable":true},"descricao":{"type":"string","nullable":true},"valor":{"type":"string","nullable":true},"data_prevista":{"type":"string","format":"date"}}}}}},"400":{"description":"Dados inválidos","content":{"application/json":{"schema":{"type":"object","properties":{"mensagem":{"type":"string"},"errors":{"type":"object"}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valor_a_receber":{"type":"number","format":"float","description":"Valor a receber"},"valor":{"type":"number","format":"float","description":"Valor"},"data_prevista":{"type":"string","format":"date","description":"Data prevista de recebimento"},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento"},"data_competencia":{"type":"string","format":"date","description":"Data de competência"},"data_pagamento":{"type":"string","format":"date","description":"Data de pagamento (para registrar recebimento)"},"data_credito":{"type":"string","format":"date","description":"Data de crédito"},"valor_recebido":{"type":"number","format":"float","description":"Valor efetivamente recebido"},"valor_liquido":{"type":"number","format":"float","description":"Valor líquido após descontos/juros"},"desconto":{"type":"number","format":"float","description":"Valor de desconto aplicado"},"juros":{"type":"number","format":"float","description":"Valor de juros aplicado"},"valor_juros":{"type":"number","format":"float","description":"Valor de juros (alternativo)"},"valor_multa":{"type":"number","format":"float","description":"Valor da multa"},"multa":{"type":"number","format":"float","description":"Multa (alternativo)"},"percentual_multa":{"type":"number","format":"float","description":"Percentual de multa"},"percentual_juros":{"type":"number","format":"float","description":"Percentual de juros"},"descricao":{"type":"string","description":"Descrição da conta"},"observacao":{"type":"string","description":"Observação"},"numero_documento":{"type":"string","description":"Número do documento"},"numero_titulo":{"type":"string","description":"Número do título/documento"},"numero_fatura":{"type":"string","description":"Número da fatura"},"numero_da_nota_fiscal":{"type":"string","description":"Número da nota fiscal"},"cpf_cnpj_cliente":{"type":"string","description":"CPF/CNPJ do cliente (apenas números)"},"forma_de_pagamento":{"type":"string","description":"Forma de pagamento"},"codigo_conta_corrente":{"type":"string","description":"Código UUID da conta corrente"},"codigo_plano_de_conta":{"type":"string","description":"Código completo do plano de conta"},"instrucao_boleto":{"type":"string","description":"Instrução do boleto"},"taxa_cambio":{"type":"number","format":"float","description":"Taxa de câmbio"},"codigo_iso_moeda":{"type":"string","description":"Código ISO da moeda"},"documento_id":{"type":"integer","description":"ID do documento (nota fiscal)"},"conta_corrente_id":{"type":"integer","description":"ID da conta corrente"},"plano_de_conta_id":{"type":"integer","description":"ID do plano de conta"},"centro_de_custo_id":{"type":"integer","description":"ID do centro de custo"},"nota_fiscal_id":{"type":"integer","description":"ID da nota fiscal"},"moeda_id":{"type":"integer","description":"ID da moeda"},"processo_id":{"type":"integer","description":"ID do processo"},"stakeholder_id":{"type":"integer","description":"ID do stakeholder"},"cliente_id":{"type":"integer","description":"ID do cliente"},"vendedor_pessoa_id":{"type":"integer","description":"ID do vendedor"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags para categorização"}},"required":["valor_a_receber","data_prevista"]}}}}}}}} ``` ## Exibe recebimento > \*\*Visualizar detalhes de um recebimento específico\*\*\ > \ > Endpoint utilizado para consultar informações detalhadas de um recebimento\ > já existente no sistema. Retorna dados completos incluindo\ > informações do cliente, nota fiscal relacionada, forma de recebimento\ > e conta corrente associada.\ > \ > \*\*Informações retornadas:\*\*\ > \- Dados financeiros completos (valores, datas, pagamentos)\ > \- Informações do cliente associado\ > \- Detalhes da nota fiscal relacionada (se houver)\ > \- Forma de pagamento configurada\ > \- Dados da conta corrente\ > \- Tags de categorização\ > \- Anexos (se houver)\ > \- Informações de processo (se aplicável) ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"05. 💰 Recebimentos","description":"**Gestão completa de recebimentos**\nControle de contas a receber, geração de boletos e análise de inadimplência.\n**Recursos disponíveis:**\n- Gestão de contas a receber\n- Geração automática de boletos\n- Conciliação bancária\n- Controle de inadimplência\n- Relatórios de aging"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_a_recebers/{id}":{"get":{"summary":"Exibe recebimento","tags":["05. 💰 Recebimentos"],"description":"**Visualizar detalhes de um recebimento específico**\n\nEndpoint utilizado para consultar informações detalhadas de um recebimento\njá existente no sistema. Retorna dados completos incluindo\ninformações do cliente, nota fiscal relacionada, forma de recebimento\ne conta corrente associada.\n\n**Informações retornadas:**\n- Dados financeiros completos (valores, datas, pagamentos)\n- Informações do cliente associado\n- Detalhes da nota fiscal relacionada (se houver)\n- Forma de pagamento configurada\n- Dados da conta corrente\n- Tags de categorização\n- Anexos (se houver)\n- Informações de processo (se aplicável)","responses":{"200":{"description":"Recebimento encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"usuario":{"type":"string","nullable":true},"descricao":{"type":"string","nullable":true},"observacao":{"type":"string","nullable":true},"numero_documento":{"type":"string","nullable":true},"numero_titulo":{"type":"string","nullable":true},"numero_fatura":{"type":"string","nullable":true},"link_boleto":{"type":"string","nullable":true},"data_vencimento":{"type":"string","format":"date","nullable":true},"data_prevista":{"type":"string","format":"date"},"data_competencia":{"type":"string","format":"date","nullable":true},"data_pagamento":{"type":"string","format":"date","nullable":true},"data_credito":{"type":"string","format":"date","nullable":true},"valor":{"type":"string","nullable":true},"valor_pago":{"type":"string","nullable":true},"status_conciliacao":{"type":"string","nullable":true},"juros":{"type":"string","nullable":true},"valor_multa":{"type":"string","nullable":true},"desconto":{"type":"string","nullable":true},"valor_liquido":{"type":"string","nullable":true},"plano_de_conta_id":{"type":"integer","nullable":true},"conta_corrente_id":{"type":"integer","nullable":true},"centro_de_custo_id":{"type":"integer","nullable":true},"cliente_id":{"type":"integer","nullable":true},"documento_id":{"type":"integer","nullable":true},"moeda_id":{"type":"integer","nullable":true},"taxa_cambio":{"type":"string","nullable":true},"vendedor_pessoa_id":{"type":"integer","nullable":true},"processo_id":{"type":"integer","nullable":true},"plano_de_conta":{"type":"string","nullable":true},"codigo_plano_de_conta":{"type":"string","nullable":true},"cliente":{"type":"object","properties":{"numero_do_documento":{"type":"string","nullable":true},"razao_social":{"type":"string","nullable":true},"nome_fantasia":{"type":"string","nullable":true}}},"nota_fiscal":{"type":"object","properties":{"id":{"type":"integer","nullable":true},"numero_nfe":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"dthr_emissao":{"type":"string","nullable":true}}},"forma_pagamento":{"type":"object","properties":{"descricao":{"type":"string","nullable":true}},"nullable":true},"conta_corrente":{"type":"object","properties":{"codigo_conta_corrente":{"type":"string","nullable":true},"numero_banco":{"type":"string","nullable":true},"nome_banco":{"type":"string","nullable":true},"agencia":{"type":"string","nullable":true},"conta_corrente":{"type":"string","nullable":true}}},"centro_de_custo":{"type":"object","properties":{"id":{"type":"integer"},"descricao":{"type":"string"},"ativo":{"type":"boolean"}},"nullable":true},"processo":{"type":"object","properties":{"id":{"type":"integer"},"codigo":{"type":"string"},"descricao":{"type":"string"}},"nullable":true},"moeda":{"type":"object","properties":{"id":{"type":"integer"},"codigo_iso":{"type":"string"},"simbolo":{"type":"string"},"taxa_cambio":{"type":"string"}},"nullable":true},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"nome":{"type":"string"}}}},"anexos":{"type":"array","nullable":true,"description":"Lista de anexos","items":{"type":"object","properties":{"id":{"type":"integer"},"nome":{"type":"string"},"url":{"type":"string","description":"URL para download do anexo"}}}}}}}}},"400":{"description":"Recebimento não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}} ``` ## Atualiza recebimento > \*\*Atualizar um recebimento existente\*\*\ > \ > Endpoint utilizado para atualizar informações de um recebimento\ > já cadastrada no sistema. Permite modificar valores, datas, e registrar\ > liquidações parciais ou totais.\ > \ > \*\*Operações suportadas:\*\*\ > \- Atualização de valores e datas\ > \- Registro de liquidações (parciais/totais)\ > \- Modificação de descrições e códigos\ > \- Aplicação de descontos e juros\ > \- Atualização de dados de recebimento\ > \ > \*\*Controle de liquidações:\*\*\ > \- valor\_recebido: Valor efetivamente recebido\ > \- valor\_liquido: Valor após descontos/juros\ > \- data\_recebimento: Data do recebimento\ > \- desconto/juros: Valores de ajuste ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"05. 💰 Recebimentos","description":"**Gestão completa de recebimentos**\nControle de contas a receber, geração de boletos e análise de inadimplência.\n**Recursos disponíveis:**\n- Gestão de contas a receber\n- Geração automática de boletos\n- Conciliação bancária\n- Controle de inadimplência\n- Relatórios de aging"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_a_recebers/{id}":{"put":{"summary":"Atualiza recebimento","tags":["05. 💰 Recebimentos"],"description":"**Atualizar um recebimento existente**\n\nEndpoint utilizado para atualizar informações de um recebimento\njá cadastrada no sistema. Permite modificar valores, datas, e registrar\nliquidações parciais ou totais.\n\n**Operações suportadas:**\n- Atualização de valores e datas\n- Registro de liquidações (parciais/totais)\n- Modificação de descrições e códigos\n- Aplicação de descontos e juros\n- Atualização de dados de recebimento\n\n**Controle de liquidações:**\n- valor_recebido: Valor efetivamente recebido\n- valor_liquido: Valor após descontos/juros\n- data_recebimento: Data do recebimento\n- desconto/juros: Valores de ajuste","parameters":[],"responses":{"200":{"description":"Recebimento atualizado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer"},"usuario":{"type":"string","nullable":true},"descricao":{"type":"string","nullable":true}}}}}},"400":{"description":"Recebimento não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"valor_a_receber":{"type":"number","format":"float","description":"Valor a receber"},"valor":{"type":"number","format":"float","description":"Valor"},"data_prevista":{"type":"string","format":"date","description":"Data prevista de recebimento"},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento"},"data_competencia":{"type":"string","format":"date","description":"Data de competência"},"data_pagamento":{"type":"string","format":"date","description":"Data de pagamento (para registrar recebimento)"},"data_credito":{"type":"string","format":"date","description":"Data de crédito"},"valor_recebido":{"type":"number","format":"float","description":"Valor efetivamente recebido"},"valor_liquido":{"type":"number","format":"float","description":"Valor líquido após descontos/juros"},"desconto":{"type":"number","format":"float","description":"Valor de desconto aplicado"},"juros":{"type":"number","format":"float","description":"Valor de juros aplicado"},"valor_juros":{"type":"number","format":"float","description":"Valor de juros (alternativo)"},"valor_multa":{"type":"number","format":"float","description":"Valor da multa"},"multa":{"type":"number","format":"float","description":"Multa (alternativo)"},"percentual_multa":{"type":"number","format":"float","description":"Percentual de multa"},"percentual_juros":{"type":"number","format":"float","description":"Percentual de juros"},"descricao":{"type":"string","description":"Descrição da conta"},"observacao":{"type":"string","description":"Observação"},"numero_documento":{"type":"string","description":"Número do documento"},"numero_titulo":{"type":"string","description":"Número do título"},"numero_fatura":{"type":"string","description":"Número da fatura"},"numero_da_nota_fiscal":{"type":"string","description":"Número da nota fiscal"},"cpf_cnpj_cliente":{"type":"string","description":"CPF/CNPJ do cliente"},"forma_de_pagamento":{"type":"string","description":"Forma de pagamento"},"codigo_conta_corrente":{"type":"string","description":"Código UUID da conta corrente"},"codigo_plano_de_conta":{"type":"string","description":"Código completo do plano de conta"},"instrucao_boleto":{"type":"string","description":"Instrução do boleto"},"taxa_cambio":{"type":"number","format":"float","description":"Taxa de câmbio"},"codigo_iso_moeda":{"type":"string","description":"Código ISO da moeda"},"documento_id":{"type":"integer","description":"ID do documento"},"conta_corrente_id":{"type":"integer","description":"ID da conta corrente"},"plano_de_conta_id":{"type":"integer","description":"ID do plano de conta"},"centro_de_custo_id":{"type":"integer","description":"ID do centro de custo"},"nota_fiscal_id":{"type":"integer","description":"ID da nota fiscal"},"moeda_id":{"type":"integer","description":"ID da moeda"},"processo_id":{"type":"integer","description":"ID do processo"},"stakeholder_id":{"type":"integer","description":"ID do stakeholder"},"cliente_id":{"type":"integer","description":"ID do cliente"},"vendedor_pessoa_id":{"type":"integer","description":"ID do vendedor"},"tags":{"type":"array","items":{"type":"string"},"description":"Tags para categorização"}}}}}}}}}} ``` ## Excluir recebimento > \*\*Excluir um recebimento existente\*\*\ > \ > Endpoint utilizado para excluir um recebimento já cadastrado\ > no sistema. O registro é marcado como excluído e pode ser restaurado\ > posteriormente se necessário.\ > \ > \*\*Importante:\*\*\ > \- Soft delete: o registro é marcado como excluído, não removido permanentemente\ > \- Possível restaurar o registro posteriormente\ > \- Mantém histórico de auditoria\ > \- Não afeta históricos já processados\ > \ > \*\*Casos de uso:\*\*\ > \- Cancelamento de vendas não efetivadas\ > \- Correção de lançamentos incorretos\ > \- Estorno de operações comerciais\ > \- Ajustes contábeis necessários ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"05. 💰 Recebimentos","description":"**Gestão completa de recebimentos**\nControle de contas a receber, geração de boletos e análise de inadimplência.\n**Recursos disponíveis:**\n- Gestão de contas a receber\n- Geração automática de boletos\n- Conciliação bancária\n- Controle de inadimplência\n- Relatórios de aging"}],"servers":[{"url":"https://api.maino.com.br/api/v2","description":"Servidor de Produção"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"**Token JWT de Autenticação**\nToken obtido através do endpoint `/authentication`.\n**Formato:** `Bearer {seu_token_jwt}`\n**Exemplo:** `Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`\n**Validade:** Sem expiração"}}},"paths":{"/contas_a_recebers/{id}":{"delete":{"summary":"Excluir recebimento","tags":["05. 💰 Recebimentos"],"description":"**Excluir um recebimento existente**\n\nEndpoint utilizado para excluir um recebimento já cadastrado\nno sistema. O registro é marcado como excluído e pode ser restaurado\nposteriormente se necessário.\n\n**Importante:**\n- Soft delete: o registro é marcado como excluído, não removido permanentemente\n- Possível restaurar o registro posteriormente\n- Mantém histórico de auditoria\n- Não afeta históricos já processados\n\n**Casos de uso:**\n- Cancelamento de vendas não efetivadas\n- Correção de lançamentos incorretos\n- Estorno de operações comerciais\n- Ajustes contábeis necessários","responses":{"200":{"description":"Recebimento excluído"},"400":{"description":"Recebimento não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://changelog.maino.com.br/api-reference-maino/05.-recebimentos.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.