GET api/v1/larcard/extrato/larcard?data={data}

Get larcard extract

Request Information

URI Parameters

NameDescriptionTypeAdditional information
data

Date for consultation of extracts. Format: {2019-01-01} Max: {Last 12 Months} Empty: {Last 2 Months}

date

None.

Requires Authorization!

Roles: larcard-base

Body Parameters

None.

Response Information

Resource Description

ResultOfExtratoLarcardDto
NameDescriptionTypeAdditional information
Data

ExtratoLarcardDto

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Data": "2025-04-29T12:06:24.9164259-03:00",
    "DataBase": "2025-04-29T12:06:24.9164259-03:00",
    "DataVencimento": "2025-04-29T12:06:24.9164259-03:00",
    "DebitoFuturo": 1.0,
    "DebitoTotal": 2.0,
    "Limite": 3.0,
    "LimiteDisponivel": 4.0,
    "LimiteDisponivelEmConta": 5.0,
    "Local": 1,
    "Matricula": 1,
    "Notificacao": "sample string 6",
    "NomeCompleto": "sample string 7",
    "SaldoAtual": 8.0,
    "TipoConsulta": "sample string 9",
    "TitulosAVencer": 10.0,
    "TitulosVencidos": 11.0,
    "Transacoes": [
      {
        "DataLancamento": "2025-04-29T12:06:24.9164259-03:00",
        "DataMovimento": "2025-04-29T12:06:24.9164259-03:00",
        "DataTransacao": "2025-04-29T12:06:24.9164259-03:00",
        "Historico": "sample string 1",
        "LocalCompra": 1,
        "NomeFilial": "sample string 2",
        "NumeroDocumento": 1,
        "TipoTransacao": "sample string 3",
        "Valor": 4.0,
        "Saldo": 5.0,
        "TipoSaldo": "sample string 6"
      },
      {
        "DataLancamento": "2025-04-29T12:06:24.9164259-03:00",
        "DataMovimento": "2025-04-29T12:06:24.9164259-03:00",
        "DataTransacao": "2025-04-29T12:06:24.9164259-03:00",
        "Historico": "sample string 1",
        "LocalCompra": 1,
        "NomeFilial": "sample string 2",
        "NumeroDocumento": 1,
        "TipoTransacao": "sample string 3",
        "Valor": 4.0,
        "Saldo": 5.0,
        "TipoSaldo": "sample string 6"
      }
    ]
  },
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<ResultOfExtratoLarcardDtoczfjpqNT xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lar.Entities.Ep">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Lar.SicopPlus.Entities.Sicop.Dto.Financeiro">
    <d2p1:Data>2025-04-29T12:06:24.9164259-03:00</d2p1:Data>
    <d2p1:DataBase>2025-04-29T12:06:24.9164259-03:00</d2p1:DataBase>
    <d2p1:DataVencimento>2025-04-29T12:06:24.9164259-03:00</d2p1:DataVencimento>
    <d2p1:DebitoFuturo>1</d2p1:DebitoFuturo>
    <d2p1:DebitoTotal>2</d2p1:DebitoTotal>
    <d2p1:Limite>3</d2p1:Limite>
    <d2p1:LimiteDisponivel>4</d2p1:LimiteDisponivel>
    <d2p1:LimiteDisponivelEmConta>5</d2p1:LimiteDisponivelEmConta>
    <d2p1:Local>1</d2p1:Local>
    <d2p1:Matricula>1</d2p1:Matricula>
    <d2p1:NomeCompleto>sample string 7</d2p1:NomeCompleto>
    <d2p1:Notificacao>sample string 6</d2p1:Notificacao>
    <d2p1:SaldoAtual>8</d2p1:SaldoAtual>
    <d2p1:TipoConsulta>sample string 9</d2p1:TipoConsulta>
    <d2p1:TitulosAVencer>10</d2p1:TitulosAVencer>
    <d2p1:TitulosVencidos>11</d2p1:TitulosVencidos>
    <d2p1:Transacoes>
      <d2p1:ExtratoLarcardDetalheDto>
        <d2p1:DataLancamento>2025-04-29T12:06:24.9164259-03:00</d2p1:DataLancamento>
        <d2p1:DataMovimento>2025-04-29T12:06:24.9164259-03:00</d2p1:DataMovimento>
        <d2p1:DataTransacao>2025-04-29T12:06:24.9164259-03:00</d2p1:DataTransacao>
        <d2p1:Historico>sample string 1</d2p1:Historico>
        <d2p1:LocalCompra>1</d2p1:LocalCompra>
        <d2p1:NomeFilial>sample string 2</d2p1:NomeFilial>
        <d2p1:NumeroDocumento>1</d2p1:NumeroDocumento>
        <d2p1:Saldo>5</d2p1:Saldo>
        <d2p1:TipoSaldo>sample string 6</d2p1:TipoSaldo>
        <d2p1:TipoTransacao>sample string 3</d2p1:TipoTransacao>
        <d2p1:Valor>4</d2p1:Valor>
      </d2p1:ExtratoLarcardDetalheDto>
      <d2p1:ExtratoLarcardDetalheDto>
        <d2p1:DataLancamento>2025-04-29T12:06:24.9164259-03:00</d2p1:DataLancamento>
        <d2p1:DataMovimento>2025-04-29T12:06:24.9164259-03:00</d2p1:DataMovimento>
        <d2p1:DataTransacao>2025-04-29T12:06:24.9164259-03:00</d2p1:DataTransacao>
        <d2p1:Historico>sample string 1</d2p1:Historico>
        <d2p1:LocalCompra>1</d2p1:LocalCompra>
        <d2p1:NomeFilial>sample string 2</d2p1:NomeFilial>
        <d2p1:NumeroDocumento>1</d2p1:NumeroDocumento>
        <d2p1:Saldo>5</d2p1:Saldo>
        <d2p1:TipoSaldo>sample string 6</d2p1:TipoSaldo>
        <d2p1:TipoTransacao>sample string 3</d2p1:TipoTransacao>
        <d2p1:Valor>4</d2p1:Valor>
      </d2p1:ExtratoLarcardDetalheDto>
    </d2p1:Transacoes>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
</ResultOfExtratoLarcardDtoczfjpqNT>