06. 💰 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

get

Retorna lista de recebimentos com filtros

Autorizações

Bearer

AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de consulta

numero_da_nota_fiscalstringOpcional

Número da nota fiscal

cpf_cnpj_clientestringOpcional

CPF/CNPJ do cliente

codigo_conta_correntestringOpcional

Código da conta corrente

data_vencimento_iniciostring · dateOpcional

Data de vencimento início

data_vencimento_fimstring · dateOpcional

Data de vencimento fim

data_emissao_iniciostring · dateOpcional

Data de emissão início

data_emissao_fimstring · dateOpcional

Data de emissão fim

tagsstring[]Opcional

Tags para filtrar

statusstring · enumOpcional

Status da conta

Valores possíveis:

pageinteger · mín: 1Opcional

Número da página para paginação (padrão: 1)

per_pageinteger · mín: 1 · máx: 100Opcional

Quantidade de itens por página (padrão: 20, máximo: 100)

Example: 20

Respostas

200

Lista de recebimentos

application/json

401

Não autorizado

application/json

get

/contas_a_recebers

HTTPcURLJavaScriptPython

GET /api/v2/contas_a_recebers HTTP/1.1
Host: api.maino.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "contas": [
    {
      "id": 1,
      "usuario": "text",
      "descricao": "text",
      "observacao": "text",
      "numero_documento": "text",
      "numero_titulo": "text",
      "numero_fatura": "text",
      "link_boleto": "text",
      "data_vencimento": "2026-03-05",
      "data_prevista": "2026-03-05",
      "data_competencia": "2026-03-05",
      "data_pagamento": "2026-03-05",
      "data_credito": "2026-03-05",
      "valor": "text",
      "valor_pago": "text",
      "status_conciliacao": "text",
      "juros": "text",
      "valor_multa": "text",
      "desconto": "text",
      "valor_liquido": "text",
      "plano_de_conta_id": 1,
      "conta_corrente_id": 1,
      "centro_de_custo_id": 1,
      "cliente_id": 1,
      "documento_id": 1,
      "moeda_id": 1,
      "taxa_cambio": "text",
      "vendedor_pessoa_id": 1,
      "processo_id": 1,
      "plano_de_conta": "text",
      "codigo_plano_de_conta": "text",
      "cliente": {
        "numero_do_documento": "text",
        "razao_social": "text",
        "nome_fantasia": "text"
      },
      "nota_fiscal": {
        "id": 1,
        "numero_nfe": "text",
        "status": "text",
        "dthr_emissao": "text"
      },
      "forma_pagamento": {
        "descricao": "text"
      },
      "conta_corrente": {
        "codigo_conta_corrente": "text",
        "numero_banco": "text",
        "nome_banco": "text",
        "agencia": "text",
        "conta_corrente": "text"
      },
      "centro_de_custo": {
        "id": 1,
        "descricao": "text",
        "ativo": true
      },
      "processo": {
        "id": 1,
        "codigo": "text",
        "descricao": "text"
      },
      "moeda": {
        "id": 1,
        "codigo_iso": "text",
        "simbolo": "text",
        "taxa_cambio": "text"
      },
      "tags": [
        {
          "id": 1,
          "nome": "text"
        }
      ],
      "anexos": [
        {
          "id": 1,
          "nome": "text",
          "url": "/uploads/anexos/comprovante.pdf"
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "previous_page": "text",
    "next_page": "text"
  }
}

Cria recebimento

post

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

Autorizações

Bearer

AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Corpo

application/json

valor_a_recebernumber · floatObrigatório

Valor a receber

Example: 1000

valornumber · floatOpcional

Valor

Example: 1000

data_previstastring · dateObrigatório

Data prevista de recebimento

Example: 2023-01-31

data_vencimentostring · dateOpcional

Data de vencimento

Example: 2023-01-31

data_competenciastring · dateOpcional

Data de competência

Example: 2023-01-01

data_pagamentostring · dateOpcional

Data de pagamento (para registrar recebimento)

Example: 2023-01-31

data_creditostring · dateOpcional

Data de crédito

Example: 2023-02-01

valor_recebidonumber · floatOpcional

Valor efetivamente recebido

Example: 1000

valor_liquidonumber · floatOpcional

Valor líquido após descontos/juros

Example: 950

descontonumber · floatOpcional

Valor de desconto aplicado

Example: 50

jurosnumber · floatOpcional

Valor de juros aplicado

Example: 0

valor_jurosnumber · floatOpcional

Valor de juros (alternativo)

Example: 0

valor_multanumber · floatOpcional

Valor da multa

Example: 0

multanumber · floatOpcional

Multa (alternativo)

Example: 0

percentual_multanumber · floatOpcional

Percentual de multa

Example: 2

percentual_jurosnumber · floatOpcional

Percentual de juros

Example: 1

descricaostringOpcional

Descrição da conta

Example: Venda de produtos

observacaostringOpcional

Observação

Example: Observação adicional

numero_documentostringOpcional

Número do documento

Example: DOC-001

numero_titulostringOpcional

Número do título/documento

Example: 001/2023

numero_faturastringOpcional

Número da fatura

Example: FAT-001

numero_da_nota_fiscalstringOpcional

Número da nota fiscal

Example: 123

cpf_cnpj_clientestringOpcional

CPF/CNPJ do cliente (apenas números)

Example: 12345678000190

forma_de_pagamentostringOpcional

Forma de pagamento

Example: boleto

codigo_conta_correntestringOpcional

Código UUID da conta corrente

Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

codigo_plano_de_contastringOpcional

Código completo do plano de conta

Example: 1.1.01

instrucao_boletostringOpcional

Instrução do boleto

Example: Não receber após o vencimento

taxa_cambionumber · floatOpcional

Taxa de câmbio

Example: 5.25

codigo_iso_moedastringOpcional

Código ISO da moeda

Example: USD

documento_idintegerOpcional

ID do documento (nota fiscal)

Example: 1

conta_corrente_idintegerOpcional

ID da conta corrente

Example: 1

plano_de_conta_idintegerOpcional

ID do plano de conta

Example: 1

centro_de_custo_idintegerOpcional

ID do centro de custo

Example: 1

nota_fiscal_idintegerOpcional

ID da nota fiscal

Example: 1

moeda_idintegerOpcional

ID da moeda

Example: 1

processo_idintegerOpcional

ID do processo

Example: 1

stakeholder_idintegerOpcional

ID do stakeholder

Example: 1

cliente_idintegerOpcional

ID do cliente

Example: 1

vendedor_pessoa_idintegerOpcional

ID do vendedor

Example: 1

tagsstring[]Opcional

Tags para categorização

Example: ["vendas","produto_a"]

Respostas

200

Recebimento criado com sucesso

application/json

idintegerOpcional

usuariostring · nuloOpcional

descricaostring · nuloOpcional

valorstring · nuloOpcional

data_previstastring · dateOpcional

400

Dados inválidos

application/json

401

Não autorizado

application/json

post

/contas_a_recebers

HTTPcURLJavaScriptPython

POST /api/v2/contas_a_recebers HTTP/1.1
Host: api.maino.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 997

{
  "valor_a_receber": 1000,
  "valor": 1000,
  "data_prevista": "2023-01-31",
  "data_vencimento": "2023-01-31",
  "data_competencia": "2023-01-01",
  "data_pagamento": "2023-01-31",
  "data_credito": "2023-02-01",
  "valor_recebido": 1000,
  "valor_liquido": 950,
  "desconto": 50,
  "juros": 0,
  "valor_juros": 0,
  "valor_multa": 0,
  "multa": 0,
  "percentual_multa": 2,
  "percentual_juros": 1,
  "descricao": "Venda de produtos",
  "observacao": "Observação adicional",
  "numero_documento": "DOC-001",
  "numero_titulo": "001/2023",
  "numero_fatura": "FAT-001",
  "numero_da_nota_fiscal": "123",
  "cpf_cnpj_cliente": "12345678000190",
  "forma_de_pagamento": "boleto",
  "codigo_conta_corrente": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "codigo_plano_de_conta": "1.1.01",
  "instrucao_boleto": "Não receber após o vencimento",
  "taxa_cambio": 5.25,
  "codigo_iso_moeda": "USD",
  "documento_id": 1,
  "conta_corrente_id": 1,
  "plano_de_conta_id": 1,
  "centro_de_custo_id": 1,
  "nota_fiscal_id": 1,
  "moeda_id": 1,
  "processo_id": 1,
  "stakeholder_id": 1,
  "cliente_id": 1,
  "vendedor_pessoa_id": 1,
  "tags": [
    "vendas",
    "produto_a"
  ]
}

{
  "id": 1,
  "usuario": "text",
  "descricao": "text",
  "valor": "text",
  "data_prevista": "2026-03-05"
}

Exibe recebimento

get

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)

Autorizações

Bearer

AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de rota

idintegerObrigatório

ID do recebimento

Respostas

200

Recebimento encontrado

application/json

idintegerOpcional

usuariostring · nuloOpcional

descricaostring · nuloOpcional

observacaostring · nuloOpcional

numero_documentostring · nuloOpcional

numero_titulostring · nuloOpcional

numero_faturastring · nuloOpcional

link_boletostring · nuloOpcional

data_vencimentostring · date · nuloOpcional

data_previstastring · dateOpcional

data_competenciastring · date · nuloOpcional

data_pagamentostring · date · nuloOpcional

data_creditostring · date · nuloOpcional

valorstring · nuloOpcional

valor_pagostring · nuloOpcional

status_conciliacaostring · nuloOpcional

jurosstring · nuloOpcional

valor_multastring · nuloOpcional

descontostring · nuloOpcional

valor_liquidostring · nuloOpcional

plano_de_conta_idinteger · nuloOpcional

conta_corrente_idinteger · nuloOpcional

centro_de_custo_idinteger · nuloOpcional

cliente_idinteger · nuloOpcional

documento_idinteger · nuloOpcional

moeda_idinteger · nuloOpcional

taxa_cambiostring · nuloOpcional

vendedor_pessoa_idinteger · nuloOpcional

processo_idinteger · nuloOpcional

plano_de_contastring · nuloOpcional

codigo_plano_de_contastring · nuloOpcional

400

Recebimento não encontrado

application/json

401

Não autorizado

application/json

get

/contas_a_recebers/{id}

HTTPcURLJavaScriptPython

GET /api/v2/contas_a_recebers/{id} HTTP/1.1
Host: api.maino.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "usuario": "text",
  "descricao": "text",
  "observacao": "text",
  "numero_documento": "text",
  "numero_titulo": "text",
  "numero_fatura": "text",
  "link_boleto": "text",
  "data_vencimento": "2026-03-05",
  "data_prevista": "2026-03-05",
  "data_competencia": "2026-03-05",
  "data_pagamento": "2026-03-05",
  "data_credito": "2026-03-05",
  "valor": "text",
  "valor_pago": "text",
  "status_conciliacao": "text",
  "juros": "text",
  "valor_multa": "text",
  "desconto": "text",
  "valor_liquido": "text",
  "plano_de_conta_id": 1,
  "conta_corrente_id": 1,
  "centro_de_custo_id": 1,
  "cliente_id": 1,
  "documento_id": 1,
  "moeda_id": 1,
  "taxa_cambio": "text",
  "vendedor_pessoa_id": 1,
  "processo_id": 1,
  "plano_de_conta": "text",
  "codigo_plano_de_conta": "text",
  "cliente": {
    "numero_do_documento": "text",
    "razao_social": "text",
    "nome_fantasia": "text"
  },
  "nota_fiscal": {
    "id": 1,
    "numero_nfe": "text",
    "status": "text",
    "dthr_emissao": "text"
  },
  "forma_pagamento": {
    "descricao": "text"
  },
  "conta_corrente": {
    "codigo_conta_corrente": "text",
    "numero_banco": "text",
    "nome_banco": "text",
    "agencia": "text",
    "conta_corrente": "text"
  },
  "centro_de_custo": {
    "id": 1,
    "descricao": "text",
    "ativo": true
  },
  "processo": {
    "id": 1,
    "codigo": "text",
    "descricao": "text"
  },
  "moeda": {
    "id": 1,
    "codigo_iso": "text",
    "simbolo": "text",
    "taxa_cambio": "text"
  },
  "tags": [
    {
      "id": 1,
      "nome": "text"
    }
  ],
  "anexos": [
    {
      "id": 1,
      "nome": "text",
      "url": "/uploads/anexos/comprovante.pdf"
    }
  ]
}

Atualiza recebimento

put

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

Autorizações

Bearer

AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de rota

idintegerObrigatório

ID do recebimento

Corpo

application/json

valor_a_recebernumber · floatOpcional

Valor a receber

valornumber · floatOpcional

Valor

data_previstastring · dateOpcional

Data prevista de recebimento

data_vencimentostring · dateOpcional

Data de vencimento

data_competenciastring · dateOpcional

Data de competência

data_pagamentostring · dateOpcional

Data de pagamento (para registrar recebimento)

data_creditostring · dateOpcional

Data de crédito

valor_recebidonumber · floatOpcional

Valor efetivamente recebido

valor_liquidonumber · floatOpcional

Valor líquido após descontos/juros

descontonumber · floatOpcional

Valor de desconto aplicado

jurosnumber · floatOpcional

Valor de juros aplicado

valor_jurosnumber · floatOpcional

Valor de juros (alternativo)

valor_multanumber · floatOpcional

Valor da multa

multanumber · floatOpcional

Multa (alternativo)

percentual_multanumber · floatOpcional

Percentual de multa

percentual_jurosnumber · floatOpcional

Percentual de juros

descricaostringOpcional

Descrição da conta

observacaostringOpcional

Observação

numero_documentostringOpcional

Número do documento

numero_titulostringOpcional

Número do título

numero_faturastringOpcional

Número da fatura

numero_da_nota_fiscalstringOpcional

Número da nota fiscal

cpf_cnpj_clientestringOpcional

CPF/CNPJ do cliente

forma_de_pagamentostringOpcional

Forma de pagamento

codigo_conta_correntestringOpcional

Código UUID da conta corrente

codigo_plano_de_contastringOpcional

Código completo do plano de conta

instrucao_boletostringOpcional

Instrução do boleto

taxa_cambionumber · floatOpcional

Taxa de câmbio

codigo_iso_moedastringOpcional

Código ISO da moeda

documento_idintegerOpcional

ID do documento

conta_corrente_idintegerOpcional

ID da conta corrente

plano_de_conta_idintegerOpcional

ID do plano de conta

centro_de_custo_idintegerOpcional

ID do centro de custo

nota_fiscal_idintegerOpcional

ID da nota fiscal

moeda_idintegerOpcional

ID da moeda

processo_idintegerOpcional

ID do processo

stakeholder_idintegerOpcional

ID do stakeholder

cliente_idintegerOpcional

ID do cliente

vendedor_pessoa_idintegerOpcional

ID do vendedor

tagsstring[]Opcional

Tags para categorização

Respostas

200

Recebimento atualizado

application/json

idintegerOpcional

usuariostring · nuloOpcional

descricaostring · nuloOpcional

400

Recebimento não encontrado

application/json

401

Não autorizado

application/json

put

/contas_a_recebers/{id}

HTTPcURLJavaScriptPython

PUT /api/v2/contas_a_recebers/{id} HTTP/1.1
Host: api.maino.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 856

{
  "valor_a_receber": 1,
  "valor": 1,
  "data_prevista": "2026-03-05",
  "data_vencimento": "2026-03-05",
  "data_competencia": "2026-03-05",
  "data_pagamento": "2026-03-05",
  "data_credito": "2026-03-05",
  "valor_recebido": 1,
  "valor_liquido": 1,
  "desconto": 1,
  "juros": 1,
  "valor_juros": 1,
  "valor_multa": 1,
  "multa": 1,
  "percentual_multa": 1,
  "percentual_juros": 1,
  "descricao": "text",
  "observacao": "text",
  "numero_documento": "text",
  "numero_titulo": "text",
  "numero_fatura": "text",
  "numero_da_nota_fiscal": "text",
  "cpf_cnpj_cliente": "text",
  "forma_de_pagamento": "text",
  "codigo_conta_corrente": "text",
  "codigo_plano_de_conta": "text",
  "instrucao_boleto": "text",
  "taxa_cambio": 1,
  "codigo_iso_moeda": "text",
  "documento_id": 1,
  "conta_corrente_id": 1,
  "plano_de_conta_id": 1,
  "centro_de_custo_id": 1,
  "nota_fiscal_id": 1,
  "moeda_id": 1,
  "processo_id": 1,
  "stakeholder_id": 1,
  "cliente_id": 1,
  "vendedor_pessoa_id": 1,
  "tags": [
    "text"
  ]
}

{
  "id": 1,
  "usuario": "text",
  "descricao": "text"
}

Excluir recebimento

delete

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

Autorizações

Bearer

AuthorizationstringObrigatório

Token JWT de Autenticação Token obtido através do endpoint /authentication. Formato: Bearer {seu_token_jwt} Exemplo: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... Validade: Sem expiração

Parâmetros de rota

idintegerObrigatório

ID do recebimento

Respostas

200

Recebimento excluído

Sem conteúdo

400

Recebimento não encontrado

application/json

401

Não autorizado

application/json

delete

/contas_a_recebers/{id}

HTTPcURLJavaScriptPython

DELETE /api/v2/contas_a_recebers/{id} HTTP/1.1
Host: api.maino.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo