POST api/Contrato/RenovaContrato?IDContexto={IDContexto}

Renovar Contrato PRIMAVERA

Request Information

URI Parameters

NameDescriptionTypeAdditional information
IDContexto

string

Default value is

Body Parameters

Cliente

BERenovacaoContrato
NameDescriptionTypeAdditional information
ID

Identificador do contrato.

 string

None.
NovaDataInicio

Identifica a data de início do Novo período.

 date

None.
NovaDataFim

Identifica a data de Fim do Novo período.

 date

None.
NovoEstado

Identifica do Novo Estado do Contrato.

 PCM_EstadoContrato

None.
NovoTipoDocumento

Identifica o Novo Tipo de contrato.

 string

None.
NovaSerie

Identifica a Nova Serie.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ID": "sample string 1",
  "NovaDataInicio": "2026-04-04T13:12:40.9401951-01:00",
  "NovaDataFim": "2026-04-04T13:12:40.9401951-01:00",
  "NovoEstado": 0,
  "NovoTipoDocumento": "sample string 4",
  "NovaSerie": "sample string 5"
}

text/plain

Sample: 
{"ID":"sample string 1","NovaDataInicio":"2026-04-04T13:12:40.9401951-01:00","NovaDataFim":"2026-04-04T13:12:40.9401951-01:00","NovoEstado":0,"NovoTipoDocumento":"sample string 4","NovaSerie":"sample string 5"}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BERenovacaoContrato'.

Response Information

Resource Description

Identificador da Renovação do Contrato

BEResultado
NameDescriptionTypeAdditional information
ID

Identificador.

 string

None.
ChaveLogica

Chave Lógica.

 string

None.
IDCBL

Identificador CBL.

 string

None.
DocumentoCBL

Nº Documento CBL.

 string

None.
IDTesouraia

Identificador Tesouraria.

 string

None.
DocumentoTesouraria

Nº Documento CBL.

 string

None.
Mensagem

Mensagem.

 string

None.
Data

Objeto Data retorno

 Object

None.

Response Formats

application/json, text/json

Sample: 
{
  "ID": "sample string 1",
  "ChaveLogica": "sample string 2",
  "IDCBL": "sample string 3",
  "DocumentoCBL": "sample string 4",
  "IDTesouraia": "sample string 5",
  "DocumentoTesouraria": "sample string 6",
  "Mensagem": "sample string 7",
  "Data": {}
}

text/plain

Sample: 
{"ID":"sample string 1","ChaveLogica":"sample string 2","IDCBL":"sample string 3","DocumentoCBL":"sample string 4","IDTesouraia":"sample string 5","DocumentoTesouraria":"sample string 6","Mensagem":"sample string 7","Data":{}}