POST api/Venda/GerarDevolucaoCupom

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
Obs	string	None.
CodigoVendedor	string	None.
IDPropriedade	integer	None.
CodigoTabelaJuros	integer	None.
TrocaMercadoria	integer	None.
DataEmissao	date	None.
DataEntrada	date	None.
DataInclusao	date	None.
UsuarioInclusao	string	None.
CodigoFilial	string	None.
CodigoCondicaoPagamento	string	None.
CodigoFormaPagamento	string	None.
CodigoOperacao	string	None.
CodigoDeposito	string	None.
CodigoPessoa	string	None.
UFCliente	string	None.
CodigoOperacaoDescricao	string	None.
ComplementoCliente	string	None.
Complemento	string	None.
Frete	decimal number	None.
IncricaoEstadualCliente	string	None.
IncricaoEstadual	string	None.
NomeRazaoSocialCliente	string	None.
NomeRazaoSocial	string	None.
ObsAdicional	string	None.
Serie	string	None.
Status	integer	None.
TipoNota	string	None.
Transacao	string	None.
NumeroNota	string	None.
Itens	Collection of DevolucaoCupomItemDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Obs": "sample string 2",
  "CodigoVendedor": "sample string 3",
  "IDPropriedade": 4,
  "CodigoTabelaJuros": 5,
  "TrocaMercadoria": 6,
  "DataEmissao": "2026-03-11T18:47:45.9283029-03:00",
  "DataEntrada": "2026-03-11T18:47:45.9283029-03:00",
  "DataInclusao": "2026-03-11T18:47:45.9283029-03:00",
  "UsuarioInclusao": "sample string 10",
  "CodigoFilial": "sample string 11",
  "CodigoCondicaoPagamento": "sample string 12",
  "CodigoFormaPagamento": "sample string 13",
  "CodigoOperacao": "sample string 14",
  "CodigoDeposito": "sample string 15",
  "CodigoPessoa": "sample string 16",
  "UFCliente": "sample string 17",
  "CodigoOperacaoDescricao": "sample string 18",
  "ComplementoCliente": "sample string 19",
  "Complemento": "sample string 20",
  "Frete": 21.0,
  "IncricaoEstadualCliente": "sample string 22",
  "IncricaoEstadual": "sample string 23",
  "NomeRazaoSocialCliente": "sample string 24",
  "NomeRazaoSocial": "sample string 25",
  "ObsAdicional": "sample string 26",
  "Serie": "sample string 27",
  "Status": 28,
  "TipoNota": "sample string 29",
  "Transacao": "sample string 30",
  "NumeroNota": "sample string 31",
  "Itens": [
    {
      "ID": 1,
      "IDNota": 2,
      "CodigoOperacao": "sample string 3",
      "Quantidade": 4.0,
      "UnidadeMedida": "sample string 5",
      "UnidadeMedidaEstoque": "sample string 6",
      "ValorItem": 7.0,
      "ValorTotalItem": 8.0,
      "TaxaDesconto": 9.0,
      "ValorDesconto": 10.0,
      "ValorMovimentoEstoque": 11.0,
      "IDOrigemDevolucao": 12,
      "IDOrigemNFDevolucao": 13
    },
    {
      "ID": 1,
      "IDNota": 2,
      "CodigoOperacao": "sample string 3",
      "Quantidade": 4.0,
      "UnidadeMedida": "sample string 5",
      "UnidadeMedidaEstoque": "sample string 6",
      "ValorItem": 7.0,
      "ValorTotalItem": 8.0,
      "TaxaDesconto": 9.0,
      "ValorDesconto": 10.0,
      "ValorMovimentoEstoque": 11.0,
      "IDOrigemDevolucao": 12,
      "IDOrigemNFDevolucao": 13
    }
  ]
}

application/xml, text/xml

Sample:

<DevolucaoCupomDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BRdata.Objetos.Servico.PDV">
  <CodigoCondicaoPagamento>sample string 12</CodigoCondicaoPagamento>
  <CodigoDeposito>sample string 15</CodigoDeposito>
  <CodigoFilial>sample string 11</CodigoFilial>
  <CodigoFormaPagamento>sample string 13</CodigoFormaPagamento>
  <CodigoOperacao>sample string 14</CodigoOperacao>
  <CodigoOperacaoDescricao>sample string 18</CodigoOperacaoDescricao>
  <CodigoPessoa>sample string 16</CodigoPessoa>
  <CodigoTabelaJuros>5</CodigoTabelaJuros>
  <CodigoVendedor>sample string 3</CodigoVendedor>
  <Complemento>sample string 20</Complemento>
  <ComplementoCliente>sample string 19</ComplementoCliente>
  <DataEmissao>2026-03-11T18:47:45.9283029-03:00</DataEmissao>
  <DataEntrada>2026-03-11T18:47:45.9283029-03:00</DataEntrada>
  <DataInclusao>2026-03-11T18:47:45.9283029-03:00</DataInclusao>
  <Frete>21</Frete>
  <ID>1</ID>
  <IDPropriedade>4</IDPropriedade>
  <IncricaoEstadual>sample string 23</IncricaoEstadual>
  <IncricaoEstadualCliente>sample string 22</IncricaoEstadualCliente>
  <Itens>
    <DevolucaoCupomItemDTO>
      <CodigoOperacao>sample string 3</CodigoOperacao>
      <ID>1</ID>
      <IDNota>2</IDNota>
      <IDOrigemDevolucao>12</IDOrigemDevolucao>
      <IDOrigemNFDevolucao>13</IDOrigemNFDevolucao>
      <Quantidade>4</Quantidade>
      <TaxaDesconto>9</TaxaDesconto>
      <UnidadeMedida>sample string 5</UnidadeMedida>
      <UnidadeMedidaEstoque>sample string 6</UnidadeMedidaEstoque>
      <ValorDesconto>10</ValorDesconto>
      <ValorItem>7</ValorItem>
      <ValorMovimentoEstoque>11</ValorMovimentoEstoque>
      <ValorTotalItem>8</ValorTotalItem>
    </DevolucaoCupomItemDTO>
    <DevolucaoCupomItemDTO>
      <CodigoOperacao>sample string 3</CodigoOperacao>
      <ID>1</ID>
      <IDNota>2</IDNota>
      <IDOrigemDevolucao>12</IDOrigemDevolucao>
      <IDOrigemNFDevolucao>13</IDOrigemNFDevolucao>
      <Quantidade>4</Quantidade>
      <TaxaDesconto>9</TaxaDesconto>
      <UnidadeMedida>sample string 5</UnidadeMedida>
      <UnidadeMedidaEstoque>sample string 6</UnidadeMedidaEstoque>
      <ValorDesconto>10</ValorDesconto>
      <ValorItem>7</ValorItem>
      <ValorMovimentoEstoque>11</ValorMovimentoEstoque>
      <ValorTotalItem>8</ValorTotalItem>
    </DevolucaoCupomItemDTO>
  </Itens>
  <NomeRazaoSocial>sample string 25</NomeRazaoSocial>
  <NomeRazaoSocialCliente>sample string 24</NomeRazaoSocialCliente>
  <NumeroNota>sample string 31</NumeroNota>
  <Obs>sample string 2</Obs>
  <ObsAdicional>sample string 26</ObsAdicional>
  <Serie>sample string 27</Serie>
  <Status>28</Status>
  <TipoNota>sample string 29</TipoNota>
  <Transacao>sample string 30</Transacao>
  <TrocaMercadoria>6</TrocaMercadoria>
  <UFCliente>sample string 17</UFCliente>
  <UsuarioInclusao>sample string 10</UsuarioInclusao>
</DevolucaoCupomDTO>

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

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>