> 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/06.-pagamentos.md). # 06. 💸 Pagamentos **Gestão completa de pagamentos** Controle de contas a pagar, fornecedores e fluxo de caixa. **Funcionalidades:** * Cadastro de contas a pagar * Controle de centro de custos * Registro de liquidações * Controle de fluxo de caixa ## Lista pagamentos > \*\*Lista contas a pagar\*\*\ > \ > Retorna as contas a pagar do usuário autenticado, em ordem decrescente de ID,\ > com paginação fixa de 50 registros por página.\ > \ > \*\*Filtros disponíveis:\*\*\ > \- \`descricao\`: busca parcial (ILIKE) na descrição da conta\ > \- \`data\_vencimento\_ini\`: filtra contas com data de vencimento >= data informada (formato: YYYY-MM-DD)\ > \- \`data\_vencimento\_fim\`: filtra contas com data de vencimento <= data informada (formato: YYYY-MM-DD)\ > \- \`status\`: filtra pelo status financeiro da conta. Valores aceitos:\ > \- \`vencidas\` — data de vencimento no passado e sem data de pagamento\ > \- \`vencimento\_iminente\` — vence nos próximos dias e ainda não foi paga\ > \- \`pagas\` — possui data de pagamento registrada\ > \- \`nao\_pagas\` — sem data de pagamento (independente do vencimento)\ > \- \`nao\_vencidas\` — vencimento futuro e sem data de pagamento\ > \- \`fornecedor\_id\`: ID do stakeholder/fornecedor associado à conta\ > \- \`page\`: número da página (padrão: 1; 50 registros por página fixo) ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"06. 💸 Pagamentos","description":"**Gestão completa de pagamentos**\nControle de contas a pagar, fornecedores e fluxo de caixa.\n**Funcionalidades:**\n- Cadastro de contas a pagar\n- Controle de centro de custos\n- Registro de liquidações\n- Controle de fluxo de caixa"}],"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_pagars":{"get":{"summary":"Lista pagamentos","tags":["06. 💸 Pagamentos"],"description":"**Lista contas a pagar**\n\nRetorna as contas a pagar do usuário autenticado, em ordem decrescente de ID,\ncom paginação fixa de 50 registros por página.\n\n**Filtros disponíveis:**\n- `descricao`: busca parcial (ILIKE) na descrição da conta\n- `data_vencimento_ini`: filtra contas com data de vencimento >= data informada (formato: YYYY-MM-DD)\n- `data_vencimento_fim`: filtra contas com data de vencimento <= data informada (formato: YYYY-MM-DD)\n- `status`: filtra pelo status financeiro da conta. Valores aceitos:\n - `vencidas` — data de vencimento no passado e sem data de pagamento\n - `vencimento_iminente` — vence nos próximos dias e ainda não foi paga\n - `pagas` — possui data de pagamento registrada\n - `nao_pagas` — sem data de pagamento (independente do vencimento)\n - `nao_vencidas` — vencimento futuro e sem data de pagamento\n- `fornecedor_id`: ID do stakeholder/fornecedor associado à conta\n- `page`: número da página (padrão: 1; 50 registros por página fixo)","parameters":[{"name":"descricao","in":"query","description":"Busca parcial na descrição da conta (case-insensitive)","required":false,"schema":{"type":"string"}},{"name":"data_vencimento_ini","in":"query","schema":{"type":"string","format":"date"},"description":"Data de vencimento inicial (>=)","required":false},{"name":"data_vencimento_fim","in":"query","schema":{"type":"string","format":"date"},"description":"Data de vencimento final (<=)","required":false},{"name":"status","in":"query","schema":{"type":"string","enum":["vencidas","vencimento_iminente","pagas","nao_pagas","nao_vencidas"]},"description":"Status financeiro da conta","required":false},{"name":"fornecedor_id","in":"query","description":"ID do stakeholder/fornecedor","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"Número da página (padrão: 1; 50 registros por página)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Lista de contas a pagar","content":{"application/json":{"schema":{"type":"object","properties":{"contas":{"type":"array","description":"Lista das contas a pagar","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID da conta a pagar"},"observacao":{"type":"string","description":"Observação da conta","nullable":true},"numero_documento":{"type":"string","description":"Número do documento","nullable":true},"numero_documento_fiscal":{"type":"string","description":"Número do documento fiscal","nullable":true},"usuario":{"type":"string","description":"Email do usuário","nullable":true},"descricao":{"type":"string","description":"Descrição da conta"},"valor":{"type":"string","description":"Valor da conta"},"valor_multa":{"type":"string","description":"Valor da multa"},"valor_juros":{"type":"string","description":"Valor dos juros"},"valor_desconto":{"type":"string","description":"Valor do desconto"},"valor_pago":{"type":"string","description":"Valor já pago","nullable":true},"valor_liquido":{"type":"string","description":"Valor líquido","nullable":true},"data_pagamento":{"type":"string","format":"date","description":"Data do pagamento","nullable":true},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento"},"data_competencia":{"type":"string","format":"date","description":"Data de competência"},"tipo_custo":{"type":"string","description":"Tipo de custo","nullable":true},"status_conciliacao":{"type":"string","description":"Status de conciliação"},"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},"stakeholder_id":{"type":"integer","description":"ID do stakeholder","nullable":true},"fornecedor_id":{"type":"integer","description":"ID do fornecedor (mesmo que stakeholder_id)","nullable":true},"documento_id":{"type":"integer","description":"ID do documento/forma de pagamento","nullable":true},"moeda_id":{"type":"integer","description":"ID da moeda","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 completo do plano de conta","nullable":true},"fornecedor":{"type":"object","description":"Dados do fornecedor","properties":{"numero_do_documento":{"type":"string","description":"CPF/CNPJ do fornecedor","nullable":true},"razao_social":{"type":"string","description":"Razão social","nullable":true},"nome_fantasia":{"type":"string","description":"Nome fantasia","nullable":true}}},"compra":{"type":"object","description":"Dados da compra relacionada","nullable":true,"properties":{"id":{"type":"integer","description":"ID da compra"},"numero_pedido":{"type":"string","description":"Número do pedido"},"data_emissao":{"type":"string","format":"date","description":"Data de emissão da compra"},"valor_total":{"type":"string","description":"Valor total da compra"}}},"nota_fiscal":{"type":"object","description":"Dados da nota fiscal relacionada","properties":{"id":{"type":"integer","description":"ID da nota fiscal","nullable":true},"serie":{"type":"string","description":"Série da nota fiscal","nullable":true},"numero_nfe":{"type":"string","description":"Número da NFe","nullable":true},"serie_numero_formatado":{"type":"string","description":"Série e número formatados","nullable":true},"status":{"type":"string","description":"Status da nota fiscal","nullable":true},"dthr_emissao":{"type":"string","format":"datetime","description":"Data e hora de emissão","nullable":true}}},"forma_pagamento":{"type":"object","description":"Forma de pagamento","nullable":true,"properties":{"descricao":{"type":"string","description":"Descrição da forma de pagamento"}}},"conta_corrente":{"type":"object","description":"Dados da conta corrente","properties":{"codigo_conta_corrente":{"type":"string","description":"UUID da conta corrente","nullable":true},"numero_banco":{"type":"string","description":"Número do banco","nullable":true},"nome_banco":{"type":"string","description":"Nome do banco","nullable":true},"agencia":{"type":"string","description":"Agência com dígito","nullable":true},"conta_corrente":{"type":"string","description":"Conta corrente com dígito","nullable":true}}},"centro_de_custo":{"type":"object","description":"Centro de custo associado","nullable":true,"properties":{"id":{"type":"integer","description":"ID do centro de custo"},"descricao":{"type":"string","description":"Descrição do centro de custo"},"ativo":{"type":"boolean","description":"Se o centro de custo está ativo"}}},"processo":{"type":"object","description":"Processo associado","nullable":true,"properties":{"codigo":{"type":"string","description":"Código do processo"},"descricao":{"type":"string","description":"Descrição do processo"}}},"vendedor_pessoa_id":{"type":"integer","description":"ID da pessoa vendedora","nullable":true},"processo_id":{"type":"integer","description":"ID do processo","nullable":true},"taxa_cambio":{"type":"string","description":"Taxa de câmbio"},"status_financeiro":{"type":"string","description":"Status financeiro da conta"},"tags":{"type":"array","description":"Tags personalizadas","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID da tag"},"nome":{"type":"string","description":"Nome da tag"}},"required":["id","nome"]}},"anexos":{"type":"array","description":"Lista de anexos","items":{"type":"object","properties":{"url":{"type":"string","description":"URL para download do anexo"}}}}},"required":["id","usuario","descricao","valor","data_vencimento","data_competencia","valor_pago","valor_liquido","status_conciliacao","fornecedor","nota_fiscal","conta_corrente","tags"]}},"pagination":{"type":"object","description":"Informações de paginação","properties":{"total":{"type":"integer","description":"Total de registros"},"previous_page":{"type":"string","description":"URL da página anterior","nullable":true},"next_page":{"type":"string","description":"URL da próxima página","nullable":true}},"required":["total"]}},"required":["contas","pagination"]}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}}}}}}} ``` ## Cria pagamento > \*\*Criar um novo pagamento\*\*\ > \ > Endpoint utilizado para criar um novo pagamento no sistema.\ > Permite registrar valores a pagar para fornecedores com informações completas\ > de vencimento, forma de pagamento e relacionamentos com notas fiscais.\ > \ > \*\*Campos obrigatórios:\*\*\ > \- fornecedor\_id: ID do fornecedor\ > \- valor\_original: Valor total a pagar\ > \- data\_emissao: Data de emissão da conta\ > \- data\_vencimento: Data de vencimento\ > \ > \*\*Funcionalidades:\*\*\ > \- Associação com fornecedores\ > \- Vinculação com notas fiscais\ > \- Sistema de centro de custo\ > \- Categorização de despesas\ > \- Configuração de forma de pagamento ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"06. 💸 Pagamentos","description":"**Gestão completa de pagamentos**\nControle de contas a pagar, fornecedores e fluxo de caixa.\n**Funcionalidades:**\n- Cadastro de contas a pagar\n- Controle de centro de custos\n- Registro de liquidações\n- Controle de fluxo de caixa"}],"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_pagars":{"post":{"summary":"Cria pagamento","tags":["06. 💸 Pagamentos"],"description":"**Criar um novo pagamento**\n\nEndpoint utilizado para criar um novo pagamento no sistema.\nPermite registrar valores a pagar para fornecedores com informações completas\nde vencimento, forma de pagamento e relacionamentos com notas fiscais.\n\n**Campos obrigatórios:**\n- fornecedor_id: ID do fornecedor\n- valor_original: Valor total a pagar\n- data_emissao: Data de emissão da conta\n- data_vencimento: Data de vencimento\n\n**Funcionalidades:**\n- Associação com fornecedores\n- Vinculação com notas fiscais\n- Sistema de centro de custo\n- Categorização de despesas\n- Configuração de forma de pagamento","parameters":[],"responses":{"201":{"description":"Pagamento criado com sucesso","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"ID da conta a pagar"},"observacao":{"type":"string","description":"Observação da conta","nullable":true},"numero_documento":{"type":"string","description":"Número do documento","nullable":true},"numero_documento_fiscal":{"type":"string","description":"Número do documento fiscal","nullable":true},"usuario":{"type":"string","description":"Email do usuário","nullable":true},"descricao":{"type":"string","description":"Descrição da conta"},"valor":{"type":"string","description":"Valor da conta"},"valor_multa":{"type":"string","description":"Valor da multa"},"valor_juros":{"type":"string","description":"Valor dos juros"},"valor_desconto":{"type":"string","description":"Valor do desconto"},"valor_pago":{"type":"string","description":"Valor já pago","nullable":true},"valor_liquido":{"type":"string","description":"Valor líquido","nullable":true},"data_pagamento":{"type":"string","format":"date","description":"Data do pagamento","nullable":true},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento"},"data_competencia":{"type":"string","format":"date","description":"Data de competência"},"tipo_custo":{"type":"string","description":"Tipo de custo","nullable":true},"status_conciliacao":{"type":"string","description":"Status de conciliação"},"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},"stakeholder_id":{"type":"integer","description":"ID do stakeholder","nullable":true},"fornecedor_id":{"type":"integer","description":"ID do fornecedor","nullable":true},"documento_id":{"type":"integer","description":"ID do documento","nullable":true},"moeda_id":{"type":"integer","description":"ID da moeda","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 completo do plano de conta","nullable":true},"fornecedor":{"type":"object","description":"Dados do fornecedor","properties":{"numero_do_documento":{"type":"string","description":"CPF/CNPJ do fornecedor","nullable":true},"razao_social":{"type":"string","description":"Razão social","nullable":true},"nome_fantasia":{"type":"string","description":"Nome fantasia","nullable":true}}},"compra":{"type":"object","description":"Dados da compra relacionada","nullable":true},"nota_fiscal":{"type":"object","description":"Dados da nota fiscal relacionada"},"forma_pagamento":{"type":"object","description":"Forma de pagamento","nullable":true},"conta_corrente":{"type":"object","description":"Dados da conta corrente"},"centro_de_custo":{"type":"object","description":"Centro de custo associado","nullable":true},"processo":{"type":"object","description":"Processo associado","nullable":true},"vendedor_pessoa_id":{"type":"integer","description":"ID da pessoa vendedora","nullable":true},"processo_id":{"type":"integer","description":"ID do processo","nullable":true},"taxa_cambio":{"type":"string","description":"Taxa de câmbio"},"status_financeiro":{"type":"string","description":"Status financeiro da conta"},"tags":{"type":"array","description":"Tags personalizadas","items":{"type":"object"}},"anexos":{"type":"array","description":"Lista de anexos","items":{"type":"object"}}}}}}},"400":{"description":"Dados inválidos","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":{"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 do pagamento"},"descricao":{"type":"string","description":"Descrição da conta"},"valor":{"type":"string","description":"Valor da conta"},"observacao":{"type":"string","description":"Observações sobre a conta"},"numero_documento":{"type":"string","description":"Número do documento interno"},"numero_documento_fiscal":{"type":"string","description":"Número do documento fiscal"},"tipo_custo":{"type":"string","description":"Tipo de custo (fixo/variável)"},"custo":{"type":"string","description":"Tipo de custo (alternativo a tipo_custo)"},"valor_juros":{"type":"string","description":"Valor dos juros"},"juros":{"type":"number","format":"float","description":"Valor dos juros (alternativo a valor_juros)"},"valor_desconto":{"type":"string","description":"Valor do desconto"},"desconto":{"type":"number","format":"float","description":"Valor do desconto (alternativo a valor_desconto)"},"conta_corrente_id":{"type":"integer","description":"ID da conta corrente"},"codigo_conta_corrente":{"type":"string","description":"UUID da conta corrente"},"documento_id":{"type":"integer","description":"ID do documento/forma de pagamento"},"forma_de_pagamento":{"type":"string","description":"Descrição da forma de pagamento"},"nota_fiscal_id":{"type":"integer","description":"ID da nota fiscal"},"numero_da_nota_fiscal":{"type":"string","description":"Número da nota fiscal"},"moeda_id":{"type":"integer","description":"ID da moeda"},"codigo_iso_moeda":{"type":"string","description":"Código ISO da moeda"},"fornecedor_id":{"type":"integer","description":"ID do fornecedor"},"stakeholder_id":{"type":"integer","description":"ID do stakeholder (alternativo a fornecedor_id)"},"cpf_cnpj_fornecedor":{"type":"string","description":"CPF/CNPJ do fornecedor"},"codigo_processo":{"type":"string","description":"Código do processo"},"compra_id":{"type":"integer","description":"ID da compra relacionada"},"tags":{"type":"array","description":"Tags personalizadas","items":{"type":"string"}},"plano_de_conta_id":{"type":"integer","description":"ID do plano de conta"},"codigo_plano_de_conta":{"type":"string","description":"Código completo do plano de conta"},"centro_de_custo_id":{"type":"integer","description":"ID do centro de custo"},"descricao_centro_de_custo":{"type":"string","description":"Descrição do centro de custo"}},"required":["descricao","valor","data_vencimento","data_competencia"]}}}}}}}} ``` ## Exibe pagamento > \*\*Visualizar detalhes de um pagamento específico\*\*\ > \ > Endpoint utilizado para consultar informações detalhadas de um pagamento\ > já existente no sistema. Retorna dados completos incluindo\ > informações do fornecedor, nota fiscal relacionada, forma de pagamento\ > e centro de custo associado.\ > \ > \*\*Informações retornadas:\*\*\ > \- Dados financeiros completos (valores, datas, liquidações)\ > \- Informações do fornecedor associado\ > \- Detalhes da nota fiscal relacionada (se houver)\ > \- Forma de pagamento configurada\ > \- Centro de custo e categoria\ > \- Histórico de liquidações realizadas\ > \- Anexos (se houver) ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"06. 💸 Pagamentos","description":"**Gestão completa de pagamentos**\nControle de contas a pagar, fornecedores e fluxo de caixa.\n**Funcionalidades:**\n- Cadastro de contas a pagar\n- Controle de centro de custos\n- Registro de liquidações\n- Controle de fluxo de caixa"}],"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_pagars/{id}":{"get":{"summary":"Exibe pagamento","tags":["06. 💸 Pagamentos"],"description":"**Visualizar detalhes de um pagamento específico**\n\nEndpoint utilizado para consultar informações detalhadas de um pagamento\njá existente no sistema. Retorna dados completos incluindo\ninformações do fornecedor, nota fiscal relacionada, forma de pagamento\ne centro de custo associado.\n\n**Informações retornadas:**\n- Dados financeiros completos (valores, datas, liquidações)\n- Informações do fornecedor associado\n- Detalhes da nota fiscal relacionada (se houver)\n- Forma de pagamento configurada\n- Centro de custo e categoria\n- Histórico de liquidações realizadas\n- Anexos (se houver)","responses":{"200":{"description":"Pagamento encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"ID da conta a pagar"},"observacao":{"type":"string","description":"Observação da conta","nullable":true},"numero_documento":{"type":"string","description":"Número do documento","nullable":true},"numero_documento_fiscal":{"type":"string","description":"Número do documento fiscal","nullable":true},"usuario":{"type":"string","description":"Email do usuário","nullable":true},"descricao":{"type":"string","description":"Descrição da conta"},"valor":{"type":"string","description":"Valor da conta"},"valor_multa":{"type":"string","description":"Valor da multa"},"valor_juros":{"type":"string","description":"Valor dos juros"},"valor_desconto":{"type":"string","description":"Valor do desconto"},"valor_pago":{"type":"string","description":"Valor já pago","nullable":true},"valor_liquido":{"type":"string","description":"Valor líquido","nullable":true},"data_pagamento":{"type":"string","format":"date","description":"Data do pagamento","nullable":true},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento"},"data_competencia":{"type":"string","format":"date","description":"Data de competência"},"tipo_custo":{"type":"string","description":"Tipo de custo","nullable":true},"status_conciliacao":{"type":"string","description":"Status de conciliação"},"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},"stakeholder_id":{"type":"integer","description":"ID do stakeholder","nullable":true},"fornecedor_id":{"type":"integer","description":"ID do fornecedor (mesmo que stakeholder_id)","nullable":true},"documento_id":{"type":"integer","description":"ID do documento/forma de pagamento","nullable":true},"moeda_id":{"type":"integer","description":"ID da moeda","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 completo do plano de conta","nullable":true},"fornecedor":{"type":"object","description":"Dados do fornecedor","properties":{"numero_do_documento":{"type":"string","description":"CPF/CNPJ do fornecedor","nullable":true},"razao_social":{"type":"string","description":"Razão social","nullable":true},"nome_fantasia":{"type":"string","description":"Nome fantasia","nullable":true}}},"compra":{"type":"object","description":"Dados da compra relacionada","nullable":true,"properties":{"id":{"type":"integer","description":"ID da compra"},"numero_pedido":{"type":"string","description":"Número do pedido"},"data_emissao":{"type":"string","format":"date","description":"Data de emissão da compra"},"valor_total":{"type":"string","description":"Valor total da compra"}}},"nota_fiscal":{"type":"object","description":"Dados da nota fiscal relacionada","properties":{"id":{"type":"integer","description":"ID da nota fiscal","nullable":true},"serie":{"type":"string","description":"Série da nota fiscal","nullable":true},"numero_nfe":{"type":"string","description":"Número da NFe","nullable":true},"serie_numero_formatado":{"type":"string","description":"Série e número formatados","nullable":true},"status":{"type":"string","description":"Status da nota fiscal","nullable":true},"dthr_emissao":{"type":"string","format":"datetime","description":"Data e hora de emissão","nullable":true}}},"forma_pagamento":{"type":"object","description":"Forma de pagamento","nullable":true,"properties":{"descricao":{"type":"string","description":"Descrição da forma de pagamento"}}},"conta_corrente":{"type":"object","description":"Dados da conta corrente","properties":{"codigo_conta_corrente":{"type":"string","description":"UUID da conta corrente","nullable":true},"numero_banco":{"type":"string","description":"Número do banco","nullable":true},"nome_banco":{"type":"string","description":"Nome do banco","nullable":true},"agencia":{"type":"string","description":"Agência com dígito","nullable":true},"conta_corrente":{"type":"string","description":"Conta corrente com dígito","nullable":true}}},"centro_de_custo":{"type":"object","description":"Centro de custo associado","nullable":true,"properties":{"id":{"type":"integer","description":"ID do centro de custo"},"descricao":{"type":"string","description":"Descrição do centro de custo"},"ativo":{"type":"boolean","description":"Se o centro de custo está ativo"}}},"processo":{"type":"object","description":"Processo associado","nullable":true,"properties":{"codigo":{"type":"string","description":"Código do processo"},"descricao":{"type":"string","description":"Descrição do processo"}}},"vendedor_pessoa_id":{"type":"integer","description":"ID da pessoa vendedora","nullable":true},"processo_id":{"type":"integer","description":"ID do processo","nullable":true},"taxa_cambio":{"type":"string","description":"Taxa de câmbio"},"status_financeiro":{"type":"string","description":"Status financeiro da conta"},"tags":{"type":"array","description":"Tags personalizadas","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID da tag"},"nome":{"type":"string","description":"Nome da tag"}},"required":["id","nome"]}},"anexos":{"type":"array","description":"Lista de anexos","items":{"type":"object","properties":{"url":{"type":"string","description":"URL para download do anexo"}}}}},"required":["id","usuario","descricao","valor","data_vencimento","data_competencia","valor_pago","valor_liquido","status_conciliacao","fornecedor","nota_fiscal","conta_corrente","tags"]}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"404":{"description":"Pagamento não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}}}}}} ``` ## Atualiza pagamento > \*\*Atualizar um pagamento existente\*\*\ > \ > Endpoint utilizado para atualizar informações de um pagamento\ > 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 pagamento\ > \ > \*\*Controle de liquidações:\*\*\ > \- valor\_pago: Valor efetivamente pago\ > \- data\_pagamento: Data do pagamento\ > \- forma\_pagamento: Forma utilizada para pagamento\ > \- observacoes: Observações sobre o pagamento ```json {"openapi":"3.0.1","info":{"title":"Mainô API","version":"v2.0"},"tags":[{"name":"06. 💸 Pagamentos","description":"**Gestão completa de pagamentos**\nControle de contas a pagar, fornecedores e fluxo de caixa.\n**Funcionalidades:**\n- Cadastro de contas a pagar\n- Controle de centro de custos\n- Registro de liquidações\n- Controle de fluxo de caixa"}],"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_pagars/{id}":{"put":{"summary":"Atualiza pagamento","tags":["06. 💸 Pagamentos"],"description":"**Atualizar um pagamento existente**\n\nEndpoint utilizado para atualizar informações de um pagamento\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 pagamento\n\n**Controle de liquidações:**\n- valor_pago: Valor efetivamente pago\n- data_pagamento: Data do pagamento\n- forma_pagamento: Forma utilizada para pagamento\n- observacoes: Observações sobre o pagamento","parameters":[],"responses":{"200":{"description":"Pagamento atualizado","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"ID da conta a pagar"},"observacao":{"type":"string","description":"Observação da conta","nullable":true},"numero_documento":{"type":"string","description":"Número do documento","nullable":true},"numero_documento_fiscal":{"type":"string","description":"Número do documento fiscal","nullable":true},"usuario":{"type":"string","description":"Email do usuário","nullable":true},"descricao":{"type":"string","description":"Descrição da conta"},"valor":{"type":"string","description":"Valor da conta"},"valor_multa":{"type":"string","description":"Valor da multa"},"valor_juros":{"type":"string","description":"Valor dos juros"},"valor_desconto":{"type":"string","description":"Valor do desconto"},"valor_pago":{"type":"string","description":"Valor já pago","nullable":true},"valor_liquido":{"type":"string","description":"Valor líquido","nullable":true},"data_pagamento":{"type":"string","format":"date","description":"Data do pagamento","nullable":true},"data_vencimento":{"type":"string","format":"date","description":"Data de vencimento"},"data_competencia":{"type":"string","format":"date","description":"Data de competência"},"tipo_custo":{"type":"string","description":"Tipo de custo","nullable":true},"status_conciliacao":{"type":"string","description":"Status de conciliação"},"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},"stakeholder_id":{"type":"integer","description":"ID do stakeholder","nullable":true},"fornecedor_id":{"type":"integer","description":"ID do fornecedor","nullable":true},"documento_id":{"type":"integer","description":"ID do documento","nullable":true},"moeda_id":{"type":"integer","description":"ID da moeda","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 completo do plano de conta","nullable":true},"fornecedor":{"type":"object","description":"Dados do fornecedor","properties":{"numero_do_documento":{"type":"string","description":"CPF/CNPJ do fornecedor","nullable":true},"razao_social":{"type":"string","description":"Razão social","nullable":true},"nome_fantasia":{"type":"string","description":"Nome fantasia","nullable":true}}},"compra":{"type":"object","description":"Dados da compra relacionada","nullable":true},"nota_fiscal":{"type":"object","description":"Dados da nota fiscal relacionada"},"forma_pagamento":{"type":"object","description":"Forma de pagamento","nullable":true},"conta_corrente":{"type":"object","description":"Dados da conta corrente"},"centro_de_custo":{"type":"object","description":"Centro de custo associado","nullable":true},"processo":{"type":"object","description":"Processo associado","nullable":true},"vendedor_pessoa_id":{"type":"integer","description":"ID da pessoa vendedora","nullable":true},"processo_id":{"type":"integer","description":"ID do processo","nullable":true},"taxa_cambio":{"type":"string","description":"Taxa de câmbio"},"status_financeiro":{"type":"string","description":"Status financeiro da conta"},"tags":{"type":"array","description":"Tags personalizadas","items":{"type":"object"}},"anexos":{"type":"array","description":"Lista de anexos","items":{"type":"object"}}}}}}},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"404":{"description":"Pagamento não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"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 do pagamento"},"descricao":{"type":"string","description":"Descrição da conta"},"valor":{"type":"string","description":"Valor da conta"},"observacao":{"type":"string","description":"Observações sobre a conta"},"numero_documento":{"type":"string","description":"Número do documento interno"},"numero_documento_fiscal":{"type":"string","description":"Número do documento fiscal"},"tipo_custo":{"type":"string","description":"Tipo de custo (fixo/variável)"},"custo":{"type":"string","description":"Tipo de custo (alternativo a tipo_custo)"},"valor_juros":{"type":"string","description":"Valor dos juros"},"juros":{"type":"number","format":"float","description":"Valor dos juros (alternativo a valor_juros)"},"valor_desconto":{"type":"string","description":"Valor do desconto"},"desconto":{"type":"number","format":"float","description":"Valor do desconto (alternativo a valor_desconto)"},"conta_corrente_id":{"type":"integer","description":"ID da conta corrente"},"codigo_conta_corrente":{"type":"string","description":"UUID da conta corrente"},"documento_id":{"type":"integer","description":"ID do documento/forma de pagamento"},"forma_de_pagamento":{"type":"string","description":"Descrição da forma de pagamento"},"nota_fiscal_id":{"type":"integer","description":"ID da nota fiscal"},"numero_da_nota_fiscal":{"type":"string","description":"Número da nota fiscal"},"moeda_id":{"type":"integer","description":"ID da moeda"},"codigo_iso_moeda":{"type":"string","description":"Código ISO da moeda"},"fornecedor_id":{"type":"integer","description":"ID do fornecedor"},"stakeholder_id":{"type":"integer","description":"ID do stakeholder (alternativo a fornecedor_id)"},"cpf_cnpj_fornecedor":{"type":"string","description":"CPF/CNPJ do fornecedor"},"codigo_processo":{"type":"string","description":"Código do processo"},"compra_id":{"type":"integer","description":"ID da compra relacionada"},"tags":{"type":"array","description":"Tags personalizadas","items":{"type":"string"}},"plano_de_conta_id":{"type":"integer","description":"ID do plano de conta"},"codigo_plano_de_conta":{"type":"string","description":"Código completo do plano de conta"},"centro_de_custo_id":{"type":"integer","description":"ID do centro de custo"},"descricao_centro_de_custo":{"type":"string","description":"Descrição do centro de custo"}}}}}}}}}} ``` ## Excluir pagamento > \*\*Excluir um pagamento existente\*\*\ > \ > Endpoint utilizado para excluir um pagamento 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 compras 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":"06. 💸 Pagamentos","description":"**Gestão completa de pagamentos**\nControle de contas a pagar, fornecedores e fluxo de caixa.\n**Funcionalidades:**\n- Cadastro de contas a pagar\n- Controle de centro de custos\n- Registro de liquidações\n- Controle de fluxo de caixa"}],"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_pagars/{id}":{"delete":{"summary":"Excluir pagamento","tags":["06. 💸 Pagamentos"],"description":"**Excluir um pagamento existente**\n\nEndpoint utilizado para excluir um pagamento 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 compras 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":"Pagamento excluído"},"401":{"description":"Não autorizado","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}}}}}},"404":{"description":"Pagamento não encontrado","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"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/06.-pagamentos.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.