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

get

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)

Autorizações

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

descricaostringOpcional

Busca parcial na descrição da conta (case-insensitive)

data_vencimento_inistring · dateOpcional

Data de vencimento inicial (>=)

data_vencimento_fimstring · dateOpcional

Data de vencimento final (<=)

statusstring · enumOpcional

Status financeiro da conta

Valores possíveis:

fornecedor_idintegerOpcional

ID do stakeholder/fornecedor

pageintegerOpcional

Número da página (padrão: 1; 50 registros por página)

Respostas

200

Lista de contas a pagar

application/json

401

Não autorizado

application/json

get

/contas_a_pagars

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

{
  "contas": [
    {
      "id": 12345,
      "observacao": "Pagamento aprovado pela diretoria",
      "numero_documento": "DOC123456",
      "numero_documento_fiscal": "NF123456",
      "usuario": "usuario@empresa.com",
      "descricao": "Pagamento de fornecedor XYZ",
      "valor": "1500.0",
      "valor_multa": "0.0",
      "valor_juros": "0.0",
      "valor_desconto": "0.0",
      "valor_pago": "750.0",
      "valor_liquido": "1450.0",
      "data_pagamento": "2023-02-15",
      "data_vencimento": "2023-02-20",
      "data_competencia": "2023-02-01",
      "tipo_custo": "fixo",
      "status_conciliacao": "nao_conciliado",
      "plano_de_conta_id": 10,
      "conta_corrente_id": 5,
      "centro_de_custo_id": 3,
      "stakeholder_id": 100,
      "fornecedor_id": 100,
      "documento_id": 7,
      "moeda_id": 1,
      "plano_de_conta": "Fornecedores - Matéria Prima",
      "codigo_plano_de_conta": "2.1.01.001",
      "fornecedor": {
        "numero_do_documento": "12.345.678/0001-90",
        "razao_social": "Fornecedor XYZ Ltda",
        "nome_fantasia": "XYZ Materiais"
      },
      "compra": {
        "id": 999,
        "numero_pedido": "PED-2023-001",
        "data_emissao": "2023-01-15",
        "valor_total": "5000.0"
      },
      "nota_fiscal": {
        "id": 54321,
        "serie": "001",
        "numero_nfe": "000123456",
        "serie_numero_formatado": "001/000123456",
        "status": "ACEITA",
        "dthr_emissao": "2023-02-01T10:30:00Z"
      },
      "forma_pagamento": {
        "descricao": "Transferência Bancária"
      },
      "conta_corrente": {
        "codigo_conta_corrente": "abc123-def456-789",
        "numero_banco": "341",
        "nome_banco": "Itaú Unibanco",
        "agencia": "1234-5",
        "conta_corrente": "12345-6"
      },
      "centro_de_custo": {
        "id": 1,
        "descricao": "Vendas",
        "ativo": true
      },
      "processo": {
        "codigo": "PROC001",
        "descricao": "Processo de compra mensal"
      },
      "vendedor_pessoa_id": 50,
      "processo_id": 20,
      "taxa_cambio": 1,
      "status_financeiro": "em_aberto",
      "tags": [
        {
          "id": 1,
          "nome": "Urgente"
        }
      ],
      "anexos": [
        {
          "url": "/uploads/anexos/comprovante.pdf"
        }
      ]
    }
  ],
  "pagination": {
    "total": 150,
    "previous_page": "http://api.exemplo.com/api/v2/contas_a_pagars?page=1",
    "next_page": "http://api.exemplo.com/api/v2/contas_a_pagars?page=3"
  }
}

Cria pagamento

post

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

Autorizações

AuthorizationstringObrigatório

Corpo

data_vencimentostring · dateObrigatório

Data de vencimento

Example: 2023-02-20

data_competenciastring · dateObrigatório

Data de competência

Example: 2023-01-01

data_pagamentostring · dateOpcional

Data do pagamento

Example: 2023-02-15

descricaostringObrigatório

Descrição da conta

Example: Pagamento de fornecedor XYZ

valorstringObrigatório

Valor da conta

Example: 1500.0

observacaostringOpcional

Observações sobre a conta

Example: Pagamento aprovado pela diretoria

numero_documentostringOpcional

Número do documento interno

Example: DOC123456

numero_documento_fiscalstringOpcional

Número do documento fiscal

Example: NF123456

tipo_custostringOpcional

Tipo de custo (fixo/variável)

Example: fixo

custostringOpcional

Tipo de custo (alternativo a tipo_custo)

Example: variavel

valor_jurosstringOpcional

Valor dos juros

Example: 50.0

jurosnumber · floatOpcional

Valor dos juros (alternativo a valor_juros)

Example: 50

valor_descontostringOpcional

Valor do desconto

Example: 100.0

descontonumber · floatOpcional

Valor do desconto (alternativo a valor_desconto)

Example: 100

conta_corrente_idintegerOpcional

ID da conta corrente

Example: 5

codigo_conta_correntestringOpcional

UUID da conta corrente

Example: abc123-def456-789

documento_idintegerOpcional

ID do documento/forma de pagamento

Example: 7

forma_de_pagamentostringOpcional

Descrição da forma de pagamento

Example: Transferência Bancária

nota_fiscal_idintegerOpcional

ID da nota fiscal

Example: 54321

numero_da_nota_fiscalstringOpcional

Número da nota fiscal

Example: 000123456

moeda_idintegerOpcional

ID da moeda

Example: 1

codigo_iso_moedastringOpcional

Código ISO da moeda

Example: BRL

fornecedor_idintegerOpcional

ID do fornecedor

Example: 100

stakeholder_idintegerOpcional

ID do stakeholder (alternativo a fornecedor_id)

Example: 100

cpf_cnpj_fornecedorstringOpcional

CPF/CNPJ do fornecedor

Example: 12345678000190

codigo_processostringOpcional

Código do processo

Example: PROC001

compra_idintegerOpcional

ID da compra relacionada

Example: 999

tagsstring[]Opcional

Tags personalizadas

Example: ["Urgente","Prioritário"]

plano_de_conta_idintegerOpcional

ID do plano de conta

Example: 10

codigo_plano_de_contastringOpcional

Código completo do plano de conta

Example: 2.1.01.001

centro_de_custo_idintegerOpcional

ID do centro de custo

Example: 3

descricao_centro_de_custostringOpcional

Descrição do centro de custo

Example: Vendas

Respostas

201

Pagamento criado com sucesso

application/json

400

Dados inválidos

application/json

401

Não autorizado

application/json

post

/contas_a_pagars

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

{
  "data_vencimento": "2023-02-20",
  "data_competencia": "2023-01-01",
  "data_pagamento": "2023-02-15",
  "descricao": "Pagamento de fornecedor XYZ",
  "valor": "1500.0",
  "observacao": "Pagamento aprovado pela diretoria",
  "numero_documento": "DOC123456",
  "numero_documento_fiscal": "NF123456",
  "tipo_custo": "fixo",
  "custo": "variavel",
  "valor_juros": "50.0",
  "juros": 50,
  "valor_desconto": "100.0",
  "desconto": 100,
  "conta_corrente_id": 5,
  "codigo_conta_corrente": "abc123-def456-789",
  "documento_id": 7,
  "forma_de_pagamento": "Transferência Bancária",
  "nota_fiscal_id": 54321,
  "numero_da_nota_fiscal": "000123456",
  "moeda_id": 1,
  "codigo_iso_moeda": "BRL",
  "fornecedor_id": 100,
  "stakeholder_id": 100,
  "cpf_cnpj_fornecedor": "12345678000190",
  "codigo_processo": "PROC001",
  "compra_id": 999,
  "tags": [
    "Urgente",
    "Prioritário"
  ],
  "plano_de_conta_id": 10,
  "codigo_plano_de_conta": "2.1.01.001",
  "centro_de_custo_id": 3,
  "descricao_centro_de_custo": "Vendas"
}

{
  "id": 12345,
  "observacao": "text",
  "numero_documento": "text",
  "numero_documento_fiscal": "text",
  "usuario": "text",
  "descricao": "text",
  "valor": "text",
  "valor_multa": "text",
  "valor_juros": "text",
  "valor_desconto": "text",
  "valor_pago": "text",
  "valor_liquido": "text",
  "data_pagamento": "2026-06-17",
  "data_vencimento": "2026-06-17",
  "data_competencia": "2026-06-17",
  "tipo_custo": "text",
  "status_conciliacao": "text",
  "plano_de_conta_id": 1,
  "conta_corrente_id": 1,
  "centro_de_custo_id": 1,
  "stakeholder_id": 1,
  "fornecedor_id": 1,
  "documento_id": 1,
  "moeda_id": 1,
  "plano_de_conta": "text",
  "codigo_plano_de_conta": "text",
  "fornecedor": {
    "numero_do_documento": "text",
    "razao_social": "text",
    "nome_fantasia": "text"
  },
  "compra": {},
  "nota_fiscal": {},
  "forma_pagamento": {},
  "conta_corrente": {},
  "centro_de_custo": {},
  "processo": {},
  "vendedor_pessoa_id": 1,
  "processo_id": 1,
  "taxa_cambio": "text",
  "status_financeiro": "text",
  "tags": [
    {}
  ],
  "anexos": [
    {}
  ]
}

Exibe pagamento

get

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)

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idintegerObrigatório

ID do pagamento

Respostas

200

Pagamento encontrado

application/json

idintegerObrigatório

ID da conta a pagar

Example: 12345

observacaostring · anulávelOpcional

Observação da conta

Example: Pagamento aprovado pela diretoria

numero_documentostring · anulávelOpcional

Número do documento

Example: DOC123456

numero_documento_fiscalstring · anulávelOpcional

Número do documento fiscal

Example: NF123456

usuariostring · anulávelObrigatório

Email do usuário

Example: usuario@empresa.com

descricaostringObrigatório

Descrição da conta

Example: Pagamento de fornecedor XYZ

valorstringObrigatório

Valor da conta

Example: 1500.0

valor_multastringOpcional

Valor da multa

Example: 0.0

valor_jurosstringOpcional

Valor dos juros

Example: 0.0

valor_descontostringOpcional

Valor do desconto

Example: 0.0

valor_pagostring · anulávelObrigatório

Valor já pago

Example: 750.0

valor_liquidostring · anulávelObrigatório

Valor líquido

Example: 1450.0

data_pagamentostring · date · anulávelOpcional

Data do pagamento

Example: 2023-02-15

data_vencimentostring · dateObrigatório

Data de vencimento

Example: 2023-02-20

data_competenciastring · dateObrigatório

Data de competência

Example: 2023-02-01

tipo_custostring · anulávelOpcional

Tipo de custo

Example: fixo

status_conciliacaostringObrigatório

Status de conciliação

Example: nao_conciliado

plano_de_conta_idinteger · anulávelOpcional

ID do plano de conta

Example: 10

conta_corrente_idinteger · anulávelOpcional

ID da conta corrente

Example: 5

centro_de_custo_idinteger · anulávelOpcional

ID do centro de custo

Example: 3

stakeholder_idinteger · anulávelOpcional

ID do stakeholder

Example: 100

fornecedor_idinteger · anulávelOpcional

ID do fornecedor (mesmo que stakeholder_id)

Example: 100

documento_idinteger · anulávelOpcional

ID do documento/forma de pagamento

Example: 7

moeda_idinteger · anulávelOpcional

ID da moeda

Example: 1

plano_de_contastring · anulávelOpcional

Descrição do plano de conta

Example: Fornecedores - Matéria Prima

codigo_plano_de_contastring · anulávelOpcional

Código completo do plano de conta

Example: 2.1.01.001

vendedor_pessoa_idinteger · anulávelOpcional

ID da pessoa vendedora

Example: 50

processo_idinteger · anulávelOpcional

ID do processo

Example: 20

taxa_cambiostringOpcional

Taxa de câmbio

Example: 1

status_financeirostringOpcional

Status financeiro da conta

Example: em_aberto

401

Não autorizado

application/json

404

Pagamento não encontrado

application/json

get

/contas_a_pagars/{id}

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

{
  "id": 12345,
  "observacao": "Pagamento aprovado pela diretoria",
  "numero_documento": "DOC123456",
  "numero_documento_fiscal": "NF123456",
  "usuario": "usuario@empresa.com",
  "descricao": "Pagamento de fornecedor XYZ",
  "valor": "1500.0",
  "valor_multa": "0.0",
  "valor_juros": "0.0",
  "valor_desconto": "0.0",
  "valor_pago": "750.0",
  "valor_liquido": "1450.0",
  "data_pagamento": "2023-02-15",
  "data_vencimento": "2023-02-20",
  "data_competencia": "2023-02-01",
  "tipo_custo": "fixo",
  "status_conciliacao": "nao_conciliado",
  "plano_de_conta_id": 10,
  "conta_corrente_id": 5,
  "centro_de_custo_id": 3,
  "stakeholder_id": 100,
  "fornecedor_id": 100,
  "documento_id": 7,
  "moeda_id": 1,
  "plano_de_conta": "Fornecedores - Matéria Prima",
  "codigo_plano_de_conta": "2.1.01.001",
  "fornecedor": {
    "numero_do_documento": "12.345.678/0001-90",
    "razao_social": "Fornecedor XYZ Ltda",
    "nome_fantasia": "XYZ Materiais"
  },
  "compra": {
    "id": 999,
    "numero_pedido": "PED-2023-001",
    "data_emissao": "2023-01-15",
    "valor_total": "5000.0"
  },
  "nota_fiscal": {
    "id": 54321,
    "serie": "001",
    "numero_nfe": "000123456",
    "serie_numero_formatado": "001/000123456",
    "status": "ACEITA",
    "dthr_emissao": "2023-02-01T10:30:00Z"
  },
  "forma_pagamento": {
    "descricao": "Transferência Bancária"
  },
  "conta_corrente": {
    "codigo_conta_corrente": "abc123-def456-789",
    "numero_banco": "341",
    "nome_banco": "Itaú Unibanco",
    "agencia": "1234-5",
    "conta_corrente": "12345-6"
  },
  "centro_de_custo": {
    "id": 1,
    "descricao": "Vendas",
    "ativo": true
  },
  "processo": {
    "codigo": "PROC001",
    "descricao": "Processo de compra mensal"
  },
  "vendedor_pessoa_id": 50,
  "processo_id": 20,
  "taxa_cambio": 1,
  "status_financeiro": "em_aberto",
  "tags": [
    {
      "id": 1,
      "nome": "Urgente"
    }
  ],
  "anexos": [
    {
      "url": "/uploads/anexos/comprovante.pdf"
    }
  ]
}

Atualiza pagamento

put

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

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idintegerObrigatório

ID do pagamento

Corpo

data_vencimentostring · dateOpcional

Data de vencimento

Example: 2023-02-20

data_competenciastring · dateOpcional

Data de competência

Example: 2023-01-01

data_pagamentostring · dateOpcional

Data do pagamento

Example: 2023-02-15

descricaostringOpcional

Descrição da conta

Example: Pagamento de fornecedor XYZ

valorstringOpcional

Valor da conta

Example: 1500.0

observacaostringOpcional

Observações sobre a conta

Example: Pagamento aprovado pela diretoria

numero_documentostringOpcional

Número do documento interno

Example: DOC123456

numero_documento_fiscalstringOpcional

Número do documento fiscal

Example: NF123456

tipo_custostringOpcional

Tipo de custo (fixo/variável)

Example: fixo

custostringOpcional

Tipo de custo (alternativo a tipo_custo)

Example: variavel

valor_jurosstringOpcional

Valor dos juros

Example: 50.0

jurosnumber · floatOpcional

Valor dos juros (alternativo a valor_juros)

Example: 50

valor_descontostringOpcional

Valor do desconto

Example: 100.0

descontonumber · floatOpcional

Valor do desconto (alternativo a valor_desconto)

Example: 100

conta_corrente_idintegerOpcional

ID da conta corrente

Example: 5

codigo_conta_correntestringOpcional

UUID da conta corrente

Example: abc123-def456-789

documento_idintegerOpcional

ID do documento/forma de pagamento

Example: 7

forma_de_pagamentostringOpcional

Descrição da forma de pagamento

Example: Transferência Bancária

nota_fiscal_idintegerOpcional

ID da nota fiscal

Example: 54321

numero_da_nota_fiscalstringOpcional

Número da nota fiscal

Example: 000123456

moeda_idintegerOpcional

ID da moeda

Example: 1

codigo_iso_moedastringOpcional

Código ISO da moeda

Example: BRL

fornecedor_idintegerOpcional

ID do fornecedor

Example: 100

stakeholder_idintegerOpcional

ID do stakeholder (alternativo a fornecedor_id)

Example: 100

cpf_cnpj_fornecedorstringOpcional

CPF/CNPJ do fornecedor

Example: 12345678000190

codigo_processostringOpcional

Código do processo

Example: PROC001

compra_idintegerOpcional

ID da compra relacionada

Example: 999

tagsstring[]Opcional

Tags personalizadas

Example: ["Urgente","Prioritário"]

plano_de_conta_idintegerOpcional

ID do plano de conta

Example: 10

codigo_plano_de_contastringOpcional

Código completo do plano de conta

Example: 2.1.01.001

centro_de_custo_idintegerOpcional

ID do centro de custo

Example: 3

descricao_centro_de_custostringOpcional

Descrição do centro de custo

Example: Vendas

Respostas

200

Pagamento atualizado

application/json

idintegerOpcional

ID da conta a pagar

Example: 12345

observacaostring · anulávelOpcional

Observação da conta

numero_documentostring · anulávelOpcional

Número do documento

numero_documento_fiscalstring · anulávelOpcional

Número do documento fiscal

usuariostring · anulávelOpcional

Email do usuário

descricaostringOpcional

Descrição da conta

valorstringOpcional

Valor da conta

valor_multastringOpcional

Valor da multa

valor_jurosstringOpcional

Valor dos juros

valor_descontostringOpcional

Valor do desconto

valor_pagostring · anulávelOpcional

Valor já pago

valor_liquidostring · anulávelOpcional

Valor líquido

data_pagamentostring · date · anulávelOpcional

Data do pagamento

data_vencimentostring · dateOpcional

Data de vencimento

data_competenciastring · dateOpcional

Data de competência

tipo_custostring · anulávelOpcional

Tipo de custo

status_conciliacaostringOpcional

Status de conciliação

plano_de_conta_idinteger · anulávelOpcional

ID do plano de conta

conta_corrente_idinteger · anulávelOpcional

ID da conta corrente

centro_de_custo_idinteger · anulávelOpcional

ID do centro de custo

stakeholder_idinteger · anulávelOpcional

ID do stakeholder

fornecedor_idinteger · anulávelOpcional

ID do fornecedor

documento_idinteger · anulávelOpcional

ID do documento

moeda_idinteger · anulávelOpcional

ID da moeda

plano_de_contastring · anulávelOpcional

Descrição do plano de conta

codigo_plano_de_contastring · anulávelOpcional

Código completo do plano de conta

compraobject · anulávelOpcional

Dados da compra relacionada

nota_fiscalobjectOpcional

Dados da nota fiscal relacionada

forma_pagamentoobject · anulávelOpcional

Forma de pagamento

conta_correnteobjectOpcional

Dados da conta corrente

centro_de_custoobject · anulávelOpcional

Centro de custo associado

processoobject · anulávelOpcional

Processo associado

vendedor_pessoa_idinteger · anulávelOpcional

ID da pessoa vendedora

processo_idinteger · anulávelOpcional

ID do processo

taxa_cambiostringOpcional

Taxa de câmbio

status_financeirostringOpcional

Status financeiro da conta

tagsobject[]Opcional

Tags personalizadas

anexosobject[]Opcional

Lista de anexos

401

Não autorizado

application/json

404

Pagamento não encontrado

application/json

put

/contas_a_pagars/{id}

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

{
  "data_vencimento": "2023-02-20",
  "data_competencia": "2023-01-01",
  "data_pagamento": "2023-02-15",
  "descricao": "Pagamento de fornecedor XYZ",
  "valor": "1500.0",
  "observacao": "Pagamento aprovado pela diretoria",
  "numero_documento": "DOC123456",
  "numero_documento_fiscal": "NF123456",
  "tipo_custo": "fixo",
  "custo": "variavel",
  "valor_juros": "50.0",
  "juros": 50,
  "valor_desconto": "100.0",
  "desconto": 100,
  "conta_corrente_id": 5,
  "codigo_conta_corrente": "abc123-def456-789",
  "documento_id": 7,
  "forma_de_pagamento": "Transferência Bancária",
  "nota_fiscal_id": 54321,
  "numero_da_nota_fiscal": "000123456",
  "moeda_id": 1,
  "codigo_iso_moeda": "BRL",
  "fornecedor_id": 100,
  "stakeholder_id": 100,
  "cpf_cnpj_fornecedor": "12345678000190",
  "codigo_processo": "PROC001",
  "compra_id": 999,
  "tags": [
    "Urgente",
    "Prioritário"
  ],
  "plano_de_conta_id": 10,
  "codigo_plano_de_conta": "2.1.01.001",
  "centro_de_custo_id": 3,
  "descricao_centro_de_custo": "Vendas"
}

{
  "id": 12345,
  "observacao": "text",
  "numero_documento": "text",
  "numero_documento_fiscal": "text",
  "usuario": "text",
  "descricao": "text",
  "valor": "text",
  "valor_multa": "text",
  "valor_juros": "text",
  "valor_desconto": "text",
  "valor_pago": "text",
  "valor_liquido": "text",
  "data_pagamento": "2026-06-17",
  "data_vencimento": "2026-06-17",
  "data_competencia": "2026-06-17",
  "tipo_custo": "text",
  "status_conciliacao": "text",
  "plano_de_conta_id": 1,
  "conta_corrente_id": 1,
  "centro_de_custo_id": 1,
  "stakeholder_id": 1,
  "fornecedor_id": 1,
  "documento_id": 1,
  "moeda_id": 1,
  "plano_de_conta": "text",
  "codigo_plano_de_conta": "text",
  "fornecedor": {
    "numero_do_documento": "text",
    "razao_social": "text",
    "nome_fantasia": "text"
  },
  "compra": {},
  "nota_fiscal": {},
  "forma_pagamento": {},
  "conta_corrente": {},
  "centro_de_custo": {},
  "processo": {},
  "vendedor_pessoa_id": 1,
  "processo_id": 1,
  "taxa_cambio": "text",
  "status_financeiro": "text",
  "tags": [
    {}
  ],
  "anexos": [
    {}
  ]
}

Excluir pagamento

delete

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

Autorizações

AuthorizationstringObrigatório

Parâmetros de rota

idintegerObrigatório

ID do pagamento

Respostas

200

Pagamento excluído

Sem conteúdo

401

Não autorizado

application/json

404

Pagamento não encontrado

application/json

delete

/contas_a_pagars/{id}

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

Sem conteúdo

Anterior05. 💰 Recebimentos Próximo07. 🏦 Contas Bancárias

Atualizado há 26 dias