POST api/Saldo/ConsultarExtrato

Consultar extrato de SimCard

Request Information

URI Parameters

None.

Body Parameters

Dados para a consulta

ConsultarExtrato
NameDescriptionTypeAdditional information
metodo

Método a ser invocado (Opcional)

string

None.

token

Token de acesso Americanet

string

None.

tempo_vida

Tempo de vida do token

string

None.

token2

token de acesso a esta Api

string

None.

idoperador

Código do operador/colaborador

integer

None.

data_inicial

Data inicial no formato AAAAMMDD

string

None.

data_final

Data final no formato AAAAMMDD

string

None.

Numero_contrato

Número do contrato do assinante junto a AmericaNet

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "metodo": "sample string 1",
  "token": "sample string 2",
  "tempo_vida": "sample string 3",
  "token2": "sample string 4",
  "idoperador": 5,
  "data_inicial": "sample string 6",
  "data_final": "sample string 7",
  "Numero_contrato": 8
}

application/xml, text/xml

Sample:
<SaldoModel.ConsultarExtrato xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/mvno">
  <Numero_contrato>8</Numero_contrato>
  <data_final>sample string 7</data_final>
  <data_inicial>sample string 6</data_inicial>
  <idoperador>5</idoperador>
  <metodo>sample string 1</metodo>
  <tempo_vida>sample string 3</tempo_vida>
  <token>sample string 2</token>
  <token2>sample string 4</token2>
</SaldoModel.ConsultarExtrato>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ConsultarExtratoRetorno
NameDescriptionTypeAdditional information
retorno

Código e mensagem de retorno do servidor. 0=Sucesso

ExtratoMensagemRetorno

None.

extrato

Extrato do consumo

Collection of ExtratoDetalhes

None.

token

Token de acesso, caso seja renovado

string

None.

tempo_vida

Tempo de vida do token

string

None.

Response Formats

application/json, text/json

Sample:
{
  "retorno": {
    "codigo": 1,
    "mensagem": "sample string 2",
    "Saldo_Gb": 3.1,
    "PlanoAtual_Gb": 4.1
  },
  "extrato": [
    {
      "Data": "sample string 1",
      "Numero_SimCard": "sample string 2",
      "Consumo_Segundos": 3,
      "Valor_Ligacoes": "sample string 4",
      "Consumo_Sms": 5,
      "Valor_Sms": "sample string 6",
      "Consumo_Dados": 7.1,
      "Valor_Dados": "sample string 8",
      "movel": [
        {
          "Seq_Arquivo_Conteudo": "sample string 1",
          "Hora": "sample string 2",
          "Nro_Destino": "sample string 3",
          "Consumo_Segundos": 4,
          "Valor_Ligacoes_Unitario": "sample string 5"
        },
        {
          "Seq_Arquivo_Conteudo": "sample string 1",
          "Hora": "sample string 2",
          "Nro_Destino": "sample string 3",
          "Consumo_Segundos": 4,
          "Valor_Ligacoes_Unitario": "sample string 5"
        }
      ]
    },
    {
      "Data": "sample string 1",
      "Numero_SimCard": "sample string 2",
      "Consumo_Segundos": 3,
      "Valor_Ligacoes": "sample string 4",
      "Consumo_Sms": 5,
      "Valor_Sms": "sample string 6",
      "Consumo_Dados": 7.1,
      "Valor_Dados": "sample string 8",
      "movel": [
        {
          "Seq_Arquivo_Conteudo": "sample string 1",
          "Hora": "sample string 2",
          "Nro_Destino": "sample string 3",
          "Consumo_Segundos": 4,
          "Valor_Ligacoes_Unitario": "sample string 5"
        },
        {
          "Seq_Arquivo_Conteudo": "sample string 1",
          "Hora": "sample string 2",
          "Nro_Destino": "sample string 3",
          "Consumo_Segundos": 4,
          "Valor_Ligacoes_Unitario": "sample string 5"
        }
      ]
    }
  ],
  "token": "sample string 1",
  "tempo_vida": "sample string 2"
}

application/xml, text/xml

Sample:
<SaldoModel.ConsultarExtratoRetorno xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/mvno">
  <extrato>
    <SaldoModel.ExtratoDetalhes>
      <Consumo_Dados>7.1</Consumo_Dados>
      <Consumo_Segundos>3</Consumo_Segundos>
      <Consumo_Sms>5</Consumo_Sms>
      <Data>sample string 1</Data>
      <Numero_SimCard>sample string 2</Numero_SimCard>
      <Valor_Dados>sample string 8</Valor_Dados>
      <Valor_Ligacoes>sample string 4</Valor_Ligacoes>
      <Valor_Sms>sample string 6</Valor_Sms>
      <movel>
        <SaldoModel.ExtratoMovel>
          <Consumo_Segundos>4</Consumo_Segundos>
          <Hora>sample string 2</Hora>
          <Nro_Destino>sample string 3</Nro_Destino>
          <Seq_Arquivo_Conteudo>sample string 1</Seq_Arquivo_Conteudo>
          <Valor_Ligacoes_Unitario>sample string 5</Valor_Ligacoes_Unitario>
        </SaldoModel.ExtratoMovel>
        <SaldoModel.ExtratoMovel>
          <Consumo_Segundos>4</Consumo_Segundos>
          <Hora>sample string 2</Hora>
          <Nro_Destino>sample string 3</Nro_Destino>
          <Seq_Arquivo_Conteudo>sample string 1</Seq_Arquivo_Conteudo>
          <Valor_Ligacoes_Unitario>sample string 5</Valor_Ligacoes_Unitario>
        </SaldoModel.ExtratoMovel>
      </movel>
    </SaldoModel.ExtratoDetalhes>
    <SaldoModel.ExtratoDetalhes>
      <Consumo_Dados>7.1</Consumo_Dados>
      <Consumo_Segundos>3</Consumo_Segundos>
      <Consumo_Sms>5</Consumo_Sms>
      <Data>sample string 1</Data>
      <Numero_SimCard>sample string 2</Numero_SimCard>
      <Valor_Dados>sample string 8</Valor_Dados>
      <Valor_Ligacoes>sample string 4</Valor_Ligacoes>
      <Valor_Sms>sample string 6</Valor_Sms>
      <movel>
        <SaldoModel.ExtratoMovel>
          <Consumo_Segundos>4</Consumo_Segundos>
          <Hora>sample string 2</Hora>
          <Nro_Destino>sample string 3</Nro_Destino>
          <Seq_Arquivo_Conteudo>sample string 1</Seq_Arquivo_Conteudo>
          <Valor_Ligacoes_Unitario>sample string 5</Valor_Ligacoes_Unitario>
        </SaldoModel.ExtratoMovel>
        <SaldoModel.ExtratoMovel>
          <Consumo_Segundos>4</Consumo_Segundos>
          <Hora>sample string 2</Hora>
          <Nro_Destino>sample string 3</Nro_Destino>
          <Seq_Arquivo_Conteudo>sample string 1</Seq_Arquivo_Conteudo>
          <Valor_Ligacoes_Unitario>sample string 5</Valor_Ligacoes_Unitario>
        </SaldoModel.ExtratoMovel>
      </movel>
    </SaldoModel.ExtratoDetalhes>
  </extrato>
  <retorno>
    <PlanoAtual_Gb>4.1</PlanoAtual_Gb>
    <Saldo_Gb>3.1</Saldo_Gb>
    <codigo>1</codigo>
    <mensagem>sample string 2</mensagem>
  </retorno>
  <tempo_vida>sample string 2</tempo_vida>
  <token>sample string 1</token>
</SaldoModel.ConsultarExtratoRetorno>