POST api/v1/comissao/consulta

Deve pesquisar os dados de comissão através dos dados de busca informados. Essa chamada ou retorna o filtro (De, Ate, Status) ou o Id do Pedido no request, e o código deve tratar ambos os casos de forma distinta.

Request Information

URI Parameters

None.

Body Parameters

ComissaoPesquisaRequest

Name	Type	Additional information
cnpj	string	None.
inicio	string	None.
fim	string	None.
statusId	integer	None.
pedido	integer	None.
RevendaId	integer	None.
DataInicial	date	None.
DataFinal	date	None.
Status	TipoStatusComissao	None.
PedidoErpId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "cnpj": "sample string 1",
  "inicio": "sample string 2",
  "fim": "sample string 3",
  "statusId": 4,
  "pedido": 1,
  "revendaId": 5,
  "dataInicial": "2025-12-12T18:13:40.966904-03:00",
  "dataFinal": "2025-12-12T18:13:40.966904-03:00",
  "status": 0,
  "pedidoErpId": "sample string 6"
}

application/xml, text/xml

Sample:

<ComissaoPesquisaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2B.Integration.GenericIntegration.Contracts.Comissao">
  <DataFinal>2025-12-12T18:13:40.966904-03:00</DataFinal>
  <DataInicial>2025-12-12T18:13:40.966904-03:00</DataInicial>
  <PedidoErpId>sample string 6</PedidoErpId>
  <RevendaId>5</RevendaId>
  <Status>Todos</Status>
  <cnpj>sample string 1</cnpj>
  <fim>sample string 3</fim>
  <inicio>sample string 2</inicio>
  <pedido>1</pedido>
  <statusId>4</statusId>
</ComissaoPesquisaRequest>

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

Response Information

Resource Description

ComissaoResultadosResponse

Name	Description	Type	Additional information
Detalhes		Collection of ComissaoDetalheResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "detalhes": [
    {
      "pedidoErpId": "sample string 1",
      "pedidoId": 2,
      "revendaId": 1,
      "numeroDaNotaFiscal": "sample string 3",
      "numeroDaNotaFiscalDaRevenda": "sample string 4",
      "dataVencimento": "2025-12-12T18:13:40.966904-03:00",
      "dataPedido": "2025-12-12T18:13:40.966904-03:00",
      "dataHotaNotaFiscal": "2025-12-12T18:13:40.966904-03:00",
      "razaoSocial": "sample string 8",
      "status": 0,
      "valorNotaFiscal": 9.0,
      "valorComissao": 10.0,
      "itens": [
        {
          "partNumber": "sample string 1",
          "quantidade": 2,
          "valorComissao": 3.0
        },
        {
          "partNumber": "sample string 1",
          "quantidade": 2,
          "valorComissao": 3.0
        }
      ]
    },
    {
      "pedidoErpId": "sample string 1",
      "pedidoId": 2,
      "revendaId": 1,
      "numeroDaNotaFiscal": "sample string 3",
      "numeroDaNotaFiscalDaRevenda": "sample string 4",
      "dataVencimento": "2025-12-12T18:13:40.966904-03:00",
      "dataPedido": "2025-12-12T18:13:40.966904-03:00",
      "dataHotaNotaFiscal": "2025-12-12T18:13:40.966904-03:00",
      "razaoSocial": "sample string 8",
      "status": 0,
      "valorNotaFiscal": 9.0,
      "valorComissao": 10.0,
      "itens": [
        {
          "partNumber": "sample string 1",
          "quantidade": 2,
          "valorComissao": 3.0
        },
        {
          "partNumber": "sample string 1",
          "quantidade": 2,
          "valorComissao": 3.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ComissaoResultadosResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/B2B.Integration.GenericIntegration.Contracts.Comissao">
  <Detalhes>
    <ComissaoDetalheResponse>
      <DataHotaNotaFiscal>2025-12-12T18:13:40.966904-03:00</DataHotaNotaFiscal>
      <DataPedido>2025-12-12T18:13:40.966904-03:00</DataPedido>
      <DataVencimento>2025-12-12T18:13:40.966904-03:00</DataVencimento>
      <Itens>
        <ComissaoDetalheItemResponse>
          <PartNumber>sample string 1</PartNumber>
          <Quantidade>2</Quantidade>
          <ValorComissao>3</ValorComissao>
        </ComissaoDetalheItemResponse>
        <ComissaoDetalheItemResponse>
          <PartNumber>sample string 1</PartNumber>
          <Quantidade>2</Quantidade>
          <ValorComissao>3</ValorComissao>
        </ComissaoDetalheItemResponse>
      </Itens>
      <NumeroDaNotaFiscal>sample string 3</NumeroDaNotaFiscal>
      <NumeroDaNotaFiscalDaRevenda>sample string 4</NumeroDaNotaFiscalDaRevenda>
      <PedidoErpId>sample string 1</PedidoErpId>
      <PedidoId>2</PedidoId>
      <RazaoSocial>sample string 8</RazaoSocial>
      <RevendaId>1</RevendaId>
      <Status>Todos</Status>
      <ValorComissao>10</ValorComissao>
      <ValorNotaFiscal>9</ValorNotaFiscal>
    </ComissaoDetalheResponse>
    <ComissaoDetalheResponse>
      <DataHotaNotaFiscal>2025-12-12T18:13:40.966904-03:00</DataHotaNotaFiscal>
      <DataPedido>2025-12-12T18:13:40.966904-03:00</DataPedido>
      <DataVencimento>2025-12-12T18:13:40.966904-03:00</DataVencimento>
      <Itens>
        <ComissaoDetalheItemResponse>
          <PartNumber>sample string 1</PartNumber>
          <Quantidade>2</Quantidade>
          <ValorComissao>3</ValorComissao>
        </ComissaoDetalheItemResponse>
        <ComissaoDetalheItemResponse>
          <PartNumber>sample string 1</PartNumber>
          <Quantidade>2</Quantidade>
          <ValorComissao>3</ValorComissao>
        </ComissaoDetalheItemResponse>
      </Itens>
      <NumeroDaNotaFiscal>sample string 3</NumeroDaNotaFiscal>
      <NumeroDaNotaFiscalDaRevenda>sample string 4</NumeroDaNotaFiscalDaRevenda>
      <PedidoErpId>sample string 1</PedidoErpId>
      <PedidoId>2</PedidoId>
      <RazaoSocial>sample string 8</RazaoSocial>
      <RevendaId>1</RevendaId>
      <Status>Todos</Status>
      <ValorComissao>10</ValorComissao>
      <ValorNotaFiscal>9</ValorNotaFiscal>
    </ComissaoDetalheResponse>
  </Detalhes>
</ComissaoResultadosResponse>