13 - Consultar Detalhes

Consulta detalhes de contrato/vínculo associado a uma parcela.

curl --request POST \
  --url https://api.example.com/contrato/parcela/consultar-detalhes \
  --header 'Content-Type: application/json' \
  --data '
{
  "NumeroContrato": 123,
  "NroParcelas": [
    0
  ]
}
'

import requests

url = "https://api.example.com/contrato/parcela/consultar-detalhes"

payload = {
    "NumeroContrato": 123,
    "NroParcelas": [0]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({NumeroContrato: 123, NroParcelas: [0]})
};

fetch('https://api.example.com/contrato/parcela/consultar-detalhes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/contrato/parcela/consultar-detalhes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'NumeroContrato' => 123,
    'NroParcelas' => [
        0
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/contrato/parcela/consultar-detalhes"

	payload := strings.NewReader("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    0\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/contrato/parcela/consultar-detalhes")
  .header("Content-Type", "application/json")
  .body("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    0\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/contrato/parcela/consultar-detalhes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    0\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "NumeroProposta": 123,
  "DtInclusao": "<string>",
  "SituacaoAgenda": 123,
  "DescricaoSituacaoAgenda": "<string>",
  "NomeCliente": "<string>",
  "NomeEmpresa": "<string>",
  "VlrFinanciado": 123,
  "SituacaoProposta": 123,
  "DtCancelamento": "<string>",
  "DtLiquidacao": "<string>",
  "DocumentoFederalCliente": "<string>",
  "EcCliente": "<string>",
  "VlrRetencaoDiarioAprox": 123,
  "VlrTotalPago": 123,
  "QtdeParcelas": 123,
  "DescricaoTipoContrato": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "Erro": "<string>"
}

Consulta detalhes de contrato/vínculo associado a uma parcela.

curl --request POST \
  --url https://api.example.com/contrato/parcela/consultar-detalhes \
  --header 'Content-Type: application/json' \
  --data '
{
  "NumeroContrato": 123,
  "NroParcelas": [
    0
  ]
}
'

import requests

url = "https://api.example.com/contrato/parcela/consultar-detalhes"

payload = {
    "NumeroContrato": 123,
    "NroParcelas": [0]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({NumeroContrato: 123, NroParcelas: [0]})
};

fetch('https://api.example.com/contrato/parcela/consultar-detalhes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/contrato/parcela/consultar-detalhes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'NumeroContrato' => 123,
    'NroParcelas' => [
        0
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/contrato/parcela/consultar-detalhes"

	payload := strings.NewReader("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    0\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/contrato/parcela/consultar-detalhes")
  .header("Content-Type", "application/json")
  .body("{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    0\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/contrato/parcela/consultar-detalhes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"NumeroContrato\": 123,\n  \"NroParcelas\": [\n    0\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "NumeroProposta": 123,
  "DtInclusao": "<string>",
  "SituacaoAgenda": 123,
  "DescricaoSituacaoAgenda": "<string>",
  "NomeCliente": "<string>",
  "NomeEmpresa": "<string>",
  "VlrFinanciado": 123,
  "SituacaoProposta": 123,
  "DtCancelamento": "<string>",
  "DtLiquidacao": "<string>",
  "DocumentoFederalCliente": "<string>",
  "EcCliente": "<string>",
  "VlrRetencaoDiarioAprox": 123,
  "VlrTotalPago": 123,
  "QtdeParcelas": 123,
  "DescricaoTipoContrato": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "ErrorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ErrorCode": "<string>",
  "ErrorCampo": "<string>",
  "Error": "<string>",
  "Origem": "<string>"
}

{
  "Erro": "<string>"
}

{
  "Erro": "<string>"
}

Corpo

application/json

NumeroContrato

integer<int64>

obrigatório

Número do contrato.

NroParcelas

integer<int32>[]

Lista de números de parcelas a obter detalhes (opcional).

Exemplo:

[0]

Resposta

NumeroProposta

integer<int64>

obrigatório

Número da proposta/contrato.

DtInclusao

string

obrigatório

Data de inclusão do contrato (ISO 8601).

SituacaoAgenda

integer<int32>

obrigatório

Código da situação da agenda (cronograma).

DescricaoSituacaoAgenda

string

obrigatório

Descrição da situação da agenda.

NomeCliente

string

obrigatório

Nome do cliente (trabalhador).

NomeEmpresa

string

obrigatório

Nome do empregador.

VlrFinanciado

number<double>

obrigatório

Valor financiado (liberado) no contrato.

SituacaoProposta

integer<int32>

obrigatório

Código da situação atual do contrato.

DtCancelamento

string

Data de cancelamento, se o contrato foi cancelado.

DtLiquidacao

string

Data de liquidação, se o contrato foi totalmente liquidado.

DocumentoFederalCliente

string

CPF do cliente (trabalhador).

EcCliente

string

Estado civil do cliente (pode ser nulo).

VlrRetencaoDiarioAprox

number<double>

Valor de retenção diária aproximado (se aplicável).

VlrTotalPago

number<double>

Valor total já pago (se houver).

QtdeParcelas

integer<int32>

Quantidade total de parcelas do contrato.

DescricaoTipoContrato

string

Descrição do tipo de contrato (se houver).

Guia Inicial

Métodos de Assinatura

Guia do Desenvolvedor

Referências de API

Guias e Casos de Uso

13 - Consultar Detalhes

Corpo

Resposta