GET v2/ExtratoPagamento?FECH_ID={FECH_ID}&corrId={corrId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FECH_ID

integer

Required

corrId

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

ExtratoPagamentoResponse
NameDescriptionTypeAdditional information
Item

ExtratoPagamentoItem

None.

CodigoResponse

integer

None.

MensagemResponse

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Item": {
    "Id": 1,
    "Data": "2025-01-09T05:48:05.3063604-03:00",
    "ValorComissao": 3.0,
    "ValorBonus": 4.0,
    "ValorAdicional": 5.0,
    "ValorDesconto": 6.0,
    "ValorTotal": 7.0,
    "Comissao": [
      {
        "Id": 1,
        "ClienteNome": "sample string 2",
        "BancoNome": "sample string 3",
        "Proposta": "sample string 4",
        "Produto": "sample string 5",
        "TipoConvenio": "sample string 6",
        "Data": "2025-01-09T05:48:05.3063604-03:00",
        "ValorBruto": 8.0,
        "ValorLiquido": 9.0,
        "ValorComissao": 10.0
      },
      {
        "Id": 1,
        "ClienteNome": "sample string 2",
        "BancoNome": "sample string 3",
        "Proposta": "sample string 4",
        "Produto": "sample string 5",
        "TipoConvenio": "sample string 6",
        "Data": "2025-01-09T05:48:05.3063604-03:00",
        "ValorBruto": 8.0,
        "ValorLiquido": 9.0,
        "ValorComissao": 10.0
      }
    ],
    "Adicional": [
      {
        "Id": 1,
        "Descricao": "sample string 2",
        "Valor": 3.0
      },
      {
        "Id": 1,
        "Descricao": "sample string 2",
        "Valor": 3.0
      }
    ],
    "Desconto": [
      {
        "Id": 1,
        "Descricao": "sample string 2",
        "Valor": 3.0
      },
      {
        "Id": 1,
        "Descricao": "sample string 2",
        "Valor": 3.0
      }
    ]
  },
  "CodigoResponse": 1,
  "MensagemResponse": "sample string 2"
}

application/xml, text/xml

Sample:
<ExtratoPagamentoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Service.Controllers.ServicosApiV2.ExtratoPagamento">
  <CodigoResponse xmlns="http://schemas.datacontract.org/2004/07/Service.Controllers.ServicosApiV2">1</CodigoResponse>
  <MensagemResponse xmlns="http://schemas.datacontract.org/2004/07/Service.Controllers.ServicosApiV2">sample string 2</MensagemResponse>
  <Item>
    <Adicional>
      <ExtratoPagamentoItemAdicional>
        <Descricao>sample string 2</Descricao>
        <Id>1</Id>
        <Valor>3</Valor>
      </ExtratoPagamentoItemAdicional>
      <ExtratoPagamentoItemAdicional>
        <Descricao>sample string 2</Descricao>
        <Id>1</Id>
        <Valor>3</Valor>
      </ExtratoPagamentoItemAdicional>
    </Adicional>
    <Comissao>
      <ExtratoPagamentoItemComissao>
        <BancoNome>sample string 3</BancoNome>
        <ClienteNome>sample string 2</ClienteNome>
        <Data>2025-01-09T05:48:05.3063604-03:00</Data>
        <Id>1</Id>
        <Produto>sample string 5</Produto>
        <Proposta>sample string 4</Proposta>
        <TipoConvenio>sample string 6</TipoConvenio>
        <ValorBruto>8</ValorBruto>
        <ValorComissao>10</ValorComissao>
        <ValorLiquido>9</ValorLiquido>
      </ExtratoPagamentoItemComissao>
      <ExtratoPagamentoItemComissao>
        <BancoNome>sample string 3</BancoNome>
        <ClienteNome>sample string 2</ClienteNome>
        <Data>2025-01-09T05:48:05.3063604-03:00</Data>
        <Id>1</Id>
        <Produto>sample string 5</Produto>
        <Proposta>sample string 4</Proposta>
        <TipoConvenio>sample string 6</TipoConvenio>
        <ValorBruto>8</ValorBruto>
        <ValorComissao>10</ValorComissao>
        <ValorLiquido>9</ValorLiquido>
      </ExtratoPagamentoItemComissao>
    </Comissao>
    <Data>2025-01-09T05:48:05.3063604-03:00</Data>
    <Desconto>
      <ExtratoPagamentoItemDesconto>
        <Descricao>sample string 2</Descricao>
        <Id>1</Id>
        <Valor>3</Valor>
      </ExtratoPagamentoItemDesconto>
      <ExtratoPagamentoItemDesconto>
        <Descricao>sample string 2</Descricao>
        <Id>1</Id>
        <Valor>3</Valor>
      </ExtratoPagamentoItemDesconto>
    </Desconto>
    <Id>1</Id>
    <ValorAdicional>5</ValorAdicional>
    <ValorBonus>4</ValorBonus>
    <ValorComissao>3</ValorComissao>
    <ValorDesconto>6</ValorDesconto>
    <ValorTotal>7</ValorTotal>
  </Item>
</ExtratoPagamentoResponse>

multipart/form-data

Sample:
<ExtratoPagamentoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Service.Controllers.ServicosApiV2.ExtratoPagamento"><CodigoResponse xmlns="http://schemas.datacontract.org/2004/07/Service.Controllers.ServicosApiV2">1</CodigoResponse><MensagemResponse xmlns="http://schemas.datacontract.org/2004/07/Service.Controllers.ServicosApiV2">sample string 2</MensagemResponse><Item><Adicional><ExtratoPagamentoItemAdicional><Descricao>sample string 2</Descricao><Id>1</Id><Valor>3</Valor></ExtratoPagamentoItemAdicional><ExtratoPagamentoItemAdicional><Descricao>sample string 2</Descricao><Id>1</Id><Valor>3</Valor></ExtratoPagamentoItemAdicional></Adicional><Comissao><ExtratoPagamentoItemComissao><BancoNome>sample string 3</BancoNome><ClienteNome>sample string 2</ClienteNome><Data>2025-01-09T05:48:05.3063604-03:00</Data><Id>1</Id><Produto>sample string 5</Produto><Proposta>sample string 4</Proposta><TipoConvenio>sample string 6</TipoConvenio><ValorBruto>8</ValorBruto><ValorComissao>10</ValorComissao><ValorLiquido>9</ValorLiquido></ExtratoPagamentoItemComissao><ExtratoPagamentoItemComissao><BancoNome>sample string 3</BancoNome><ClienteNome>sample string 2</ClienteNome><Data>2025-01-09T05:48:05.3063604-03:00</Data><Id>1</Id><Produto>sample string 5</Produto><Proposta>sample string 4</Proposta><TipoConvenio>sample string 6</TipoConvenio><ValorBruto>8</ValorBruto><ValorComissao>10</ValorComissao><ValorLiquido>9</ValorLiquido></ExtratoPagamentoItemComissao></Comissao><Data>2025-01-09T05:48:05.3063604-03:00</Data><Desconto><ExtratoPagamentoItemDesconto><Descricao>sample string 2</Descricao><Id>1</Id><Valor>3</Valor></ExtratoPagamentoItemDesconto><ExtratoPagamentoItemDesconto><Descricao>sample string 2</Descricao><Id>1</Id><Valor>3</Valor></ExtratoPagamentoItemDesconto></Desconto><Id>1</Id><ValorAdicional>5</ValorAdicional><ValorBonus>4</ValorBonus><ValorComissao>3</ValorComissao><ValorDesconto>6</ValorDesconto><ValorTotal>7</ValorTotal></Item></ExtratoPagamentoResponse>