GET api/PlanoPagamentos/Edita?NumPlano={NumPlano}

Edita Plano de Pagamentos.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
NumPlano

Identificador do N.º do Plano de Pagamentos.

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Informação do Documento Interno.

BEPlanoPagamento
NameDescriptionTypeAdditional information
CamposUtil

Campos do Utilizador.

 Collection of BECampo

None.
DataUltimaActualizacao

Data da Última Actualização.

 date

None.
Descricao

Descrição do Plano de Pagamento.

 string

None.
Documentos

Lista de Documentos/Pendentes (utilizados para gerar o Plano de Pagamento).

 Collection of BEDocumentoPlanoPagamento

None.
EmModoEdicao

Em Modo de Edição?

 boolean

None.
Entidade

Identificador da Entidade do Plano de Pagamento.

 string

None.
Id

Identificador (Id) do Plano de Pagamento.

 string

None.
Linhas

Linhas do Plano de Pagamento (Pendentes utilizados para gerar o Plano de Pagamento).

 Collection of BELinhaPlanoPagamento

None.
Moeda

Identificador da Moeda do Plano de Pagamento.

 string

None.
NumPlano

Identificador (Número) do Plano de Pagamento.

 integer

None.
Observacoes

Informação adicional sobre o Plano de Pagamento.

 string

None.
TipoEntidade

Identificador do Tipo de Entidade do Plano de Pagamento.

 string

None.
Total

Valor Total do Plano de Pagamento.

 decimal number

None.
Utilizador

Utilizador que gravou/alteoru o Plano de Pagamento.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "CamposUtil": [
    {
      "Nome": "sample string 1",
      "Valor": {},
      "Chave": true
    },
    {
      "Nome": "sample string 1",
      "Valor": {},
      "Chave": true
    }
  ],
  "DataUltimaActualizacao": "2026-04-04T13:13:08.9404123-01:00",
  "Descricao": "sample string 1",
  "Documentos": [
    {
      "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
      "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
      "EmModoEdicao": true,
      "Entidade": "sample string 2",
      "Estado": "sample string 3",
      "Filial": "sample string 4",
      "IdDocumento": "sample string 5",
      "IdHistorico": "sample string 6",
      "IdPlano": "sample string 7",
      "ModoPag": "sample string 8",
      "Modulo": "sample string 9",
      "Moeda": "sample string 10",
      "NumDoc": 1,
      "NumPrestacao": 1,
      "NumTransferencia": 1,
      "Serie": "sample string 11",
      "TipoConta": "sample string 12",
      "TipoDoc": "sample string 13",
      "TipoEntidade": "sample string 14",
      "ValorPendente": 1.1,
      "ValorTotal": 1.1
    },
    {
      "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
      "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
      "EmModoEdicao": true,
      "Entidade": "sample string 2",
      "Estado": "sample string 3",
      "Filial": "sample string 4",
      "IdDocumento": "sample string 5",
      "IdHistorico": "sample string 6",
      "IdPlano": "sample string 7",
      "ModoPag": "sample string 8",
      "Modulo": "sample string 9",
      "Moeda": "sample string 10",
      "NumDoc": 1,
      "NumPrestacao": 1,
      "NumTransferencia": 1,
      "Serie": "sample string 11",
      "TipoConta": "sample string 12",
      "TipoDoc": "sample string 13",
      "TipoEntidade": "sample string 14",
      "ValorPendente": 1.1,
      "ValorTotal": 1.1
    }
  ],
  "EmModoEdicao": true,
  "Entidade": "sample string 2",
  "Id": "sample string 3",
  "Linhas": [
    {
      "CamposUtil": [
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        },
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        }
      ],
      "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
      "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
      "EmModoEdicao": true,
      "IdLinhaTesChq": "sample string 1",
      "IdPlano": "sample string 2",
      "Pendentes": [
        {
          "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
          "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
          "EmModoEdicao": true,
          "Entidade": "sample string 1",
          "Estado": "sample string 2",
          "Filial": "sample string 3",
          "IdDocumento": "sample string 4",
          "IdHistorico": "sample string 5",
          "IdPlano": "sample string 6",
          "ModoPag": "sample string 7",
          "Modulo": "sample string 8",
          "Moeda": "sample string 9",
          "NumDoc": 10,
          "NumPrestacao": 11,
          "NumPrestacaoAnt": 1,
          "NumTransferencia": 1,
          "NumTransferenciaAnt": 1,
          "Serie": "sample string 12",
          "TipoConta": "sample string 13",
          "TipoDoc": "sample string 14",
          "TipoEntidade": "sample string 15",
          "ValorPendente": 1.1,
          "ValorTotal": 1.1
        },
        {
          "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
          "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
          "EmModoEdicao": true,
          "Entidade": "sample string 1",
          "Estado": "sample string 2",
          "Filial": "sample string 3",
          "IdDocumento": "sample string 4",
          "IdHistorico": "sample string 5",
          "IdPlano": "sample string 6",
          "ModoPag": "sample string 7",
          "Modulo": "sample string 8",
          "Moeda": "sample string 9",
          "NumDoc": 10,
          "NumPrestacao": 11,
          "NumPrestacaoAnt": 1,
          "NumTransferencia": 1,
          "NumTransferenciaAnt": 1,
          "Serie": "sample string 12",
          "TipoConta": "sample string 13",
          "TipoDoc": "sample string 14",
          "TipoEntidade": "sample string 15",
          "ValorPendente": 1.1,
          "ValorTotal": 1.1
        }
      ],
      "ModoPag": "sample string 3",
      "NumeroChq": "sample string 4",
      "Valor": 1.1
    },
    {
      "CamposUtil": [
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        },
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        }
      ],
      "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
      "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
      "EmModoEdicao": true,
      "IdLinhaTesChq": "sample string 1",
      "IdPlano": "sample string 2",
      "Pendentes": [
        {
          "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
          "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
          "EmModoEdicao": true,
          "Entidade": "sample string 1",
          "Estado": "sample string 2",
          "Filial": "sample string 3",
          "IdDocumento": "sample string 4",
          "IdHistorico": "sample string 5",
          "IdPlano": "sample string 6",
          "ModoPag": "sample string 7",
          "Modulo": "sample string 8",
          "Moeda": "sample string 9",
          "NumDoc": 10,
          "NumPrestacao": 11,
          "NumPrestacaoAnt": 1,
          "NumTransferencia": 1,
          "NumTransferenciaAnt": 1,
          "Serie": "sample string 12",
          "TipoConta": "sample string 13",
          "TipoDoc": "sample string 14",
          "TipoEntidade": "sample string 15",
          "ValorPendente": 1.1,
          "ValorTotal": 1.1
        },
        {
          "DataPrevTes": "2026-04-04T13:13:08.9404123-01:00",
          "DataVenc": "2026-04-04T13:13:08.9404123-01:00",
          "EmModoEdicao": true,
          "Entidade": "sample string 1",
          "Estado": "sample string 2",
          "Filial": "sample string 3",
          "IdDocumento": "sample string 4",
          "IdHistorico": "sample string 5",
          "IdPlano": "sample string 6",
          "ModoPag": "sample string 7",
          "Modulo": "sample string 8",
          "Moeda": "sample string 9",
          "NumDoc": 10,
          "NumPrestacao": 11,
          "NumPrestacaoAnt": 1,
          "NumTransferencia": 1,
          "NumTransferenciaAnt": 1,
          "Serie": "sample string 12",
          "TipoConta": "sample string 13",
          "TipoDoc": "sample string 14",
          "TipoEntidade": "sample string 15",
          "ValorPendente": 1.1,
          "ValorTotal": 1.1
        }
      ],
      "ModoPag": "sample string 3",
      "NumeroChq": "sample string 4",
      "Valor": 1.1
    }
  ],
  "Moeda": "sample string 4",
  "NumPlano": 5,
  "Observacoes": "sample string 6",
  "TipoEntidade": "sample string 7",
  "Total": 1.1,
  "Utilizador": "sample string 8"
}

text/plain

Sample: 
{"CamposUtil":[{"Nome":"sample string 1","Valor":{},"Chave":true},{"Nome":"sample string 1","Valor":{},"Chave":true}],"DataUltimaActualizacao":"2026-04-04T13:13:08.9404123-01:00","Descricao":"sample string 1","Documentos":[{"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"Entidade":"sample string 2","Estado":"sample string 3","Filial":"sample string 4","IdDocumento":"sample string 5","IdHistorico":"sample string 6","IdPlano":"sample string 7","ModoPag":"sample string 8","Modulo":"sample string 9","Moeda":"sample string 10","NumDoc":1,"NumPrestacao":1,"NumTransferencia":1,"Serie":"sample string 11","TipoConta":"sample string 12","TipoDoc":"sample string 13","TipoEntidade":"sample string 14","ValorPendente":1.1,"ValorTotal":1.1},{"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"Entidade":"sample string 2","Estado":"sample string 3","Filial":"sample string 4","IdDocumento":"sample string 5","IdHistorico":"sample string 6","IdPlano":"sample string 7","ModoPag":"sample string 8","Modulo":"sample string 9","Moeda":"sample string 10","NumDoc":1,"NumPrestacao":1,"NumTransferencia":1,"Serie":"sample string 11","TipoConta":"sample string 12","TipoDoc":"sample string 13","TipoEntidade":"sample string 14","ValorPendente":1.1,"ValorTotal":1.1}],"EmModoEdicao":true,"Entidade":"sample string 2","Id":"sample string 3","Linhas":[{"CamposUtil":[{"Nome":"sample string 1","Valor":{},"Chave":true},{"Nome":"sample string 1","Valor":{},"Chave":true}],"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"IdLinhaTesChq":"sample string 1","IdPlano":"sample string 2","Pendentes":[{"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"Entidade":"sample string 1","Estado":"sample string 2","Filial":"sample string 3","IdDocumento":"sample string 4","IdHistorico":"sample string 5","IdPlano":"sample string 6","ModoPag":"sample string 7","Modulo":"sample string 8","Moeda":"sample string 9","NumDoc":10,"NumPrestacao":11,"NumPrestacaoAnt":1,"NumTransferencia":1,"NumTransferenciaAnt":1,"Serie":"sample string 12","TipoConta":"sample string 13","TipoDoc":"sample string 14","TipoEntidade":"sample string 15","ValorPendente":1.1,"ValorTotal":1.1},{"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"Entidade":"sample string 1","Estado":"sample string 2","Filial":"sample string 3","IdDocumento":"sample string 4","IdHistorico":"sample string 5","IdPlano":"sample string 6","ModoPag":"sample string 7","Modulo":"sample string 8","Moeda":"sample string 9","NumDoc":10,"NumPrestacao":11,"NumPrestacaoAnt":1,"NumTransferencia":1,"NumTransferenciaAnt":1,"Serie":"sample string 12","TipoConta":"sample string 13","TipoDoc":"sample string 14","TipoEntidade":"sample string 15","ValorPendente":1.1,"ValorTotal":1.1}],"ModoPag":"sample string 3","NumeroChq":"sample string 4","Valor":1.1},{"CamposUtil":[{"Nome":"sample string 1","Valor":{},"Chave":true},{"Nome":"sample string 1","Valor":{},"Chave":true}],"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"IdLinhaTesChq":"sample string 1","IdPlano":"sample string 2","Pendentes":[{"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"Entidade":"sample string 1","Estado":"sample string 2","Filial":"sample string 3","IdDocumento":"sample string 4","IdHistorico":"sample string 5","IdPlano":"sample string 6","ModoPag":"sample string 7","Modulo":"sample string 8","Moeda":"sample string 9","NumDoc":10,"NumPrestacao":11,"NumPrestacaoAnt":1,"NumTransferencia":1,"NumTransferenciaAnt":1,"Serie":"sample string 12","TipoConta":"sample string 13","TipoDoc":"sample string 14","TipoEntidade":"sample string 15","ValorPendente":1.1,"ValorTotal":1.1},{"DataPrevTes":"2026-04-04T13:13:08.9404123-01:00","DataVenc":"2026-04-04T13:13:08.9404123-01:00","EmModoEdicao":true,"Entidade":"sample string 1","Estado":"sample string 2","Filial":"sample string 3","IdDocumento":"sample string 4","IdHistorico":"sample string 5","IdPlano":"sample string 6","ModoPag":"sample string 7","Modulo":"sample string 8","Moeda":"sample string 9","NumDoc":10,"NumPrestacao":11,"NumPrestacaoAnt":1,"NumTransferencia":1,"NumTransferenciaAnt":1,"Serie":"sample string 12","TipoConta":"sample string 13","TipoDoc":"sample string 14","TipoEntidade":"sample string 15","ValorPendente":1.1,"ValorTotal":1.1}],"ModoPag":"sample string 3","NumeroChq":"sample string 4","Valor":1.1}],"Moeda":"sample string 4","NumPlano":5,"Observacoes":"sample string 6","TipoEntidade":"sample string 7","Total":1.1,"Utilizador":"sample string 8"}