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

Estorna um documento de compra.

Request Information

URI Parameters

Name	Description	Type	Additional information
IDContexto		string	Default value is

Body Parameters

Objeto do tipo com os dados do documento a estornar.

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.
PPS_ReferenciaExternaOrigem	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 7",
  "PPS_ReferenciaExternaOrigem": "sample string 7",
  "Motivo": "sample string 8",
  "Observacoes": "sample string 9",
  "DataDocumentoEstorno": "2026-05-30T13:13:18.0832247-01:00",
  "DataIntroducao": "2026-05-30T13:13:18.0832247-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 14",
  "SerieEstorno": "sample string 15"
}

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 7","PPS_ReferenciaExternaOrigem":"sample string 7","Motivo":"sample string 8","Observacoes":"sample string 9","DataDocumentoEstorno":"2026-05-30T13:13:18.0832247-01:00","DataIntroducao":"2026-05-30T13:13:18.0832247-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 14","SerieEstorno":"sample string 15"}

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

Retorna um objeto com: - Success (bool): indica se a operação foi bem-sucedida. - Error (BEError): detalhes em caso de erro. - Data : resultado da operação, se for bem-sucedida.

BEResult

Name	Type	Additional information
Success	boolean	None.
Error	BEError	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Error": {
    "Message": "sample string 1"
  },
  "Data": {}
}

text/plain

Sample:

{"Success":true,"Error":{"Message":"sample string 1"},"Data":{}}