POST api/DocumentosCompra/EstornaDocumento?IDContexto={IDContexto}

Estorna Documento de Compra.

Request Information

URI Parameters

Name	Description	Type	Additional information
IDContexto		string	Default value is

Body Parameters

Business Entity Object: Estorno.

BEEstorno

Name	Description	Type	Additional information
IDDocumentoOrigem	IDentificador Documento Origem.	string	None.
FilialOrigem	Filial Origem.	string	None.
TipoDocOrigem	Tipo Documento Origem.	string	None.
SerieOrigem	Serie Origem.	string	None.
NumDocOrigem	Nº Documento Origem.	integer	None.
PPS_ReferenciaExtrnaOrigem	Referência Externa Documento Origem.	string	None.
Motivo	Motivo de Estorno.	string	None.
Observacoes	Observações.	string	None.
DataDocumentoEstorno	Data Documento Estorno.	date	None.
DataIntroducao	Data Introdução.	date	None.
Linhas	Linhas a Estornar (Se Estorno Parcial).	Collection of BEEstornoLinha	None.
CamposUtil	Campos do Utilizador.	Collection of BECampo	None.
PPS_IgnoraIntegracaoCBL	PPS: Ignora Integração na Contabilidade. Por defeito o valor vem a false	boolean	None.
PPS_RequerIntegracaoCBL	PPS: Requer Integração na Contabilidade. Por defeito o valor vem a true	boolean	None.
DocumentoEstorno	Documento do Estorno quando diferente do configurado no ERP	string	None.
SerieEstorno	Serie do Estorno quando diferente do configurado no ERP	string	None.

Request Formats

application/json, text/json

Sample:

{
  "IDDocumentoOrigem": "sample string 1",
  "FilialOrigem": "sample string 2",
  "TipoDocOrigem": "sample string 3",
  "SerieOrigem": "sample string 4",
  "NumDocOrigem": 5,
  "PPS_ReferenciaExtrnaOrigem": "sample string 6",
  "Motivo": "sample string 7",
  "Observacoes": "sample string 8",
  "DataDocumentoEstorno": "2026-04-04T13:11:18.7521322-01:00",
  "DataIntroducao": "2026-04-04T13:11:18.7521322-01:00",
  "Linhas": [
    {
      "IDLinhaOrig": "sample string 1",
      "NumLinhaOrig": 2,
      "Quantidade": 3.1,
      "Valor": 4.0,
      "Motivo": "sample string 5",
      "Observacoes": "sample string 6",
      "CamposUtil": [
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        },
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        }
      ]
    },
    {
      "IDLinhaOrig": "sample string 1",
      "NumLinhaOrig": 2,
      "Quantidade": 3.1,
      "Valor": 4.0,
      "Motivo": "sample string 5",
      "Observacoes": "sample string 6",
      "CamposUtil": [
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        },
        {
          "Nome": "sample string 1",
          "Valor": {},
          "Chave": true
        }
      ]
    }
  ],
  "CamposUtil": [
    {
      "Nome": "sample string 1",
      "Valor": {},
      "Chave": true
    },
    {
      "Nome": "sample string 1",
      "Valor": {},
      "Chave": true
    }
  ],
  "PPS_IgnoraIntegracaoCBL": true,
  "PPS_RequerIntegracaoCBL": true,
  "DocumentoEstorno": "sample string 13",
  "SerieEstorno": "sample string 14"
}

text/plain

Sample:

{"IDDocumentoOrigem":"sample string 1","FilialOrigem":"sample string 2","TipoDocOrigem":"sample string 3","SerieOrigem":"sample string 4","NumDocOrigem":5,"PPS_ReferenciaExtrnaOrigem":"sample string 6","Motivo":"sample string 7","Observacoes":"sample string 8","DataDocumentoEstorno":"2026-04-04T13:11:18.7521322-01:00","DataIntroducao":"2026-04-04T13:11:18.7521322-01:00","Linhas":[{"IDLinhaOrig":"sample string 1","NumLinhaOrig":2,"Quantidade":3.1,"Valor":4.0,"Motivo":"sample string 5","Observacoes":"sample string 6","CamposUtil":[{"Nome":"sample string 1","Valor":{},"Chave":true},{"Nome":"sample string 1","Valor":{},"Chave":true}]},{"IDLinhaOrig":"sample string 1","NumLinhaOrig":2,"Quantidade":3.1,"Valor":4.0,"Motivo":"sample string 5","Observacoes":"sample string 6","CamposUtil":[{"Nome":"sample string 1","Valor":{},"Chave":true},{"Nome":"sample string 1","Valor":{},"Chave":true}]}],"CamposUtil":[{"Nome":"sample string 1","Valor":{},"Chave":true},{"Nome":"sample string 1","Valor":{},"Chave":true}],"PPS_IgnoraIntegracaoCBL":true,"PPS_RequerIntegracaoCBL":true,"DocumentoEstorno":"sample string 13","SerieEstorno":"sample string 14"}

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 'BEEstorno'.

Response Information

Resource Description

Verdadeiro/Falso

BEResultado

Name	Description	Type	Additional 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":{}}