API Tegge v1
  1. Sandbox
API Tegge v1
  • Tegge FGTS
    • Inicio
    • Aplicação
    • Web
    • API
    • Formalização
    • Suporte
  • Introdução a API
    • Casos de uso
    • Ambientes
    • Autenticação
  • Endpoints
    • Sandbox
      • Token
        POST
      • Consulta de saldo
        POST
      • Consulta de taxas
        GET
      • Simulação
        POST
      • Inserir proposta
        POST
      • Consulta de propostas
        GET
  1. Sandbox

Consulta de propostas

Testing
GET
https://sandbox-api.workbankvirtual.com.br/api/tegge/v1/proposal
token

Request

Query Params
startDate
string 
required
Example:
2024-06-13
endDate
string 
required
Example:
2024-06-13
Header Params
Content-Type
string 
optional
Example:
application/json
x-api-key
string 
required
Example:
PFJTQUtleVZhbHVlPjxNb2R1bHVzPnUzSGZIT0hGb1RVRHh4eWI5bEhHR0JDNjVPc1NOUm0zVmt3VDBGSXdpVzVKenoyRGpVWHFUazFpYnBwQ0ZrL1ZpYUpkcnZHU1dEdHBFblhOakRtaUtscmd0VmF0eTZFbnhUZERSNTQ0THBkQkJGMi9ZMVNoeXJRNTlFNFNmMHZicXA5RU1HVWZpTWx4OWsvVDU5Q3BPakgrenJ6NVlwMGJ5WW9kSHdqWnNXMkhyNDUya2xkemlyc2tNYjJ1RTRldm1Qb213UHV3bmErdHIrdmwweHZITjR6aWU5TFV3dTY2UGF4TTVteUlyUUNrM3dxMExiTUVsWWpVb0hMY2lpT2NqM2I1dlVrQkhBTnVSNW53Ylc1RVpDU0pkWFpFQUNqbEhicVNQS3dyeFpvVjBMZ0RmM1FoS0svWHp2SXEvdDNBMG8wOW9UeHZMUytIdk9rTUZIVFJDUT09PC9Nb2R1bHVzPjxFeHBvbmVudD5BUUFCPC9FeHBvbmVudD48L1JTQUtleVZhbHVlPg==
x-api-token
string 
required
Example:
{{token}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://sandbox-api.workbankvirtual.com.br/api/tegge/v1/proposal?startDate=2024-06-13&endDate=2024-06-13' \
--header 'x-api-key: PFJTQUtleVZhbHVlPjxNb2R1bHVzPnUzSGZIT0hGb1RVRHh4eWI5bEhHR0JDNjVPc1NOUm0zVmt3VDBGSXdpVzVKenoyRGpVWHFUazFpYnBwQ0ZrL1ZpYUpkcnZHU1dEdHBFblhOakRtaUtscmd0VmF0eTZFbnhUZERSNTQ0THBkQkJGMi9ZMVNoeXJRNTlFNFNmMHZicXA5RU1HVWZpTWx4OWsvVDU5Q3BPakgrenJ6NVlwMGJ5WW9kSHdqWnNXMkhyNDUya2xkemlyc2tNYjJ1RTRldm1Qb213UHV3bmErdHIrdmwweHZITjR6aWU5TFV3dTY2UGF4TTVteUlyUUNrM3dxMExiTUVsWWpVb0hMY2lpT2NqM2I1dlVrQkhBTnVSNW53Ylc1RVpDU0pkWFpFQUNqbEhicVNQS3dyeFpvVjBMZ0RmM1FoS0svWHp2SXEvdDNBMG8wOW9UeHZMUytIdk9rTUZIVFJDUT09PC9Nb2R1bHVzPjxFeHBvbmVudD5BUUFCPC9FeHBvbmVudD48L1JTQUtleVZhbHVlPg==' \
--header 'x-api-token: ' \
--header 'Content-Type: application/json'

Responses

🟢200OK
application/json
Body
array of:
idProposta
integer 
required
ID da proposta
dtProposta
string 
required
Data da proposta
qtPrazo
integer 
required
Prazo
vrLiquido
integer  | number 
required
Valor líquido
vrBruto
number  | integer 
required
Valor bruto
nmCpfCliente
string 
required
CPF do cliente
nmCliente
string 
required
Nome do cliente
dsStatus
string 
required
Situação da proposta
nmAgente
string 
required
Nome do Agente
nmProposta
string 
required
Numero da proposta
Example
[
    {
        "idProposta": 28386,
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 0,
        "vrBruto": 348.03,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "CONSIGNET HOMOLOG"
    },
    {
        "idProposta": 28387,
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 0,
        "vrBruto": 293.25,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "CONSIGNET HOMOLOG"
    },
    {
        "idProposta": 28388,
        "nmProposta": "0000101504/MP",
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 252.78,
        "vrBruto": 293.25,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "CONSIGNET HOMOLOG"
    },
    {
        "idProposta": 28389,
        "nmProposta": "0000101515/MP",
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 252.78,
        "vrBruto": 293.25,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "CONSIGNET HOMOLOG"
    },
    {
        "idProposta": 28403,
        "nmProposta": "0000101547/MP",
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 252.4,
        "vrBruto": 291.08,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "CONSIGNET HOMOLOG"
    },
    {
        "idProposta": 28404,
        "nmProposta": "0000101548/MP",
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 250,
        "vrBruto": 290.02,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "CONSIGNET HOMOLOG"
    },
    {
        "idProposta": 28405,
        "nmProposta": "0000101549/MP",
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 250,
        "vrBruto": 290.02,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "CONSIGNET HOMOLOG"
    },
    {
        "idProposta": 28406,
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 0,
        "vrBruto": 1000,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "JOAQUIM SLAGER"
    },
    {
        "idProposta": 28407,
        "nmProposta": "0000101551/ECB",
        "dtProposta": "2024-08-12T00:00:00",
        "qtPrazo": 1,
        "vrLiquido": 1761.93,
        "vrBruto": 2020.33,
        "nmCpfCliente": "66702118805",
        "nmCliente": "EDUARDO COELHO BABO",
        "dsStatus": "Pend. Parceiro",
        "nmAgente": "JOAQUIM SLAGER"
    }
]
🟠401Unauthorized
🔴500Server Error
Modified at 2024-08-15 12:20:52
Previous
Inserir proposta
Built with