Help us shape the future of Go! Take the 2026 Go Developer Survey

directd

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 18, 2026 License: MIT Imports: 24 Imported by: 0

README

Arandu

Arandu Direct Data

A Go client for the Direct Data API, the Brazilian data bureau: CPF and CNPJ registry data, sanctions and restriction lists, court records, tax status, vehicles, rural producers, environmental records and more. It covers every one of the 154 APIs in Direct Data's public catalogue, each with a typed request builder and a typed response, generated from a catalogue read off the public documentation.

It returns evidence, never a decision. A Result says which API was asked about which document (masked), when, at what price, what Direct Data answered (its consultaUid, status and message), the Outcome of the query, the raw retorno and the retorno decoded into its generated type. Whether a record supports a case is the application's policy.

Every query costs money, so every call goes through a Meter: a Ledger the application implements holds the price before the request and settles or releases it after, and an optional Dedupe answers a same-day repeat, which Direct Data bills again, without a request. A CPF or CNPJ is checked (check digits, alphanumeric CNPJ included, with arandu-br) before anything is reserved or sent, and a circuit breaker stops calling a source that keeps failing.

What it is not

  • Not a verdict. No field says a person or company is regular, approved, trusted or risky. found means the source returned a record. The provider's own fields (a situacaoCadastral, a score, a riscoFraude) come back as data, exactly as Direct Data sent them.
  • Not a wallet. It keeps no balance, no hold and no remembered result. The Ledger and Dedupe interfaces are implemented by the application, over its wallet (arandu-wallet) and its own storage, bound to the tenant of the Grant the query is made under.
  • Not a tenant reader. It never looks at a request, a path, a header or a body. The application builds the Meter from an authorized Grant and passes it in.
  • Not a route. Routes registers nothing: a query costs money and returns personal data, so it is made through the application's controllers, behind its policies.
  • Not a store of personal data. Nothing is written to disk or logged except one log record per call with the product, the masked document, the outcome, the status, the timing and the consultaUid.

Requirements
Go 1.26 or later
Arandu framework 0.57 or later, github.com/hyz-is/arandu-br
Direct Data an account and its API token (portal: Configurações → Integrações)

Install

go get github.com/hyz-is/arandu-directd@v0.1.0

Wire it

An Arandu application builds the client explicitly. There is no service provider, no container and no discovery, so these are the lines to write into bootstrap/app.go and there are no others.

The import, with the other module imports:

import (
	directd "github.com/hyz-is/arandu-directd"
)

The construction, in Build, before k.Register. Every value comes from the application's own typed configuration; this package reads no environment variable and no file:

	directdClient, err := directd.New(directd.Config{
		Token:  directd.Token(cfg.DirectData.Token),
		Logger: logger,
		Products: map[string]directd.Product{
			// Disable every API the contract or the purpose does not cover.
			"CNJMandadosPrisao": {Disabled: true},
		},
	})
	if err != nil {
		return App{}, err
	}

The registration, inside the k.Register(...) call already there, so the application lists the module (it adds no route, no table and no loop):

		directdClient,

and the client is passed, as a constructor argument, to the services that query.

Configuration

Field Default What it does
Token required The API token, sent as the TOKEN query parameter. A Token never prints: String, %#v, LogValue and JSON all write [redacted]
BaseURL https://apiv3.directd.com.br The API host; https only, except a loopback test double
HTTPClient a new http.Client Copied; every redirect is refused, so the token never travels elsewhere
Timeout 30 s Bound on one request
Products none Overrides or additions by slug: a contract price, Disabled, an API newer than the catalogue
Breaker 5 failures, 30 s Consecutive transport errors or 5xx answers that open the breaker, and how long it stays open
Location UTC−3 Where a day starts and ends for Dedupe
Logger none One record per call, never the token, the URL or a response value
ResultCodes none metaDados.resultadoId values mapped to outcomes, once observed
CallbackVerifier none Authenticates an asynchronous callback; without one every callback is refused
CallbackURLParam none The parameter carrying a per-request callback URL, which the documentation does not name
MaxBodyBytes 8 MiB Bound on the answer read

Query

Every API has a generated method, named after its slug, with a typed parameter struct and a typed result:

meter := directd.Meter{Ledger: walletLedger, Dedupe: dayCache} // built from the Grant's tenant

res, pf, err := directdClient.CadastroPessoaFisicaPlus(ctx, meter,
	directd.CadastroPessoaFisicaPlusParams{CPF: cpf})
if err != nil {
	return err // no answer could be read, or the Ledger refused
}
// res: Product, Document (masked), RequestedAt, ElapsedMs, ConsultaUID,
//      PriceCents, ChargedCents, Cached, Outcome, HTTPStatus, Status, Message,
//      ReceiptURL, Meta, Retorno, Body, Data, DataError
// pf:  *directd.CadastroPessoaFisicaPlusRetorno (nil when nothing decoded)
switch res.Outcome {
case directd.OutcomeFound, directd.OutcomeFoundWithCaveats:
	_ = pf.SituacaoCadastral // "REGULAR", as Direct Data sent it
case directd.OutcomeNotFound:
}

The same query without the generated method, for an API added later through Config.Products:

res, err := directdClient.Query(ctx, meter, directd.Request{
	Product:  "ReceitaFederalPessoaFisica",
	Document: cpf,                                         // checked, sent bare in Cpf
	Params:   map[string]string{"DataNascimento": birth}, // other documented parameters
})
data, ok := directd.As[directd.ReceitaFederalPessoaFisicaRetorno](res)

Client.Check(req) says why a request would be refused without costing anything. A query Direct Data answered returns a nil error whatever its outcome; not_found is an answer.

The response fields are typed from the documented examples with tolerant scalars: Text (a string, or a number or boolean sent where a string was documented), Number (kept as its text, with Int64 and Float64) and Flag (a boolean, or "true"/"false"). A retorno that still does not decode leaves Data nil and says why in DataError; Retorno keeps the bytes either way. Each generated field carries a pii:"..." tag (document, name, address, phone, email, birthdate, vehicle, ...) when its key holds personal data.

Costs, budget and dedupe

The hooks the application implements:

type Ledger interface {
	Reserve(ctx context.Context, c Charge) (holdID string, err error) // wrap ErrBudgetExceeded to refuse
	Settle(ctx context.Context, holdID string, cents int64) error
	Release(ctx context.Context, holdID string) error
}

type Dedupe interface {
	Seen(ctx context.Context, key DedupeKey) (*Result, bool, error)
	Remember(ctx context.Context, key DedupeKey, r *Result) error
}

The order of a call:

  1. The product and the document are checked. An invalid document is refused with ErrInvalidDocument before anything else; no request, no hold.
  2. Dedupe.Seen may answer with a result remembered for the day (DedupeKey{Product, Document, ParamsDigest, Day}); it comes back Cached: true, ChargedCents: 0, and no request is made.
  3. An open circuit breaker refuses with ErrUnavailable; no request, no hold.
  4. Ledger.Reserve holds the list price; a refusal (ErrBudgetExceeded) means no request.
  5. The request is made.
  6. The hold is settled at the list price when the outcome is billable (found, found_with_caveats; terms clause 2.5) and released otherwise, a transport failure included.
  7. A billable result is remembered with Dedupe.Remember.

MemoryLedger and MemoryDedupe are in-memory implementations for tests and commands; they are not storage. The prices are Direct Data's documented list prices; a contract that prices differently overrides them in Config.Products, and the application reconciles its ledger with Direct Data's statement by consultaUid.

Outcomes

Outcome When Source
found metaDados.resultado is "Sucesso" Terms, clause 2.5
found_with_caveats "Sucesso com Ressalvas" Terms, clause 2.5
not_found HTTP 404, or a status or message saying no record was found Quickstart (404); the words are undocumented
invalid_document HTTP 400 or 422, or a message saying a value is invalid Quickstart (400 "parâmetro inválido")
unauthorized HTTP 401 or 403, or a message about the token Quickstart (401 "token inválido")
insufficient_balance HTTP 402, or a message about balance undocumented
rate_limited HTTP 429 undocumented; the introduction says there are no rate limits
unavailable transport failure, timeout, HTTP 5xx, or a message saying the source is down Quickstart (500)
error anything else; Message and Errors keep what Direct Data said —

The HTTP status is the answer's, or the httpStatusCode field of the error envelope ({httpStatusCode, message, errors[]}, introduction) when the body carries one. The public documentation lists no resultadoId values, so none is mapped by default: Config.ResultCodes takes them once observed, and they take precedence over everything else.

Asynchronous queries

Every product page offers ASync=habilitar, at no extra cost, with the result delivered to a webhook.

ticket, err := directdClient.QueryAsync(ctx, meter, req, directd.AsyncOptions{})
// store ticket (ConsultaUID, HoldID, PriceCents); the hold stays open

// in the application's callback controller:
res, err := directdClient.ParseCallback(directd.CallbackRequest{Header: r.Header, Query: r.URL.Query(), Body: body})
ticket := findTicket(res.ConsultaUID)
err = directdClient.CompleteAsync(ctx, meter.Ledger, ticket, res) // settles or releases, once

The documentation does not say how Direct Data authenticates a callback, nor which parameter carries a per-request callback URL (the callback appears to be configured in the portal). So ParseCallback refuses every callback until a CallbackVerifier is configured, and AsyncOptions.CallbackURL is refused until Config.CallbackURLParam names the parameter. SecretQueryVerifier checks a secret of the application's own in the registered callback URL (https://app.example/directd/callback?k=<secret>), in constant time; SecretHeaderVerifier checks a header, should the portal allow one. A secret in a URL is only as private as the logs of every hop that sees it; the consultaUid match CompleteAsync requires is a second check, not a substitute.

Redaction

Redact(body) rewrites an answer for logs, tickets or fixtures: the structure is kept, a CPF or CNPJ becomes its mask, names, addresses, phones, e-mails, birth dates and vehicle identifiers become placeholders, status-like values (situacaoCadastral, resultado, cnaeDescricao, ...) are kept unless they hold a run of digits or an @, and every other string becomes <string>.

The catalogue

catalog/catalog.json holds every API as the public documentation describes it, with the crawl date and the source page of each entry: slug, name, category, target (PF, PJ, PF/PJ), endpoint path and template, method, parameters (name, spelling in the template, type, required flag as documented, description), list price in cents, supplier flag (origin Online: the source is queried at call time), status (available or maintenance), whether a PDF receipt exists, the documented response example, its field paths, and the field labels and descriptions. Entries the documentation leaves incomplete say so, with the reason; nothing is invented to fill them.

go run ./cmd/directd-catalog -out catalog/catalog.json   # reads only the public documentation
go generate ./...                                         # products, types, methods, the table below

cmd/directd-catalog reads https://directd.com.br/central-de-ajuda/apis/catalogo and one page per API, with a pause between requests, refuses the API and the portal hosts by name, and stops without retrying on a 401, 403 or 429. A test holds the generated files equal to what the generator writes from the committed catalogue.

Checking against the real API

cmd/directd-smoke makes a capped run of real queries, each billed to the token's owner:

DIRECTD_TOKEN_FILE=$HOME/.config/directd/token \
go run ./cmd/directd-smoke -spend-limit-cents 300 -out /tmp/directd-smoke \
  -call 'CadastroPessoaFisicaPlus <cpf>' \
  -call 'ReceitaFederalPessoaFisica <cpf> DataNascimento=<dd/mm/aaaa>' \
  -dry-run

The token comes from the file DIRECTD_TOKEN_FILE names, never an argument, and is never printed. -spend-limit-cents is required and refused above 5000 (R$ 50,00); each call's list price is held on a capped ledger before the request, a refused query counts as spent, and the run stops at the first call that would pass the cap. -dry-run prints the plan and its cost without reading the token. One line per call: product, masked document, HTTP status, outcome, status, message (redacted), consultaUid, elapsed time, price and running total. Each answer is written redacted to -out, which must be outside every git repository.

Security and privacy

CPF and CNPJ registry data, kinship, addresses, phones and court records are personal data under the LGPD. This package holds none of it beyond the call: it stores nothing and logs only the masked document. Collecting only what is needed, encrypting Retorno and Body apart from the normalized facts, controlling and auditing every access (arandu-activitylog), a lawful basis and deletion on schedule are the application's.

The token is a credential that spends money. It travels only in the request URL, because Direct Data authenticates that way; transport errors are stripped of the URL, redirects are refused, and the base URL must be https. Report vulnerabilities privately; see SECURITY.md.

Direct Data's terms that bind the integrating application

From the terms of use, read on 2026-10-18. They are the provider's, not this package's, and the application's contract with Direct Data governs.

  • 2.5 — a query is billed when its status is "Sucesso" or "Sucesso com Ressalvas"; a duplicate (same document, same API, same day) is billed again.
  • 2.3.1 — APIs that depend on outside sources may become unavailable.
  • 7.4 (ii) — the client may not disclose the data to third parties, directly or indirectly. An application that shows results to its own customers must confirm its contract allows it.
  • 8.1 and 8.3 — Direct Data may collect, store and relate the queries made, and may sell products derived from them, with the client's personal data and its customers' removed or anonymised. The application's privacy notice should say so.
  • 9.2 — personal data of individuals may only be processed for credit assessment, entering into contracts, collection, or legitimate interest.

Uso no KUAA

O KUAA consulta a Direct Data somente depois que o documento foi extraído e validado: o OCR leu o documento, o CPF ou CNPJ passou nos dígitos verificadores e o caso tem uma finalidade registrada. A consulta é evidência do caso, nunca a decisão: o Result é gravado (cifrado, com o consultaUid) e a política do KUAA decide.

  • Por onde passa. O controller do KUAA autoriza a ação (Policy → security.Authorize → Grant), monta o Meter com o Ledger sobre a carteira do tenant (arandu-wallet, tenant de data.Tenant(g)) e o Dedupe sobre o armazenamento do próprio KUAA, e chama o método gerado. O módulo nunca lê tenant de requisição.

  • O que consultar primeiro.

    API Slug Preço de tabela
    Cadastro PF Básica CadastroPessoaFisica R$ 0,16
    Cadastro PF Plus (situação na Receita, óbito, parentescos) CadastroPessoaFisicaPlus R$ 0,36
    Receita Federal PF (CPF + data de nascimento, comprovante) ReceitaFederalPessoaFisica R$ 0,36
    Cadastro PJ Básica CadastroPessoaJuridica R$ 0,16
    Cadastro PJ Plus (QSA, filiais, tributação) CadastroPessoaJuridicaPlus R$ 0,36
    AML — vínculos societários (óbito, PEP, parentescos, sociedades) AML R$ 0,72
    Similarity — Brazil (dados informados × base, por campo) Similarity R$ 0,72
    Simples Nacional SimplesNacional R$ 0,36
    Processos Judiciais — Simplificada ProcessosJudiciaisSimplificada R$ 1,50

    O Similarity é o que compara o que o OCR leu com a base: cada campo volta com description ("MATCH EXATO", "MATCH PARCIAL") e distance; a política do KUAA decide o que cada distância significa.

  • Custo. Toda consulta é cobrada; a repetida no mesmo dia também (cláusula 2.5). O Dedupe evita a repetição; o Ledger segura o preço antes e só liquida quando o status é cobrável. Desative em Config.Products toda API fora da finalidade.

  • Termos. Antes de mostrar resultado da Direct Data ao cliente do KUAA, confirmar que o contrato permite (cláusula 7.4(ii)). Informar no aviso de privacidade que o fornecedor guarda as consultas e pode comercializar derivados anonimizados (8.1 e 8.3). Dados de pessoa física só para as finalidades da cláusula 9.2.

  • Callback. Enquanto a Direct Data não documentar como autentica o webhook, usar consulta síncrona, ou registrar no portal uma URL com segredo próprio e SecretQueryVerifier.

Tests

export GOWORK=off
test -z "$(gofmt -l $(find . -name '*.go' -not -path '*/testdata/*'))"
go build ./...
go vet ./...
go test -race -count=1 ./...

No test calls Direct Data. Every request goes to an httptest double: every catalogue API is driven through it with its documented path, token placement and parameters, and answered with its own documented example; synthetic answers check the typed KYC products, the outcomes, the settle-or-release contract, dedupe, the budget, the breaker, the async flow, redaction, the smoke command's cap, and that neither the token nor a personal value reaches a log, an error or a file. The documents in the tests have valid check digits and belong to nobody known.

Versioning and releases

The module follows Semantic Versioning. While the major version is v0, a minor release may break the API, and every break is named in UPGRADE.md. A new catalogue changes products, prices, types and methods, and is always a changelog line. A release is a tag vX.Y.Z on main whose notes are the ## [X.Y.Z] - date entry in CHANGELOG.md.

Licence

The code is MIT; see LICENSE.md. Copyright HYZIS - Serviços Digitais Ltda. Direct Data is a trademark of its owner; this package is not affiliated with it, and the catalogue records facts from its public documentation.

API catalogue

154 APIs in 13 categories, read from the public catalogue on 2026-10-18. Prices are list prices per query; Online means the source is queried at call time. The slug is Request.Product, and the generated method on *directd.Client is the slug as a Go name (SintegraCCC-Completa → SintegraCCCCompleta).

Ambiental (5)
API Slug Target Parameters Price Origin Notes
IBAMA - Certidão Negativa de Débitos IBAMACertidaoNegativaDebitos PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online maintenance; PDF receipt
IBAMA - Certidão Negativa de Embargo IBAMACertidaoNegativaEmbargos PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online maintenance; PDF receipt
IBAMA - Certificado de Regularidade IBAMACertificadoRegularidade PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online maintenance; PDF receipt
IBAMA - Consulta de Autuações Ambientais IBAMAConsultaAutuacoesAmbientais PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online maintenance; PDF receipt
Suframa - CNPJ SuframaCNPJ PJ Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Cadastral (37)
API Slug Target Parameters Price Origin Notes
Auxílio Emergencial AuxilioEmergencial PF CPF, NIS R$ 0,36 Online
Auxílio Reconstrução AuxilioReconstrucao PF CPF, NIS R$ 0,36 Base
Benefício de Prestação Continuada - BPC BeneficioPrestacaoContinuada PF Cpf, Nis R$ 0,36 Online
Benefícios Sociais - Pessoa Física BeneficiosSociais PF CPF R$ 0,75 Base
Bolsa Família BolsaFamilia PF Nis, MesReferencia, AnoReferencia, MesCompetencia, AnoCompetencia R$ 0,36 Online
CFM - Conselho Federal de Medicina CFMConselhoFederalMedicina PF/PJ CRM, UF R$ 0,36 Online PDF receipt; incomplete: the documentation page lists no parameter
CONFEA/CREA - Conselho Federal de Engenharia e Agronomia CONFEA PF CPF, RegistroNacional, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CVM - Comissão de Valores Mobiliários CVMComissaodeValoresMobiliarios PF/PJ CPF, CNPJ R$ 0,36 Online
CVM - Processos Administrativos Sancionadores CVMProcessosAdministrativosSancionadores PF/PJ CPF, CNPJ R$ 0,36 Online
Cadastro - Pessoa Física - Básica CadastroPessoaFisica PF CPF R$ 0,16 Base
Cadastro - Pessoa Física - Plus CadastroPessoaFisicaPlus PF CPF R$ 0,36 Base
Cadastro - Pessoa Jurídica - Básica CadastroPessoaJuridica PJ CNPJ R$ 0,16 Base
Cadastro - Pessoa Jurídica - Plus CadastroPessoaJuridicaPlus PJ CNPJ R$ 0,36 Base
Cadastro + Receita Federal - Pessoa Física CadastroReceitaPessoaFisica PF CPF, DATANASCIMENTO, GERARCOMPROVANTE R$ 0,42 Online PDF receipt
CNH - Carteira Nacional de Habilitação CarteiraNacionalHabilitacao PF CPF R$ 0,90 Online
CNH - Carteira Nacional de Habilitação Plus CnhPlus PF CPF R$ 1,45 Online
Correios - Busca CEP CorreiosBuscaCEP PF/PJ Endereco R$ 0,36 Online
Enriquecimento de Lead EnriquecimentoLead PF Celular, Email R$ 0,16 Base
Gás do Povo GasDoPovo PF CPF R$ 0,36 Online
Identity Verification - Argentina IdentityVerificationArgentina PF DNI, Name, Surname, DOB, GENDER, Address, City, State, PostCode, Phone, Country R$ 0,72 Base
Ministério do Trabalho - PIS MinisterioTrabalhoPIS PF Cpf R$ 0,36 Base
OAB - Cadastro Nacional dos Advogados OABCadastroNacionalAdvogados PF Nome, INSCRICAO, UF, GERARCOMPROVANTE, IE R$ 0,36 Online PDF receipt
Óbito Obito PF Cpf R$ 0,36 Base
Portal da Transparência - Indicadores Pessoa Física PortalTransparenciaIndicadoresPessoaFisica PF CPF, NIS R$ 1,30 Online
Portal da Transparência - Indicadores Pessoa Jurídica PortalTransparenciaIndicadoresPessoaJuridica PJ CNPJ R$ 1,30 Online
Portal da Transparência - Servidores do Poder Executivo Federal PortalTransparenciaServidores PF CPF R$ 0,72 Online
Portal da Transparência - Servidores - Completa PortalTransparenciaServidoresCompleta PF CPF, GERARCOMPROVANTE R$ 2,30 Online PDF receipt
Portal da Transparência - Servidores - Remuneração PortalTransparenciaServidoresRemuneracao PF CPF, MesAno R$ 0,36 Online
Portal da Transparência - Servidores Viagens e despesas PortalTransparenciaServidoresViagens PF CPF R$ 0,36 Online
Registration Data - Argentina RegistrationDataArgentina PF DNI R$ 0,36 Base
Registration Data - Brazil RegistrationDataBrazil PF Cpf, Name, Surname, DOB R$ 0,36 Base
Registration Data - México RegistrationDataMexico PF Curp R$ 0,36 Base
Seguro Defeso SeguroDefeso PF Cpf, Nis R$ 0,36 Online
Similarity - Brazil Similarity PF Cpf, Name, Surname, DOB, Address, City, State, PostCode, Phone R$ 0,72 Base
Similarity - Argentina SimilarityArgentina PF DNI, Name, Surname, DOB, Address, City, State, PostCode, Phone R$ 0,72 Base
Similarity - México SimilarityMexico PF CURP, Name, Surname, DOB, Address, City, State, PostCode, Phone R$ 0,72 Base
Vínculo Empregatício VinculoEmpregaticio PJ CNPJ R$ 0,72 Base
Crédito (15)
API Slug Target Parameters Price Origin Notes
Antifraude Chave PIX AntifraudePix PF/PJ Documento, Chave, Tipo R$ 1,55 Base maintenance
Boa Vista - Acerta Completo Positivo Pessoa Física BoaVistaAcertaCompletoPositivoPF PF CPF, GERARCOMPROVANTE R$ 14,03 Online PDF receipt
Boa Vista - Acerta Mais Positivo Pessoa Física BoaVistaAcertaMaisPositivoPF PF CPF, GERARCOMPROVANTE R$ 11,18 Online PDF receipt
Boa Vista - Define Limite Positivo Pessoa Jurídica BoaVistaDefineLimitePositivoPJ PJ CNPJ, GERARCOMPROVANTE R$ 21,00 Online PDF receipt
Boa Vista - Risco Positivo Pessoa Jurídica BoaVistaRiscoPositivoPJ PJ CNPJ, GERARCOMPROVANTE R$ 14,03 Online PDF receipt
CADIN - Secretaria da Fazenda CADINSecretariaFazendaEstaduais PF/PJ Cpf, Cnpj, Uf, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CADIN - Secretaria da Fazenda - São Paulo CADINSecretariaFazendaSP PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Detalhamento Negativo QUOD DetalhamentoNegativo PF/PJ CPF, CNPJ R$ 2,38 Online
Dossiê QUOD - Completo DossieCreditoCompleto PF/PJ Cpf, Cnpj R$ 6,99 Online
Protestos Nacional - IEPTB Básica ProtestosNacionalBasica PF/PJ Cnpj, Cpf R$ 2,95 Online incomplete: the documentation page lists no parameter
Protestos Nacional - IEPTB Online ProtestosOnline PF/PJ Cnpj, Cpf R$ 3,50 Online
SCR Analítico - Resumo BACEN SCRBacen PF/PJ CNPJ, CPF R$ 3,90 Base
SCR Detalhada - Resumo BACEN SCRBacenDetalhada PF/PJ CNPJ, CPF, MESANO, GERARCOMPROVANTE R$ 4,90 Base PDF receipt
Score de Crédito - QUOD Score PF/PJ CPF, CNPJ R$ 1,98 Online
Nível Socioeconômico e Renda Estimada nivelSocioeconomico PF CPF R$ 0,36 Base incomplete: the documentation page lists no parameter
Fiscal e Tributário (15)
API Slug Target Parameters Price Origin Notes
CCD - Certidão Conjunta de Débitos - Pessoa Física CertidaoConjuntaDebitosPessoaFisica PF Cpf, DATANASCIMENTO, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CCD - Certidão Conjunta de Débitos - Pessoa Jurídica CertidaoConjuntaDebitosPessoaJuridica PJ Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CND - Certidão Negativa de Débitos Estaduais CertidaoNegativaDebitos PF/PJ Cnpj, ie, Cpf, Uf, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CNDIR - Certidão Negativa de Débitos e Dívida Ativa da União de Imóvel Rural CertidaoNegativaDebitosImovelRural PF/PJ CIB, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CNDM - Certidão Negativa de Débitos Municipal CertidaoNegativaDebitosMunicipal PF/PJ Cnpj, IM, Cpf, Municipio, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
NFe - Nota Fiscal Eletrônica - Completa NotaFiscalEletronicaCompleta PF/PJ Chave, GERARCOMPROVANTE R$ 1,30 Online PDF receipt
NFe - Nota Fiscal Eletrônica - Inutilizações NotaFiscalEletronicaInutilizacao PJ CNPJ, Ano, GERARCOMPROVANTE R$ 1,30 Online PDF receipt
Receita Federal - Pessoa Física ReceitaFederalPessoaFisica PF Cpf, DataNascimento, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Receita Federal - Pessoa Jurídica ReceitaFederalPessoaJuridica PJ Cnpj, Qsa, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Receita Federal - Pessoa Jurídica - QSA + Participação Societária ReceitaPJParticipacaoSocietaria PJ CNPJ R$ 2,80 Online
Restituição Imposto de Renda - IRPF RestituicaoIRPF PF Cpf, DataNascimento, AnoExercicio R$ 0,36 Online
Simples Nacional SimplesNacional PJ Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Sintegra - Cadastros Estaduais Sintegra PF/PJ Cnpj, ie, Cpf, Uf, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Sintegra - Cadastro Centralizado de Contribuinte - CCC SintegraCCC PF/PJ Cnpj, ie, Cpf, Uf, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Sintegra - CCC - Completa SintegraCCC-Completa PF/PJ Cnpj, ie, Cpf, Uf, GERARCOMPROVANTE R$ 1,80 Online PDF receipt
Processos (7)
API Slug Target Parameters Price Origin Notes
CARF - Conselho Administrativo de Recursos Fiscais CARFConselhoAdmistrativodeRecursosFiscais PF/PJ CPF, CNPJ R$ 0,36 Online incomplete: the documentation page lists no parameter
TCU - Certidão Negativa de Processo CertidaoNegativaProcesso PF/PJ Cpf, Cnpj R$ 0,36 Online PDF receipt; incomplete: the documentation page lists no parameter
Ministério do Trabalho e do Emprego (MTE) - Infrações Trabalhistas MTEInfracoesTrabalhistas PF/PJ Cpf, Cnpj, TIPO, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Processos Judiciais - Agrupada (Base) ProcessosJudiciaisAgrupada PF/PJ Cpf, Cnpj R$ 1,10 Base
Processos Judiciais - Completa (Base) ProcessosJudiciaisCompleta PF/PJ Cpf, Cnpj R$ 3,30 Base
Processos Judiciais - Simplificada (Base) ProcessosJudiciaisSimplificada PF/PJ Cpf, Cnpj R$ 1,50 Base
TJ - Tribunal de Justiça - Processos TribunalJustica PJ Cpf, Cnpj, NomeParte, NumeroProcesso, Uf, Grau R$ 0,36 Online
Produtores Rurais (8)
API Slug Target Parameters Price Origin Notes
APF Rural - Autorização Provisória de Funcionamento Rural APFRural PF/PJ CNPJ, CPF, NumeroAPF, NumeroCAR, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CAF - Cadastro Nacional de Agricultura Familiar - PF CAFCadastroNacionalAgriculturaPF PF CPF, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CAF - Cadastro Nacional de Agricultura Familiar - PJ CAFCadastroNacionalAgriculturaPJ PJ CNPJ, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CAR - Cadastro Ambiental Rural CadastroAmbientalRural PF/PJ NumeroCAR, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
CAFIR - Cadastros de Imóveis Rurais CadastroImoveisRurais PF/PJ CIB, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
DAP - Declaração de Aptidão ao Pronaf - Pessoa Física DAPPessoaFisica PF CPF, GERARCOMPROVANTE, DataNascimento R$ 0,72 Online PDF receipt
DAP - Declaração de Aptidão ao Pronaf - Pessoa Jurídica DAPPessoaJuridica PJ CNPJ, GERARCOMPROVANTE R$ 0,72 Online PDF receipt
Garantia Safra GarantiaSafra PF CPF, NIS R$ 0,36 Online
Regularidade (7)
API Slug Target Parameters Price Origin Notes
Consultoria Geral da União - CGU CGUConsultoriaGeralUniao PF/PJ Cpf, Cnpj, Tipo, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
FGTS - Regularidade do Empregador CaixaRegularidadeEmpregadorFGTS PJ Cnpj, CPF, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
STM - Certidão Negativa da União STMCertidaoNegativauniao PF Nome, CPF, DataNascimento, NomeMae R$ 0,36 Online PDF receipt; incomplete: the documentation page lists no parameter
TSE - Situação Eleitoral SituacaoEleitoral PF Nome, CPF, NumeroTituloEleitoral, DataNascimento R$ 0,36 Online
TSE - Certidão de Crimes Eleitorais TSECertidaoCrimesEleitorais PF Nome, CPF, NomeMae, NOMEPAI, NumeroTituloEleitoral, DataNascimento, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
TSE - Certidão de Quitação Eleitoral TSECertidaodeQuitacaoEleitoral PF Nome, CPF, NOMEMAE, NOMEPAI, NUMEROTITULOELEITORAL, DATANASCIMENTO, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
TSE - Título e Local de Votação TituloLocalVotacao PF Nome, CPF, NumeroTituloEleitoral, DataNascimento, NomeMae R$ 0,72 Online
Sanções e Restrições (22)
API Slug Target Parameters Price Origin Notes
Acordos de Leniência AcordosLeniencia PJ Cnpj R$ 0,36 Online
Banco Central - Quadro Geral de Inabilitados BancoCentralInabilitados PF Cpf R$ 0,36 Online
Banco Central - Quadro Geral de Proibidos BancoCentralProibidos PF/PJ Cnpj, Cpf R$ 0,36 Online
CNJ - Mandados de Prisão CNJMandadosPrisao PF Cpf, Nome, NomeMae, NomePai, Alcunha, GERARCOMPROVANTE R$ 0,72 Online PDF receipt
CEIS - Cadastro de Empresas Inidôneas e Suspensas CadastroEmpresasInidoneasSuspensas PF/PJ Cnpj, Cpf R$ 0,36 Online
CEPIM - Cadastro de Entidades Privadas Sem Fins Lucrativos Impedidas CadastroEntidadesPrivadasImpedidas PJ Cnpj R$ 0,36 Online
CEAF - Cadastro de Expulsões da Administração Federal CadastroExpulsoesAdministracaoFederal PF Cpf R$ 0,36 Online
CNEP - Cadastro Nacional de Empresas Punidas CadastroNacionalEmpresasPunidas PF/PJ Cnpj, Cpf R$ 0,36 Online
CNIA - Cadastro Nacional de Condenações Cíveis por Ato de Improbidade Administrativa e Inelegibilidade CadastroNacionalImprobidadeAdministrativa PF/PJ Cnpj, Cpf R$ 0,36 Online PDF receipt
Ministério Público Federal - Certidão Negativa MPFCertidaoNegativa PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Ministério Público do Estado de Mato Grosso (MPMT) - Procedimentos Investigatórios Extrajudiciais MPMTMinisterioPublicoMatoGrosso PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
PEP Estendida - Pessoa Exposta Politicamente + Parentescos PEPParentescos PF Cpf R$ 0,36 Base
PETI - Programa de Erradicação do Trabalho Infantil PETITrabalhoInfantil PF CPF, NIS R$ 0,36 Online
PGFN - Lista de Devedores da União PGFNListaDevedoresUniao PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
PEP - Pessoa Exposta Politicamente PessoaExpostaPoliticamente PF Cpf R$ 0,36 Base
Polícia Civil - Antecedentes Criminais PoliciaCivilAntecedentesCriminais PF CPF, Rg, NomeMae, Nome, DataNascimento, GENERO, Uf, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Polícia Federal - Antecedentes Criminais PoliciaFederalAntecedentesCriminais PF Cpf, Nome, DataNascimento, NomeMae, NomePai, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
TCU - Certidão Negativa de Licitante Inidôneo TCUCertidaoNegativaLicitanteInidoneo PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
TCU - Consulta Consolidada de Pessoa Jurídica - APF TCUConsultaConsolidadaPessoaJuridica PJ Cnpj, GERARCOMPROVANTE R$ 0,72 Online PDF receipt
TJ - Certidão Cível, Criminal e Fiscal - Tribunal de Justiça TJCertidaoCivelCriminalFiscal PF/PJ CPF, CNPJ, Nome, DataNascimento, NomeMae, NomePai, RG, Genero, UF, Tipo, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
TRF - Tribunal Regional Federal (Certidão Cível, Eleitoral ou Criminal) TribunalRegionalFederal PF/PJ Cnpj, Cpf, Regiao, Tipo, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Verificação de Empregador - Trabalho Forçado VerificacaoEmpregadorTrabalhoForcado PF/PJ Cnpj, Cpf R$ 0,36 Online
Sanções e Restrições (Internacional) (11)
API Slug Target Parameters Price Origin Notes
Austrália DFAT - Sanções Internacionais AustraliaDFAT PF/PJ Nome R$ 0,36 Base
Canada SEMA - Sanções Internacionais CanadaSEMA PF/PJ Nome R$ 0,36 Base
EU Financial Sanctions List EUFinancialList PF/PJ Nome R$ 0,36 Online
FBI - Most Wanted FBIMostWanted PF Nome, Sobrenome R$ 0,36 Online
FINCEN - Financial Crimes Enforcement Network FinCEN PF/PJ Nome R$ 0,36 Online PDF receipt
INTERPOL Interpol PF Nome, Sobrenome, DataNascimento R$ 0,36 Online
OFAC - Sanctions List (SND and Non-SDN) OFAC PF/PJ Nome, Sobrenome R$ 0,36 Online
Offshore Leaks - ICIJ OffshoreLeaks PF/PJ Nome, NodeID R$ 0,36 Base
Suíça SECO - Sanções Internacionais SuicaSECO PF/PJ Nome R$ 0,36 Base
UK Hm Treasury - Financial Sanctions UKHmTreasury PF/PJ Nome R$ 0,36 Online
UNSCCL - United Nations Security Council Consolidated List UnitedNationsSecurityList PF/PJ Nome, Sobrenome R$ 0,36 Online
Societário (3)
API Slug Target Parameters Price Origin Notes
AML - Anti Money Laundering (Vínculos Societários) AML PF Cpf R$ 0,72 Base
Beneficiário Final BeneficiarioFinal PF/PJ Cnpj, Cpf R$ 1,44 Base
Vínculos Societários VinculosSocietarios PF/PJ CNPJ, CPF R$ 1,84 Base
Socio-Demográficos (2)
API Slug Target Parameters Price Origin Notes
Certificado Anbima EDU AnbimaCertificadoEDU PF CPF R$ 0,36 Online
Bet Safe Compliance BetSafeCompliance PF CPF R$ 0,72 Base
Trabalhista (3)
API Slug Target Parameters Price Origin Notes
MPT - Ministério Público do Trabalho MinisterioPublicoTrabalho PF/PJ Cnpj, Cpf, Regiao, GERARCOMPROVANTE R$ 1,30 Online PDF receipt
TST - Certidão Negativa de Débitos Trabalhistas TSTCertidaoNegativaDebitosTrabalhistas PF/PJ Cpf, Cnpj, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
TRT - Tribunal Regional do Trabalho TribunalRegionalTrabalho PF/PJ Cnpj, Cpf, Regiao, TIPO, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Veículos (19)
API Slug Target Parameters Price Origin Notes
ANTT - Código Identificador Operação Transporte ANTTConsultaCodigoIdentificadorOperacaoTransporte PF/PJ RNTRC, RENAVAM R$ 0,36 Online
ANTT - Consulta de Regularidade da Transportadora ANTTConsultaRegularidadeTransportadora PF/PJ CPF, CNPJ, RNTRC, GERARCOMPROVANTE R$ 0,36 Online PDF receipt
Consulta Veicular - Leilão Veicular ConsultaLeilaoVeicular PF/PJ Placa, Chassi R$ 12,00 Online
Consulta Veicular Serpro - Multas Radar ConsultaSerproMultasRadar PF/PJ Placa, Renavam R$ 0,36 Online PDF receipt; incomplete: the documentation page lists no parameter
Consulta Veicular - Nacional ConsultaVeicular PF/PJ Placa R$ 1,10 Online
Consulta Veicular - CRLV-e SP ConsultaVeicularCrlvSP PF/PJ Placa, GERARCOMPROVANTE R$ 12,00 Online PDF receipt
Consulta Veicular - Estadual ConsultaVeicularEstadual PF/PJ Placa, Chassi R$ 1,90 Online
Veículos - FIPE ConsultaVeicularFipe PF/PJ Placa, Chassi R$ 3,89 Online
Consulta Veicular - Frotas Nacional ConsultaVeicularFrotasNacional PF/PJ Cpf, Cnpj R$ 4,55 Online
Consulta Veicular - Gravame ConsultaVeicularGravame PF/PJ Placa, Chassi R$ 1,80 Online
Consulta Veicular - Histórico de Proprietários ConsultaVeicularHistoricoProprietarios PF/PJ Placa R$ 4,10 Base
Consulta Veicular - Proprietário Atual ConsultaVeicularProprietarioAtual PF/PJ Placa R$ 0,90 Online
Consulta Veicular - Recall ConsultaVeicularRecall PF/PJ Placa R$ 1,20 Online
Consulta Veicular - Renainf ConsultaVeicularRenainf PF/PJ Placa R$ 2,10 Base
Consulta Veicular - Renajud ConsultaVeicularRenajud PF/PJ Placa R$ 1,90 Base
Consulta Veicular - Roubo e Furto ConsultaVeicularRouboFurto PF/PJ Placa, Chassi R$ 1,45 Online
Histórico Veicular PF e PJ - São Paulo HistoricoVeiculos PF/PJ Cpf, Cnpj R$ 0,36 Base
Histórico Veicular PF e PJ - Nacional HistoricoVeiculosNacional PF/PJ Cpf, Cnpj R$ 1,80 Base
Polícia Rodoviária Federal - Infrações PRFInfracoes PF/PJ Placa, Renavam, TIPO R$ 0,36 Online

Documentation

Overview

Package directd is a Go client for the Direct Data API (https://directd.com.br), the Brazilian data bureau: registry data of CPFs and CNPJs, sanctions and restriction lists, court records, tax status, vehicles and more -- every one of the APIs in its public catalogue.

It returns evidence, never a decision. A Result says which API was asked about which (masked) document, when, at what price, what Direct Data answered (its consultaUid, status and message), the Outcome of the query (found, not_found, unavailable, ...), the raw retorno and, for every API, the retorno decoded into a type generated from the documentation. Whether a record supports a case is the application's policy.

Every query costs money, so every call takes a Meter: the Ledger the application implements (normally over its wallet, bound to the tenant of the Grant the query is made under) holds the price before the request and settles or releases it after, and an optional Dedupe answers a same-day repeat -- which Direct Data bills again -- without a request. A document is checked (CPF and alphanumeric CNPJ check digits, with arandu-br) before anything is reserved or sent, and a circuit breaker stops calling a source that keeps failing.

An application builds one Client in bootstrap/app.go with New and passes it to the services that query. There is no service provider, no container and no discovery. The package reads no environment variable and no file.

The products, the response types and the per-API methods are generated from catalog/catalog.json, which cmd/directd-catalog reads from the public documentation; go generate rewrites them.

Index

Constants

View Source 
const (
	// DefaultBaseURL is Direct Data's API host.
	DefaultBaseURL = "https://apiv3.directd.com.br"
	// DefaultTimeout bounds one request when Config leaves Timeout at zero.
	DefaultTimeout = 30 * time.Second
	// DefaultBreakerThreshold is how many consecutive transport errors or 5xx
	// answers open the circuit breaker.
	DefaultBreakerThreshold = 5
	// DefaultBreakerCooldown is how long an open breaker refuses calls.
	DefaultBreakerCooldown = 30 * time.Second
	// DefaultMaxBodyBytes bounds the answer the client reads.
	DefaultMaxBodyBytes = 8 << 20
)

The defaults for the optional settings. They are constants rather than literals inside Config.WithDefaults, so the value a reader finds here is the value the package uses.

View Source 
const CatalogCrawledAt = "2026-10-18"

CatalogCrawledAt is the date catalog/catalog.json was read from the public documentation.

View Source 
const CatalogSource = "https://directd.com.br/central-de-ajuda/apis/catalogo"

CatalogSource is the documentation index the catalogue was read from.

Variables

View Source 
var (
	// ErrCallbackUnverified is a callback ParseCallback would not read: no
	// CallbackVerifier is configured, or the verifier refused it. The
	// documentation does not say how Direct Data authenticates a callback,
	// so an unauthenticated one is never read.
	ErrCallbackUnverified = errors.New("directd: callback not verified")
	// ErrCallbackMismatch is a callback whose consultaUid is not the
	// ticket's.
	ErrCallbackMismatch = errors.New("directd: callback does not belong to the ticket")
	// ErrCallbackParamUnknown is a per-request callback URL asked for while
	// Config.CallbackURLParam is empty: the documentation names no parameter
	// for it.
	ErrCallbackParamUnknown = errors.New("directd: no documented parameter carries a callback URL; set Config.CallbackURLParam or configure the callback in the portal")
	// ErrTicketClosed is a ticket already completed.
	ErrTicketClosed = errors.New("directd: ticket already completed")
)

The errors of asynchronous queries.

View Source 
var (
	// ErrUnknownProduct is a slug that is neither in the catalogue nor in
	// Config.Products.
	ErrUnknownProduct = errors.New("directd: unknown product")
	// ErrProductDisabled is a product disabled in Config.Products, or one the
	// documentation lists as inactive.
	ErrProductDisabled = errors.New("directd: product disabled")
	// ErrInvalidParams is a parameter the product does not document, a
	// reserved one (TOKEN, ASync), a document passed in Params, or a query
	// with nothing to ask.
	ErrInvalidParams = errors.New("directd: invalid parameters")
)

The errors a call is refused with before anything leaves the process. Each is wrapped with the detail of the case, so callers test for them with errors.Is.

View Source 
var ErrBudgetExceeded = errors.New("directd: budget exceeded")

ErrBudgetExceeded is what a Ledger returns from Reserve when the price does not fit the budget. The client then makes no request.

View Source 
var ErrInvalidDocument = errors.New("directd: invalid document")

ErrInvalidDocument is a document that is not a valid CPF or CNPJ, or not one the product takes. It is refused before any request, reservation or lookup.

View Source 
var ErrNoLedger = errors.New("directd: no ledger: every query is billed, and Meter.Ledger accounts for it")

ErrNoLedger is a query made without a Ledger. Every query costs money, so the client refuses to make one nobody accounts for.

View Source 
var ErrUnavailable = errors.New("directd: unavailable: the circuit breaker is open")

ErrUnavailable is a call the circuit breaker refused, after Threshold consecutive transport errors or 5xx answers, until its cooldown ends. No request is made and nothing is reserved.

Functions

func As 

func As[T any](r *Result) (*T, bool)

As returns r.Data as *T, and false when it holds something else.

func DefaultProducts 

func DefaultProducts() map[string]Product

DefaultProducts returns every API of the public catalogue, by slug, read from catalog/catalog.json when the package was generated. The map and every Product in it are copies.

func MaskDocument 

func MaskDocument(s string) string

MaskDocument writes a CPF with only its check digits shown (***.***.***-09) and a CNPJ with its first two and last two characters shown (11.***.***/****-81). Anything else comes back as "".

func ProductSlugs 

func ProductSlugs() []string

ProductSlugs returns the slugs of DefaultProducts, sorted.

func Redact 

func Redact(body []byte) ([]byte, bool)

Redact rewrites a Direct Data answer so that it can be logged, shown in a support ticket or kept as a fixture without the personal data in it.

The structure is kept: every key, every array and every boolean. A string under a key that holds personal data becomes a placeholder naming its kind ("<name>", "<address>", "<phone>", "<email>", "<birthdate>", "<vehicle>", "<network>", "<account>"), a CPF or CNPJ becomes its masked form (or "<document>"), and a number under such a key becomes 0. A string under a key that describes a status, a category or a count (situacaoCadastral, resultado, cnaeDescricao, ...) is kept, unless it holds a run of nine or more digits or an "@", which become "<redacted>". Every other string becomes "<string>".

When the input is not JSON it returns nil and false: a body that cannot be read cannot be shown to be clean, so none of it is returned.

Types

type AMLParams 

type AMLParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

AMLParams are the parameters of AML (AML - Anti Money Laundering (Vínculos Societários)).

func (AMLParams) Request 

func (p AMLParams) Request() (Request, error)

Request builds the Request for AML.

type AMLRetorno 

type AMLRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Genero is retorno.genero, documented as a string.
	Genero Text `json:"genero"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.obito, documented as a boolean.
	Obito Flag `json:"obito"`
	// Parentescos is retorno.parentescos, a list.
	Parentescos []AMLRetornoParentescos `json:"parentescos"`
	// Pep is retorno.pep, documented as a boolean.
	Pep Flag `json:"pep"`
	// Sociedades is retorno.sociedades, a list.
	Sociedades []AMLRetornoSociedades `json:"sociedades"`
}

AMLRetorno is retorno in the answer of AML.

type AMLRetornoParentescos 

type AMLRetornoParentescos struct {
	// Cpf is retorno.parentescos[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.parentescos[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.parentescos[].dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Genero is retorno.parentescos[].genero, documented as a string.
	Genero Text `json:"genero"`
	// GrauParentesco is retorno.parentescos[].grauParentesco, documented as a string.
	GrauParentesco Text `json:"grauParentesco"`
	// Nome is retorno.parentescos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.parentescos[].obito, documented as a boolean.
	Obito Flag `json:"obito"`
}

AMLRetornoParentescos is retorno.parentescos[] in the answer of AML.

type AMLRetornoSociedades 

type AMLRetornoSociedades struct {
	// Baixada is retorno.sociedades[].baixada, documented as a boolean.
	Baixada Flag `json:"baixada"`
	// Cnpj is retorno.sociedades[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DataAbertura is retorno.sociedades[].dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// NomeFantasia is retorno.sociedades[].nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// RazaoSocial is retorno.sociedades[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Socios is retorno.sociedades[].socios, a list.
	Socios []AMLRetornoSociedadesSocios `json:"socios"`
}

AMLRetornoSociedades is retorno.sociedades[] in the answer of AML.

type AMLRetornoSociedadesSocios 

type AMLRetornoSociedadesSocios struct {
	// Baixada is retorno.sociedades[].socios[].baixada, documented as a boolean.
	Baixada Flag `json:"baixada"`
	// Cnpj is retorno.sociedades[].socios[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Cpf is retorno.sociedades[].socios[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataAbertura is retorno.sociedades[].socios[].dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataBaixada is retorno.sociedades[].socios[].dataBaixada, documented as a string.
	DataBaixada Text `json:"dataBaixada"`
	// DataNascimento is retorno.sociedades[].socios[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.sociedades[].socios[].dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Genero is retorno.sociedades[].socios[].genero, documented as a string.
	Genero Text `json:"genero"`
	// Nome is retorno.sociedades[].socios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.sociedades[].socios[].obito, documented as a boolean.
	Obito Flag `json:"obito"`
	// QualificacaoSocio is retorno.sociedades[].socios[].qualificacaoSocio, documented as a string.
	QualificacaoSocio Text `json:"qualificacaoSocio"`
	// RazaoSocial is retorno.sociedades[].socios[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

AMLRetornoSociedadesSocios is retorno.sociedades[].socios[] in the answer of AML.

type ANTTConsultaCodigoIdentificadorOperacaoTransporteParams 

type ANTTConsultaCodigoIdentificadorOperacaoTransporteParams struct {
	// RNTRC is sent as RNTRC. O parâmetro RNTRC é um conjunto de 9 números.
	RNTRC string
	// RENAVAM is sent as RENAVAM. O parâmetro RENAVAM deve ser informado juntamente com seus 11 dígitos numéricos.
	RENAVAM string
}

ANTTConsultaCodigoIdentificadorOperacaoTransporteParams are the parameters of ANTTConsultaCodigoIdentificadorOperacaoTransporte (ANTT - Código Identificador Operação Transporte).

func (ANTTConsultaCodigoIdentificadorOperacaoTransporteParams) Request 

func (p ANTTConsultaCodigoIdentificadorOperacaoTransporteParams) Request() (Request, error)

Request builds the Request for ANTTConsultaCodigoIdentificadorOperacaoTransporte.

type ANTTConsultaCodigoIdentificadorOperacaoTransporteRetorno 

type ANTTConsultaCodigoIdentificadorOperacaoTransporteRetorno struct {
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// RetornoCIOT is retorno.retornoCIOT, a list.
	RetornoCIOT []ANTTConsultaCodigoIdentificadorOperacaoTransporteRetornoRetornoCIOT `json:"retornoCIOT"`
	// Rntrc is retorno.rntrc, documented as a string.
	Rntrc Text `json:"rntrc"`
	// TotalCIOT is retorno.totalCIOT, documented as a string.
	TotalCIOT Text `json:"totalCIOT"`
}

ANTTConsultaCodigoIdentificadorOperacaoTransporteRetorno is retorno in the answer of ANTTConsultaCodigoIdentificadorOperacaoTransporte.

type ANTTConsultaCodigoIdentificadorOperacaoTransporteRetornoRetornoCIOT 

type ANTTConsultaCodigoIdentificadorOperacaoTransporteRetornoRetornoCIOT struct {
	// CnpjContratante is retorno.retornoCIOT[].cnpjContratante, documented as a string.
	CnpjContratante Text `json:"cnpjContratante" pii:"document"`
	// DataFimVinculo is retorno.retornoCIOT[].dataFimVinculo, documented as a string.
	DataFimVinculo Text `json:"dataFimVinculo"`
	// NumeroCIOT is retorno.retornoCIOT[].numeroCIOT, documented as a string.
	NumeroCIOT Text `json:"numeroCIOT"`
	// Situacao is retorno.retornoCIOT[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoOperacao is retorno.retornoCIOT[].tipoOperacao, documented as a string.
	TipoOperacao Text `json:"tipoOperacao"`
}

ANTTConsultaCodigoIdentificadorOperacaoTransporteRetornoRetornoCIOT is retorno.retornoCIOT[] in the answer of ANTTConsultaCodigoIdentificadorOperacaoTransporte.

type ANTTConsultaRegularidadeTransportadoraParams 

type ANTTConsultaRegularidadeTransportadoraParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// RNTRC is sent as RNTRC. O parâmetro RNTRC é um conjunto de 9 números.
	RNTRC string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

ANTTConsultaRegularidadeTransportadoraParams are the parameters of ANTTConsultaRegularidadeTransportadora (ANTT - Consulta de Regularidade da Transportadora).

func (ANTTConsultaRegularidadeTransportadoraParams) Request 

func (p ANTTConsultaRegularidadeTransportadoraParams) Request() (Request, error)

Request builds the Request for ANTTConsultaRegularidadeTransportadora.

type ANTTConsultaRegularidadeTransportadoraRetorno 

type ANTTConsultaRegularidadeTransportadoraRetorno struct {
	// Apto is retorno.apto, documented as a boolean.
	Apto Flag `json:"apto"`
	// Categoria is retorno.categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Localizacao is retorno.localizacao.
	Localizacao ANTTConsultaRegularidadeTransportadoraRetornoLocalizacao `json:"localizacao"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Protocolo is retorno.protocolo, documented as a string.
	Protocolo Text `json:"protocolo"`
	// Rntrc is retorno.rntrc, documented as a number.
	Rntrc Number `json:"rntrc"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Transportador is retorno.transportador, documented as a string.
	Transportador Text `json:"transportador"`
}

ANTTConsultaRegularidadeTransportadoraRetorno is retorno in the answer of ANTTConsultaRegularidadeTransportadora.

type ANTTConsultaRegularidadeTransportadoraRetornoLocalizacao 

type ANTTConsultaRegularidadeTransportadoraRetornoLocalizacao struct {
	// Municipio is retorno.localizacao.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Uf is retorno.localizacao.uf, documented as a string.
	Uf Text `json:"uf"`
}

ANTTConsultaRegularidadeTransportadoraRetornoLocalizacao is retorno.localizacao in the answer of ANTTConsultaRegularidadeTransportadora.

type APFRuralParams 

type APFRuralParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NumeroAPF is sent as NumeroAPF. O parâmetro NumeroAPF pode ser enviado com ou sem formatação.
	NumeroAPF string
	// NumeroCAR is sent as NumeroCAR. O parâmetro NumeroCAR pode ser enviado com ou sem formatação.
	NumeroCAR string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

APFRuralParams are the parameters of APFRural (APF Rural - Autorização Provisória de Funcionamento Rural).

func (APFRuralParams) Request 

func (p APFRuralParams) Request() (Request, error)

Request builds the Request for APFRural.

type APFRuralRetorno 

type APFRuralRetorno struct {
	// Autorizacoes is retorno.autorizacoes, a list.
	Autorizacoes []APFRuralRetornoAutorizacoes `json:"autorizacoes"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// QuantidadeAutorizacoes is retorno.quantidadeAutorizacoes, documented as a number.
	QuantidadeAutorizacoes Number `json:"quantidadeAutorizacoes"`
}

APFRuralRetorno is retorno in the answer of APFRural.

type APFRuralRetornoAutorizacoes 

type APFRuralRetornoAutorizacoes struct {
	// Apf is retorno.autorizacoes[].apf, documented as a string.
	Apf Text `json:"apf"`
	// Atividade is retorno.autorizacoes[].atividade, documented as a string.
	Atividade Text `json:"atividade"`
	// Car is retorno.autorizacoes[].car, documented as a string.
	Car Text `json:"car"`
	// DataEmissao is retorno.autorizacoes[].dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.autorizacoes[].dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Imovel is retorno.autorizacoes[].imovel, documented as a string.
	Imovel Text `json:"imovel"`
	// InformacoesAdicionais is retorno.autorizacoes[].informacoesAdicionais.
	InformacoesAdicionais APFRuralRetornoAutorizacoesInformacoesAdicionais `json:"informacoesAdicionais"`
	// Municipio is retorno.autorizacoes[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Proprietario is retorno.autorizacoes[].proprietario.
	Proprietario APFRuralRetornoAutorizacoesProprietario `json:"proprietario"`
	// Responsavel is retorno.autorizacoes[].responsavel.
	Responsavel APFRuralRetornoAutorizacoesResponsavel `json:"responsavel"`
	// SituacaoCAR is retorno.autorizacoes[].situacaoCAR, documented as a string.
	SituacaoCAR Text `json:"situacaoCAR"`
	// Status is retorno.autorizacoes[].status, documented as a string.
	Status Text `json:"status"`
}

APFRuralRetornoAutorizacoes is retorno.autorizacoes[] in the answer of APFRural.

type APFRuralRetornoAutorizacoesInformacoesAdicionais 

type APFRuralRetornoAutorizacoesInformacoesAdicionais struct {
	// AreaTotal is retorno.autorizacoes[].informacoesAdicionais.areaTotal, documented as a string.
	AreaTotal Text `json:"areaTotal"`
	// AreaUtilizada is retorno.autorizacoes[].informacoesAdicionais.areaUtilizada, documented as a string.
	AreaUtilizada Text `json:"areaUtilizada"`
	// Coordenadas is retorno.autorizacoes[].informacoesAdicionais.coordenadas, documented as a string.
	Coordenadas Text `json:"coordenadas"`
}

APFRuralRetornoAutorizacoesInformacoesAdicionais is retorno.autorizacoes[].informacoesAdicionais in the answer of APFRural.

type APFRuralRetornoAutorizacoesProprietario 

type APFRuralRetornoAutorizacoesProprietario struct {
	// Documento is retorno.autorizacoes[].proprietario.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.autorizacoes[].proprietario.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

APFRuralRetornoAutorizacoesProprietario is retorno.autorizacoes[].proprietario in the answer of APFRural.

type APFRuralRetornoAutorizacoesResponsavel 

type APFRuralRetornoAutorizacoesResponsavel struct {
	// Documento is retorno.autorizacoes[].responsavel.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.autorizacoes[].responsavel.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

APFRuralRetornoAutorizacoesResponsavel is retorno.autorizacoes[].responsavel in the answer of APFRural.

type AcordosLenienciaParams 

type AcordosLenienciaParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

AcordosLenienciaParams are the parameters of AcordosLeniencia (Acordos de Leniência).

func (AcordosLenienciaParams) Request 

func (p AcordosLenienciaParams) Request() (Request, error)

Request builds the Request for AcordosLeniencia.

type AcordosLenienciaRetorno 

type AcordosLenienciaRetorno struct {
	// Acordos is retorno.acordos, a list.
	Acordos []AcordosLenienciaRetornoAcordos `json:"acordos"`
	// ConstamAcordos is retorno.constamAcordos, documented as a boolean.
	ConstamAcordos Flag `json:"constamAcordos"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// QuantidadeAcordos is retorno.quantidadeAcordos, documented as a number.
	QuantidadeAcordos Number `json:"quantidadeAcordos"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// TotalSancoes is retorno.totalSancoes, documented as a number.
	TotalSancoes Number `json:"totalSancoes"`
}

AcordosLenienciaRetorno is retorno in the answer of AcordosLeniencia.

type AcordosLenienciaRetornoAcordos 

type AcordosLenienciaRetornoAcordos struct {
	// DetalhamentoAcordo is retorno.acordos[].detalhamentoAcordo.
	DetalhamentoAcordo AcordosLenienciaRetornoAcordosDetalhamentoAcordo `json:"detalhamentoAcordo"`
	// NumeroRegistro is retorno.acordos[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// QuantidadeSancoes is retorno.acordos[].quantidadeSancoes, documented as a number.
	QuantidadeSancoes Number `json:"quantidadeSancoes"`
	// Sancoes is retorno.acordos[].sancoes, a list.
	Sancoes []AcordosLenienciaRetornoAcordosSancoes `json:"sancoes"`
}

AcordosLenienciaRetornoAcordos is retorno.acordos[] in the answer of AcordosLeniencia.

type AcordosLenienciaRetornoAcordosDetalhamentoAcordo 

type AcordosLenienciaRetornoAcordosDetalhamentoAcordo struct {
	// DataFimAcordo is retorno.acordos[].detalhamentoAcordo.dataFimAcordo, documented as a string.
	DataFimAcordo Text `json:"dataFimAcordo"`
	// DataInicioAcordo is retorno.acordos[].detalhamentoAcordo.dataInicioAcordo, documented as a string.
	DataInicioAcordo Text `json:"dataInicioAcordo"`
	// OrgaoResponsavel is retorno.acordos[].detalhamentoAcordo.orgaoResponsavel, documented as a string.
	OrgaoResponsavel Text `json:"orgaoResponsavel"`
	// SituacaoAcordo is retorno.acordos[].detalhamentoAcordo.situacaoAcordo, documented as a string.
	SituacaoAcordo Text `json:"situacaoAcordo"`
}

AcordosLenienciaRetornoAcordosDetalhamentoAcordo is retorno.acordos[].detalhamentoAcordo in the answer of AcordosLeniencia.

type AcordosLenienciaRetornoAcordosSancoes 

type AcordosLenienciaRetornoAcordosSancoes struct {
	// Cnpj is retorno.acordos[].sancoes[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// NomeFantasia is retorno.acordos[].sancoes[].nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// RazaoSocial is retorno.acordos[].sancoes[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

AcordosLenienciaRetornoAcordosSancoes is retorno.acordos[].sancoes[] in the answer of AcordosLeniencia.

type AnbimaCertificadoEDUParams 

type AnbimaCertificadoEDUParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

AnbimaCertificadoEDUParams are the parameters of AnbimaCertificadoEDU (Certificado Anbima EDU).

func (AnbimaCertificadoEDUParams) Request 

func (p AnbimaCertificadoEDUParams) Request() (Request, error)

Request builds the Request for AnbimaCertificadoEDU.

type AnbimaCertificadoEDURetorno 

type AnbimaCertificadoEDURetorno struct {
	// Certificacoes is retorno.certificacoes, a list.
	Certificacoes []AnbimaCertificadoEDURetornoCertificacoes `json:"certificacoes"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiCertificacoes is retorno.possuiCertificacoes, documented as a boolean.
	PossuiCertificacoes Flag `json:"possuiCertificacoes"`
}

AnbimaCertificadoEDURetorno is retorno in the answer of AnbimaCertificadoEDU.

type AnbimaCertificadoEDURetornoCertificacoes 

type AnbimaCertificadoEDURetornoCertificacoes struct {
	// FormaObtencao is retorno.certificacoes[].formaObtencao, documented as a string.
	FormaObtencao Text `json:"formaObtencao"`
	// PrimeiraCertificacao is retorno.certificacoes[].primeiraCertificacao, documented as a string.
	PrimeiraCertificacao Text `json:"primeiraCertificacao"`
	// Situacao is retorno.certificacoes[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Titulo is retorno.certificacoes[].titulo, documented as a string.
	Titulo Text `json:"titulo"`
	// UltimaAtualizacao is retorno.certificacoes[].ultimaAtualizacao, documented as a string.
	UltimaAtualizacao Text `json:"ultimaAtualizacao"`
	// Vencimento is retorno.certificacoes[].vencimento, documented as a string.
	Vencimento Text `json:"vencimento"`
}

AnbimaCertificadoEDURetornoCertificacoes is retorno.certificacoes[] in the answer of AnbimaCertificadoEDU.

type AntifraudePixParams 

type AntifraudePixParams struct {
	// Documento is sent as Documento. O parâmetro DOCUMENTO pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	Documento string
	// Chave is sent as Chave. O parâmetro CHAVE pode ser enviado com qualquer outro.
	Chave string
	// Tipo is sent as Tipo. O parâmetro TIPO deve ser enviado.
	Tipo string
}

AntifraudePixParams are the parameters of AntifraudePix (Antifraude Chave PIX).

func (AntifraudePixParams) Request 

func (p AntifraudePixParams) Request() (Request, error)

Request builds the Request for AntifraudePix.

type AntifraudePixRetorno 

type AntifraudePixRetorno struct {
	// ChavePix is retorno.chavePix, documented as a string.
	ChavePix Text `json:"chavePix"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// ProbabilidadeTitularidade is retorno.probabilidadeTitularidade, documented as a string.
	ProbabilidadeTitularidade Text `json:"probabilidadeTitularidade"`
	// RiscoFraude is retorno.riscoFraude, documented as a string.
	RiscoFraude Text `json:"riscoFraude"`
	// RiscoLaranja is retorno.riscoLaranja, documented as a string.
	RiscoLaranja Text `json:"riscoLaranja"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Tipo is retorno.tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

AntifraudePixRetorno is retorno in the answer of AntifraudePix.

type AsyncOptions 

type AsyncOptions struct {
	// CallbackURL is where Direct Data should post the result. It is sent in
	// Config.CallbackURLParam, which the documentation does not name; leave
	// it empty to use the callback configured in the portal.
	CallbackURL string
}

AsyncOptions are the options of an asynchronous query.

type AustraliaDFATParams 

type AustraliaDFATParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
}

AustraliaDFATParams are the parameters of AustraliaDFAT (Austrália DFAT - Sanções Internacionais).

func (AustraliaDFATParams) Request 

func (p AustraliaDFATParams) Request() (Request, error)

Request builds the Request for AustraliaDFAT.

type AustraliaDFATRetorno 

type AustraliaDFATRetorno struct {
	// DataLista is retorno.dataLista, documented as a string.
	DataLista Text `json:"dataLista"`
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []AustraliaDFATRetornoSancoes `json:"sancoes"`
}

AustraliaDFATRetorno is retorno in the answer of AustraliaDFAT.

type AustraliaDFATRetornoSancoes 

type AustraliaDFATRetornoSancoes struct {
	// Apelidos is retorno.sancoes[].apelidos, a list.
	Apelidos []AustraliaDFATRetornoSancoesApelidos `json:"apelidos"`
	// Atributos is retorno.sancoes[].atributos, a list.
	Atributos []AustraliaDFATRetornoSancoesAtributos `json:"atributos"`
	// DataInclusaoLista is retorno.sancoes[].dataInclusaoLista, documented as a string.
	DataInclusaoLista Text `json:"dataInclusaoLista"`
	// DataNascimento is retorno.sancoes[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Enderecos is retorno.sancoes[].enderecos, a list.
	Enderecos []AustraliaDFATRetornoSancoesEnderecos `json:"enderecos"`
	// Identificacoes is retorno.sancoes[].identificacoes, a list.
	Identificacoes []AustraliaDFATRetornoSancoesIdentificacoes `json:"identificacoes"`
	// LocalNascimento is retorno.sancoes[].localNascimento, documented as a string.
	LocalNascimento Text `json:"localNascimento"`
	// Nacionalidade is retorno.sancoes[].nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Nome is retorno.sancoes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Programas is retorno.sancoes[].programas, documented as a string.
	Programas Text `json:"programas"`
	// Status is retorno.sancoes[].status, documented as a string.
	Status Text `json:"status"`
	// TipoRegistro is retorno.sancoes[].tipoRegistro, documented as a string.
	TipoRegistro Text `json:"tipoRegistro"`
}

AustraliaDFATRetornoSancoes is retorno.sancoes[] in the answer of AustraliaDFAT.

type AustraliaDFATRetornoSancoesApelidos 

type AustraliaDFATRetornoSancoesApelidos struct {
	// Nome is retorno.sancoes[].apelidos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Qualidade is retorno.sancoes[].apelidos[].qualidade, documented as a string.
	Qualidade Text `json:"qualidade"`
	// Tipo is retorno.sancoes[].apelidos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

AustraliaDFATRetornoSancoesApelidos is retorno.sancoes[].apelidos[] in the answer of AustraliaDFAT.

type AustraliaDFATRetornoSancoesAtributos 

type AustraliaDFATRetornoSancoesAtributos struct {
	// Chave is retorno.sancoes[].atributos[].chave, documented as a string.
	Chave Text `json:"chave" pii:"document"`
	// Valor is retorno.sancoes[].atributos[].valor, documented as a string.
	Valor Text `json:"valor"`
}

AustraliaDFATRetornoSancoesAtributos is retorno.sancoes[].atributos[] in the answer of AustraliaDFAT.

type AustraliaDFATRetornoSancoesEnderecos 

type AustraliaDFATRetornoSancoesEnderecos struct {
	// Endereco is retorno.sancoes[].enderecos[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
}

AustraliaDFATRetornoSancoesEnderecos is retorno.sancoes[].enderecos[] in the answer of AustraliaDFAT.

type AustraliaDFATRetornoSancoesIdentificacoes 

type AustraliaDFATRetornoSancoesIdentificacoes struct {
	// Documento is retorno.sancoes[].identificacoes[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Tipo is retorno.sancoes[].identificacoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

AustraliaDFATRetornoSancoesIdentificacoes is retorno.sancoes[].identificacoes[] in the answer of AustraliaDFAT.

type AuxilioEmergencialParams 

type AuxilioEmergencialParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NIS is sent as NIS. O parâmetro NIS pode ser enviado com ou sem formatação.
	NIS string
}

AuxilioEmergencialParams are the parameters of AuxilioEmergencial (Auxílio Emergencial).

func (AuxilioEmergencialParams) Request 

func (p AuxilioEmergencialParams) Request() (Request, error)

Request builds the Request for AuxilioEmergencial.

type AuxilioEmergencialRetorno 

type AuxilioEmergencialRetorno struct {
	// Beneficios is retorno.beneficios, a list.
	Beneficios []AuxilioEmergencialRetornoBeneficios `json:"beneficios"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

AuxilioEmergencialRetorno is retorno in the answer of AuxilioEmergencial.

type AuxilioEmergencialRetornoBeneficios 

type AuxilioEmergencialRetornoBeneficios struct {
	// Data is retorno.beneficios[].data, documented as a string.
	Data Text `json:"data"`
	// Enquadramento is retorno.beneficios[].enquadramento, documented as a string.
	Enquadramento Text `json:"enquadramento"`
	// Municipio is retorno.beneficios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroParcela is retorno.beneficios[].numeroParcela, documented as a number.
	NumeroParcela Number `json:"numeroParcela"`
	// NumeroRegistro is retorno.beneficios[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Situacao is retorno.beneficios[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Uf is retorno.beneficios[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.beneficios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

AuxilioEmergencialRetornoBeneficios is retorno.beneficios[] in the answer of AuxilioEmergencial.

type AuxilioReconstrucaoParams 

type AuxilioReconstrucaoParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NIS is sent as NIS. O parâmetro NIS pode ser enviado com ou sem formatação.
	NIS string
}

AuxilioReconstrucaoParams are the parameters of AuxilioReconstrucao (Auxílio Reconstrução).

func (AuxilioReconstrucaoParams) Request 

func (p AuxilioReconstrucaoParams) Request() (Request, error)

Request builds the Request for AuxilioReconstrucao.

type AuxilioReconstrucaoRetorno 

type AuxilioReconstrucaoRetorno struct {
	// Beneficios is retorno.beneficios, a list.
	Beneficios []AuxilioReconstrucaoRetornoBeneficios `json:"beneficios"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// QuantidadePessoasFamilia is retorno.quantidadePessoasFamilia, documented as a number.
	QuantidadePessoasFamilia Number `json:"quantidadePessoasFamilia"`
}

AuxilioReconstrucaoRetorno is retorno in the answer of AuxilioReconstrucao.

type AuxilioReconstrucaoRetornoBeneficios 

type AuxilioReconstrucaoRetornoBeneficios struct {
	// Data is retorno.beneficios[].data, documented as a string.
	Data Text `json:"data"`
	// Municipio is retorno.beneficios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Uf is retorno.beneficios[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.beneficios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

AuxilioReconstrucaoRetornoBeneficios is retorno.beneficios[] in the answer of AuxilioReconstrucao.

type BancoCentralInabilitadosParams 

type BancoCentralInabilitadosParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

BancoCentralInabilitadosParams are the parameters of BancoCentralInabilitados (Banco Central - Quadro Geral de Inabilitados).

func (BancoCentralInabilitadosParams) Request 

func (p BancoCentralInabilitadosParams) Request() (Request, error)

Request builds the Request for BancoCentralInabilitados.

type BancoCentralInabilitadosRetorno 

type BancoCentralInabilitadosRetorno struct {
	// ConstamPenalidades is retorno.constamPenalidades, documented as a boolean.
	ConstamPenalidades Flag `json:"constamPenalidades"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Penalidades is retorno.penalidades, a list.
	Penalidades []BancoCentralInabilitadosRetornoPenalidades `json:"penalidades"`
}

BancoCentralInabilitadosRetorno is retorno in the answer of BancoCentralInabilitados.

type BancoCentralInabilitadosRetornoPenalidades 

type BancoCentralInabilitadosRetornoPenalidades struct {
	// DataFim is retorno.penalidades[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.penalidades[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Descricao is retorno.penalidades[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// NumeroPAS is retorno.penalidades[].numeroPAS, documented as a string.
	NumeroPAS Text `json:"numeroPAS"`
	// PrazoEmAnos is retorno.penalidades[].prazoEmAnos, documented as a string.
	PrazoEmAnos Text `json:"prazoEmAnos"`
}

BancoCentralInabilitadosRetornoPenalidades is retorno.penalidades[] in the answer of BancoCentralInabilitados.

type BancoCentralProibidosParams 

type BancoCentralProibidosParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

BancoCentralProibidosParams are the parameters of BancoCentralProibidos (Banco Central - Quadro Geral de Proibidos).

func (BancoCentralProibidosParams) Request 

func (p BancoCentralProibidosParams) Request() (Request, error)

Request builds the Request for BancoCentralProibidos.

type BancoCentralProibidosRetorno 

type BancoCentralProibidosRetorno struct {
	// ConstamPenalidades is retorno.constamPenalidades, documented as a boolean.
	ConstamPenalidades Flag `json:"constamPenalidades"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Penalidades is retorno.penalidades, a list.
	Penalidades []BancoCentralProibidosRetornoPenalidades `json:"penalidades"`
}

BancoCentralProibidosRetorno is retorno in the answer of BancoCentralProibidos.

type BancoCentralProibidosRetornoPenalidades 

type BancoCentralProibidosRetornoPenalidades struct {
	// DataFim is retorno.penalidades[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.penalidades[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Descricao is retorno.penalidades[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// NumeroPAS is retorno.penalidades[].numeroPAS, documented as a string.
	NumeroPAS Text `json:"numeroPAS"`
	// PrazoEmAnos is retorno.penalidades[].prazoEmAnos, documented as a string.
	PrazoEmAnos Text `json:"prazoEmAnos"`
}

BancoCentralProibidosRetornoPenalidades is retorno.penalidades[] in the answer of BancoCentralProibidos.

type BeneficiarioFinalParams 

type BeneficiarioFinalParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

BeneficiarioFinalParams are the parameters of BeneficiarioFinal (Beneficiário Final).

func (BeneficiarioFinalParams) Request 

func (p BeneficiarioFinalParams) Request() (Request, error)

Request builds the Request for BeneficiarioFinal.

type BeneficiarioFinalRetorno 

type BeneficiarioFinalRetorno struct {
	// DataCadastro is retorno.dataCadastro, documented as a string.
	DataCadastro Text `json:"dataCadastro"`
	// DataUpdate is retorno.dataUpdate, documented as a string.
	DataUpdate Text `json:"dataUpdate"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeRazaoSocial is retorno.nomeRazaoSocial, documented as a string.
	NomeRazaoSocial Text `json:"nomeRazaoSocial" pii:"name"`
	// PepMatriz is retorno.pepMatriz, documented as a boolean.
	PepMatriz Flag `json:"pepMatriz"`
	// Sociedades is retorno.sociedades, a list.
	Sociedades []BeneficiarioFinalRetornoSociedades `json:"sociedades"`
}

BeneficiarioFinalRetorno is retorno in the answer of BeneficiarioFinal.

type BeneficiarioFinalRetornoSociedades 

type BeneficiarioFinalRetornoSociedades struct {
	// Documento is retorno.sociedades[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// HistoricoSociedades is retorno.sociedades[].historicoSociedades, a list.
	HistoricoSociedades []BeneficiarioFinalRetornoSociedadesHistoricoSociedades `json:"historicoSociedades"`
	// Nivel is retorno.sociedades[].nivel, documented as a number.
	Nivel Number `json:"nivel"`
	// NomeRazaoSocial is retorno.sociedades[].nomeRazaoSocial, documented as a string.
	NomeRazaoSocial Text `json:"nomeRazaoSocial" pii:"name"`
	// PepMatriz is retorno.sociedades[].pepMatriz, documented as a boolean.
	PepMatriz Flag `json:"pepMatriz"`
	// Socios is retorno.sociedades[].socios, a list.
	Socios []Text `json:"socios"`
	// Status is retorno.sociedades[].status, documented as a boolean.
	Status Flag `json:"status"`
}

BeneficiarioFinalRetornoSociedades is retorno.sociedades[] in the answer of BeneficiarioFinal.

type BeneficiarioFinalRetornoSociedadesHistoricoSociedades 

type BeneficiarioFinalRetornoSociedadesHistoricoSociedades struct {
	// Cargo is retorno.sociedades[].historicoSociedades[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataFim is retorno.sociedades[].historicoSociedades[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.sociedades[].historicoSociedades[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Status is retorno.sociedades[].historicoSociedades[].status, documented as a boolean.
	Status Flag `json:"status"`
}

BeneficiarioFinalRetornoSociedadesHistoricoSociedades is retorno.sociedades[].historicoSociedades[] in the answer of BeneficiarioFinal.

type BeneficioPrestacaoContinuadaParams 

type BeneficioPrestacaoContinuadaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Nis is sent as Nis. O parâmetro NIS pode ser enviado com ou sem formatação.
	Nis string
}

BeneficioPrestacaoContinuadaParams are the parameters of BeneficioPrestacaoContinuada (Benefício de Prestação Continuada - BPC).

func (BeneficioPrestacaoContinuadaParams) Request 

func (p BeneficioPrestacaoContinuadaParams) Request() (Request, error)

Request builds the Request for BeneficioPrestacaoContinuada.

type BeneficioPrestacaoContinuadaRetorno 

type BeneficioPrestacaoContinuadaRetorno struct {
	// BeneficioConcedidoJudicialmente is retorno.beneficioConcedidoJudicialmente, documented as a boolean.
	BeneficioConcedidoJudicialmente Flag `json:"beneficioConcedidoJudicialmente"`
	// Beneficios is retorno.beneficios, a list.
	Beneficios []BeneficioPrestacaoContinuadaRetornoBeneficios `json:"beneficios"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

BeneficioPrestacaoContinuadaRetorno is retorno in the answer of BeneficioPrestacaoContinuada.

type BeneficioPrestacaoContinuadaRetornoBeneficios 

type BeneficioPrestacaoContinuadaRetornoBeneficios struct {
	// DataMesCompetencia is retorno.beneficios[].dataMesCompetencia, documented as a string.
	DataMesCompetencia Text `json:"dataMesCompetencia"`
	// DataMesReferencia is retorno.beneficios[].dataMesReferencia, documented as a string.
	DataMesReferencia Text `json:"dataMesReferencia"`
	// Municipio is retorno.beneficios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroRegistro is retorno.beneficios[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Uf is retorno.beneficios[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.beneficios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BeneficioPrestacaoContinuadaRetornoBeneficios is retorno.beneficios[] in the answer of BeneficioPrestacaoContinuada.

type BeneficiosSociaisParams 

type BeneficiosSociaisParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

BeneficiosSociaisParams are the parameters of BeneficiosSociais (Benefícios Sociais - Pessoa Física).

func (BeneficiosSociaisParams) Request 

func (p BeneficiosSociaisParams) Request() (Request, error)

Request builds the Request for BeneficiosSociais.

type BeneficiosSociaisRetorno 

type BeneficiosSociaisRetorno struct {
	// AuxilioEmergencial is retorno.auxilioEmergencial, documented as a boolean.
	AuxilioEmergencial Flag `json:"auxilioEmergencial"`
	// AuxilioReconstrucao is retorno.auxilioReconstrucao, documented as a boolean.
	AuxilioReconstrucao Flag `json:"auxilioReconstrucao"`
	// BolsaFamilia is retorno.bolsaFamilia, documented as a boolean.
	BolsaFamilia Flag `json:"bolsaFamilia"`
	// Bpc is retorno.bpc, documented as a boolean.
	Bpc Flag `json:"bpc"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// GarantiaSafra is retorno.garantiaSafra, documented as a boolean.
	GarantiaSafra Flag `json:"garantiaSafra"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// Obito is retorno.obito, documented as a boolean.
	Obito Flag `json:"obito"`
	// SeguroDefeso is retorno.seguroDefeso, documented as a boolean.
	SeguroDefeso Flag `json:"seguroDefeso"`
}

BeneficiosSociaisRetorno is retorno in the answer of BeneficiosSociais.

type BetSafeComplianceParams 

type BetSafeComplianceParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

BetSafeComplianceParams are the parameters of BetSafeCompliance (Bet Safe Compliance).

func (BetSafeComplianceParams) Request 

func (p BetSafeComplianceParams) Request() (Request, error)

Request builds the Request for BetSafeCompliance.

type BetSafeComplianceRetorno 

type BetSafeComplianceRetorno struct {
	// Beneficios is retorno.beneficios.
	Beneficios BetSafeComplianceRetornoBeneficios `json:"beneficios"`
	// Cbo is retorno.cbo, documented as a string.
	Cbo Text `json:"cbo"`
	// CodigoCBO is retorno.codigoCBO, documented as a string.
	CodigoCBO Text `json:"codigoCBO"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Genero is retorno.genero, documented as a string.
	Genero Text `json:"genero"`
	// Idade is retorno.idade, documented as a number.
	Idade Number `json:"idade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.obito, documented as a boolean.
	Obito Flag `json:"obito"`
	// Parentescos is retorno.parentescos, a list.
	Parentescos []BetSafeComplianceRetornoParentescos `json:"parentescos"`
	// Pep is retorno.pep, documented as a boolean.
	Pep Flag `json:"pep"`
	// PersonalidadePublica is retorno.personalidadePublica, documented as a boolean.
	PersonalidadePublica Flag `json:"personalidadePublica"`
	// RelacionadoEsporte is retorno.relacionadoEsporte, documented as a boolean.
	RelacionadoEsporte Flag `json:"relacionadoEsporte"`
}

BetSafeComplianceRetorno is retorno in the answer of BetSafeCompliance.

type BetSafeComplianceRetornoBeneficios 

type BetSafeComplianceRetornoBeneficios struct {
	// AuxilioEmergencial is retorno.beneficios.auxilioEmergencial, documented as a boolean.
	AuxilioEmergencial Flag `json:"auxilioEmergencial"`
	// AuxilioReconstrucao is retorno.beneficios.auxilioReconstrucao, documented as a boolean.
	AuxilioReconstrucao Flag `json:"auxilioReconstrucao"`
	// BolsaFamilia is retorno.beneficios.bolsaFamilia, documented as a boolean.
	BolsaFamilia Flag `json:"bolsaFamilia"`
	// Bpc is retorno.beneficios.bpc, documented as a boolean.
	Bpc Flag `json:"bpc"`
	// GarantiaSafra is retorno.beneficios.garantiaSafra, documented as a boolean.
	GarantiaSafra Flag `json:"garantiaSafra"`
	// Nis is retorno.beneficios.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// SeguroDefeso is retorno.beneficios.seguroDefeso, documented as a boolean.
	SeguroDefeso Flag `json:"seguroDefeso"`
}

BetSafeComplianceRetornoBeneficios is retorno.beneficios in the answer of BetSafeCompliance.

type BetSafeComplianceRetornoParentescos 

type BetSafeComplianceRetornoParentescos struct {
	// Cbo is retorno.parentescos[].cbo, documented as a string.
	Cbo Text `json:"cbo"`
	// CodigoCBO is retorno.parentescos[].codigoCBO, documented as a string.
	CodigoCBO Text `json:"codigoCBO"`
	// Cpf is retorno.parentescos[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.parentescos[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.parentescos[].dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Genero is retorno.parentescos[].genero, documented as a string.
	Genero Text `json:"genero"`
	// GrauParentesco is retorno.parentescos[].grauParentesco, documented as a string.
	GrauParentesco Text `json:"grauParentesco"`
	// Nome is retorno.parentescos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.parentescos[].obito, documented as a boolean.
	Obito Flag `json:"obito"`
	// RelacionadoEsporte is retorno.parentescos[].relacionadoEsporte, documented as a boolean.
	RelacionadoEsporte Flag `json:"relacionadoEsporte"`
}

BetSafeComplianceRetornoParentescos is retorno.parentescos[] in the answer of BetSafeCompliance.

type BoaVistaAcertaCompletoPositivoPFParams 

type BoaVistaAcertaCompletoPositivoPFParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

BoaVistaAcertaCompletoPositivoPFParams are the parameters of BoaVistaAcertaCompletoPositivoPF (Boa Vista - Acerta Completo Positivo Pessoa Física).

func (BoaVistaAcertaCompletoPositivoPFParams) Request 

func (p BoaVistaAcertaCompletoPositivoPFParams) Request() (Request, error)

Request builds the Request for BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetorno 

type BoaVistaAcertaCompletoPositivoPFRetorno struct {
	// AcoesCiveis is retorno.acoesCiveis.
	AcoesCiveis BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveis `json:"acoesCiveis"`
	// CartaoNacionalSaude is retorno.cartaoNacionalSaude, documented as a string.
	CartaoNacionalSaude Text `json:"cartaoNacionalSaude"`
	// ChequeSemFundoBacen is retorno.chequeSemFundoBacen.
	ChequeSemFundoBacen BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoBacen `json:"chequeSemFundoBacen"`
	// ChequeSemFundoVarejo is retorno.chequeSemFundoVarejo.
	ChequeSemFundoVarejo BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoVarejo `json:"chequeSemFundoVarejo"`
	// ClasseSocial is retorno.classeSocial, documented as a string.
	ClasseSocial Text `json:"classeSocial"`
	// ControlePositivo is retorno.controlePositivo.
	ControlePositivo BoaVistaAcertaCompletoPositivoPFRetornoControlePositivo `json:"controlePositivo"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// CpfDataAtualizacaoReceita is retorno.cpfDataAtualizacaoReceita, documented as a string.
	CpfDataAtualizacaoReceita Text `json:"cpfDataAtualizacaoReceita" pii:"document"`
	// CpfOrigem is retorno.cpfOrigem, documented as a string.
	CpfOrigem Text `json:"cpfOrigem" pii:"document"`
	// CpfSituacao is retorno.cpfSituacao, documented as a string.
	CpfSituacao Text `json:"cpfSituacao" pii:"document"`
	// Decisao is retorno.decisao.
	Decisao BoaVistaAcertaCompletoPositivoPFRetornoDecisao `json:"decisao"`
	// Email is retorno.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []BoaVistaAcertaCompletoPositivoPFRetornoEnderecos `json:"enderecos"`
	// EstadoCivil is retorno.estadoCivil, documented as a string.
	EstadoCivil Text `json:"estadoCivil"`
	// FaixaRenda is retorno.faixaRenda, documented as a string.
	FaixaRenda Text `json:"faixaRenda"`
	// FalenciasAcoesRecuperacoes is retorno.falenciasAcoesRecuperacoes.
	FalenciasAcoesRecuperacoes BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoes `json:"falenciasAcoesRecuperacoes"`
	// GrauInstrucao is retorno.grauInstrucao, documented as a string.
	GrauInstrucao Text `json:"grauInstrucao"`
	// IndicacaoObito is retorno.indicacaoObito, documented as a string.
	IndicacaoObito Text `json:"indicacaoObito"`
	// Mae is retorno.mae, documented as a string.
	Mae Text `json:"mae" pii:"name"`
	// Nacionalidade is retorno.nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Nascimento is retorno.nascimento, documented as a string.
	Nascimento Text `json:"nascimento" pii:"birthdate"`
	// Naturalidade is retorno.naturalidade, documented as a string.
	Naturalidade Text `json:"naturalidade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomePai is retorno.nomePai, documented as a string.
	NomePai Text `json:"nomePai" pii:"name"`
	// NomeSocial is retorno.nomeSocial, documented as a string.
	NomeSocial Text `json:"nomeSocial" pii:"name"`
	// NumeroDependentes is retorno.numeroDependentes, documented as a string.
	NumeroDependentes Text `json:"numeroDependentes"`
	// NumeroPIS is retorno.numeroPIS, documented as a string.
	NumeroPIS Text `json:"numeroPIS"`
	// ParticipacaoEmEmpresas is retorno.participacaoEmEmpresas.
	ParticipacaoEmEmpresas BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresas `json:"participacaoEmEmpresas"`
	// PassagensComerciais is retorno.passagensComerciais.
	PassagensComerciais BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciais `json:"passagensComerciais"`
	// PendenciasFinanceiras is retorno.pendenciasFinanceiras.
	PendenciasFinanceiras BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceiras `json:"pendenciasFinanceiras"`
	// PoderAquisitivo is retorno.poderAquisitivo, documented as a string.
	PoderAquisitivo Text `json:"poderAquisitivo"`
	// Protestos is retorno.protestos.
	Protestos BoaVistaAcertaCompletoPositivoPFRetornoProtestos `json:"protestos"`
	// QtdDependentesBolsaFamilia is retorno.qtdDependentesBolsaFamilia, documented as a string.
	QtdDependentesBolsaFamilia Text `json:"qtdDependentesBolsaFamilia"`
	// RendaPresumida is retorno.rendaPresumida.
	RendaPresumida BoaVistaAcertaCompletoPositivoPFRetornoRendaPresumida `json:"rendaPresumida"`
	// Restricoes is retorno.restricoes.
	Restricoes BoaVistaAcertaCompletoPositivoPFRetornoRestricoes `json:"restricoes"`
	// Rg is retorno.rg, documented as a string.
	Rg Text `json:"rg" pii:"document"`
	// RgDataEmissao is retorno.rgDataEmissao, documented as a string.
	RgDataEmissao Text `json:"rgDataEmissao"`
	// Rguf is retorno.rguf, documented as a string.
	Rguf Text `json:"rguf"`
	// Scores is retorno.scores.
	Scores BoaVistaAcertaCompletoPositivoPFRetornoScores `json:"scores"`
	// Sexo is retorno.sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Telefones is retorno.telefones, a list.
	Telefones []BoaVistaAcertaCompletoPositivoPFRetornoTelefones `json:"telefones"`
	// TituloEleitor is retorno.tituloEleitor, documented as a string.
	TituloEleitor Text `json:"tituloEleitor"`
	// UltimoImpostoRenda is retorno.ultimoImpostoRenda, documented as a string.
	UltimoImpostoRenda Text `json:"ultimoImpostoRenda"`
}

BoaVistaAcertaCompletoPositivoPFRetorno is retorno in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveis 

type BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveis struct {
	// DataMaior is retorno.acoesCiveis.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataMenor is retorno.acoesCiveis.dataMenor, documented as a string.
	DataMenor Text `json:"dataMenor"`
	// DataPrimeiro is retorno.acoesCiveis.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// DataUltimo is retorno.acoesCiveis.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.acoesCiveis.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveisOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencia is retorno.acoesCiveis.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// ValorMaior is retorno.acoesCiveis.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorMenor is retorno.acoesCiveis.valorMenor, documented as a string.
	ValorMenor Text `json:"valorMenor"`
	// ValorPrimeiro is retorno.acoesCiveis.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.acoesCiveis.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.acoesCiveis.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveis is retorno.acoesCiveis in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveisOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveisOcorrencias struct {
	// Acao is retorno.acoesCiveis.ocorrencias[].acao, documented as a string.
	Acao Text `json:"acao"`
	// Autor is retorno.acoesCiveis.ocorrencias[].autor, documented as a string.
	Autor Text `json:"autor"`
	// Comarca is retorno.acoesCiveis.ocorrencias[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataDistribuicao is retorno.acoesCiveis.ocorrencias[].dataDistribuicao, documented as a string.
	DataDistribuicao Text `json:"dataDistribuicao"`
	// Documento is retorno.acoesCiveis.ocorrencias[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Foro is retorno.acoesCiveis.ocorrencias[].foro, documented as a string.
	Foro Text `json:"foro"`
	// Origem is retorno.acoesCiveis.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Processo is retorno.acoesCiveis.ocorrencias[].processo, documented as a string.
	Processo Text `json:"processo"`
	// Requerido is retorno.acoesCiveis.ocorrencias[].requerido, documented as a string.
	Requerido Text `json:"requerido"`
	// Valor is retorno.acoesCiveis.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// Vara is retorno.acoesCiveis.ocorrencias[].vara, documented as a string.
	Vara Text `json:"vara"`
}

BoaVistaAcertaCompletoPositivoPFRetornoAcoesCiveisOcorrencias is retorno.acoesCiveis.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoBacen 

type BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoBacen struct {
	// Correntista is retorno.chequeSemFundoBacen.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.chequeSemFundoBacen.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// QuantidadeOcorrencia is retorno.chequeSemFundoBacen.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// TipoPessoa is retorno.chequeSemFundoBacen.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoBacen is retorno.chequeSemFundoBacen in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoVarejo 

type BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoVarejo struct {
	// Correntista is retorno.chequeSemFundoVarejo.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.chequeSemFundoVarejo.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// QuantidadeOcorrencia is retorno.chequeSemFundoVarejo.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// TipoPessoa is retorno.chequeSemFundoVarejo.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaAcertaCompletoPositivoPFRetornoChequeSemFundoVarejo is retorno.chequeSemFundoVarejo in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoControlePositivo 

type BoaVistaAcertaCompletoPositivoPFRetornoControlePositivo struct {
	// OcorrenciasFaturasEmAtraso is retorno.controlePositivo.ocorrenciasFaturasEmAtraso, a list.
	OcorrenciasFaturasEmAtraso []BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso `json:"ocorrenciasFaturasEmAtraso"`
	// OcorrenciasNotaComportamentosContratosRecentes is retorno.controlePositivo.ocorrenciasNotaComportamentosContratosRecentes, a list.
	OcorrenciasNotaComportamentosContratosRecentes []BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes `json:"ocorrenciasNotaComportamentosContratosRecentes"`
}

BoaVistaAcertaCompletoPositivoPFRetornoControlePositivo is retorno.controlePositivo in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso 

type BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso struct {
	// NotaComportamentoFaturaEmAtraso is retorno.controlePositivo.ocorrenciasFaturasEmAtraso[].notaComportamentoFaturaEmAtraso, documented as a string.
	NotaComportamentoFaturaEmAtraso Text `json:"notaComportamentoFaturaEmAtraso"`
}

BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso is retorno.controlePositivo.ocorrenciasFaturasEmAtraso[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes 

type BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes struct {
	// Nota is retorno.controlePositivo.ocorrenciasNotaComportamentosContratosRecentes[].nota, documented as a string.
	Nota Text `json:"nota"`
}

BoaVistaAcertaCompletoPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes is retorno.controlePositivo.ocorrenciasNotaComportamentosContratosRecentes[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoDecisao 

type BoaVistaAcertaCompletoPositivoPFRetornoDecisao struct {
	// CodigoSituacao is retorno.decisao.codigoSituacao, documented as a string.
	CodigoSituacao Text `json:"codigoSituacao"`
	// Descricao is retorno.decisao.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Layout is retorno.decisao.layout, documented as a string.
	Layout Text `json:"layout"`
	// Resultado is retorno.decisao.resultado, documented as a string.
	Resultado Text `json:"resultado"`
}

BoaVistaAcertaCompletoPositivoPFRetornoDecisao is retorno.decisao in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoEnderecos 

type BoaVistaAcertaCompletoPositivoPFRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

BoaVistaAcertaCompletoPositivoPFRetornoEnderecos is retorno.enderecos[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoes 

type BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoes struct {
	// Ocorrencias is retorno.falenciasAcoesRecuperacoes.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencia is retorno.falenciasAcoesRecuperacoes.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// UltimoRegistro is retorno.falenciasAcoesRecuperacoes.ultimoRegistro, documented as a string.
	UltimoRegistro Text `json:"ultimoRegistro"`
	// ValorTotal is retorno.falenciasAcoesRecuperacoes.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
}

BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoes is retorno.falenciasAcoesRecuperacoes in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias struct {
	// Cartorio is retorno.falenciasAcoesRecuperacoes.ocorrencias[].cartorio, documented as a string.
	Cartorio Text `json:"cartorio"`
	// Data is retorno.falenciasAcoesRecuperacoes.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Documento is retorno.falenciasAcoesRecuperacoes.ocorrencias[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Origem is retorno.falenciasAcoesRecuperacoes.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Quantidade is retorno.falenciasAcoesRecuperacoes.ocorrencias[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// RazaoSocial is retorno.falenciasAcoesRecuperacoes.ocorrencias[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Tipo is retorno.falenciasAcoesRecuperacoes.ocorrencias[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Valor is retorno.falenciasAcoesRecuperacoes.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaAcertaCompletoPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias is retorno.falenciasAcoesRecuperacoes.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresas 

type BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresas struct {
	// Ocorrencias is retorno.participacaoEmEmpresas.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresasOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.participacaoEmEmpresas.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresas is retorno.participacaoEmEmpresas in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresasOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresasOcorrencias struct {
	// Cnpj is retorno.participacaoEmEmpresas.ocorrencias[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Participacao is retorno.participacaoEmEmpresas.ocorrencias[].participacao, documented as a string.
	Participacao Text `json:"participacao"`
	// ParticipanteCargo is retorno.participacaoEmEmpresas.ocorrencias[].participanteCargo, documented as a string.
	ParticipanteCargo Text `json:"participanteCargo"`
	// ParticipanteDocumento is retorno.participacaoEmEmpresas.ocorrencias[].participanteDocumento, documented as a string.
	ParticipanteDocumento Text `json:"participanteDocumento"`
	// ParticipanteEntrada is retorno.participacaoEmEmpresas.ocorrencias[].participanteEntrada, documented as a string.
	ParticipanteEntrada Text `json:"participanteEntrada"`
	// ParticipanteTipo is retorno.participacaoEmEmpresas.ocorrencias[].participanteTipo, documented as a string.
	ParticipanteTipo Text `json:"participanteTipo"`
	// QuantidadeOutrosSocios is retorno.participacaoEmEmpresas.ocorrencias[].quantidadeOutrosSocios, documented as a string.
	QuantidadeOutrosSocios Text `json:"quantidadeOutrosSocios"`
	// RazaoSocial is retorno.participacaoEmEmpresas.ocorrencias[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

BoaVistaAcertaCompletoPositivoPFRetornoParticipacaoEmEmpresasOcorrencias is retorno.participacaoEmEmpresas.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciais 

type BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciais struct {
	// Ocorrencias is retorno.passagensComerciais.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciaisOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.passagensComerciais.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciais is retorno.passagensComerciais in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciaisOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciaisOcorrencias struct {
	// ClienteConsulta is retorno.passagensComerciais.ocorrencias[].clienteConsulta, documented as a string.
	ClienteConsulta Text `json:"clienteConsulta"`
	// DataConsulta is retorno.passagensComerciais.ocorrencias[].dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// EnderecoCliente is retorno.passagensComerciais.ocorrencias[].enderecoCliente, documented as a string.
	EnderecoCliente Text `json:"enderecoCliente" pii:"address"`
	// HoraConsulta is retorno.passagensComerciais.ocorrencias[].horaConsulta, documented as a string.
	HoraConsulta Text `json:"horaConsulta"`
	// TelefoneCliente is retorno.passagensComerciais.ocorrencias[].telefoneCliente, documented as a string.
	TelefoneCliente Text `json:"telefoneCliente" pii:"phone"`
}

BoaVistaAcertaCompletoPositivoPFRetornoPassagensComerciaisOcorrencias is retorno.passagensComerciais.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceiras 

type BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceiras struct {
	// DataMaior is retorno.pendenciasFinanceiras.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.pendenciasFinanceiras.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// Ocorrencias is retorno.pendenciasFinanceiras.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasOcorrencias `json:"ocorrencias"`
	// PeriodoFinal is retorno.pendenciasFinanceiras.periodoFinal, documented as a string.
	PeriodoFinal Text `json:"periodoFinal"`
	// PeriodoInicial is retorno.pendenciasFinanceiras.periodoInicial, documented as a string.
	PeriodoInicial Text `json:"periodoInicial"`
	// Provedores is retorno.pendenciasFinanceiras.provedores, a list.
	Provedores []BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasProvedores `json:"provedores"`
	// QuantidadeOcorrencia is retorno.pendenciasFinanceiras.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// TotalCredores is retorno.pendenciasFinanceiras.totalCredores, documented as a string.
	TotalCredores Text `json:"totalCredores"`
	// UltimoVencimento is retorno.pendenciasFinanceiras.ultimoVencimento, documented as a string.
	UltimoVencimento Text `json:"ultimoVencimento"`
	// ValorMaior is retorno.pendenciasFinanceiras.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.pendenciasFinanceiras.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.pendenciasFinanceiras.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
}

BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceiras is retorno.pendenciasFinanceiras in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasOcorrencias struct {
	// Contrato is retorno.pendenciasFinanceiras.ocorrencias[].contrato, documented as a string.
	Contrato Text `json:"contrato"`
	// Credor is retorno.pendenciasFinanceiras.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// DataInclusao is retorno.pendenciasFinanceiras.ocorrencias[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataVencimento is retorno.pendenciasFinanceiras.ocorrencias[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// Entidade is retorno.pendenciasFinanceiras.ocorrencias[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// Informante is retorno.pendenciasFinanceiras.ocorrencias[].informante, documented as a string.
	Informante Text `json:"informante"`
	// Modalidade is retorno.pendenciasFinanceiras.ocorrencias[].modalidade, documented as a string.
	Modalidade Text `json:"modalidade"`
	// Moeda is retorno.pendenciasFinanceiras.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.pendenciasFinanceiras.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Subjudice is retorno.pendenciasFinanceiras.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoDevedor is retorno.pendenciasFinanceiras.ocorrencias[].tipoDevedor, documented as a string.
	TipoDevedor Text `json:"tipoDevedor"`
	// Valor is retorno.pendenciasFinanceiras.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasOcorrencias is retorno.pendenciasFinanceiras.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasProvedores 

type BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasProvedores struct {
	// Provedor is retorno.pendenciasFinanceiras.provedores[].provedor, documented as a string.
	Provedor Text `json:"provedor"`
}

BoaVistaAcertaCompletoPositivoPFRetornoPendenciasFinanceirasProvedores is retorno.pendenciasFinanceiras.provedores[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoProtestos 

type BoaVistaAcertaCompletoPositivoPFRetornoProtestos struct {
	// DataMaior is retorno.protestos.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.protestos.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// DataUltimo is retorno.protestos.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.protestos.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoProtestosOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencia is retorno.protestos.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// UltimoProtesto is retorno.protestos.ultimoProtesto, documented as a string.
	UltimoProtesto Text `json:"ultimoProtesto"`
	// ValorMaior is retorno.protestos.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.protestos.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.protestos.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.protestos.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaAcertaCompletoPositivoPFRetornoProtestos is retorno.protestos in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoProtestosOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoProtestosOcorrencias struct {
	// Anuencia is retorno.protestos.ocorrencias[].anuencia, documented as a string.
	Anuencia Text `json:"anuencia"`
	// Cartorio is retorno.protestos.ocorrencias[].cartorio, documented as a string.
	Cartorio Text `json:"cartorio"`
	// Credor is retorno.protestos.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// Data is retorno.protestos.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Moeda is retorno.protestos.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.protestos.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Quantidade is retorno.protestos.ocorrencias[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// Subjudice is retorno.protestos.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoAnotacao is retorno.protestos.ocorrencias[].tipoAnotacao, documented as a string.
	TipoAnotacao Text `json:"tipoAnotacao"`
	// Valor is retorno.protestos.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// ValorCustas is retorno.protestos.ocorrencias[].valorCustas, documented as a string.
	ValorCustas Text `json:"valorCustas"`
	// Vencimento is retorno.protestos.ocorrencias[].vencimento, documented as a string.
	Vencimento Text `json:"vencimento"`
}

BoaVistaAcertaCompletoPositivoPFRetornoProtestosOcorrencias is retorno.protestos.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoRendaPresumida 

type BoaVistaAcertaCompletoPositivoPFRetornoRendaPresumida struct {
	// DadosCadastroPositivo is retorno.rendaPresumida.dadosCadastroPositivo, documented as a string.
	DadosCadastroPositivo Text `json:"dadosCadastroPositivo"`
	// DataReferencia is retorno.rendaPresumida.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// Descricao is retorno.rendaPresumida.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Faixa is retorno.rendaPresumida.faixa, documented as a string.
	Faixa Text `json:"faixa"`
	// Mensagem is retorno.rendaPresumida.mensagem, documented as a string.
	Mensagem Text `json:"mensagem"`
	// RendaAnual is retorno.rendaPresumida.rendaAnual, documented as a string.
	RendaAnual Text `json:"rendaAnual"`
	// ValorPresumido is retorno.rendaPresumida.valorPresumido, documented as a string.
	ValorPresumido Text `json:"valorPresumido"`
}

BoaVistaAcertaCompletoPositivoPFRetornoRendaPresumida is retorno.rendaPresumida in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoRestricoes 

type BoaVistaAcertaCompletoPositivoPFRetornoRestricoes struct {
	// Ocorrencias is retorno.restricoes.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoRestricoesOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.restricoes.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaCompletoPositivoPFRetornoRestricoes is retorno.restricoes in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoRestricoesOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoRestricoesOcorrencias struct {
	// CodigoInformacao is retorno.restricoes.ocorrencias[].codigoInformacao, documented as a string.
	CodigoInformacao Text `json:"codigoInformacao"`
	// DescricaoInformacao is retorno.restricoes.ocorrencias[].descricaoInformacao, documented as a string.
	DescricaoInformacao Text `json:"descricaoInformacao"`
	// Observacao is retorno.restricoes.ocorrencias[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Titulo is retorno.restricoes.ocorrencias[].titulo, documented as a string.
	Titulo Text `json:"titulo"`
}

BoaVistaAcertaCompletoPositivoPFRetornoRestricoesOcorrencias is retorno.restricoes.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoScores 

type BoaVistaAcertaCompletoPositivoPFRetornoScores struct {
	// Ocorrencias is retorno.scores.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaCompletoPositivoPFRetornoScoresOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.scores.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaCompletoPositivoPFRetornoScores is retorno.scores in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoScoresOcorrencias 

type BoaVistaAcertaCompletoPositivoPFRetornoScoresOcorrencias struct {
	// ClassificacaoABC is retorno.scores.ocorrencias[].classificacaoABC, documented as a string.
	ClassificacaoABC Text `json:"classificacaoABC"`
	// ClassificacaoNro is retorno.scores.ocorrencias[].classificacaoNro, documented as a string.
	ClassificacaoNro Text `json:"classificacaoNro"`
	// DescricaoPlano is retorno.scores.ocorrencias[].descricaoPlano, documented as a string.
	DescricaoPlano Text `json:"descricaoPlano"`
	// DescricaoScore is retorno.scores.ocorrencias[].descricaoScore, documented as a string.
	DescricaoScore Text `json:"descricaoScore"`
	// Execucao is retorno.scores.ocorrencias[].execucao, documented as a string.
	Execucao Text `json:"execucao"`
	// Informante is retorno.scores.ocorrencias[].informante, documented as a string.
	Informante Text `json:"informante"`
	// Layout is retorno.scores.ocorrencias[].layout, documented as a string.
	Layout Text `json:"layout"`
	// ModeloScore is retorno.scores.ocorrencias[].modeloScore, documented as a string.
	ModeloScore Text `json:"modeloScore"`
	// ProbabilidadeInadimplencia is retorno.scores.ocorrencias[].probabilidadeInadimplencia, documented as a string.
	ProbabilidadeInadimplencia Text `json:"probabilidadeInadimplencia"`
	// Risco is retorno.scores.ocorrencias[].risco, documented as a string.
	Risco Text `json:"risco"`
	// Score is retorno.scores.ocorrencias[].score, documented as a string.
	Score Text `json:"score"`
	// Texto is retorno.scores.ocorrencias[].texto, documented as a string.
	Texto Text `json:"texto"`
	// TipoScore is retorno.scores.ocorrencias[].tipoScore, documented as a string.
	TipoScore Text `json:"tipoScore"`
}

BoaVistaAcertaCompletoPositivoPFRetornoScoresOcorrencias is retorno.scores.ocorrencias[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaCompletoPositivoPFRetornoTelefones 

type BoaVistaAcertaCompletoPositivoPFRetornoTelefones struct {
	// Ddd is retorno.telefones[].ddd, documented as a string.
	Ddd Text `json:"ddd"`
	// Numero is retorno.telefones[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// TelefoneComDDD is retorno.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
}

BoaVistaAcertaCompletoPositivoPFRetornoTelefones is retorno.telefones[] in the answer of BoaVistaAcertaCompletoPositivoPF.

type BoaVistaAcertaMaisPositivoPFParams 

type BoaVistaAcertaMaisPositivoPFParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

BoaVistaAcertaMaisPositivoPFParams are the parameters of BoaVistaAcertaMaisPositivoPF (Boa Vista - Acerta Mais Positivo Pessoa Física).

func (BoaVistaAcertaMaisPositivoPFParams) Request 

func (p BoaVistaAcertaMaisPositivoPFParams) Request() (Request, error)

Request builds the Request for BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetorno 

type BoaVistaAcertaMaisPositivoPFRetorno struct {
	// AcoesCiveis is retorno.acoesCiveis.
	AcoesCiveis BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveis `json:"acoesCiveis"`
	// Bairro is retorno.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// CartaoNacionalSaude is retorno.cartaoNacionalSaude, documented as a string.
	CartaoNacionalSaude Text `json:"cartaoNacionalSaude"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// ChequeSemFundoBacen is retorno.chequeSemFundoBacen.
	ChequeSemFundoBacen BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoBacen `json:"chequeSemFundoBacen"`
	// ChequeSemFundoVarejo is retorno.chequeSemFundoVarejo.
	ChequeSemFundoVarejo BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoVarejo `json:"chequeSemFundoVarejo"`
	// Cidade is retorno.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// ClasseSocial is retorno.classeSocial, documented as a string.
	ClasseSocial Text `json:"classeSocial"`
	// ControlePositivo is retorno.controlePositivo.
	ControlePositivo BoaVistaAcertaMaisPositivoPFRetornoControlePositivo `json:"controlePositivo"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// CpfDataAtualizacaoReceita is retorno.cpfDataAtualizacaoReceita, documented as a string.
	CpfDataAtualizacaoReceita Text `json:"cpfDataAtualizacaoReceita" pii:"document"`
	// CpfOrigem is retorno.cpfOrigem, documented as a string.
	CpfOrigem Text `json:"cpfOrigem" pii:"document"`
	// CpfSituacao is retorno.cpfSituacao, documented as a string.
	CpfSituacao Text `json:"cpfSituacao" pii:"document"`
	// Decisao is retorno.decisao.
	Decisao BoaVistaAcertaMaisPositivoPFRetornoDecisao `json:"decisao"`
	// Email is retorno.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// EstadoCivil is retorno.estadoCivil, documented as a string.
	EstadoCivil Text `json:"estadoCivil"`
	// FaixaRenda is retorno.faixaRenda, documented as a string.
	FaixaRenda Text `json:"faixaRenda"`
	// FalenciasAcoesRecuperacoes is retorno.falenciasAcoesRecuperacoes.
	FalenciasAcoesRecuperacoes BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoes `json:"falenciasAcoesRecuperacoes"`
	// GrauInstrucao is retorno.grauInstrucao, documented as a string.
	GrauInstrucao Text `json:"grauInstrucao"`
	// IndicacaoObito is retorno.indicacaoObito, documented as a string.
	IndicacaoObito Text `json:"indicacaoObito"`
	// Mae is retorno.mae, documented as a string.
	Mae Text `json:"mae" pii:"name"`
	// Nacionalidade is retorno.nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Nascimento is retorno.nascimento, documented as a string.
	Nascimento Text `json:"nascimento" pii:"birthdate"`
	// Naturalidade is retorno.naturalidade, documented as a string.
	Naturalidade Text `json:"naturalidade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomePai is retorno.nomePai, documented as a string.
	NomePai Text `json:"nomePai" pii:"name"`
	// NomeSocial is retorno.nomeSocial, documented as a string.
	NomeSocial Text `json:"nomeSocial" pii:"name"`
	// NumeroDependentes is retorno.numeroDependentes, documented as a string.
	NumeroDependentes Text `json:"numeroDependentes"`
	// NumeroPIS is retorno.numeroPIS, documented as a string.
	NumeroPIS Text `json:"numeroPIS"`
	// ParticipacaoEmEmpresas is retorno.participacaoEmEmpresas.
	ParticipacaoEmEmpresas BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresas `json:"participacaoEmEmpresas"`
	// PassagensComerciais is retorno.passagensComerciais.
	PassagensComerciais BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciais `json:"passagensComerciais"`
	// PendenciasFinanceiras is retorno.pendenciasFinanceiras.
	PendenciasFinanceiras BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceiras `json:"pendenciasFinanceiras"`
	// PoderAquisitivo is retorno.poderAquisitivo, documented as a string.
	PoderAquisitivo Text `json:"poderAquisitivo"`
	// Protestos is retorno.protestos.
	Protestos BoaVistaAcertaMaisPositivoPFRetornoProtestos `json:"protestos"`
	// QtdDependentesBolsaFamilia is retorno.qtdDependentesBolsaFamilia, documented as a string.
	QtdDependentesBolsaFamilia Text `json:"qtdDependentesBolsaFamilia"`
	// RendaPresumida is retorno.rendaPresumida.
	RendaPresumida BoaVistaAcertaMaisPositivoPFRetornoRendaPresumida `json:"rendaPresumida"`
	// Restricoes is retorno.restricoes.
	Restricoes BoaVistaAcertaMaisPositivoPFRetornoRestricoes `json:"restricoes"`
	// Rg is retorno.rg, documented as a string.
	Rg Text `json:"rg" pii:"document"`
	// RgDataEmissao is retorno.rgDataEmissao, documented as a string.
	RgDataEmissao Text `json:"rgDataEmissao"`
	// Rguf is retorno.rguf, documented as a string.
	Rguf Text `json:"rguf"`
	// Rua is retorno.rua, documented as a string.
	Rua Text `json:"rua"`
	// Scores is retorno.scores.
	Scores BoaVistaAcertaMaisPositivoPFRetornoScores `json:"scores"`
	// Sexo is retorno.sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// SomenteEndereco is retorno.somenteEndereco.
	SomenteEndereco BoaVistaAcertaMaisPositivoPFRetornoSomenteEndereco `json:"somenteEndereco"`
	// SomenteTelefone is retorno.somenteTelefone.
	SomenteTelefone BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefone `json:"somenteTelefone"`
	// Telefone is retorno.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TituloEleitor is retorno.tituloEleitor, documented as a string.
	TituloEleitor Text `json:"tituloEleitor"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// UltimoImpostoRenda is retorno.ultimoImpostoRenda, documented as a string.
	UltimoImpostoRenda Text `json:"ultimoImpostoRenda"`
}

BoaVistaAcertaMaisPositivoPFRetorno is retorno in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveis 

type BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveis struct {
	// DataMaior is retorno.acoesCiveis.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataMenor is retorno.acoesCiveis.dataMenor, documented as a string.
	DataMenor Text `json:"dataMenor"`
	// DataPrimeiro is retorno.acoesCiveis.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// DataUltimo is retorno.acoesCiveis.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.acoesCiveis.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveisOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencia is retorno.acoesCiveis.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// ValorMaior is retorno.acoesCiveis.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorMenor is retorno.acoesCiveis.valorMenor, documented as a string.
	ValorMenor Text `json:"valorMenor"`
	// ValorPrimeiro is retorno.acoesCiveis.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.acoesCiveis.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.acoesCiveis.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveis is retorno.acoesCiveis in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveisOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveisOcorrencias struct {
	// Acao is retorno.acoesCiveis.ocorrencias[].acao, documented as a string.
	Acao Text `json:"acao"`
	// Autor is retorno.acoesCiveis.ocorrencias[].autor, documented as a string.
	Autor Text `json:"autor"`
	// Comarca is retorno.acoesCiveis.ocorrencias[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataDistribuicao is retorno.acoesCiveis.ocorrencias[].dataDistribuicao, documented as a string.
	DataDistribuicao Text `json:"dataDistribuicao"`
	// Documento is retorno.acoesCiveis.ocorrencias[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Foro is retorno.acoesCiveis.ocorrencias[].foro, documented as a string.
	Foro Text `json:"foro"`
	// Origem is retorno.acoesCiveis.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Processo is retorno.acoesCiveis.ocorrencias[].processo, documented as a string.
	Processo Text `json:"processo"`
	// Requerido is retorno.acoesCiveis.ocorrencias[].requerido, documented as a string.
	Requerido Text `json:"requerido"`
	// Valor is retorno.acoesCiveis.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// Vara is retorno.acoesCiveis.ocorrencias[].vara, documented as a string.
	Vara Text `json:"vara"`
}

BoaVistaAcertaMaisPositivoPFRetornoAcoesCiveisOcorrencias is retorno.acoesCiveis.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoBacen 

type BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoBacen struct {
	// Correntista is retorno.chequeSemFundoBacen.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.chequeSemFundoBacen.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// QuantidadeOcorrencia is retorno.chequeSemFundoBacen.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// TipoPessoa is retorno.chequeSemFundoBacen.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoBacen is retorno.chequeSemFundoBacen in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoVarejo 

type BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoVarejo struct {
	// Correntista is retorno.chequeSemFundoVarejo.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.chequeSemFundoVarejo.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// QuantidadeOcorrencia is retorno.chequeSemFundoVarejo.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// TipoPessoa is retorno.chequeSemFundoVarejo.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaAcertaMaisPositivoPFRetornoChequeSemFundoVarejo is retorno.chequeSemFundoVarejo in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoControlePositivo 

type BoaVistaAcertaMaisPositivoPFRetornoControlePositivo struct {
	// OcorrenciasFaturasEmAtraso is retorno.controlePositivo.ocorrenciasFaturasEmAtraso, a list.
	OcorrenciasFaturasEmAtraso []BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso `json:"ocorrenciasFaturasEmAtraso"`
	// OcorrenciasNotaComportamentosContratosRecentes is retorno.controlePositivo.ocorrenciasNotaComportamentosContratosRecentes, a list.
	OcorrenciasNotaComportamentosContratosRecentes []BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes `json:"ocorrenciasNotaComportamentosContratosRecentes"`
}

BoaVistaAcertaMaisPositivoPFRetornoControlePositivo is retorno.controlePositivo in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso 

type BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso struct {
	// NotaComportamentoFaturaEmAtraso is retorno.controlePositivo.ocorrenciasFaturasEmAtraso[].notaComportamentoFaturaEmAtraso, documented as a string.
	NotaComportamentoFaturaEmAtraso Text `json:"notaComportamentoFaturaEmAtraso"`
}

BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasFaturasEmAtraso is retorno.controlePositivo.ocorrenciasFaturasEmAtraso[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes 

type BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes struct {
	// Nota is retorno.controlePositivo.ocorrenciasNotaComportamentosContratosRecentes[].nota, documented as a string.
	Nota Text `json:"nota"`
}

BoaVistaAcertaMaisPositivoPFRetornoControlePositivoOcorrenciasNotaComportamentosContratosRecentes is retorno.controlePositivo.ocorrenciasNotaComportamentosContratosRecentes[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoDecisao 

type BoaVistaAcertaMaisPositivoPFRetornoDecisao struct {
	// CodigoSituacao is retorno.decisao.codigoSituacao, documented as a string.
	CodigoSituacao Text `json:"codigoSituacao"`
	// Descricao is retorno.decisao.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Layout is retorno.decisao.layout, documented as a string.
	Layout Text `json:"layout"`
	// Observacoes is retorno.decisao.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
}

BoaVistaAcertaMaisPositivoPFRetornoDecisao is retorno.decisao in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoes 

type BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoes struct {
	// Ocorrencias is retorno.falenciasAcoesRecuperacoes.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencia is retorno.falenciasAcoesRecuperacoes.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// UltimoRegistro is retorno.falenciasAcoesRecuperacoes.ultimoRegistro, documented as a string.
	UltimoRegistro Text `json:"ultimoRegistro"`
	// ValorTotal is retorno.falenciasAcoesRecuperacoes.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
}

BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoes is retorno.falenciasAcoesRecuperacoes in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias struct {
	// Cartorio is retorno.falenciasAcoesRecuperacoes.ocorrencias[].cartorio, documented as a string.
	Cartorio Text `json:"cartorio"`
	// Data is retorno.falenciasAcoesRecuperacoes.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Documento is retorno.falenciasAcoesRecuperacoes.ocorrencias[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Origem is retorno.falenciasAcoesRecuperacoes.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Quantidade is retorno.falenciasAcoesRecuperacoes.ocorrencias[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// RazaoSocial is retorno.falenciasAcoesRecuperacoes.ocorrencias[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Tipo is retorno.falenciasAcoesRecuperacoes.ocorrencias[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Valor is retorno.falenciasAcoesRecuperacoes.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaAcertaMaisPositivoPFRetornoFalenciasAcoesRecuperacoesOcorrencias is retorno.falenciasAcoesRecuperacoes.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresas 

type BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresas struct {
	// Ocorrencias is retorno.participacaoEmEmpresas.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresasOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.participacaoEmEmpresas.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresas is retorno.participacaoEmEmpresas in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresasOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresasOcorrencias struct {
	// Cnpj is retorno.participacaoEmEmpresas.ocorrencias[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Participacao is retorno.participacaoEmEmpresas.ocorrencias[].participacao, documented as a string.
	Participacao Text `json:"participacao"`
	// ParticipanteCargo is retorno.participacaoEmEmpresas.ocorrencias[].participanteCargo, documented as a string.
	ParticipanteCargo Text `json:"participanteCargo"`
	// ParticipanteDocumento is retorno.participacaoEmEmpresas.ocorrencias[].participanteDocumento, documented as a string.
	ParticipanteDocumento Text `json:"participanteDocumento"`
	// ParticipanteRenda is retorno.participacaoEmEmpresas.ocorrencias[].participanteRenda, documented as a string.
	ParticipanteRenda Text `json:"participanteRenda"`
	// ParticipanteTipo is retorno.participacaoEmEmpresas.ocorrencias[].participanteTipo, documented as a string.
	ParticipanteTipo Text `json:"participanteTipo"`
	// QuantidadeOutrosSocios is retorno.participacaoEmEmpresas.ocorrencias[].quantidadeOutrosSocios, documented as a string.
	QuantidadeOutrosSocios Text `json:"quantidadeOutrosSocios"`
	// RazaoSocial is retorno.participacaoEmEmpresas.ocorrencias[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

BoaVistaAcertaMaisPositivoPFRetornoParticipacaoEmEmpresasOcorrencias is retorno.participacaoEmEmpresas.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciais 

type BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciais struct {
	// Ocorrencias is retorno.passagensComerciais.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciaisOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.passagensComerciais.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciais is retorno.passagensComerciais in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciaisOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciaisOcorrencias struct {
	// ClienteConsulta is retorno.passagensComerciais.ocorrencias[].clienteConsulta, documented as a string.
	ClienteConsulta Text `json:"clienteConsulta"`
	// DataConsulta is retorno.passagensComerciais.ocorrencias[].dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// EnderecoCliente is retorno.passagensComerciais.ocorrencias[].enderecoCliente, documented as a string.
	EnderecoCliente Text `json:"enderecoCliente" pii:"address"`
	// HoraConsulta is retorno.passagensComerciais.ocorrencias[].horaConsulta, documented as a string.
	HoraConsulta Text `json:"horaConsulta"`
	// TelefoneCliente is retorno.passagensComerciais.ocorrencias[].telefoneCliente, documented as a string.
	TelefoneCliente Text `json:"telefoneCliente" pii:"phone"`
}

BoaVistaAcertaMaisPositivoPFRetornoPassagensComerciaisOcorrencias is retorno.passagensComerciais.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceiras 

type BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceiras struct {
	// DataMaior is retorno.pendenciasFinanceiras.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.pendenciasFinanceiras.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// Ocorrencias is retorno.pendenciasFinanceiras.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasOcorrencias `json:"ocorrencias"`
	// PeriodoFinal is retorno.pendenciasFinanceiras.periodoFinal, documented as a string.
	PeriodoFinal Text `json:"periodoFinal"`
	// PeriodoInicial is retorno.pendenciasFinanceiras.periodoInicial, documented as a string.
	PeriodoInicial Text `json:"periodoInicial"`
	// Provedores is retorno.pendenciasFinanceiras.provedores, a list.
	Provedores []BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasProvedores `json:"provedores"`
	// QuantidadeOcorrencia is retorno.pendenciasFinanceiras.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// TotalCredores is retorno.pendenciasFinanceiras.totalCredores, documented as a string.
	TotalCredores Text `json:"totalCredores"`
	// UltimoVencimento is retorno.pendenciasFinanceiras.ultimoVencimento, documented as a string.
	UltimoVencimento Text `json:"ultimoVencimento"`
	// ValorMaior is retorno.pendenciasFinanceiras.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.pendenciasFinanceiras.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.pendenciasFinanceiras.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
}

BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceiras is retorno.pendenciasFinanceiras in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasOcorrencias struct {
	// Contrato is retorno.pendenciasFinanceiras.ocorrencias[].contrato, documented as a string.
	Contrato Text `json:"contrato"`
	// Credor is retorno.pendenciasFinanceiras.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// DataInclusao is retorno.pendenciasFinanceiras.ocorrencias[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataVencimento is retorno.pendenciasFinanceiras.ocorrencias[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// Entidade is retorno.pendenciasFinanceiras.ocorrencias[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// Informante is retorno.pendenciasFinanceiras.ocorrencias[].informante, documented as a string.
	Informante Text `json:"informante"`
	// Modalidade is retorno.pendenciasFinanceiras.ocorrencias[].modalidade, documented as a string.
	Modalidade Text `json:"modalidade"`
	// Moeda is retorno.pendenciasFinanceiras.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.pendenciasFinanceiras.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Subjudice is retorno.pendenciasFinanceiras.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoDevedor is retorno.pendenciasFinanceiras.ocorrencias[].tipoDevedor, documented as a string.
	TipoDevedor Text `json:"tipoDevedor"`
	// Valor is retorno.pendenciasFinanceiras.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasOcorrencias is retorno.pendenciasFinanceiras.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasProvedores 

type BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasProvedores struct {
	// Provedor is retorno.pendenciasFinanceiras.provedores[].provedor, documented as a string.
	Provedor Text `json:"provedor"`
}

BoaVistaAcertaMaisPositivoPFRetornoPendenciasFinanceirasProvedores is retorno.pendenciasFinanceiras.provedores[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoProtestos 

type BoaVistaAcertaMaisPositivoPFRetornoProtestos struct {
	// DataMaior is retorno.protestos.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.protestos.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// DataUltimo is retorno.protestos.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.protestos.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoProtestosOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencia is retorno.protestos.quantidadeOcorrencia, documented as a string.
	QuantidadeOcorrencia Text `json:"quantidadeOcorrencia"`
	// UltimoProtesto is retorno.protestos.ultimoProtesto, documented as a string.
	UltimoProtesto Text `json:"ultimoProtesto"`
	// ValorMaior is retorno.protestos.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.protestos.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.protestos.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.protestos.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaAcertaMaisPositivoPFRetornoProtestos is retorno.protestos in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoProtestosOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoProtestosOcorrencias struct {
	// Anuencia is retorno.protestos.ocorrencias[].anuencia, documented as a string.
	Anuencia Text `json:"anuencia"`
	// Cartorio is retorno.protestos.ocorrencias[].cartorio, documented as a string.
	Cartorio Text `json:"cartorio"`
	// Credor is retorno.protestos.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// Data is retorno.protestos.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Moeda is retorno.protestos.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.protestos.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Quantidade is retorno.protestos.ocorrencias[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// Subjudice is retorno.protestos.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoAnotacao is retorno.protestos.ocorrencias[].tipoAnotacao, documented as a string.
	TipoAnotacao Text `json:"tipoAnotacao"`
	// Valor is retorno.protestos.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// ValorCustas is retorno.protestos.ocorrencias[].valorCustas, documented as a string.
	ValorCustas Text `json:"valorCustas"`
	// Vencimento is retorno.protestos.ocorrencias[].vencimento, documented as a string.
	Vencimento Text `json:"vencimento"`
}

BoaVistaAcertaMaisPositivoPFRetornoProtestosOcorrencias is retorno.protestos.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoRendaPresumida 

type BoaVistaAcertaMaisPositivoPFRetornoRendaPresumida struct {
	// DadosCadastroPositivo is retorno.rendaPresumida.dadosCadastroPositivo, documented as a string.
	DadosCadastroPositivo Text `json:"dadosCadastroPositivo"`
	// DataReferencia is retorno.rendaPresumida.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// Descricao is retorno.rendaPresumida.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Faixa is retorno.rendaPresumida.faixa, documented as a string.
	Faixa Text `json:"faixa"`
	// Mensagem is retorno.rendaPresumida.mensagem, documented as a string.
	Mensagem Text `json:"mensagem"`
	// RendaAnual is retorno.rendaPresumida.rendaAnual, documented as a string.
	RendaAnual Text `json:"rendaAnual"`
	// ValorPresumido is retorno.rendaPresumida.valorPresumido, documented as a string.
	ValorPresumido Text `json:"valorPresumido"`
}

BoaVistaAcertaMaisPositivoPFRetornoRendaPresumida is retorno.rendaPresumida in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoRestricoes 

type BoaVistaAcertaMaisPositivoPFRetornoRestricoes struct {
	// Ocorrencias is retorno.restricoes.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoRestricoesOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.restricoes.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaMaisPositivoPFRetornoRestricoes is retorno.restricoes in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoRestricoesOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoRestricoesOcorrencias struct {
	// CodigoInformacao is retorno.restricoes.ocorrencias[].codigoInformacao, documented as a string.
	CodigoInformacao Text `json:"codigoInformacao"`
	// DescricaoInformacao is retorno.restricoes.ocorrencias[].descricaoInformacao, documented as a string.
	DescricaoInformacao Text `json:"descricaoInformacao"`
	// Observacoes is retorno.restricoes.ocorrencias[].observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Titulo is retorno.restricoes.ocorrencias[].titulo, documented as a string.
	Titulo Text `json:"titulo"`
}

BoaVistaAcertaMaisPositivoPFRetornoRestricoesOcorrencias is retorno.restricoes.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoScores 

type BoaVistaAcertaMaisPositivoPFRetornoScores struct {
	// Ocorrencias is retorno.scores.ocorrencias, a list.
	Ocorrencias []BoaVistaAcertaMaisPositivoPFRetornoScoresOcorrencias `json:"ocorrencias"`
	// QuantidadeOcorrencias is retorno.scores.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaAcertaMaisPositivoPFRetornoScores is retorno.scores in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoScoresOcorrencias 

type BoaVistaAcertaMaisPositivoPFRetornoScoresOcorrencias struct {
	// ClassificacaoABC is retorno.scores.ocorrencias[].classificacaoABC, documented as a string.
	ClassificacaoABC Text `json:"classificacaoABC"`
	// ClassificacaoNro is retorno.scores.ocorrencias[].classificacaoNro, documented as a string.
	ClassificacaoNro Text `json:"classificacaoNro"`
	// DescricaoPlano is retorno.scores.ocorrencias[].descricaoPlano, documented as a string.
	DescricaoPlano Text `json:"descricaoPlano"`
	// DescricaoScore is retorno.scores.ocorrencias[].descricaoScore, documented as a string.
	DescricaoScore Text `json:"descricaoScore"`
	// Execucao is retorno.scores.ocorrencias[].execucao, documented as a string.
	Execucao Text `json:"execucao"`
	// Informante is retorno.scores.ocorrencias[].informante, documented as a string.
	Informante Text `json:"informante"`
	// Layout is retorno.scores.ocorrencias[].layout, documented as a string.
	Layout Text `json:"layout"`
	// ModeloScore is retorno.scores.ocorrencias[].modeloScore, documented as a string.
	ModeloScore Text `json:"modeloScore"`
	// ProbabilidadeInadimplencia is retorno.scores.ocorrencias[].probabilidadeInadimplencia, documented as a string.
	ProbabilidadeInadimplencia Text `json:"probabilidadeInadimplencia"`
	// Risco is retorno.scores.ocorrencias[].risco, documented as a string.
	Risco Text `json:"risco"`
	// Score is retorno.scores.ocorrencias[].score, documented as a string.
	Score Text `json:"score"`
	// Texto is retorno.scores.ocorrencias[].texto, documented as a string.
	Texto Text `json:"texto"`
	// TipoScore is retorno.scores.ocorrencias[].tipoScore, documented as a string.
	TipoScore Text `json:"tipoScore"`
}

BoaVistaAcertaMaisPositivoPFRetornoScoresOcorrencias is retorno.scores.ocorrencias[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoSomenteEndereco 

type BoaVistaAcertaMaisPositivoPFRetornoSomenteEndereco struct {
	// Dados is retorno.somenteEndereco.dados, a list.
	Dados []BoaVistaAcertaMaisPositivoPFRetornoSomenteEnderecoDados `json:"dados"`
	// RegistroLocalizado is retorno.somenteEndereco.registroLocalizado, documented as a string.
	RegistroLocalizado Text `json:"registroLocalizado"`
}

BoaVistaAcertaMaisPositivoPFRetornoSomenteEndereco is retorno.somenteEndereco in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoSomenteEnderecoDados 

type BoaVistaAcertaMaisPositivoPFRetornoSomenteEnderecoDados struct {
	// Bairro is retorno.somenteEndereco.dados[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.somenteEndereco.dados[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.somenteEndereco.dados[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoIdentificacaoEndereco is retorno.somenteEndereco.dados[].codigoIdentificacaoEndereco, documented as a string.
	CodigoIdentificacaoEndereco Text `json:"codigoIdentificacaoEndereco"`
	// Complemento is retorno.somenteEndereco.dados[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Documento is retorno.somenteEndereco.dados[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Endereco is retorno.somenteEndereco.dados[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Latitude is retorno.somenteEndereco.dados[].latitude, documented as a string.
	Latitude Text `json:"latitude" pii:"address"`
	// Longitude is retorno.somenteEndereco.dados[].longitude, documented as a string.
	Longitude Text `json:"longitude" pii:"address"`
	// Numero is retorno.somenteEndereco.dados[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Pontuacao is retorno.somenteEndereco.dados[].pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
	// TipoPessoa is retorno.somenteEndereco.dados[].tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
	// Uf is retorno.somenteEndereco.dados[].uf, documented as a string.
	Uf Text `json:"uf"`
}

BoaVistaAcertaMaisPositivoPFRetornoSomenteEnderecoDados is retorno.somenteEndereco.dados[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefone 

type BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefone struct {
	// Dados is retorno.somenteTelefone.dados, a list.
	Dados []BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefoneDados `json:"dados"`
	// RegistroLocalizado is retorno.somenteTelefone.registroLocalizado, documented as a string.
	RegistroLocalizado Text `json:"registroLocalizado"`
}

BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefone is retorno.somenteTelefone in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefoneDados 

type BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefoneDados struct {
	// CodigoIdentificacaoTelefone is retorno.somenteTelefone.dados[].codigoIdentificacaoTelefone, documented as a string.
	CodigoIdentificacaoTelefone Text `json:"codigoIdentificacaoTelefone" pii:"phone"`
	// Ddd is retorno.somenteTelefone.dados[].ddd, documented as a string.
	Ddd Text `json:"ddd"`
	// Documento is retorno.somenteTelefone.dados[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NumeroTelefone is retorno.somenteTelefone.dados[].numeroTelefone, documented as a string.
	NumeroTelefone Text `json:"numeroTelefone" pii:"phone"`
	// Pontuacao is retorno.somenteTelefone.dados[].pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
	// TipoPessoa is retorno.somenteTelefone.dados[].tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
	// TipoTelefone is retorno.somenteTelefone.dados[].tipoTelefone, documented as a string.
	TipoTelefone Text `json:"tipoTelefone" pii:"phone"`
}

BoaVistaAcertaMaisPositivoPFRetornoSomenteTelefoneDados is retorno.somenteTelefone.dados[] in the answer of BoaVistaAcertaMaisPositivoPF.

type BoaVistaDefineLimitePositivoPJParams 

type BoaVistaDefineLimitePositivoPJParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

BoaVistaDefineLimitePositivoPJParams are the parameters of BoaVistaDefineLimitePositivoPJ (Boa Vista - Define Limite Positivo Pessoa Jurídica).

func (BoaVistaDefineLimitePositivoPJParams) Request 

func (p BoaVistaDefineLimitePositivoPJParams) Request() (Request, error)

Request builds the Request for BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetorno 

type BoaVistaDefineLimitePositivoPJRetorno struct {
	// Alertas is retorno.alertas, a list.
	Alertas []BoaVistaDefineLimitePositivoPJRetornoAlertas `json:"alertas"`
	// CapitalSocial is retorno.capitalSocial, documented as a string.
	CapitalSocial Text `json:"capitalSocial"`
	// CidadesFiliais is retorno.cidadesFiliais, documented as a string.
	CidadesFiliais Text `json:"cidadesFiliais"`
	// CnaePrimario is retorno.cnaePrimario, documented as a string.
	CnaePrimario Text `json:"cnaePrimario"`
	// CnaeSecundario is retorno.cnaeSecundario, documented as a string.
	CnaeSecundario Text `json:"cnaeSecundario"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataConsultaSintegra is retorno.dataConsultaSintegra, documented as a string.
	DataConsultaSintegra Text `json:"dataConsultaSintegra"`
	// DataEncerramento is retorno.dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataFundacao is retorno.dataFundacao, documented as a string.
	DataFundacao Text `json:"dataFundacao"`
	// DataSituacao is retorno.dataSituacao, documented as a string.
	DataSituacao Text `json:"dataSituacao"`
	// DataSituacaoSintegra is retorno.dataSituacaoSintegra, documented as a string.
	DataSituacaoSintegra Text `json:"dataSituacaoSintegra"`
	// Decisoes is retorno.decisoes.
	Decisoes BoaVistaDefineLimitePositivoPJRetornoDecisoes `json:"decisoes"`
	// Email is retorno.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []BoaVistaDefineLimitePositivoPJRetornoEnderecos `json:"enderecos"`
	// FaixaFuncionarios is retorno.faixaFuncionarios, documented as a string.
	FaixaFuncionarios Text `json:"faixaFuncionarios"`
	// Governancas is retorno.governancas.
	Governancas BoaVistaDefineLimitePositivoPJRetornoGovernancas `json:"governancas"`
	// HistoricoConsulta is retorno.historicoConsulta.
	HistoricoConsulta BoaVistaDefineLimitePositivoPJRetornoHistoricoConsulta `json:"historicoConsulta"`
	// Indicadores is retorno.indicadores.
	Indicadores BoaVistaDefineLimitePositivoPJRetornoIndicadores `json:"indicadores"`
	// InscricaoEstadual is retorno.inscricaoEstadual, documented as a string.
	InscricaoEstadual Text `json:"inscricaoEstadual" pii:"document"`
	// InscricaoEstadualUf is retorno.inscricaoEstadualUf, documented as a string.
	InscricaoEstadualUf Text `json:"inscricaoEstadualUf"`
	// NaturezaJuridica is retorno.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// Nire is retorno.nire, documented as a string.
	Nire Text `json:"nire"`
	// NireUf is retorno.nireUf, documented as a string.
	NireUf Text `json:"nireUf"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// OpcaoTributaria is retorno.opcaoTributaria, documented as a string.
	OpcaoTributaria Text `json:"opcaoTributaria"`
	// Participacoes is retorno.participacoes.
	Participacoes BoaVistaDefineLimitePositivoPJRetornoParticipacoes `json:"participacoes"`
	// Porte is retorno.porte, documented as a string.
	Porte Text `json:"porte"`
	// QuantidadeFiliais is retorno.quantidadeFiliais, documented as a string.
	QuantidadeFiliais Text `json:"quantidadeFiliais"`
	// RamoAtividadePrimario is retorno.ramoAtividadePrimario, documented as a string.
	RamoAtividadePrimario Text `json:"ramoAtividadePrimario"`
	// RamoAtividadeSecundario is retorno.ramoAtividadeSecundario, documented as a string.
	RamoAtividadeSecundario Text `json:"ramoAtividadeSecundario"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// RazaoSocialAnterior is retorno.razaoSocialAnterior, documented as a string.
	RazaoSocialAnterior Text `json:"razaoSocialAnterior"`
	// Restricoes is retorno.restricoes.
	Restricoes BoaVistaDefineLimitePositivoPJRetornoRestricoes `json:"restricoes"`
	// Score is retorno.score.
	Score BoaVistaDefineLimitePositivoPJRetornoScore `json:"score"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// SituacaoSintegra is retorno.situacaoSintegra, documented as a string.
	SituacaoSintegra Text `json:"situacaoSintegra"`
	// Telefones is retorno.telefones, a list.
	Telefones []BoaVistaDefineLimitePositivoPJRetornoTelefones `json:"telefones"`
	// TipoSociedade is retorno.tipoSociedade, documented as a string.
	TipoSociedade Text `json:"tipoSociedade"`
}

BoaVistaDefineLimitePositivoPJRetorno is retorno in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoAlertas 

type BoaVistaDefineLimitePositivoPJRetornoAlertas struct {
	// Observacao is retorno.alertas[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Tipo is retorno.alertas[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Titulo is retorno.alertas[].titulo, documented as a string.
	Titulo Text `json:"titulo"`
}

BoaVistaDefineLimitePositivoPJRetornoAlertas is retorno.alertas[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoDecisoes 

type BoaVistaDefineLimitePositivoPJRetornoDecisoes struct {
	// CodigoSituacao is retorno.decisoes.codigoSituacao, documented as a string.
	CodigoSituacao Text `json:"codigoSituacao"`
	// Descricao is retorno.decisoes.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Layout is retorno.decisoes.layout, documented as a string.
	Layout Text `json:"layout"`
	// Resultado is retorno.decisoes.resultado, documented as a string.
	Resultado Text `json:"resultado"`
}

BoaVistaDefineLimitePositivoPJRetornoDecisoes is retorno.decisoes in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoEnderecos 

type BoaVistaDefineLimitePositivoPJRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

BoaVistaDefineLimitePositivoPJRetornoEnderecos is retorno.enderecos[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoGovernancas 

type BoaVistaDefineLimitePositivoPJRetornoGovernancas struct {
	// Administradores is retorno.governancas.administradores, a list.
	Administradores []BoaVistaDefineLimitePositivoPJRetornoGovernancasAdministradores `json:"administradores"`
	// QuantidadeAdministradores is retorno.governancas.quantidadeAdministradores, documented as a string.
	QuantidadeAdministradores Text `json:"quantidadeAdministradores"`
	// QuantidadeSocios is retorno.governancas.quantidadeSocios, documented as a string.
	QuantidadeSocios Text `json:"quantidadeSocios"`
	// Socios is retorno.governancas.socios, a list.
	Socios []BoaVistaDefineLimitePositivoPJRetornoGovernancasSocios `json:"socios"`
}

BoaVistaDefineLimitePositivoPJRetornoGovernancas is retorno.governancas in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoGovernancasAdministradores 

type BoaVistaDefineLimitePositivoPJRetornoGovernancasAdministradores struct {
	// Cargo is retorno.governancas.administradores[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataEntrada is retorno.governancas.administradores[].dataEntrada, documented as a string.
	DataEntrada Text `json:"dataEntrada"`
	// Documento is retorno.governancas.administradores[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.governancas.administradores[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// SituacaoDocumento is retorno.governancas.administradores[].situacaoDocumento, documented as a string.
	SituacaoDocumento Text `json:"situacaoDocumento"`
}

BoaVistaDefineLimitePositivoPJRetornoGovernancasAdministradores is retorno.governancas.administradores[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoGovernancasSocios 

type BoaVistaDefineLimitePositivoPJRetornoGovernancasSocios struct {
	// Documento is retorno.governancas.socios[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.governancas.socios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// PercentualParticipacao is retorno.governancas.socios[].percentualParticipacao, documented as a string.
	PercentualParticipacao Text `json:"percentualParticipacao"`
	// Restricoes is retorno.governancas.socios[].restricoes, a list.
	Restricoes []BoaVistaDefineLimitePositivoPJRetornoGovernancasSociosRestricoes `json:"restricoes"`
	// SituacaoDocumento is retorno.governancas.socios[].situacaoDocumento, documented as a string.
	SituacaoDocumento Text `json:"situacaoDocumento"`
	// TipoDocumento is retorno.governancas.socios[].tipoDocumento, documented as a string.
	TipoDocumento Text `json:"tipoDocumento"`
}

BoaVistaDefineLimitePositivoPJRetornoGovernancasSocios is retorno.governancas.socios[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoGovernancasSociosRestricoes 

type BoaVistaDefineLimitePositivoPJRetornoGovernancasSociosRestricoes struct {
	// Quantidade is retorno.governancas.socios[].restricoes[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// Tipo is retorno.governancas.socios[].restricoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Ultima is retorno.governancas.socios[].restricoes[].ultima, documented as a string.
	Ultima Text `json:"ultima"`
	// Valor is retorno.governancas.socios[].restricoes[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaDefineLimitePositivoPJRetornoGovernancasSociosRestricoes is retorno.governancas.socios[].restricoes[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoHistoricoConsulta 

type BoaVistaDefineLimitePositivoPJRetornoHistoricoConsulta struct {
	// DataFinal is retorno.historicoConsulta.dataFinal, documented as a string.
	DataFinal Text `json:"dataFinal"`
	// DataInicial is retorno.historicoConsulta.dataInicial, documented as a string.
	DataInicial Text `json:"dataInicial"`
	// Detalhes is retorno.historicoConsulta.detalhes, a list.
	Detalhes []BoaVistaDefineLimitePositivoPJRetornoHistoricoConsultaDetalhes `json:"detalhes"`
	// QuantidadeOcorrencias is retorno.historicoConsulta.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaDefineLimitePositivoPJRetornoHistoricoConsulta is retorno.historicoConsulta in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoHistoricoConsultaDetalhes 

type BoaVistaDefineLimitePositivoPJRetornoHistoricoConsultaDetalhes struct {
	// Cnpj is retorno.historicoConsulta.detalhes[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Data is retorno.historicoConsulta.detalhes[].data, documented as a string.
	Data Text `json:"data"`
	// RazaoSocial is retorno.historicoConsulta.detalhes[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

BoaVistaDefineLimitePositivoPJRetornoHistoricoConsultaDetalhes is retorno.historicoConsulta.detalhes[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadores 

type BoaVistaDefineLimitePositivoPJRetornoIndicadores struct {
	// Compromissos is retorno.indicadores.compromissos.
	Compromissos BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissos `json:"compromissos"`
	// CreditoObtido is retorno.indicadores.creditoObtido.
	CreditoObtido BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtido `json:"creditoObtido"`
	// EventosPessoaJuridica is retorno.indicadores.eventosPessoaJuridica.
	EventosPessoaJuridica BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridica `json:"eventosPessoaJuridica"`
	// PagamentoAtrasado is retorno.indicadores.pagamentoAtrasado.
	PagamentoAtrasado BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasado `json:"pagamentoAtrasado"`
	// PagamentoPontual is retorno.indicadores.pagamentoPontual.
	PagamentoPontual BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontual `json:"pagamentoPontual"`
	// PeriodoRelacionamentoFornecedores is retorno.indicadores.periodoRelacionamentoFornecedores.
	PeriodoRelacionamentoFornecedores BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores `json:"periodoRelacionamentoFornecedores"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadores is retorno.indicadores in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissos 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissos struct {
	// Ocorrencias is retorno.indicadores.compromissos.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissosOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.compromissos.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissos is retorno.indicadores.compromissos in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissosOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissosOcorrencias struct {
	// Periodo is retorno.indicadores.compromissos.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.compromissos.ocorrencias[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresCompromissosOcorrencias is retorno.indicadores.compromissos.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtido 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtido struct {
	// Ocorrencias is retorno.indicadores.creditoObtido.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtidoOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.creditoObtido.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtido is retorno.indicadores.creditoObtido in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtidoOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtidoOcorrencias struct {
	// Periodo is retorno.indicadores.creditoObtido.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.creditoObtido.ocorrencias[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresCreditoObtidoOcorrencias is retorno.indicadores.creditoObtido.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridica 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridica struct {
	// Ocorrencias is retorno.indicadores.eventosPessoaJuridica.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.eventosPessoaJuridica.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridica is retorno.indicadores.eventosPessoaJuridica in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias struct {
	// Indicador is retorno.indicadores.eventosPessoaJuridica.ocorrencias[].indicador, documented as a string.
	Indicador Text `json:"indicador"`
	// Periodo is retorno.indicadores.eventosPessoaJuridica.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// Pontuacao is retorno.indicadores.eventosPessoaJuridica.ocorrencias[].pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias is retorno.indicadores.eventosPessoaJuridica.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasado 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasado struct {
	// Ocorrencias is retorno.indicadores.pagamentoAtrasado.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias `json:"ocorrencias"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasado is retorno.indicadores.pagamentoAtrasado in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias struct {
	// Descricao is retorno.indicadores.pagamentoAtrasado.ocorrencias[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Itens is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens, a list.
	Itens []BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens `json:"itens"`
	// Pontuacao is retorno.indicadores.pagamentoAtrasado.ocorrencias[].pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias is retorno.indicadores.pagamentoAtrasado.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens struct {
	// Periodo is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontual 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontual struct {
	// Ocorrencias is retorno.indicadores.pagamentoPontual.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontualOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.pagamentoPontual.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontual is retorno.indicadores.pagamentoPontual in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontualOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontualOcorrencias struct {
	// Periodo is retorno.indicadores.pagamentoPontual.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.pagamentoPontual.ocorrencias[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresPagamentoPontualOcorrencias is retorno.indicadores.pagamentoPontual.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores struct {
	// Ocorrencias is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.periodoRelacionamentoFornecedores.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores is retorno.indicadores.periodoRelacionamentoFornecedores in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias struct {
	// Periodo is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// Valor is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaDefineLimitePositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoParticipacoes 

type BoaVistaDefineLimitePositivoPJRetornoParticipacoes struct {
	// ParticipacoesEmpresasConsultadas is retorno.participacoes.participacoesEmpresasConsultadas, a list.
	ParticipacoesEmpresasConsultadas []BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesEmpresasConsultadas `json:"participacoesEmpresasConsultadas"`
	// ParticipacoesSocioAdmOutrasEmpresas is retorno.participacoes.participacoesSocioAdmOutrasEmpresas, a list.
	ParticipacoesSocioAdmOutrasEmpresas []BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresas `json:"participacoesSocioAdmOutrasEmpresas"`
	// QuantidadeParticipacoesConsultada is retorno.participacoes.quantidadeParticipacoesConsultada, documented as a string.
	QuantidadeParticipacoesConsultada Text `json:"quantidadeParticipacoesConsultada"`
	// QuantidadeParticipacoesSocioAdm is retorno.participacoes.quantidadeParticipacoesSocioAdm, documented as a string.
	QuantidadeParticipacoesSocioAdm Text `json:"quantidadeParticipacoesSocioAdm"`
}

BoaVistaDefineLimitePositivoPJRetornoParticipacoes is retorno.participacoes in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesEmpresasConsultadas 

type BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesEmpresasConsultadas struct {
	// CnpjParticipada is retorno.participacoes.participacoesEmpresasConsultadas[].cnpjParticipada, documented as a string.
	CnpjParticipada Text `json:"cnpjParticipada" pii:"document"`
	// Entrada is retorno.participacoes.participacoesEmpresasConsultadas[].entrada, documented as a string.
	Entrada Text `json:"entrada"`
	// IndicadorDebito is retorno.participacoes.participacoesEmpresasConsultadas[].indicadorDebito, documented as a string.
	IndicadorDebito Text `json:"indicadorDebito"`
	// IndicadorFraude is retorno.participacoes.participacoesEmpresasConsultadas[].indicadorFraude, documented as a string.
	IndicadorFraude Text `json:"indicadorFraude"`
	// Participacao is retorno.participacoes.participacoesEmpresasConsultadas[].participacao, documented as a string.
	Participacao Text `json:"participacao"`
	// RazaoSocialParticipada is retorno.participacoes.participacoesEmpresasConsultadas[].razaoSocialParticipada, documented as a string.
	RazaoSocialParticipada Text `json:"razaoSocialParticipada"`
	// SituacaoCnpj is retorno.participacoes.participacoesEmpresasConsultadas[].situacaoCnpj, documented as a string.
	SituacaoCnpj Text `json:"situacaoCnpj" pii:"document"`
}

BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesEmpresasConsultadas is retorno.participacoes.participacoesEmpresasConsultadas[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresas 

type BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresas struct {
	// CpfCnpj is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].cpfCnpj, documented as a string.
	CpfCnpj Text `json:"cpfCnpj" pii:"document"`
	// Empresas is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas, a list.
	Empresas []BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresasEmpresas `json:"empresas"`
	// NomeSocio is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].nomeSocio, documented as a string.
	NomeSocio Text `json:"nomeSocio" pii:"name"`
	// TipoDocumento is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].tipoDocumento, documented as a string.
	TipoDocumento Text `json:"tipoDocumento"`
}

BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresas is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresasEmpresas 

type BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresasEmpresas struct {
	// Cnpj is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// IndicadorDebito is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas[].indicadorDebito, documented as a string.
	IndicadorDebito Text `json:"indicadorDebito"`
	// IndicadorFraude is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas[].indicadorFraude, documented as a string.
	IndicadorFraude Text `json:"indicadorFraude"`
	// Participacao is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas[].participacao, documented as a string.
	Participacao Text `json:"participacao"`
	// RazaoSocial is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// SituacaoCnpj is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas[].situacaoCnpj, documented as a string.
	SituacaoCnpj Text `json:"situacaoCnpj" pii:"document"`
}

BoaVistaDefineLimitePositivoPJRetornoParticipacoesParticipacoesSocioAdmOutrasEmpresasEmpresas is retorno.participacoes.participacoesSocioAdmOutrasEmpresas[].empresas[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoes 

type BoaVistaDefineLimitePositivoPJRetornoRestricoes struct {
	// AcoesCiveis is retorno.restricoes.acoesCiveis.
	AcoesCiveis BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveis `json:"acoesCiveis"`
	// ChequesSemFundoBacen is retorno.restricoes.chequesSemFundoBacen.
	ChequesSemFundoBacen BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoBacen `json:"chequesSemFundoBacen"`
	// ChequesSemFundoVarejo is retorno.restricoes.chequesSemFundoVarejo.
	ChequesSemFundoVarejo BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoVarejo `json:"chequesSemFundoVarejo"`
	// Contumacia is retorno.restricoes.contumacia.
	Contumacia BoaVistaDefineLimitePositivoPJRetornoRestricoesContumacia `json:"contumacia"`
	// FalenciaRecuperacaoJudicial is retorno.restricoes.falenciaRecuperacaoJudicial.
	FalenciaRecuperacaoJudicial BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial `json:"falenciaRecuperacaoJudicial"`
	// FaturamentoPresumido is retorno.restricoes.faturamentoPresumido.
	FaturamentoPresumido BoaVistaDefineLimitePositivoPJRetornoRestricoesFaturamentoPresumido `json:"faturamentoPresumido"`
	// LimiteCredito is retorno.restricoes.limiteCredito.
	LimiteCredito BoaVistaDefineLimitePositivoPJRetornoRestricoesLimiteCredito `json:"limiteCredito"`
	// PendenciasFinanceiras is retorno.restricoes.pendenciasFinanceiras.
	PendenciasFinanceiras BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceiras `json:"pendenciasFinanceiras"`
	// Protestos is retorno.restricoes.protestos.
	Protestos BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestos `json:"protestos"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoes is retorno.restricoes in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveis 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveis struct {
	// DataMaior is retorno.restricoes.acoesCiveis.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataMenor is retorno.restricoes.acoesCiveis.dataMenor, documented as a string.
	DataMenor Text `json:"dataMenor"`
	// DataPrimeira is retorno.restricoes.acoesCiveis.dataPrimeira, documented as a string.
	DataPrimeira Text `json:"dataPrimeira"`
	// DataUltimo is retorno.restricoes.acoesCiveis.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.restricoes.acoesCiveis.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveisOcorrencias `json:"ocorrencias"`
	// Quantidade is retorno.restricoes.acoesCiveis.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// ValorMaior is retorno.restricoes.acoesCiveis.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorMenor is retorno.restricoes.acoesCiveis.valorMenor, documented as a string.
	ValorMenor Text `json:"valorMenor"`
	// ValorPrimeiro is retorno.restricoes.acoesCiveis.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.restricoes.acoesCiveis.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.restricoes.acoesCiveis.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveis is retorno.restricoes.acoesCiveis in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveisOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveisOcorrencias struct {
	// Acao is retorno.restricoes.acoesCiveis.ocorrencias[].acao, documented as a string.
	Acao Text `json:"acao"`
	// Autor is retorno.restricoes.acoesCiveis.ocorrencias[].autor, documented as a string.
	Autor Text `json:"autor"`
	// Comarca is retorno.restricoes.acoesCiveis.ocorrencias[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataDistribuicao is retorno.restricoes.acoesCiveis.ocorrencias[].dataDistribuicao, documented as a string.
	DataDistribuicao Text `json:"dataDistribuicao"`
	// Documento is retorno.restricoes.acoesCiveis.ocorrencias[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Foro is retorno.restricoes.acoesCiveis.ocorrencias[].foro, documented as a string.
	Foro Text `json:"foro"`
	// Origem is retorno.restricoes.acoesCiveis.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Processo is retorno.restricoes.acoesCiveis.ocorrencias[].processo, documented as a string.
	Processo Text `json:"processo"`
	// Requerido is retorno.restricoes.acoesCiveis.ocorrencias[].requerido, documented as a string.
	Requerido Text `json:"requerido"`
	// Valor is retorno.restricoes.acoesCiveis.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// Vara is retorno.restricoes.acoesCiveis.ocorrencias[].vara, documented as a string.
	Vara Text `json:"vara"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesAcoesCiveisOcorrencias is retorno.restricoes.acoesCiveis.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoBacen 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoBacen struct {
	// Correntista is retorno.restricoes.chequesSemFundoBacen.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.restricoes.chequesSemFundoBacen.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Quantidade is retorno.restricoes.chequesSemFundoBacen.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// TipoPessoa is retorno.restricoes.chequesSemFundoBacen.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoBacen is retorno.restricoes.chequesSemFundoBacen in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoVarejo 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoVarejo struct {
	// Correntista is retorno.restricoes.chequesSemFundoVarejo.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.restricoes.chequesSemFundoVarejo.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Quantidade is retorno.restricoes.chequesSemFundoVarejo.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// TipoPessoa is retorno.restricoes.chequesSemFundoVarejo.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesChequesSemFundoVarejo is retorno.restricoes.chequesSemFundoVarejo in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesContumacia 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesContumacia struct {
	// DataPrimeiraOcorrencia is retorno.restricoes.contumacia.dataPrimeiraOcorrencia, documented as a string.
	DataPrimeiraOcorrencia Text `json:"dataPrimeiraOcorrencia"`
	// DataUltimaOcorrencia is retorno.restricoes.contumacia.dataUltimaOcorrencia, documented as a string.
	DataUltimaOcorrencia Text `json:"dataUltimaOcorrencia"`
	// Quantidade is retorno.restricoes.contumacia.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesContumacia is retorno.restricoes.contumacia in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial struct {
	// Ocorrencias is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias `json:"ocorrencias"`
	// PeriodoFinal is retorno.restricoes.falenciaRecuperacaoJudicial.periodoFinal, documented as a string.
	PeriodoFinal Text `json:"periodoFinal"`
	// PeriodoInicial is retorno.restricoes.falenciaRecuperacaoJudicial.periodoInicial, documented as a string.
	PeriodoInicial Text `json:"periodoInicial"`
	// Quantidade is retorno.restricoes.falenciaRecuperacaoJudicial.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial is retorno.restricoes.falenciaRecuperacaoJudicial in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias struct {
	// Data is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Origem is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Tipo is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Vara is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].vara, documented as a string.
	Vara Text `json:"vara"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesFaturamentoPresumido 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesFaturamentoPresumido struct {
	// DadosCadastroPositivo is retorno.restricoes.faturamentoPresumido.dadosCadastroPositivo, documented as a string.
	DadosCadastroPositivo Text `json:"dadosCadastroPositivo"`
	// DataReferencia is retorno.restricoes.faturamentoPresumido.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// Faixa is retorno.restricoes.faturamentoPresumido.faixa, documented as a string.
	Faixa Text `json:"faixa"`
	// FaturamentoAnual is retorno.restricoes.faturamentoPresumido.faturamentoAnual, documented as a string.
	FaturamentoAnual Text `json:"faturamentoAnual"`
	// Mensagem is retorno.restricoes.faturamentoPresumido.mensagem, documented as a string.
	Mensagem Text `json:"mensagem"`
	// ValorPresumido is retorno.restricoes.faturamentoPresumido.valorPresumido, documented as a string.
	ValorPresumido Text `json:"valorPresumido"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesFaturamentoPresumido is retorno.restricoes.faturamentoPresumido in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesLimiteCredito 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesLimiteCredito struct {
	// Descricao is retorno.restricoes.limiteCredito.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Texto is retorno.restricoes.limiteCredito.texto, documented as a string.
	Texto Text `json:"texto"`
	// Valor is retorno.restricoes.limiteCredito.valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesLimiteCredito is retorno.restricoes.limiteCredito in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceiras 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceiras struct {
	// DataMaior is retorno.restricoes.pendenciasFinanceiras.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.restricoes.pendenciasFinanceiras.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// Ocorrencias is retorno.restricoes.pendenciasFinanceiras.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias `json:"ocorrencias"`
	// PeriodoFinal is retorno.restricoes.pendenciasFinanceiras.periodoFinal, documented as a string.
	PeriodoFinal Text `json:"periodoFinal"`
	// PeriodoInicial is retorno.restricoes.pendenciasFinanceiras.periodoInicial, documented as a string.
	PeriodoInicial Text `json:"periodoInicial"`
	// Provedores is retorno.restricoes.pendenciasFinanceiras.provedores, a list.
	Provedores []Text `json:"provedores"`
	// Quantidade is retorno.restricoes.pendenciasFinanceiras.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// TotalCredores is retorno.restricoes.pendenciasFinanceiras.totalCredores, documented as a string.
	TotalCredores Text `json:"totalCredores"`
	// UltimoVencimento is retorno.restricoes.pendenciasFinanceiras.ultimoVencimento, documented as a string.
	UltimoVencimento Text `json:"ultimoVencimento"`
	// ValorMaior is retorno.restricoes.pendenciasFinanceiras.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.restricoes.pendenciasFinanceiras.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.restricoes.pendenciasFinanceiras.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceiras is retorno.restricoes.pendenciasFinanceiras in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias struct {
	// Contrato is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].contrato, documented as a string.
	Contrato Text `json:"contrato"`
	// Credor is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// DataInclusao is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataVencimento is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// Entidade is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// Informante is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].informante, documented as a string.
	Informante Text `json:"informante"`
	// Modalidade is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].modalidade, documented as a string.
	Modalidade Text `json:"modalidade"`
	// Moeda is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Subjudice is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoDevedor is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].tipoDevedor, documented as a string.
	TipoDevedor Text `json:"tipoDevedor"`
	// Valor is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias is retorno.restricoes.pendenciasFinanceiras.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestos 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestos struct {
	// DataMaior is retorno.restricoes.protestos.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.restricoes.protestos.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// DataUltimo is retorno.restricoes.protestos.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.restricoes.protestos.ocorrencias, a list.
	Ocorrencias []BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestosOcorrencias `json:"ocorrencias"`
	// Quantidade is retorno.restricoes.protestos.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// UltimoProtesto is retorno.restricoes.protestos.ultimoProtesto, documented as a string.
	UltimoProtesto Text `json:"ultimoProtesto"`
	// ValorMaior is retorno.restricoes.protestos.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.restricoes.protestos.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.restricoes.protestos.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.restricoes.protestos.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestos is retorno.restricoes.protestos in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestosOcorrencias 

type BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestosOcorrencias struct {
	// Anuencia is retorno.restricoes.protestos.ocorrencias[].anuencia, documented as a string.
	Anuencia Text `json:"anuencia"`
	// Cartorio is retorno.restricoes.protestos.ocorrencias[].cartorio, documented as a string.
	Cartorio Text `json:"cartorio"`
	// Credor is retorno.restricoes.protestos.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// Data is retorno.restricoes.protestos.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Moeda is retorno.restricoes.protestos.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.restricoes.protestos.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Quantidade is retorno.restricoes.protestos.ocorrencias[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// Subjudice is retorno.restricoes.protestos.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoAnotacao is retorno.restricoes.protestos.ocorrencias[].tipoAnotacao, documented as a string.
	TipoAnotacao Text `json:"tipoAnotacao"`
	// Valor is retorno.restricoes.protestos.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// ValorCustas is retorno.restricoes.protestos.ocorrencias[].valorCustas, documented as a string.
	ValorCustas Text `json:"valorCustas"`
	// Vencimento is retorno.restricoes.protestos.ocorrencias[].vencimento, documented as a string.
	Vencimento Text `json:"vencimento"`
}

BoaVistaDefineLimitePositivoPJRetornoRestricoesProtestosOcorrencias is retorno.restricoes.protestos.ocorrencias[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoScore 

type BoaVistaDefineLimitePositivoPJRetornoScore struct {
	// ClassificacaoABC is retorno.score.classificacaoABC, documented as a string.
	ClassificacaoABC Text `json:"classificacaoABC"`
	// ClassificacaoNumero is retorno.score.classificacaoNumero, documented as a string.
	ClassificacaoNumero Text `json:"classificacaoNumero"`
	// DescrPlano is retorno.score.descrPlano, documented as a string.
	DescrPlano Text `json:"descrPlano"`
	// DescrScore is retorno.score.descrScore, documented as a string.
	DescrScore Text `json:"descrScore"`
	// Execucao is retorno.score.execucao, documented as a string.
	Execucao Text `json:"execucao"`
	// Informante is retorno.score.informante, documented as a string.
	Informante Text `json:"informante"`
	// Layout is retorno.score.layout, documented as a string.
	Layout Text `json:"layout"`
	// ModeloScore is retorno.score.modeloScore, documented as a string.
	ModeloScore Text `json:"modeloScore"`
	// ProbabilidadeInadimplencia is retorno.score.probabilidadeInadimplencia, documented as a string.
	ProbabilidadeInadimplencia Text `json:"probabilidadeInadimplencia"`
	// Risco is retorno.score.risco, documented as a string.
	Risco Text `json:"risco"`
	// Score is retorno.score.score, documented as a string.
	Score Text `json:"score"`
	// Texto is retorno.score.texto, documented as a string.
	Texto Text `json:"texto"`
	// TipoScore is retorno.score.tipoScore, documented as a string.
	TipoScore Text `json:"tipoScore"`
}

BoaVistaDefineLimitePositivoPJRetornoScore is retorno.score in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaDefineLimitePositivoPJRetornoTelefones 

type BoaVistaDefineLimitePositivoPJRetornoTelefones struct {
	// Ddd is retorno.telefones[].ddd, documented as a string.
	Ddd Text `json:"ddd"`
	// Numero is retorno.telefones[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// TelefoneComDDD is retorno.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
}

BoaVistaDefineLimitePositivoPJRetornoTelefones is retorno.telefones[] in the answer of BoaVistaDefineLimitePositivoPJ.

type BoaVistaRiscoPositivoPJParams 

type BoaVistaRiscoPositivoPJParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

BoaVistaRiscoPositivoPJParams are the parameters of BoaVistaRiscoPositivoPJ (Boa Vista - Risco Positivo Pessoa Jurídica).

func (BoaVistaRiscoPositivoPJParams) Request 

func (p BoaVistaRiscoPositivoPJParams) Request() (Request, error)

Request builds the Request for BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetorno 

type BoaVistaRiscoPositivoPJRetorno struct {
	// Alertas is retorno.alertas, a list.
	Alertas []BoaVistaRiscoPositivoPJRetornoAlertas `json:"alertas"`
	// Decisoes is retorno.decisoes.
	Decisoes BoaVistaRiscoPositivoPJRetornoDecisoes `json:"decisoes"`
	// Empresa is retorno.empresa.
	Empresa BoaVistaRiscoPositivoPJRetornoEmpresa `json:"empresa"`
	// Governancas is retorno.governancas.
	Governancas BoaVistaRiscoPositivoPJRetornoGovernancas `json:"governancas"`
	// HistoricoConsulta is retorno.historicoConsulta.
	HistoricoConsulta BoaVistaRiscoPositivoPJRetornoHistoricoConsulta `json:"historicoConsulta"`
	// Indicadores is retorno.indicadores.
	Indicadores BoaVistaRiscoPositivoPJRetornoIndicadores `json:"indicadores"`
	// Restricoes is retorno.restricoes.
	Restricoes BoaVistaRiscoPositivoPJRetornoRestricoes `json:"restricoes"`
	// Score is retorno.score.
	Score BoaVistaRiscoPositivoPJRetornoScore `json:"score"`
}

BoaVistaRiscoPositivoPJRetorno is retorno in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoAlertas 

type BoaVistaRiscoPositivoPJRetornoAlertas struct {
	// Observacoes is retorno.alertas[].observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Tipo is retorno.alertas[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Titulo is retorno.alertas[].titulo, documented as a string.
	Titulo Text `json:"titulo"`
}

BoaVistaRiscoPositivoPJRetornoAlertas is retorno.alertas[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoDecisoes 

type BoaVistaRiscoPositivoPJRetornoDecisoes struct {
	// CodigoSituacao is retorno.decisoes.codigoSituacao, documented as a string.
	CodigoSituacao Text `json:"codigoSituacao"`
	// Descricao is retorno.decisoes.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Layout is retorno.decisoes.layout, documented as a string.
	Layout Text `json:"layout"`
	// Observacoes is retorno.decisoes.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
}

BoaVistaRiscoPositivoPJRetornoDecisoes is retorno.decisoes in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoEmpresa 

type BoaVistaRiscoPositivoPJRetornoEmpresa struct {
	// CapitalSocial is retorno.empresa.capitalSocial, documented as a string.
	CapitalSocial Text `json:"capitalSocial"`
	// CidadesFiliais is retorno.empresa.cidadesFiliais, documented as a string.
	CidadesFiliais Text `json:"cidadesFiliais"`
	// CnaePrimario is retorno.empresa.cnaePrimario, documented as a string.
	CnaePrimario Text `json:"cnaePrimario"`
	// CnaeSecundario is retorno.empresa.cnaeSecundario, documented as a string.
	CnaeSecundario Text `json:"cnaeSecundario"`
	// Cnpj is retorno.empresa.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DataConsulta is retorno.empresa.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataConsultaSintegra is retorno.empresa.dataConsultaSintegra, documented as a string.
	DataConsultaSintegra Text `json:"dataConsultaSintegra"`
	// DataEncerramento is retorno.empresa.dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataFundacao is retorno.empresa.dataFundacao, documented as a string.
	DataFundacao Text `json:"dataFundacao"`
	// DataSituacao is retorno.empresa.dataSituacao, documented as a string.
	DataSituacao Text `json:"dataSituacao"`
	// DataSituacaoSintegra is retorno.empresa.dataSituacaoSintegra, documented as a string.
	DataSituacaoSintegra Text `json:"dataSituacaoSintegra"`
	// Email is retorno.empresa.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Endereco is retorno.empresa.endereco.
	Endereco BoaVistaRiscoPositivoPJRetornoEmpresaEndereco `json:"endereco"`
	// FaixaFuncionarios is retorno.empresa.faixaFuncionarios, documented as a string.
	FaixaFuncionarios Text `json:"faixaFuncionarios"`
	// InscricaoEstadual is retorno.empresa.inscricaoEstadual, documented as a string.
	InscricaoEstadual Text `json:"inscricaoEstadual" pii:"document"`
	// InscricaoEstadualUf is retorno.empresa.inscricaoEstadualUf, documented as a string.
	InscricaoEstadualUf Text `json:"inscricaoEstadualUf"`
	// NaturezaJuridica is retorno.empresa.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// Nire is retorno.empresa.nire, documented as a string.
	Nire Text `json:"nire"`
	// NireUf is retorno.empresa.nireUf, documented as a string.
	NireUf Text `json:"nireUf"`
	// NomeFantasia is retorno.empresa.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// OpcaoTributaria is retorno.empresa.opcaoTributaria, documented as a string.
	OpcaoTributaria Text `json:"opcaoTributaria"`
	// Porte is retorno.empresa.porte, documented as a string.
	Porte Text `json:"porte"`
	// QuantidadeFiliais is retorno.empresa.quantidadeFiliais, documented as a string.
	QuantidadeFiliais Text `json:"quantidadeFiliais"`
	// RamoAtividadePrimario is retorno.empresa.ramoAtividadePrimario, documented as a string.
	RamoAtividadePrimario Text `json:"ramoAtividadePrimario"`
	// RamoAtividadeSecundario is retorno.empresa.ramoAtividadeSecundario, documented as a string.
	RamoAtividadeSecundario Text `json:"ramoAtividadeSecundario"`
	// RazaoSocial is retorno.empresa.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// RazaoSocialAnterior is retorno.empresa.razaoSocialAnterior, documented as a string.
	RazaoSocialAnterior Text `json:"razaoSocialAnterior"`
	// Situacao is retorno.empresa.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// SituacaoSintegra is retorno.empresa.situacaoSintegra, documented as a string.
	SituacaoSintegra Text `json:"situacaoSintegra"`
	// Telefone is retorno.empresa.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TipoSociedade is retorno.empresa.tipoSociedade, documented as a string.
	TipoSociedade Text `json:"tipoSociedade"`
}

BoaVistaRiscoPositivoPJRetornoEmpresa is retorno.empresa in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoEmpresaEndereco 

type BoaVistaRiscoPositivoPJRetornoEmpresaEndereco struct {
	// Bairro is retorno.empresa.endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.empresa.endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.empresa.endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Rua is retorno.empresa.endereco.rua, documented as a string.
	Rua Text `json:"rua"`
	// Uf is retorno.empresa.endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

BoaVistaRiscoPositivoPJRetornoEmpresaEndereco is retorno.empresa.endereco in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoGovernancas 

type BoaVistaRiscoPositivoPJRetornoGovernancas struct {
	// Administradores is retorno.governancas.administradores, a list.
	Administradores []BoaVistaRiscoPositivoPJRetornoGovernancasAdministradores `json:"administradores"`
	// QuantidadeAdministradores is retorno.governancas.quantidadeAdministradores, documented as a string.
	QuantidadeAdministradores Text `json:"quantidadeAdministradores"`
	// QuantidadeSocios is retorno.governancas.quantidadeSocios, documented as a string.
	QuantidadeSocios Text `json:"quantidadeSocios"`
	// Socios is retorno.governancas.socios, a list.
	Socios []BoaVistaRiscoPositivoPJRetornoGovernancasSocios `json:"socios"`
}

BoaVistaRiscoPositivoPJRetornoGovernancas is retorno.governancas in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoGovernancasAdministradores 

type BoaVistaRiscoPositivoPJRetornoGovernancasAdministradores struct {
	// Cargo is retorno.governancas.administradores[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataEntrada is retorno.governancas.administradores[].dataEntrada, documented as a string.
	DataEntrada Text `json:"dataEntrada"`
	// Documento is retorno.governancas.administradores[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.governancas.administradores[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// SituacaoDocumento is retorno.governancas.administradores[].situacaoDocumento, documented as a string.
	SituacaoDocumento Text `json:"situacaoDocumento"`
}

BoaVistaRiscoPositivoPJRetornoGovernancasAdministradores is retorno.governancas.administradores[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoGovernancasSocios 

type BoaVistaRiscoPositivoPJRetornoGovernancasSocios struct {
	// Documento is retorno.governancas.socios[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.governancas.socios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// PercentualParticipacao is retorno.governancas.socios[].percentualParticipacao, documented as a string.
	PercentualParticipacao Text `json:"percentualParticipacao"`
	// SituacaoDocumento is retorno.governancas.socios[].situacaoDocumento, documented as a string.
	SituacaoDocumento Text `json:"situacaoDocumento"`
	// TipoDocumento is retorno.governancas.socios[].tipoDocumento, documented as a string.
	TipoDocumento Text `json:"tipoDocumento"`
}

BoaVistaRiscoPositivoPJRetornoGovernancasSocios is retorno.governancas.socios[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoHistoricoConsulta 

type BoaVistaRiscoPositivoPJRetornoHistoricoConsulta struct {
	// DataFinal is retorno.historicoConsulta.dataFinal, documented as a string.
	DataFinal Text `json:"dataFinal"`
	// DataInicial is retorno.historicoConsulta.dataInicial, documented as a string.
	DataInicial Text `json:"dataInicial"`
	// Detalhes is retorno.historicoConsulta.detalhes, a list.
	Detalhes []BoaVistaRiscoPositivoPJRetornoHistoricoConsultaDetalhes `json:"detalhes"`
	// QuantidadeOcorrencias is retorno.historicoConsulta.quantidadeOcorrencias, documented as a string.
	QuantidadeOcorrencias Text `json:"quantidadeOcorrencias"`
}

BoaVistaRiscoPositivoPJRetornoHistoricoConsulta is retorno.historicoConsulta in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoHistoricoConsultaDetalhes 

type BoaVistaRiscoPositivoPJRetornoHistoricoConsultaDetalhes struct {
	// Cnpj is retorno.historicoConsulta.detalhes[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Data is retorno.historicoConsulta.detalhes[].data, documented as a string.
	Data Text `json:"data"`
	// RazaoSocial is retorno.historicoConsulta.detalhes[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

BoaVistaRiscoPositivoPJRetornoHistoricoConsultaDetalhes is retorno.historicoConsulta.detalhes[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadores 

type BoaVistaRiscoPositivoPJRetornoIndicadores struct {
	// Compromissos is retorno.indicadores.compromissos.
	Compromissos BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissos `json:"compromissos"`
	// CreditoObtido is retorno.indicadores.creditoObtido.
	CreditoObtido BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtido `json:"creditoObtido"`
	// EventosPessoaJuridica is retorno.indicadores.eventosPessoaJuridica.
	EventosPessoaJuridica BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridica `json:"eventosPessoaJuridica"`
	// PagamentoAtrasado is retorno.indicadores.pagamentoAtrasado.
	PagamentoAtrasado BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasado `json:"pagamentoAtrasado"`
	// PagamentoPontual is retorno.indicadores.pagamentoPontual.
	PagamentoPontual BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontual `json:"pagamentoPontual"`
	// PeriodoRelacionamentoFornecedores is retorno.indicadores.periodoRelacionamentoFornecedores.
	PeriodoRelacionamentoFornecedores BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores `json:"periodoRelacionamentoFornecedores"`
}

BoaVistaRiscoPositivoPJRetornoIndicadores is retorno.indicadores in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissos 

type BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissos struct {
	// Ocorrencias is retorno.indicadores.compromissos.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissosOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.compromissos.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissos is retorno.indicadores.compromissos in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissosOcorrencias 

type BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissosOcorrencias struct {
	// Periodo is retorno.indicadores.compromissos.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.compromissos.ocorrencias[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresCompromissosOcorrencias is retorno.indicadores.compromissos.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtido 

type BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtido struct {
	// Ocorrencias is retorno.indicadores.creditoObtido.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtidoOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.creditoObtido.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtido is retorno.indicadores.creditoObtido in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtidoOcorrencias 

type BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtidoOcorrencias struct {
	// Periodo is retorno.indicadores.creditoObtido.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.creditoObtido.ocorrencias[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresCreditoObtidoOcorrencias is retorno.indicadores.creditoObtido.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridica 

type BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridica struct {
	// Ocorrencias is retorno.indicadores.eventosPessoaJuridica.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.eventosPessoaJuridica.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridica is retorno.indicadores.eventosPessoaJuridica in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias 

type BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias struct {
	// Indicador is retorno.indicadores.eventosPessoaJuridica.ocorrencias[].indicador, documented as a string.
	Indicador Text `json:"indicador"`
	// Periodo is retorno.indicadores.eventosPessoaJuridica.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// Pontuacao is retorno.indicadores.eventosPessoaJuridica.ocorrencias[].pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresEventosPessoaJuridicaOcorrencias is retorno.indicadores.eventosPessoaJuridica.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasado 

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasado struct {
	// Ocorrencias is retorno.indicadores.pagamentoAtrasado.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias `json:"ocorrencias"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasado is retorno.indicadores.pagamentoAtrasado in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias 

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias struct {
	// Descricao is retorno.indicadores.pagamentoAtrasado.ocorrencias[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Itens is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens, a list.
	Itens []BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens `json:"itens"`
	// Pontuacao is retorno.indicadores.pagamentoAtrasado.ocorrencias[].pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrencias is retorno.indicadores.pagamentoAtrasado.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens 

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens struct {
	// Periodo is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoAtrasadoOcorrenciasItens is retorno.indicadores.pagamentoAtrasado.ocorrencias[].itens[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontual 

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontual struct {
	// Ocorrencias is retorno.indicadores.pagamentoPontual.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontualOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.pagamentoPontual.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontual is retorno.indicadores.pagamentoPontual in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontualOcorrencias 

type BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontualOcorrencias struct {
	// Periodo is retorno.indicadores.pagamentoPontual.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// PontuacaoMensal is retorno.indicadores.pagamentoPontual.ocorrencias[].pontuacao_Mensal, documented as a string.
	PontuacaoMensal Text `json:"pontuacao_Mensal"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresPagamentoPontualOcorrencias is retorno.indicadores.pagamentoPontual.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores 

type BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores struct {
	// Ocorrencias is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias `json:"ocorrencias"`
	// Pontuacao is retorno.indicadores.periodoRelacionamentoFornecedores.pontuacao, documented as a string.
	Pontuacao Text `json:"pontuacao"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedores is retorno.indicadores.periodoRelacionamentoFornecedores in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias 

type BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias struct {
	// Periodo is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias[].periodo, documented as a string.
	Periodo Text `json:"periodo"`
	// Valor is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaRiscoPositivoPJRetornoIndicadoresPeriodoRelacionamentoFornecedoresOcorrencias is retorno.indicadores.periodoRelacionamentoFornecedores.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoes 

type BoaVistaRiscoPositivoPJRetornoRestricoes struct {
	// AcoesCiveis is retorno.restricoes.acoesCiveis.
	AcoesCiveis BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveis `json:"acoesCiveis"`
	// ChequesSemFundoBacen is retorno.restricoes.chequesSemFundoBacen.
	ChequesSemFundoBacen BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoBacen `json:"chequesSemFundoBacen"`
	// ChequesSemFundoVarejo is retorno.restricoes.chequesSemFundoVarejo.
	ChequesSemFundoVarejo BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoVarejo `json:"chequesSemFundoVarejo"`
	// Contumacia is retorno.restricoes.contumacia.
	Contumacia BoaVistaRiscoPositivoPJRetornoRestricoesContumacia `json:"contumacia"`
	// FalenciaRecuperacaoJudicial is retorno.restricoes.falenciaRecuperacaoJudicial.
	FalenciaRecuperacaoJudicial BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial `json:"falenciaRecuperacaoJudicial"`
	// FaturamentoPresumido is retorno.restricoes.faturamentoPresumido.
	FaturamentoPresumido BoaVistaRiscoPositivoPJRetornoRestricoesFaturamentoPresumido `json:"faturamentoPresumido"`
	// LimiteCredito is retorno.restricoes.limiteCredito.
	LimiteCredito BoaVistaRiscoPositivoPJRetornoRestricoesLimiteCredito `json:"limiteCredito"`
	// PendenciasFinanceiras is retorno.restricoes.pendenciasFinanceiras.
	PendenciasFinanceiras BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceiras `json:"pendenciasFinanceiras"`
	// Protestos is retorno.restricoes.protestos.
	Protestos BoaVistaRiscoPositivoPJRetornoRestricoesProtestos `json:"protestos"`
}

BoaVistaRiscoPositivoPJRetornoRestricoes is retorno.restricoes in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveis 

type BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveis struct {
	// DataMaior is retorno.restricoes.acoesCiveis.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataMenor is retorno.restricoes.acoesCiveis.dataMenor, documented as a string.
	DataMenor Text `json:"dataMenor"`
	// DataPrimeira is retorno.restricoes.acoesCiveis.dataPrimeira, documented as a string.
	DataPrimeira Text `json:"dataPrimeira"`
	// DataUltimo is retorno.restricoes.acoesCiveis.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.restricoes.acoesCiveis.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveisOcorrencias `json:"ocorrencias"`
	// Quantidade is retorno.restricoes.acoesCiveis.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// ValorMaior is retorno.restricoes.acoesCiveis.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorMenor is retorno.restricoes.acoesCiveis.valorMenor, documented as a string.
	ValorMenor Text `json:"valorMenor"`
	// ValorPrimeiro is retorno.restricoes.acoesCiveis.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.restricoes.acoesCiveis.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.restricoes.acoesCiveis.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveis is retorno.restricoes.acoesCiveis in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveisOcorrencias 

type BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveisOcorrencias struct {
	// Acao is retorno.restricoes.acoesCiveis.ocorrencias[].acao, documented as a string.
	Acao Text `json:"acao"`
	// Autor is retorno.restricoes.acoesCiveis.ocorrencias[].autor, documented as a string.
	Autor Text `json:"autor"`
	// Comarca is retorno.restricoes.acoesCiveis.ocorrencias[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataDistribuicao is retorno.restricoes.acoesCiveis.ocorrencias[].dataDistribuicao, documented as a string.
	DataDistribuicao Text `json:"dataDistribuicao"`
	// Documento is retorno.restricoes.acoesCiveis.ocorrencias[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Foro is retorno.restricoes.acoesCiveis.ocorrencias[].foro, documented as a string.
	Foro Text `json:"foro"`
	// Origem is retorno.restricoes.acoesCiveis.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Processo is retorno.restricoes.acoesCiveis.ocorrencias[].processo, documented as a string.
	Processo Text `json:"processo"`
	// Requerido is retorno.restricoes.acoesCiveis.ocorrencias[].requerido, documented as a string.
	Requerido Text `json:"requerido"`
	// Valor is retorno.restricoes.acoesCiveis.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// Vara is retorno.restricoes.acoesCiveis.ocorrencias[].vara, documented as a string.
	Vara Text `json:"vara"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesAcoesCiveisOcorrencias is retorno.restricoes.acoesCiveis.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoBacen 

type BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoBacen struct {
	// Correntista is retorno.restricoes.chequesSemFundoBacen.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.restricoes.chequesSemFundoBacen.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Quantidade is retorno.restricoes.chequesSemFundoBacen.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// TipoPessoa is retorno.restricoes.chequesSemFundoBacen.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoBacen is retorno.restricoes.chequesSemFundoBacen in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoVarejo 

type BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoVarejo struct {
	// Correntista is retorno.restricoes.chequesSemFundoVarejo.correntista, documented as a string.
	Correntista Text `json:"correntista"`
	// Documento is retorno.restricoes.chequesSemFundoVarejo.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Quantidade is retorno.restricoes.chequesSemFundoVarejo.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// TipoPessoa is retorno.restricoes.chequesSemFundoVarejo.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesChequesSemFundoVarejo is retorno.restricoes.chequesSemFundoVarejo in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesContumacia 

type BoaVistaRiscoPositivoPJRetornoRestricoesContumacia struct {
	// DataPrimeiraOcorrencia is retorno.restricoes.contumacia.dataPrimeiraOcorrencia, documented as a string.
	DataPrimeiraOcorrencia Text `json:"dataPrimeiraOcorrencia"`
	// DataUltimaOcorrencia is retorno.restricoes.contumacia.dataUltimaOcorrencia, documented as a string.
	DataUltimaOcorrencia Text `json:"dataUltimaOcorrencia"`
	// Quantidade is retorno.restricoes.contumacia.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesContumacia is retorno.restricoes.contumacia in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial 

type BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial struct {
	// Ocorrencias is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias `json:"ocorrencias"`
	// PeriodoFinal is retorno.restricoes.falenciaRecuperacaoJudicial.periodoFinal, documented as a string.
	PeriodoFinal Text `json:"periodoFinal"`
	// PeriodoInicial is retorno.restricoes.falenciaRecuperacaoJudicial.periodoInicial, documented as a string.
	PeriodoInicial Text `json:"periodoInicial"`
	// Quantidade is retorno.restricoes.falenciaRecuperacaoJudicial.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicial is retorno.restricoes.falenciaRecuperacaoJudicial in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias 

type BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias struct {
	// Data is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Origem is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Tipo is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Vara is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[].vara, documented as a string.
	Vara Text `json:"vara"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesFalenciaRecuperacaoJudicialOcorrencias is retorno.restricoes.falenciaRecuperacaoJudicial.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesFaturamentoPresumido 

type BoaVistaRiscoPositivoPJRetornoRestricoesFaturamentoPresumido struct {
	// DadosCadastroPositivo is retorno.restricoes.faturamentoPresumido.dadosCadastroPositivo, documented as a string.
	DadosCadastroPositivo Text `json:"dadosCadastroPositivo"`
	// DataReferencia is retorno.restricoes.faturamentoPresumido.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// Faixa is retorno.restricoes.faturamentoPresumido.faixa, documented as a string.
	Faixa Text `json:"faixa"`
	// FaturamentoAnual is retorno.restricoes.faturamentoPresumido.faturamentoAnual, documented as a string.
	FaturamentoAnual Text `json:"faturamentoAnual"`
	// Mensagem is retorno.restricoes.faturamentoPresumido.mensagem, documented as a string.
	Mensagem Text `json:"mensagem"`
	// ValorPresumido is retorno.restricoes.faturamentoPresumido.valorPresumido, documented as a string.
	ValorPresumido Text `json:"valorPresumido"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesFaturamentoPresumido is retorno.restricoes.faturamentoPresumido in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesLimiteCredito 

type BoaVistaRiscoPositivoPJRetornoRestricoesLimiteCredito struct {
	// Descricao is retorno.restricoes.limiteCredito.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Texto is retorno.restricoes.limiteCredito.texto, documented as a string.
	Texto Text `json:"texto"`
	// Valor is retorno.restricoes.limiteCredito.valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesLimiteCredito is retorno.restricoes.limiteCredito in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceiras 

type BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceiras struct {
	// DataMaior is retorno.restricoes.pendenciasFinanceiras.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.restricoes.pendenciasFinanceiras.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// Ocorrencias is retorno.restricoes.pendenciasFinanceiras.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias `json:"ocorrencias"`
	// PeriodoFinal is retorno.restricoes.pendenciasFinanceiras.periodoFinal, documented as a string.
	PeriodoFinal Text `json:"periodoFinal"`
	// PeriodoInicial is retorno.restricoes.pendenciasFinanceiras.periodoInicial, documented as a string.
	PeriodoInicial Text `json:"periodoInicial"`
	// Provedores is retorno.restricoes.pendenciasFinanceiras.provedores, a list.
	Provedores []Text `json:"provedores"`
	// Quantidade is retorno.restricoes.pendenciasFinanceiras.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// TotalCredores is retorno.restricoes.pendenciasFinanceiras.totalCredores, documented as a string.
	TotalCredores Text `json:"totalCredores"`
	// UltimoVencimento is retorno.restricoes.pendenciasFinanceiras.ultimoVencimento, documented as a string.
	UltimoVencimento Text `json:"ultimoVencimento"`
	// ValorMaior is retorno.restricoes.pendenciasFinanceiras.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.restricoes.pendenciasFinanceiras.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.restricoes.pendenciasFinanceiras.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceiras is retorno.restricoes.pendenciasFinanceiras in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias 

type BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias struct {
	// Contrato is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].contrato, documented as a string.
	Contrato Text `json:"contrato"`
	// Credor is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// DataInclusao is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataVencimento is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// Entidade is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// Informante is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].informante, documented as a string.
	Informante Text `json:"informante"`
	// Modalidade is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].modalidade, documented as a string.
	Modalidade Text `json:"modalidade"`
	// Moeda is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Subjudice is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoDevedor is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].tipoDevedor, documented as a string.
	TipoDevedor Text `json:"tipoDevedor"`
	// Valor is retorno.restricoes.pendenciasFinanceiras.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesPendenciasFinanceirasOcorrencias is retorno.restricoes.pendenciasFinanceiras.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesProtestos 

type BoaVistaRiscoPositivoPJRetornoRestricoesProtestos struct {
	// DataMaior is retorno.restricoes.protestos.dataMaior, documented as a string.
	DataMaior Text `json:"dataMaior"`
	// DataPrimeiro is retorno.restricoes.protestos.dataPrimeiro, documented as a string.
	DataPrimeiro Text `json:"dataPrimeiro"`
	// DataUltimo is retorno.restricoes.protestos.dataUltimo, documented as a string.
	DataUltimo Text `json:"dataUltimo"`
	// Ocorrencias is retorno.restricoes.protestos.ocorrencias, a list.
	Ocorrencias []BoaVistaRiscoPositivoPJRetornoRestricoesProtestosOcorrencias `json:"ocorrencias"`
	// Quantidade is retorno.restricoes.protestos.quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// UltimoProtesto is retorno.restricoes.protestos.ultimoProtesto, documented as a string.
	UltimoProtesto Text `json:"ultimoProtesto"`
	// ValorMaior is retorno.restricoes.protestos.valorMaior, documented as a string.
	ValorMaior Text `json:"valorMaior"`
	// ValorPrimeiro is retorno.restricoes.protestos.valorPrimeiro, documented as a string.
	ValorPrimeiro Text `json:"valorPrimeiro"`
	// ValorTotal is retorno.restricoes.protestos.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUltimo is retorno.restricoes.protestos.valorUltimo, documented as a string.
	ValorUltimo Text `json:"valorUltimo"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesProtestos is retorno.restricoes.protestos in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoRestricoesProtestosOcorrencias 

type BoaVistaRiscoPositivoPJRetornoRestricoesProtestosOcorrencias struct {
	// Anuencia is retorno.restricoes.protestos.ocorrencias[].anuencia, documented as a string.
	Anuencia Text `json:"anuencia"`
	// Cartorio is retorno.restricoes.protestos.ocorrencias[].cartorio, documented as a string.
	Cartorio Text `json:"cartorio"`
	// Credor is retorno.restricoes.protestos.ocorrencias[].credor, documented as a string.
	Credor Text `json:"credor"`
	// Data is retorno.restricoes.protestos.ocorrencias[].data, documented as a string.
	Data Text `json:"data"`
	// Moeda is retorno.restricoes.protestos.ocorrencias[].moeda, documented as a string.
	Moeda Text `json:"moeda"`
	// Origem is retorno.restricoes.protestos.ocorrencias[].origem, documented as a string.
	Origem Text `json:"origem"`
	// Quantidade is retorno.restricoes.protestos.ocorrencias[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// Subjudice is retorno.restricoes.protestos.ocorrencias[].subjudice, documented as a string.
	Subjudice Text `json:"subjudice"`
	// TipoAnotacao is retorno.restricoes.protestos.ocorrencias[].tipoAnotacao, documented as a string.
	TipoAnotacao Text `json:"tipoAnotacao"`
	// Valor is retorno.restricoes.protestos.ocorrencias[].valor, documented as a string.
	Valor Text `json:"valor"`
	// ValorCustas is retorno.restricoes.protestos.ocorrencias[].valorCustas, documented as a string.
	ValorCustas Text `json:"valorCustas"`
	// Vencimento is retorno.restricoes.protestos.ocorrencias[].vencimento, documented as a string.
	Vencimento Text `json:"vencimento"`
}

BoaVistaRiscoPositivoPJRetornoRestricoesProtestosOcorrencias is retorno.restricoes.protestos.ocorrencias[] in the answer of BoaVistaRiscoPositivoPJ.

type BoaVistaRiscoPositivoPJRetornoScore 

type BoaVistaRiscoPositivoPJRetornoScore struct {
	// ClassificacaoABC is retorno.score.classificacaoABC, documented as a string.
	ClassificacaoABC Text `json:"classificacaoABC"`
	// ClassificacaoNumero is retorno.score.classificacaoNumero, documented as a string.
	ClassificacaoNumero Text `json:"classificacaoNumero"`
	// DescrPlano is retorno.score.descrPlano, documented as a string.
	DescrPlano Text `json:"descrPlano"`
	// DescrScore is retorno.score.descrScore, documented as a string.
	DescrScore Text `json:"descrScore"`
	// Execucao is retorno.score.execucao, documented as a string.
	Execucao Text `json:"execucao"`
	// Informante is retorno.score.informante, documented as a string.
	Informante Text `json:"informante"`
	// Layout is retorno.score.layout, documented as a string.
	Layout Text `json:"layout"`
	// ModeloScore is retorno.score.modeloScore, documented as a string.
	ModeloScore Text `json:"modeloScore"`
	// ProbabilidadeInadimplencia is retorno.score.probabilidadeInadimplencia, documented as a string.
	ProbabilidadeInadimplencia Text `json:"probabilidadeInadimplencia"`
	// Risco is retorno.score.risco, documented as a string.
	Risco Text `json:"risco"`
	// Score is retorno.score.score, documented as a string.
	Score Text `json:"score"`
	// Texto is retorno.score.texto, documented as a string.
	Texto Text `json:"texto"`
	// TipoScore is retorno.score.tipoScore, documented as a string.
	TipoScore Text `json:"tipoScore"`
}

BoaVistaRiscoPositivoPJRetornoScore is retorno.score in the answer of BoaVistaRiscoPositivoPJ.

type BolsaFamiliaParams 

type BolsaFamiliaParams struct {
	// Nis is sent as Nis. O parâmetro NIS pode ser enviado com ou sem formatação.
	Nis string
	// MesReferencia is sent as MesReferencia. O parâmetro MESREFERENCIA deve ser de 01 até 12.
	MesReferencia string
	// AnoReferencia is sent as AnoReferencia. O parâmetro ANOREFERENCIA deve conter os 4 dígitos. Ex: 2024.
	AnoReferencia string
	// MesCompetencia is sent as MesCompetencia. O parâmetro MESCOMPETENCIA deve ser de 01 até 12.
	MesCompetencia string
	// AnoCompetencia is sent as AnoCompetencia. O parâmetro ANOCOMPETENCIA deve conter os 4 dígitos. Ex: 2024.
	AnoCompetencia string
}

BolsaFamiliaParams are the parameters of BolsaFamilia (Bolsa Família).

func (BolsaFamiliaParams) Request 

func (p BolsaFamiliaParams) Request() (Request, error)

Request builds the Request for BolsaFamilia.

type BolsaFamiliaRetorno 

type BolsaFamiliaRetorno struct {
	// Beneficios is retorno.beneficios, a list.
	Beneficios []BolsaFamiliaRetornoBeneficios `json:"beneficios"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

BolsaFamiliaRetorno is retorno in the answer of BolsaFamilia.

type BolsaFamiliaRetornoBeneficios 

type BolsaFamiliaRetornoBeneficios struct {
	// DataMesCompetencia is retorno.beneficios[].dataMesCompetencia, documented as a string.
	DataMesCompetencia Text `json:"dataMesCompetencia"`
	// DataMesReferencia is retorno.beneficios[].dataMesReferencia, documented as a string.
	DataMesReferencia Text `json:"dataMesReferencia"`
	// Municipio is retorno.beneficios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroRegistro is retorno.beneficios[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Uf is retorno.beneficios[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.beneficios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

BolsaFamiliaRetornoBeneficios is retorno.beneficios[] in the answer of BolsaFamilia.

type BreakerConfig 

type BreakerConfig struct {
	// Threshold is how many consecutive transport errors or 5xx answers open
	// the breaker. Default 5.
	Threshold int
	// Cooldown is how long an open breaker refuses calls before letting one
	// through to probe. Default 30 seconds.
	Cooldown time.Duration
}

BreakerConfig configures the circuit breaker.

type BreakerState 

type BreakerState string

BreakerState is where the breaker is. 

const (
	// BreakerClosed lets every call through.
	BreakerClosed BreakerState = "closed"
	// BreakerOpen refuses every call until the cooldown ends.
	BreakerOpen BreakerState = "open"
	// BreakerHalfOpen lets one probe through; its outcome closes or reopens
	// the breaker.
	BreakerHalfOpen BreakerState = "half_open"
)

The breaker states.

type CADINSecretariaFazendaEstaduaisParams 

type CADINSecretariaFazendaEstaduaisParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Uf is sent as Uf. Not described by the documentation.
	Uf string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CADINSecretariaFazendaEstaduaisParams are the parameters of CADINSecretariaFazendaEstaduais (CADIN - Secretaria da Fazenda).

func (CADINSecretariaFazendaEstaduaisParams) Request 

func (p CADINSecretariaFazendaEstaduaisParams) Request() (Request, error)

Request builds the Request for CADINSecretariaFazendaEstaduais.

type CADINSecretariaFazendaEstaduaisRetorno 

type CADINSecretariaFazendaEstaduaisRetorno struct {
	// CodigoDeclaracao is retorno.codigoDeclaracao, documented as a string.
	CodigoDeclaracao Text `json:"codigoDeclaracao"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Pendencias is retorno.pendencias, a list.
	Pendencias []CADINSecretariaFazendaEstaduaisRetornoPendencias `json:"pendencias"`
	// PossuiPendencias is retorno.possuiPendencias, documented as a boolean.
	PossuiPendencias Flag `json:"possuiPendencias"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TotalPendencias is retorno.totalPendencias, documented as a number.
	TotalPendencias Number `json:"totalPendencias"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

CADINSecretariaFazendaEstaduaisRetorno is retorno in the answer of CADINSecretariaFazendaEstaduais.

type CADINSecretariaFazendaEstaduaisRetornoPendencias 

type CADINSecretariaFazendaEstaduaisRetornoPendencias struct {
	// DataInclusaoCADIN is retorno.pendencias[].dataInclusaoCADIN, documented as a string.
	DataInclusaoCADIN Text `json:"dataInclusaoCADIN"`
	// Entidade is retorno.pendencias[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// LocalRegularizacao is retorno.pendencias[].localRegularizacao, documented as a string.
	LocalRegularizacao Text `json:"localRegularizacao"`
	// NumeroProcesso is retorno.pendencias[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Orgao is retorno.pendencias[].orgao, documented as a string.
	Orgao Text `json:"orgao"`
	// QuantidadePendencias is retorno.pendencias[].quantidadePendencias, documented as a number.
	QuantidadePendencias Number `json:"quantidadePendencias"`
	// TipoPendencia is retorno.pendencias[].tipoPendencia, documented as a string.
	TipoPendencia Text `json:"tipoPendencia"`
}

CADINSecretariaFazendaEstaduaisRetornoPendencias is retorno.pendencias[] in the answer of CADINSecretariaFazendaEstaduais.

type CADINSecretariaFazendaSPParams 

type CADINSecretariaFazendaSPParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CADINSecretariaFazendaSPParams are the parameters of CADINSecretariaFazendaSP (CADIN - Secretaria da Fazenda - São Paulo).

func (CADINSecretariaFazendaSPParams) Request 

func (p CADINSecretariaFazendaSPParams) Request() (Request, error)

Request builds the Request for CADINSecretariaFazendaSP.

type CADINSecretariaFazendaSPRetorno 

type CADINSecretariaFazendaSPRetorno struct {
	// CodigoDeclaracao is retorno.codigoDeclaracao, documented as a string.
	CodigoDeclaracao Text `json:"codigoDeclaracao"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Pendencias is retorno.pendencias, a list.
	Pendencias []CADINSecretariaFazendaSPRetornoPendencias `json:"pendencias"`
	// PossuiPendencias is retorno.possuiPendencias, documented as a boolean.
	PossuiPendencias Flag `json:"possuiPendencias"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TotalPendencias is retorno.totalPendencias, documented as a number.
	TotalPendencias Number `json:"totalPendencias"`
}

CADINSecretariaFazendaSPRetorno is retorno in the answer of CADINSecretariaFazendaSP.

type CADINSecretariaFazendaSPRetornoPendencias 

type CADINSecretariaFazendaSPRetornoPendencias struct {
	// DataInclusaoCADIN is retorno.pendencias[].dataInclusaoCADIN, documented as a string.
	DataInclusaoCADIN Text `json:"dataInclusaoCADIN"`
	// Entidade is retorno.pendencias[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// LocalRegularizacao is retorno.pendencias[].localRegularizacao, documented as a string.
	LocalRegularizacao Text `json:"localRegularizacao"`
	// QuantidadePendencias is retorno.pendencias[].quantidadePendencias, documented as a number.
	QuantidadePendencias Number `json:"quantidadePendencias"`
}

CADINSecretariaFazendaSPRetornoPendencias is retorno.pendencias[] in the answer of CADINSecretariaFazendaSP.

type CAFCadastroNacionalAgriculturaPFParams 

type CAFCadastroNacionalAgriculturaPFParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CAFCadastroNacionalAgriculturaPFParams are the parameters of CAFCadastroNacionalAgriculturaPF (CAF - Cadastro Nacional de Agricultura Familiar - PF).

func (CAFCadastroNacionalAgriculturaPFParams) Request 

func (p CAFCadastroNacionalAgriculturaPFParams) Request() (Request, error)

Request builds the Request for CAFCadastroNacionalAgriculturaPF.

type CAFCadastroNacionalAgriculturaPFRetorno 

type CAFCadastroNacionalAgriculturaPFRetorno struct {
	// AtividadePrincipal is retorno.atividadePrincipal, documented as a string.
	AtividadePrincipal Text `json:"atividadePrincipal"`
	// Cadastrador is retorno.cadastrador, documented as a string.
	Cadastrador Text `json:"cadastrador"`
	// CaracterizacaoUFPA is retorno.caracterizacaoUFPA, documented as a string.
	CaracterizacaoUFPA Text `json:"caracterizacaoUFPA"`
	// CnpjEntidade is retorno.cnpjEntidade, documented as a string.
	CnpjEntidade Text `json:"cnpjEntidade" pii:"document"`
	// ComposicaoFamiliar is retorno.composicaoFamiliar, a list.
	ComposicaoFamiliar []CAFCadastroNacionalAgriculturaPFRetornoComposicaoFamiliar `json:"composicaoFamiliar"`
	// CondicaoPosseUso is retorno.condicaoPosseUso, documented as a string.
	CondicaoPosseUso Text `json:"condicaoPosseUso"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataInscricao is retorno.dataInscricao, documented as a string.
	DataInscricao Text `json:"dataInscricao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// EnquadramentoPRONAF is retorno.enquadramentoPRONAF, documented as a string.
	EnquadramentoPRONAF Text `json:"enquadramentoPRONAF"`
	// EntidadeResponsavel is retorno.entidadeResponsavel, documented as a string.
	EntidadeResponsavel Text `json:"entidadeResponsavel"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumImoveisExplorados is retorno.numImoveisExplorados, documented as a number.
	NumImoveisExplorados Number `json:"numImoveisExplorados"`
	// NumeroCaf is retorno.numeroCaf, documented as a string.
	NumeroCaf Text `json:"numeroCaf"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TamanhoImovelPrincipal is retorno.tamanhoImovelPrincipal, documented as a string.
	TamanhoImovelPrincipal Text `json:"tamanhoImovelPrincipal"`
	// TotalEstabelecimentoHA is retorno.totalEstabelecimentoHA, documented as a number.
	TotalEstabelecimentoHA Number `json:"totalEstabelecimentoHA"`
	// TotalEstabelecimentoM2 is retorno.totalEstabelecimentoM2, documented as a number.
	TotalEstabelecimentoM2 Number `json:"totalEstabelecimentoM2"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// UltimaAtualizacao is retorno.ultimaAtualizacao, documented as a string.
	UltimaAtualizacao Text `json:"ultimaAtualizacao"`
}

CAFCadastroNacionalAgriculturaPFRetorno is retorno in the answer of CAFCadastroNacionalAgriculturaPF.

type CAFCadastroNacionalAgriculturaPFRetornoComposicaoFamiliar 

type CAFCadastroNacionalAgriculturaPFRetornoComposicaoFamiliar struct {
	// Cpf is retorno.composicaoFamiliar[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// MaoDeObraFamiliar is retorno.composicaoFamiliar[].maoDeObraFamiliar, documented as a boolean.
	MaoDeObraFamiliar Flag `json:"maoDeObraFamiliar"`
	// Nome is retorno.composicaoFamiliar[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// RelacaoParentesco is retorno.composicaoFamiliar[].relacaoParentesco, documented as a string.
	RelacaoParentesco Text `json:"relacaoParentesco"`
}

CAFCadastroNacionalAgriculturaPFRetornoComposicaoFamiliar is retorno.composicaoFamiliar[] in the answer of CAFCadastroNacionalAgriculturaPF.

type CAFCadastroNacionalAgriculturaPJParams 

type CAFCadastroNacionalAgriculturaPJParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CAFCadastroNacionalAgriculturaPJParams are the parameters of CAFCadastroNacionalAgriculturaPJ (CAF - Cadastro Nacional de Agricultura Familiar - PJ).

func (CAFCadastroNacionalAgriculturaPJParams) Request 

func (p CAFCadastroNacionalAgriculturaPJParams) Request() (Request, error)

Request builds the Request for CAFCadastroNacionalAgriculturaPJ.

type CAFCadastroNacionalAgriculturaPJRetorno 

type CAFCadastroNacionalAgriculturaPJRetorno struct {
	// Cadastrador is retorno.cadastrador, documented as a string.
	Cadastrador Text `json:"cadastrador"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// CnpjEntidade is retorno.cnpjEntidade, documented as a string.
	CnpjEntidade Text `json:"cnpjEntidade" pii:"document"`
	// ComposicaoSocietaria is retorno.composicaoSocietaria, a list.
	ComposicaoSocietaria []CAFCadastroNacionalAgriculturaPJRetornoComposicaoSocietaria `json:"composicaoSocietaria"`
	// CpfRepresentante is retorno.cpfRepresentante, documented as a string.
	CpfRepresentante Text `json:"cpfRepresentante" pii:"document"`
	// DataConstituicao is retorno.dataConstituicao, documented as a string.
	DataConstituicao Text `json:"dataConstituicao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataInscricao is retorno.dataInscricao, documented as a string.
	DataInscricao Text `json:"dataInscricao"`
	// DataUltimoExtrato is retorno.dataUltimoExtrato, documented as a string.
	DataUltimoExtrato Text `json:"dataUltimoExtrato"`
	// DataUltimoUploadAssociados is retorno.dataUltimoUploadAssociados, documented as a string.
	DataUltimoUploadAssociados Text `json:"dataUltimoUploadAssociados"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Emissor is retorno.emissor.
	Emissor CAFCadastroNacionalAgriculturaPJRetornoEmissor `json:"emissor"`
	// EntidadeResponsavel is retorno.entidadeResponsavel, documented as a string.
	EntidadeResponsavel Text `json:"entidadeResponsavel"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroCaf is retorno.numeroCaf, documented as a string.
	NumeroCaf Text `json:"numeroCaf"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// RepresentanteLegal is retorno.representanteLegal, documented as a string.
	RepresentanteLegal Text `json:"representanteLegal"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// SociosPorMunicipio is retorno.sociosPorMunicipio, a list.
	SociosPorMunicipio []CAFCadastroNacionalAgriculturaPJRetornoSociosPorMunicipio `json:"sociosPorMunicipio"`
	// TipoPessoaJuridica is retorno.tipoPessoaJuridica, documented as a string.
	TipoPessoaJuridica Text `json:"tipoPessoaJuridica"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// UltimaAtualizacao is retorno.ultimaAtualizacao, documented as a string.
	UltimaAtualizacao Text `json:"ultimaAtualizacao"`
}

CAFCadastroNacionalAgriculturaPJRetorno is retorno in the answer of CAFCadastroNacionalAgriculturaPJ.

type CAFCadastroNacionalAgriculturaPJRetornoComposicaoSocietaria 

type CAFCadastroNacionalAgriculturaPJRetornoComposicaoSocietaria struct {
	// Categoria is retorno.composicaoSocietaria[].categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// ParticipacaoRelativa is retorno.composicaoSocietaria[].participacaoRelativa, documented as a string.
	ParticipacaoRelativa Text `json:"participacaoRelativa"`
	// Quantidade is retorno.composicaoSocietaria[].quantidade, documented as a number.
	Quantidade Number `json:"quantidade"`
}

CAFCadastroNacionalAgriculturaPJRetornoComposicaoSocietaria is retorno.composicaoSocietaria[] in the answer of CAFCadastroNacionalAgriculturaPJ.

type CAFCadastroNacionalAgriculturaPJRetornoEmissor 

type CAFCadastroNacionalAgriculturaPJRetornoEmissor struct {
	// Cpf is retorno.emissor.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nome is retorno.emissor.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

CAFCadastroNacionalAgriculturaPJRetornoEmissor is retorno.emissor in the answer of CAFCadastroNacionalAgriculturaPJ.

type CAFCadastroNacionalAgriculturaPJRetornoSociosPorMunicipio 

type CAFCadastroNacionalAgriculturaPJRetornoSociosPorMunicipio struct {
	// Municipio is retorno.sociosPorMunicipio[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Quantidade is retorno.sociosPorMunicipio[].quantidade, documented as a number.
	Quantidade Number `json:"quantidade"`
	// Uf is retorno.sociosPorMunicipio[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CAFCadastroNacionalAgriculturaPJRetornoSociosPorMunicipio is retorno.sociosPorMunicipio[] in the answer of CAFCadastroNacionalAgriculturaPJ.

type CARFConselhoAdmistrativodeRecursosFiscaisParams 

type CARFConselhoAdmistrativodeRecursosFiscaisParams struct {
	// CPF is sent as CPF. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as CNPJ. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CNPJ string
}

CARFConselhoAdmistrativodeRecursosFiscaisParams are the parameters of CARFConselhoAdmistrativodeRecursosFiscais (CARF - Conselho Administrativo de Recursos Fiscais).

func (CARFConselhoAdmistrativodeRecursosFiscaisParams) Request 

func (p CARFConselhoAdmistrativodeRecursosFiscaisParams) Request() (Request, error)

Request builds the Request for CARFConselhoAdmistrativodeRecursosFiscais.

type CARFConselhoAdmistrativodeRecursosFiscaisRetorno 

type CARFConselhoAdmistrativodeRecursosFiscaisRetorno struct {
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Processos is retorno.processos, a list.
	Processos []CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessos `json:"processos"`
	// TotalProcessos is retorno.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
}

CARFConselhoAdmistrativodeRecursosFiscaisRetorno is retorno in the answer of CARFConselhoAdmistrativodeRecursosFiscais.

type CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessos 

type CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessos struct {
	// Andamentos is retorno.processos[].andamentos, a list.
	Andamentos []CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosAndamentos `json:"andamentos"`
	// DataEntrada is retorno.processos[].dataEntrada, documented as a string.
	DataEntrada Text `json:"dataEntrada"`
	// NumeroProcesso is retorno.processos[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Recursos is retorno.processos[].recursos, a list.
	Recursos []CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosRecursos `json:"recursos"`
	// Tributo is retorno.processos[].tributo, documented as a string.
	Tributo Text `json:"tributo"`
}

CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessos is retorno.processos[] in the answer of CARFConselhoAdmistrativodeRecursosFiscais.

type CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosAndamentos 

type CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosAndamentos struct {
	// Data is retorno.processos[].andamentos[].data, documented as a string.
	Data Text `json:"data"`
	// Ocorrencia is retorno.processos[].andamentos[].ocorrencia, documented as a string.
	Ocorrencia Text `json:"ocorrencia"`
}

CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosAndamentos is retorno.processos[].andamentos[] in the answer of CARFConselhoAdmistrativodeRecursosFiscais.

type CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosRecursos 

type CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosRecursos struct {
	// DataEntrada is retorno.processos[].recursos[].dataEntrada, documented as a string.
	DataEntrada Text `json:"dataEntrada"`
	// TipoRecurso is retorno.processos[].recursos[].tipoRecurso, documented as a string.
	TipoRecurso Text `json:"tipoRecurso"`
}

CARFConselhoAdmistrativodeRecursosFiscaisRetornoProcessosRecursos is retorno.processos[].recursos[] in the answer of CARFConselhoAdmistrativodeRecursosFiscais.

type CFMConselhoFederalMedicinaParams 

type CFMConselhoFederalMedicinaParams struct {
	// CRM is sent as CRM. Named by the endpoint template only; the parameter table does not list it.
	CRM string
	// UF is sent as UF. Named by the endpoint template only; the parameter table does not list it.
	UF string
}

CFMConselhoFederalMedicinaParams are the parameters of CFMConselhoFederalMedicina (CFM - Conselho Federal de Medicina).

func (CFMConselhoFederalMedicinaParams) Request 

func (p CFMConselhoFederalMedicinaParams) Request() (Request, error)

Request builds the Request for CFMConselhoFederalMedicina.

type CFMConselhoFederalMedicinaRetorno 

type CFMConselhoFederalMedicinaRetorno struct {
	// Crm is retorno.crm, documented as a string.
	Crm Text `json:"crm" pii:"document"`
	// Medicos is retorno.medicos, a list.
	Medicos []CFMConselhoFederalMedicinaRetornoMedicos `json:"medicos"`
	// NomePesquisado is retorno.nomePesquisado, documented as a string.
	NomePesquisado Text `json:"nomePesquisado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

CFMConselhoFederalMedicinaRetorno is retorno in the answer of CFMConselhoFederalMedicina.

type CFMConselhoFederalMedicinaRetornoMedicos 

type CFMConselhoFederalMedicinaRetornoMedicos struct {
	// AnoFormatura is retorno.medicos[].anoFormatura, documented as a string.
	AnoFormatura Text `json:"anoFormatura"`
	// Crm is retorno.medicos[].crm, documented as a string.
	Crm Text `json:"crm" pii:"document"`
	// DataInscricao is retorno.medicos[].dataInscricao, documented as a string.
	DataInscricao Text `json:"dataInscricao"`
	// Endereco is retorno.medicos[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Especialidades is retorno.medicos[].especialidades, a list.
	Especialidades []Text `json:"especialidades"`
	// InscricaoOutrosEstados is retorno.medicos[].inscricaoOutrosEstados, documented as a string.
	InscricaoOutrosEstados Text `json:"inscricaoOutrosEstados"`
	// InstituicaoGraduacao is retorno.medicos[].instituicaoGraduacao, documented as a string.
	InstituicaoGraduacao Text `json:"instituicaoGraduacao"`
	// NomeEntidade is retorno.medicos[].nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Situacao is retorno.medicos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Status is retorno.medicos[].status, documented as a string.
	Status Text `json:"status"`
	// Telefone is retorno.medicos[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TipoInscricao is retorno.medicos[].tipoInscricao, documented as a string.
	TipoInscricao Text `json:"tipoInscricao"`
	// Uf is retorno.medicos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CFMConselhoFederalMedicinaRetornoMedicos is retorno.medicos[] in the answer of CFMConselhoFederalMedicina.

type CGUConsultoriaGeralUniaoParams 

type CGUConsultoriaGeralUniaoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Tipo is sent as Tipo. O parâmetro TIPO deve ser escolhido.
	Tipo string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CGUConsultoriaGeralUniaoParams are the parameters of CGUConsultoriaGeralUniao (Consultoria Geral da União - CGU).

func (CGUConsultoriaGeralUniaoParams) Request 

func (p CGUConsultoriaGeralUniaoParams) Request() (Request, error)

Request builds the Request for CGUConsultoriaGeralUniao.

type CGUConsultoriaGeralUniaoRetorno 

type CGUConsultoriaGeralUniaoRetorno struct {
	// CodigoControle is retorno.codigoControle, documented as a string.
	CodigoControle Text `json:"codigoControle"`
	// ConstamCorrecionais is retorno.constamCorrecionais, documented as a boolean.
	ConstamCorrecionais Flag `json:"constamCorrecionais"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// RestricoesCGU is retorno.restricoesCGU, a list.
	RestricoesCGU []CGUConsultoriaGeralUniaoRetornoRestricoesCGU `json:"restricoesCGU"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TipoConsultado is retorno.tipoConsultado, documented as a string.
	TipoConsultado Text `json:"tipoConsultado"`
}

CGUConsultoriaGeralUniaoRetorno is retorno in the answer of CGUConsultoriaGeralUniao.

type CGUConsultoriaGeralUniaoRetornoRestricoesCGU 

type CGUConsultoriaGeralUniaoRetornoRestricoesCGU struct {
	// Descricao is retorno.restricoesCGU[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Emissor is retorno.restricoesCGU[].emissor, documented as a string.
	Emissor Text `json:"emissor"`
	// PossuiCorrecional is retorno.restricoesCGU[].possuiCorrecional, documented as a boolean.
	PossuiCorrecional Flag `json:"possuiCorrecional"`
	// Status is retorno.restricoesCGU[].status, documented as a string.
	Status Text `json:"status"`
}

CGUConsultoriaGeralUniaoRetornoRestricoesCGU is retorno.restricoesCGU[] in the answer of CGUConsultoriaGeralUniao.

type CNJMandadosPrisaoParams 

type CNJMandadosPrisaoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
	// NomeMae is sent as NomeMae. O parâmetro NOMEMAE pode ser enviado com qualquer outro.
	NomeMae string
	// NomePai is sent as NomePai. O parâmetro NOMEPAI pode ser enviado com qualquer outro.
	NomePai string
	// Alcunha is sent as Alcunha. O parâmetro ALCUNHA pode ser enviado com qualquer outro.
	Alcunha string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CNJMandadosPrisaoParams are the parameters of CNJMandadosPrisao (CNJ - Mandados de Prisão).

func (CNJMandadosPrisaoParams) Request 

func (p CNJMandadosPrisaoParams) Request() (Request, error)

Request builds the Request for CNJMandadosPrisao.

type CNJMandadosPrisaoRetorno 

type CNJMandadosPrisaoRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// MandadosPrisao is retorno.mandadosPrisao, a list.
	MandadosPrisao []CNJMandadosPrisaoRetornoMandadosPrisao `json:"mandadosPrisao"`
	// PossuiMandado is retorno.possuiMandado, documented as a boolean.
	PossuiMandado Flag `json:"possuiMandado"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

CNJMandadosPrisaoRetorno is retorno in the answer of CNJMandadosPrisao.

type CNJMandadosPrisaoRetornoMandadosPrisao 

type CNJMandadosPrisaoRetornoMandadosPrisao struct {
	// Alcunha is retorno.mandadosPrisao[].alcunha, documented as a string.
	Alcunha Text `json:"alcunha" pii:"name"`
	// DataNascimento is retorno.mandadosPrisao[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Expedicao is retorno.mandadosPrisao[].expedicao.
	Expedicao CNJMandadosPrisaoRetornoMandadosPrisaoExpedicao `json:"expedicao"`
	// IsRecaptura is retorno.mandadosPrisao[].isRecaptura, documented as a boolean.
	IsRecaptura Flag `json:"isRecaptura"`
	// Nome is retorno.mandadosPrisao[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.mandadosPrisao[].nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// NomePai is retorno.mandadosPrisao[].nomePai, documented as a string.
	NomePai Text `json:"nomePai" pii:"name"`
	// Numero is retorno.mandadosPrisao[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Profissao is retorno.mandadosPrisao[].profissao, documented as a string.
	Profissao Text `json:"profissao"`
	// RegimePrisional is retorno.mandadosPrisao[].regimePrisional, documented as a string.
	RegimePrisional Text `json:"regimePrisional"`
	// Sexo is retorno.mandadosPrisao[].sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Situacao is retorno.mandadosPrisao[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TempoPena is retorno.mandadosPrisao[].tempoPena, documented as a string.
	TempoPena Text `json:"tempoPena"`
}

CNJMandadosPrisaoRetornoMandadosPrisao is retorno.mandadosPrisao[] in the answer of CNJMandadosPrisao.

type CNJMandadosPrisaoRetornoMandadosPrisaoExpedicao 

type CNJMandadosPrisaoRetornoMandadosPrisaoExpedicao struct {
	// Data is retorno.mandadosPrisao[].expedicao.data, documented as a string.
	Data Text `json:"data"`
	// DataValidade is retorno.mandadosPrisao[].expedicao.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// EspeciePrisao is retorno.mandadosPrisao[].expedicao.especiePrisao, documented as a string.
	EspeciePrisao Text `json:"especiePrisao"`
	// Magistrado is retorno.mandadosPrisao[].expedicao.magistrado, documented as a string.
	Magistrado Text `json:"magistrado"`
	// Municipio is retorno.mandadosPrisao[].expedicao.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroProcesso is retorno.mandadosPrisao[].expedicao.numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Orgao is retorno.mandadosPrisao[].expedicao.orgao, documented as a string.
	Orgao Text `json:"orgao"`
	// TipificacoesPenais is retorno.mandadosPrisao[].expedicao.tipificacoesPenais, a list.
	TipificacoesPenais []Text `json:"tipificacoesPenais"`
}

CNJMandadosPrisaoRetornoMandadosPrisaoExpedicao is retorno.mandadosPrisao[].expedicao in the answer of CNJMandadosPrisao.

type CONFEAParams 

type CONFEAParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// RegistroNacional is sent as RegistroNacional. O parâmetro REGISTRONACIONAL pode ser enviado com ou sem formatação.
	RegistroNacional string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CONFEAParams are the parameters of CONFEA (CONFEA/CREA - Conselho Federal de Engenharia e Agronomia).

func (CONFEAParams) Request 

func (p CONFEAParams) Request() (Request, error)

Request builds the Request for CONFEA.

type CONFEARetorno 

type CONFEARetorno struct {
	// AtribuicoesGraduacao is retorno.atribuicoesGraduacao, documented as a string.
	AtribuicoesGraduacao Text `json:"atribuicoesGraduacao"`
	// AtribuicoesPosGraduacao is retorno.atribuicoesPosGraduacao, documented as a string.
	AtribuicoesPosGraduacao Text `json:"atribuicoesPosGraduacao"`
	// Crea is retorno.crea, documented as a string.
	Crea Text `json:"crea"`
	// CursosPosGraduacao is retorno.cursosPosGraduacao, a list.
	CursosPosGraduacao []Text `json:"cursosPosGraduacao"`
	// DataRegistro is retorno.dataRegistro, documented as a string.
	DataRegistro Text `json:"dataRegistro"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// RegistroNacional is retorno.registroNacional, documented as a string.
	RegistroNacional Text `json:"registroNacional" pii:"document"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TitulosGraduacao is retorno.titulosGraduacao, a list.
	TitulosGraduacao []Text `json:"titulosGraduacao"`
	// Vistos is retorno.vistos, a list.
	Vistos []Text `json:"vistos"`
}

CONFEARetorno is retorno in the answer of CONFEA.

type CVMComissaodeValoresMobiliariosParams 

type CVMComissaodeValoresMobiliariosParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

CVMComissaodeValoresMobiliariosParams are the parameters of CVMComissaodeValoresMobiliarios (CVM - Comissão de Valores Mobiliários).

func (CVMComissaodeValoresMobiliariosParams) Request 

func (p CVMComissaodeValoresMobiliariosParams) Request() (Request, error)

Request builds the Request for CVMComissaodeValoresMobiliarios.

type CVMComissaodeValoresMobiliariosRetorno 

type CVMComissaodeValoresMobiliariosRetorno struct {
	// Bairro is retorno.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Categoria is retorno.categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// CategoriaRegistro is retorno.categoriaRegistro, documented as a string.
	CategoriaRegistro Text `json:"categoriaRegistro"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoCVM is retorno.codigoCVM, documented as a string.
	CodigoCVM Text `json:"codigoCVM"`
	// CompanhiaDeMenorPorte is retorno.companhiaDeMenorPorte, documented as a string.
	CompanhiaDeMenorPorte Text `json:"companhiaDeMenorPorte"`
	// DataInicioNaCategoria is retorno.dataInicioNaCategoria, documented as a string.
	DataInicioNaCategoria Text `json:"dataInicioNaCategoria"`
	// DataPatrimonioLiquido is retorno.dataPatrimonioLiquido, documented as a string.
	DataPatrimonioLiquido Text `json:"dataPatrimonioLiquido"`
	// DataRegistro is retorno.dataRegistro, documented as a string.
	DataRegistro Text `json:"dataRegistro"`
	// DataSituacao is retorno.dataSituacao, documented as a string.
	DataSituacao Text `json:"dataSituacao"`
	// Diretores is retorno.diretores, a list.
	Diretores []CVMComissaodeValoresMobiliariosRetornoDiretores `json:"diretores"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Endereco is retorno.endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PatrimonioLiquido is retorno.patrimonioLiquido, documented as a string.
	PatrimonioLiquido Text `json:"patrimonioLiquido"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Telefone is retorno.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TiposParticipante is retorno.tiposParticipante, a list.
	TiposParticipante []Text `json:"tiposParticipante"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Website is retorno.website, documented as a string.
	Website Text `json:"website"`
}

CVMComissaodeValoresMobiliariosRetorno is retorno in the answer of CVMComissaodeValoresMobiliarios.

type CVMComissaodeValoresMobiliariosRetornoDiretores 

type CVMComissaodeValoresMobiliariosRetornoDiretores struct {
	// DataInicio is retorno.diretores[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Instrucao is retorno.diretores[].instrucao, documented as a string.
	Instrucao Text `json:"instrucao"`
	// Nome is retorno.diretores[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

CVMComissaodeValoresMobiliariosRetornoDiretores is retorno.diretores[] in the answer of CVMComissaodeValoresMobiliarios.

type CVMProcessosAdministrativosSancionadoresParams 

type CVMProcessosAdministrativosSancionadoresParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

CVMProcessosAdministrativosSancionadoresParams are the parameters of CVMProcessosAdministrativosSancionadores (CVM - Processos Administrativos Sancionadores).

func (CVMProcessosAdministrativosSancionadoresParams) Request 

func (p CVMProcessosAdministrativosSancionadoresParams) Request() (Request, error)

Request builds the Request for CVMProcessosAdministrativosSancionadores.

type CVMProcessosAdministrativosSancionadoresRetorno 

type CVMProcessosAdministrativosSancionadoresRetorno struct {
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiProcesso is retorno.possuiProcesso, documented as a boolean.
	PossuiProcesso Flag `json:"possuiProcesso"`
	// Processos is retorno.processos, a list.
	Processos []CVMProcessosAdministrativosSancionadoresRetornoProcessos `json:"processos"`
	// TotalProcessos is retorno.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
}

CVMProcessosAdministrativosSancionadoresRetorno is retorno in the answer of CVMProcessosAdministrativosSancionadores.

type CVMProcessosAdministrativosSancionadoresRetornoProcessos 

type CVMProcessosAdministrativosSancionadoresRetornoProcessos struct {
	// Acusados is retorno.processos[].acusados, a list.
	Acusados []CVMProcessosAdministrativosSancionadoresRetornoProcessosAcusados `json:"acusados"`
	// AssuntoObjeto is retorno.processos[].assuntoObjeto, documented as a string.
	AssuntoObjeto Text `json:"assuntoObjeto"`
	// DataAbertura is retorno.processos[].dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataRelatorioInquerito is retorno.processos[].dataRelatorioInquerito, documented as a string.
	DataRelatorioInquerito Text `json:"dataRelatorioInquerito"`
	// DataUltimaMovimentacaoLocal is retorno.processos[].dataUltimaMovimentacaoLocal, documented as a string.
	DataUltimaMovimentacaoLocal Text `json:"dataUltimaMovimentacaoLocal"`
	// DataUltimaMudancaFase is retorno.processos[].dataUltimaMudancaFase, documented as a string.
	DataUltimaMudancaFase Text `json:"dataUltimaMudancaFase"`
	// Ementa is retorno.processos[].ementa, documented as a string.
	Ementa Text `json:"ementa"`
	// EncarregadoInstrucao is retorno.processos[].encarregadoInstrucao, documented as a string.
	EncarregadoInstrucao Text `json:"encarregadoInstrucao"`
	// FaseAtual is retorno.processos[].faseAtual, documented as a string.
	FaseAtual Text `json:"faseAtual"`
	// LocalAtual is retorno.processos[].localAtual, documented as a string.
	LocalAtual Text `json:"localAtual"`
	// Movimentacoes is retorno.processos[].movimentacoes, a list.
	Movimentacoes []CVMProcessosAdministrativosSancionadoresRetornoProcessosMovimentacoes `json:"movimentacoes"`
	// NumeroProcesso is retorno.processos[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// ProcessoEncerrado is retorno.processos[].processoEncerrado, documented as a boolean.
	ProcessoEncerrado Flag `json:"processoEncerrado"`
	// SubfaseAtual is retorno.processos[].subfaseAtual, documented as a string.
	SubfaseAtual Text `json:"subfaseAtual"`
	// TotalAcusados is retorno.processos[].totalAcusados, documented as a number.
	TotalAcusados Number `json:"totalAcusados"`
}

CVMProcessosAdministrativosSancionadoresRetornoProcessos is retorno.processos[] in the answer of CVMProcessosAdministrativosSancionadores.

type CVMProcessosAdministrativosSancionadoresRetornoProcessosAcusados 

type CVMProcessosAdministrativosSancionadoresRetornoProcessosAcusados struct {
	// DataSituacao is retorno.processos[].acusados[].dataSituacao, documented as a string.
	DataSituacao Text `json:"dataSituacao"`
	// Nome is retorno.processos[].acusados[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Situacao is retorno.processos[].acusados[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
}

CVMProcessosAdministrativosSancionadoresRetornoProcessosAcusados is retorno.processos[].acusados[] in the answer of CVMProcessosAdministrativosSancionadores.

type CVMProcessosAdministrativosSancionadoresRetornoProcessosMovimentacoes 

type CVMProcessosAdministrativosSancionadoresRetornoProcessosMovimentacoes struct {
	// DataMovimentacao is retorno.processos[].movimentacoes[].dataMovimentacao, documented as a string.
	DataMovimentacao Text `json:"dataMovimentacao"`
	// Local is retorno.processos[].movimentacoes[].local, documented as a string.
	Local Text `json:"local"`
	// Subfase is retorno.processos[].movimentacoes[].subfase, documented as a string.
	Subfase Text `json:"subfase"`
}

CVMProcessosAdministrativosSancionadoresRetornoProcessosMovimentacoes is retorno.processos[].movimentacoes[] in the answer of CVMProcessosAdministrativosSancionadores.

type CadastroAmbientalRuralParams 

type CadastroAmbientalRuralParams struct {
	// NumeroCAR is sent as NumeroCAR. O parâmetro NumeroCAR pode ser enviado com ou sem formatação.
	NumeroCAR string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CadastroAmbientalRuralParams are the parameters of CadastroAmbientalRural (CAR - Cadastro Ambiental Rural).

func (CadastroAmbientalRuralParams) Request 

func (p CadastroAmbientalRuralParams) Request() (Request, error)

Request builds the Request for CadastroAmbientalRural.

type CadastroAmbientalRuralRetorno 

type CadastroAmbientalRuralRetorno struct {
	// App is retorno.app.
	App CadastroAmbientalRuralRetornoApp `json:"app"`
	// CoberturaSolo is retorno.coberturaSolo.
	CoberturaSolo CadastroAmbientalRuralRetornoCoberturaSolo `json:"coberturaSolo"`
	// CondicaoExterna is retorno.condicaoExterna, documented as a string.
	CondicaoExterna Text `json:"condicaoExterna"`
	// DadosImovel is retorno.dadosImovel.
	DadosImovel CadastroAmbientalRuralRetornoDadosImovel `json:"dadosImovel"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// InformacoesAdicionais is retorno.informacoesAdicionais, a list.
	InformacoesAdicionais []CadastroAmbientalRuralRetornoInformacoesAdicionais `json:"informacoesAdicionais"`
	// InscricaoCAR is retorno.inscricaoCAR, documented as a string.
	InscricaoCAR Text `json:"inscricaoCAR"`
	// ReservaLegal is retorno.reservaLegal.
	ReservaLegal CadastroAmbientalRuralRetornoReservaLegal `json:"reservaLegal"`
	// SituacaoCadastro is retorno.situacaoCadastro, documented as a string.
	SituacaoCadastro Text `json:"situacaoCadastro"`
	// UsoRestrito is retorno.usoRestrito.
	UsoRestrito CadastroAmbientalRuralRetornoUsoRestrito `json:"usoRestrito"`
}

CadastroAmbientalRuralRetorno is retorno in the answer of CadastroAmbientalRural.

type CadastroAmbientalRuralRetornoApp 

type CadastroAmbientalRuralRetornoApp struct {
	// Area is retorno.app.area, documented as a string.
	Area Text `json:"area"`
	// Recompor is retorno.app.recompor, documented as a string.
	Recompor Text `json:"recompor"`
	// RemanescenteVegetacaoNativa is retorno.app.remanescenteVegetacaoNativa, documented as a string.
	RemanescenteVegetacaoNativa Text `json:"remanescenteVegetacaoNativa"`
	// RuralConsolidada is retorno.app.ruralConsolidada, documented as a string.
	RuralConsolidada Text `json:"ruralConsolidada"`
}

CadastroAmbientalRuralRetornoApp is retorno.app in the answer of CadastroAmbientalRural.

type CadastroAmbientalRuralRetornoCoberturaSolo 

type CadastroAmbientalRuralRetornoCoberturaSolo struct {
	// RuralConsolidada is retorno.coberturaSolo.ruralConsolidada, documented as a string.
	RuralConsolidada Text `json:"ruralConsolidada"`
	// ServidaoAdministrativa is retorno.coberturaSolo.servidaoAdministrativa, documented as a string.
	ServidaoAdministrativa Text `json:"servidaoAdministrativa"`
	// VegetacaoNativa is retorno.coberturaSolo.vegetacaoNativa, documented as a string.
	VegetacaoNativa Text `json:"vegetacaoNativa"`
}

CadastroAmbientalRuralRetornoCoberturaSolo is retorno.coberturaSolo in the answer of CadastroAmbientalRural.

type CadastroAmbientalRuralRetornoDadosImovel 

type CadastroAmbientalRuralRetornoDadosImovel struct {
	// Area is retorno.dadosImovel.area, documented as a string.
	Area Text `json:"area"`
	// DataInscricao is retorno.dadosImovel.dataInscricao, documented as a string.
	DataInscricao Text `json:"dataInscricao"`
	// DataUltimaRetificacao is retorno.dadosImovel.dataUltimaRetificacao, documented as a string.
	DataUltimaRetificacao Text `json:"dataUltimaRetificacao"`
	// Latitude is retorno.dadosImovel.latitude, documented as a string.
	Latitude Text `json:"latitude" pii:"address"`
	// Longitude is retorno.dadosImovel.longitude, documented as a string.
	Longitude Text `json:"longitude" pii:"address"`
	// ModulosFiscais is retorno.dadosImovel.modulosFiscais, documented as a string.
	ModulosFiscais Text `json:"modulosFiscais"`
	// Municipio is retorno.dadosImovel.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Uf is retorno.dadosImovel.uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroAmbientalRuralRetornoDadosImovel is retorno.dadosImovel in the answer of CadastroAmbientalRural.

type CadastroAmbientalRuralRetornoInformacoesAdicionais 

type CadastroAmbientalRuralRetornoInformacoesAdicionais struct {
	// AreaSobreposicao is retorno.informacoesAdicionais[].areaSobreposicao, documented as a string.
	AreaSobreposicao Text `json:"areaSobreposicao"`
	// DataProcessamento is retorno.informacoesAdicionais[].dataProcessamento, documented as a string.
	DataProcessamento Text `json:"dataProcessamento"`
	// Descricao is retorno.informacoesAdicionais[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Fase is retorno.informacoesAdicionais[].fase, documented as a string.
	Fase Text `json:"fase"`
	// PercentualSobreposicao is retorno.informacoesAdicionais[].percentualSobreposicao, documented as a string.
	PercentualSobreposicao Text `json:"percentualSobreposicao"`
	// Tema is retorno.informacoesAdicionais[].tema, documented as a string.
	Tema Text `json:"tema"`
}

CadastroAmbientalRuralRetornoInformacoesAdicionais is retorno.informacoesAdicionais[] in the answer of CadastroAmbientalRural.

type CadastroAmbientalRuralRetornoReservaLegal 

type CadastroAmbientalRuralRetornoReservaLegal struct {
	// AprovadaNaoAverbada is retorno.reservaLegal.aprovadaNaoAverbada, documented as a string.
	AprovadaNaoAverbada Text `json:"aprovadaNaoAverbada"`
	// Averbada is retorno.reservaLegal.averbada, documented as a string.
	Averbada Text `json:"averbada"`
	// AverbadaArt30 is retorno.reservaLegal.averbadaArt30, documented as a string.
	AverbadaArt30 Text `json:"averbadaArt30"`
	// Declarada is retorno.reservaLegal.declarada, documented as a string.
	Declarada Text `json:"declarada"`
	// Localizacao is retorno.reservaLegal.localizacao, documented as a string.
	Localizacao Text `json:"localizacao"`
	// PassivoExcedente is retorno.reservaLegal.passivoExcedente, documented as a string.
	PassivoExcedente Text `json:"passivoExcedente"`
	// Proposta is retorno.reservaLegal.proposta, documented as a string.
	Proposta Text `json:"proposta"`
	// Recompor is retorno.reservaLegal.recompor, documented as a string.
	Recompor Text `json:"recompor"`
}

CadastroAmbientalRuralRetornoReservaLegal is retorno.reservaLegal in the answer of CadastroAmbientalRural.

type CadastroAmbientalRuralRetornoUsoRestrito 

type CadastroAmbientalRuralRetornoUsoRestrito struct {
	// Area is retorno.usoRestrito.area, documented as a string.
	Area Text `json:"area"`
	// Recompor is retorno.usoRestrito.recompor, documented as a string.
	Recompor Text `json:"recompor"`
}

CadastroAmbientalRuralRetornoUsoRestrito is retorno.usoRestrito in the answer of CadastroAmbientalRural.

type CadastroEmpresasInidoneasSuspensasParams 

type CadastroEmpresasInidoneasSuspensasParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CadastroEmpresasInidoneasSuspensasParams are the parameters of CadastroEmpresasInidoneasSuspensas (CEIS - Cadastro de Empresas Inidôneas e Suspensas).

func (CadastroEmpresasInidoneasSuspensasParams) Request 

func (p CadastroEmpresasInidoneasSuspensasParams) Request() (Request, error)

Request builds the Request for CadastroEmpresasInidoneasSuspensas.

type CadastroEmpresasInidoneasSuspensasRetorno 

type CadastroEmpresasInidoneasSuspensasRetorno struct {
	// ConstamSancoes is retorno.constamSancoes, documented as a boolean.
	ConstamSancoes Flag `json:"constamSancoes"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []CadastroEmpresasInidoneasSuspensasRetornoSancoes `json:"sancoes"`
}

CadastroEmpresasInidoneasSuspensasRetorno is retorno in the answer of CadastroEmpresasInidoneasSuspensas.

type CadastroEmpresasInidoneasSuspensasRetornoSancoes 

type CadastroEmpresasInidoneasSuspensasRetornoSancoes struct {
	// DetalhamentoSancao is retorno.sancoes[].detalhamentoSancao.
	DetalhamentoSancao CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancao `json:"detalhamentoSancao"`
	// FundamentoLegal is retorno.sancoes[].fundamentoLegal, documented as a string.
	FundamentoLegal Text `json:"fundamentoLegal"`
	// NumeroRegistro is retorno.sancoes[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Orgao is retorno.sancoes[].orgao.
	Orgao CadastroEmpresasInidoneasSuspensasRetornoSancoesOrgao `json:"orgao"`
}

CadastroEmpresasInidoneasSuspensasRetornoSancoes is retorno.sancoes[] in the answer of CadastroEmpresasInidoneasSuspensas.

type CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancao 

type CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancao struct {
	// AbrangenciaDefinidaDecisaoJudicial is retorno.sancoes[].detalhamentoSancao.abrangenciaDefinidaDecisaoJudicial, documented as a string.
	AbrangenciaDefinidaDecisaoJudicial Text `json:"abrangenciaDefinidaDecisaoJudicial"`
	// Categoria is retorno.sancoes[].detalhamentoSancao.categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// DataFim is retorno.sancoes[].detalhamentoSancao.dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.sancoes[].detalhamentoSancao.dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// DataOrigemInformacao is retorno.sancoes[].detalhamentoSancao.dataOrigemInformacao, documented as a string.
	DataOrigemInformacao Text `json:"dataOrigemInformacao"`
	// DataReferencia is retorno.sancoes[].detalhamentoSancao.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// DataTransitadoJulgado is retorno.sancoes[].detalhamentoSancao.dataTransitadoJulgado, documented as a string.
	DataTransitadoJulgado Text `json:"dataTransitadoJulgado"`
	// Fonte is retorno.sancoes[].detalhamentoSancao.fonte.
	Fonte CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonte `json:"fonte"`
	// NumeroProcesso is retorno.sancoes[].detalhamentoSancao.numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Observacao is retorno.sancoes[].detalhamentoSancao.observacao, documented as a string.
	Observacao Text `json:"observacao"`
}

CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancao is retorno.sancoes[].detalhamentoSancao in the answer of CadastroEmpresasInidoneasSuspensas.

type CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonte 

type CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonte struct {
	// DadosPublicacao is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.
	DadosPublicacao CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao `json:"dadosPublicacao"`
	// Endereco is retorno.sancoes[].detalhamentoSancao.fonte.endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.sancoes[].detalhamentoSancao.fonte.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Telefone is retorno.sancoes[].detalhamentoSancao.fonte.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
}

CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonte is retorno.sancoes[].detalhamentoSancao.fonte in the answer of CadastroEmpresasInidoneasSuspensas.

type CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao 

type CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao struct {
	// Data is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.data, documented as a string.
	Data Text `json:"data"`
	// Detalhamento is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.detalhamento, documented as a string.
	Detalhamento Text `json:"detalhamento"`
	// Link is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.link, documented as a string.
	Link Text `json:"link"`
	// Texto is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.texto, documented as a string.
	Texto Text `json:"texto"`
}

CadastroEmpresasInidoneasSuspensasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao in the answer of CadastroEmpresasInidoneasSuspensas.

type CadastroEmpresasInidoneasSuspensasRetornoSancoesOrgao 

type CadastroEmpresasInidoneasSuspensasRetornoSancoesOrgao struct {
	// Esfera is retorno.sancoes[].orgao.esfera, documented as a string.
	Esfera Text `json:"esfera"`
	// Nome is retorno.sancoes[].orgao.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Poder is retorno.sancoes[].orgao.poder, documented as a string.
	Poder Text `json:"poder"`
	// Uf is retorno.sancoes[].orgao.uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroEmpresasInidoneasSuspensasRetornoSancoesOrgao is retorno.sancoes[].orgao in the answer of CadastroEmpresasInidoneasSuspensas.

type CadastroEntidadesPrivadasImpedidasParams 

type CadastroEntidadesPrivadasImpedidasParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

CadastroEntidadesPrivadasImpedidasParams are the parameters of CadastroEntidadesPrivadasImpedidas (CEPIM - Cadastro de Entidades Privadas Sem Fins Lucrativos Impedidas).

func (CadastroEntidadesPrivadasImpedidasParams) Request 

func (p CadastroEntidadesPrivadasImpedidasParams) Request() (Request, error)

Request builds the Request for CadastroEntidadesPrivadasImpedidas.

type CadastroEntidadesPrivadasImpedidasRetorno 

type CadastroEntidadesPrivadasImpedidasRetorno struct {
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// ConstamSancoes is retorno.constamSancoes, documented as a boolean.
	ConstamSancoes Flag `json:"constamSancoes"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []CadastroEntidadesPrivadasImpedidasRetornoSancoes `json:"sancoes"`
}

CadastroEntidadesPrivadasImpedidasRetorno is retorno in the answer of CadastroEntidadesPrivadasImpedidas.

type CadastroEntidadesPrivadasImpedidasRetornoSancoes 

type CadastroEntidadesPrivadasImpedidasRetornoSancoes struct {
	// DetalhamentoSancao is retorno.sancoes[].detalhamentoSancao.
	DetalhamentoSancao CadastroEntidadesPrivadasImpedidasRetornoSancoesDetalhamentoSancao `json:"detalhamentoSancao"`
	// NumeroRegistro is retorno.sancoes[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Orgao is retorno.sancoes[].orgao.
	Orgao CadastroEntidadesPrivadasImpedidasRetornoSancoesOrgao `json:"orgao"`
}

CadastroEntidadesPrivadasImpedidasRetornoSancoes is retorno.sancoes[] in the answer of CadastroEntidadesPrivadasImpedidas.

type CadastroEntidadesPrivadasImpedidasRetornoSancoesDetalhamentoSancao 

type CadastroEntidadesPrivadasImpedidasRetornoSancoesDetalhamentoSancao struct {
	// DataReferencia is retorno.sancoes[].detalhamentoSancao.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// Motivo is retorno.sancoes[].detalhamentoSancao.motivo, documented as a string.
	Motivo Text `json:"motivo"`
}

CadastroEntidadesPrivadasImpedidasRetornoSancoesDetalhamentoSancao is retorno.sancoes[].detalhamentoSancao in the answer of CadastroEntidadesPrivadasImpedidas.

type CadastroEntidadesPrivadasImpedidasRetornoSancoesOrgao 

type CadastroEntidadesPrivadasImpedidasRetornoSancoesOrgao struct {
	// Cnpj is retorno.sancoes[].orgao.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Nome is retorno.sancoes[].orgao.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Poder is retorno.sancoes[].orgao.poder, documented as a string.
	Poder Text `json:"poder"`
	// Sigla is retorno.sancoes[].orgao.sigla, documented as a string.
	Sigla Text `json:"sigla"`
}

CadastroEntidadesPrivadasImpedidasRetornoSancoesOrgao is retorno.sancoes[].orgao in the answer of CadastroEntidadesPrivadasImpedidas.

type CadastroExpulsoesAdministracaoFederalParams 

type CadastroExpulsoesAdministracaoFederalParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CadastroExpulsoesAdministracaoFederalParams are the parameters of CadastroExpulsoesAdministracaoFederal (CEAF - Cadastro de Expulsões da Administração Federal).

func (CadastroExpulsoesAdministracaoFederalParams) Request 

func (p CadastroExpulsoesAdministracaoFederalParams) Request() (Request, error)

Request builds the Request for CadastroExpulsoesAdministracaoFederal.

type CadastroExpulsoesAdministracaoFederalRetorno 

type CadastroExpulsoesAdministracaoFederalRetorno struct {
	// ConstamSancoes is retorno.constamSancoes, documented as a boolean.
	ConstamSancoes Flag `json:"constamSancoes"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NumeroIdentificacao is retorno.numeroIdentificacao, documented as a number.
	NumeroIdentificacao Number `json:"numeroIdentificacao"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []CadastroExpulsoesAdministracaoFederalRetornoSancoes `json:"sancoes"`
}

CadastroExpulsoesAdministracaoFederalRetorno is retorno in the answer of CadastroExpulsoesAdministracaoFederal.

type CadastroExpulsoesAdministracaoFederalRetornoSancoes 

type CadastroExpulsoesAdministracaoFederalRetornoSancoes struct {
	// DetalhamentoSancao is retorno.sancoes[].detalhamentoSancao.
	DetalhamentoSancao CadastroExpulsoesAdministracaoFederalRetornoSancoesDetalhamentoSancao `json:"detalhamentoSancao"`
	// FundamentoLegal is retorno.sancoes[].fundamentoLegal, documented as a string.
	FundamentoLegal Text `json:"fundamentoLegal"`
	// NumeroRegistro is retorno.sancoes[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Orgao is retorno.sancoes[].orgao.
	Orgao CadastroExpulsoesAdministracaoFederalRetornoSancoesOrgao `json:"orgao"`
}

CadastroExpulsoesAdministracaoFederalRetornoSancoes is retorno.sancoes[] in the answer of CadastroExpulsoesAdministracaoFederal.

type CadastroExpulsoesAdministracaoFederalRetornoSancoesDetalhamentoSancao 

type CadastroExpulsoesAdministracaoFederalRetornoSancoesDetalhamentoSancao struct {
	// CargoComissao is retorno.sancoes[].detalhamentoSancao.cargoComissao, documented as a string.
	CargoComissao Text `json:"cargoComissao"`
	// CargoEfetivo is retorno.sancoes[].detalhamentoSancao.cargoEfetivo, documented as a string.
	CargoEfetivo Text `json:"cargoEfetivo"`
	// DataReferencia is retorno.sancoes[].detalhamentoSancao.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
}

CadastroExpulsoesAdministracaoFederalRetornoSancoesDetalhamentoSancao is retorno.sancoes[].detalhamentoSancao in the answer of CadastroExpulsoesAdministracaoFederal.

type CadastroExpulsoesAdministracaoFederalRetornoSancoesOrgao 

type CadastroExpulsoesAdministracaoFederalRetornoSancoesOrgao struct {
	// Nome is retorno.sancoes[].orgao.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Sigla is retorno.sancoes[].orgao.sigla, documented as a string.
	Sigla Text `json:"sigla"`
}

CadastroExpulsoesAdministracaoFederalRetornoSancoesOrgao is retorno.sancoes[].orgao in the answer of CadastroExpulsoesAdministracaoFederal.

type CadastroImoveisRuraisParams 

type CadastroImoveisRuraisParams struct {
	// CIB is sent as CIB. O parâmetro CIB pode ser enviado com ou sem formatação.
	CIB string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CadastroImoveisRuraisParams are the parameters of CadastroImoveisRurais (CAFIR - Cadastros de Imóveis Rurais).

func (CadastroImoveisRuraisParams) Request 

func (p CadastroImoveisRuraisParams) Request() (Request, error)

Request builds the Request for CadastroImoveisRurais.

type CadastroImoveisRuraisRetorno 

type CadastroImoveisRuraisRetorno struct {
	// Area is retorno.area, documented as a string.
	Area Text `json:"area"`
	// CadeiaCIB is retorno.cadeiaCIB, documented as a string.
	CadeiaCIB Text `json:"cadeiaCIB"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cib is retorno.cib, documented as a string.
	Cib Text `json:"cib"`
	// CodigoINCRA is retorno.codigoINCRA, documented as a string.
	CodigoINCRA Text `json:"codigoINCRA"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// Localizacao is retorno.localizacao, documented as a string.
	Localizacao Text `json:"localizacao"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NomeImovel is retorno.nomeImovel, documented as a string.
	NomeImovel Text `json:"nomeImovel" pii:"name"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroImoveisRuraisRetorno is retorno in the answer of CadastroImoveisRurais.

type CadastroNacionalEmpresasPunidasParams 

type CadastroNacionalEmpresasPunidasParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CadastroNacionalEmpresasPunidasParams are the parameters of CadastroNacionalEmpresasPunidas (CNEP - Cadastro Nacional de Empresas Punidas).

func (CadastroNacionalEmpresasPunidasParams) Request 

func (p CadastroNacionalEmpresasPunidasParams) Request() (Request, error)

Request builds the Request for CadastroNacionalEmpresasPunidas.

type CadastroNacionalEmpresasPunidasRetorno 

type CadastroNacionalEmpresasPunidasRetorno struct {
	// ConstamSancoes is retorno.constamSancoes, documented as a boolean.
	ConstamSancoes Flag `json:"constamSancoes"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []CadastroNacionalEmpresasPunidasRetornoSancoes `json:"sancoes"`
}

CadastroNacionalEmpresasPunidasRetorno is retorno in the answer of CadastroNacionalEmpresasPunidas.

type CadastroNacionalEmpresasPunidasRetornoSancoes 

type CadastroNacionalEmpresasPunidasRetornoSancoes struct {
	// DetalhamentoSancao is retorno.sancoes[].detalhamentoSancao.
	DetalhamentoSancao CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancao `json:"detalhamentoSancao"`
	// FundamentoLegal is retorno.sancoes[].fundamentoLegal, documented as a string.
	FundamentoLegal Text `json:"fundamentoLegal"`
	// NumeroRegistro is retorno.sancoes[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Orgao is retorno.sancoes[].orgao.
	Orgao CadastroNacionalEmpresasPunidasRetornoSancoesOrgao `json:"orgao"`
}

CadastroNacionalEmpresasPunidasRetornoSancoes is retorno.sancoes[] in the answer of CadastroNacionalEmpresasPunidas.

type CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancao 

type CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancao struct {
	// AbrangenciaDefinidaDecisaoJudicial is retorno.sancoes[].detalhamentoSancao.abrangenciaDefinidaDecisaoJudicial, documented as a string.
	AbrangenciaDefinidaDecisaoJudicial Text `json:"abrangenciaDefinidaDecisaoJudicial"`
	// Categoria is retorno.sancoes[].detalhamentoSancao.categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// DataFim is retorno.sancoes[].detalhamentoSancao.dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.sancoes[].detalhamentoSancao.dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// DataOrigemInformacao is retorno.sancoes[].detalhamentoSancao.dataOrigemInformacao, documented as a string.
	DataOrigemInformacao Text `json:"dataOrigemInformacao"`
	// DataReferencia is retorno.sancoes[].detalhamentoSancao.dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// DataTransitadoJulgado is retorno.sancoes[].detalhamentoSancao.dataTransitadoJulgado, documented as a string.
	DataTransitadoJulgado Text `json:"dataTransitadoJulgado"`
	// Fonte is retorno.sancoes[].detalhamentoSancao.fonte.
	Fonte CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonte `json:"fonte"`
	// NumeroProcesso is retorno.sancoes[].detalhamentoSancao.numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Observacao is retorno.sancoes[].detalhamentoSancao.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// ValorMulta is retorno.sancoes[].detalhamentoSancao.valorMulta, documented as a string.
	ValorMulta Text `json:"valorMulta"`
}

CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancao is retorno.sancoes[].detalhamentoSancao in the answer of CadastroNacionalEmpresasPunidas.

type CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonte 

type CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonte struct {
	// DadosPublicacao is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.
	DadosPublicacao CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao `json:"dadosPublicacao"`
	// Endereco is retorno.sancoes[].detalhamentoSancao.fonte.endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.sancoes[].detalhamentoSancao.fonte.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Telefone is retorno.sancoes[].detalhamentoSancao.fonte.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
}

CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonte is retorno.sancoes[].detalhamentoSancao.fonte in the answer of CadastroNacionalEmpresasPunidas.

type CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao 

type CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao struct {
	// Data is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.data, documented as a string.
	Data Text `json:"data"`
	// Detalhamento is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.detalhamento, documented as a string.
	Detalhamento Text `json:"detalhamento"`
	// Link is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.link, documented as a string.
	Link Text `json:"link"`
	// Texto is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao.texto, documented as a string.
	Texto Text `json:"texto"`
}

CadastroNacionalEmpresasPunidasRetornoSancoesDetalhamentoSancaoFonteDadosPublicacao is retorno.sancoes[].detalhamentoSancao.fonte.dadosPublicacao in the answer of CadastroNacionalEmpresasPunidas.

type CadastroNacionalEmpresasPunidasRetornoSancoesOrgao 

type CadastroNacionalEmpresasPunidasRetornoSancoesOrgao struct {
	// Esfera is retorno.sancoes[].orgao.esfera, documented as a string.
	Esfera Text `json:"esfera"`
	// Nome is retorno.sancoes[].orgao.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Poder is retorno.sancoes[].orgao.poder, documented as a string.
	Poder Text `json:"poder"`
	// Uf is retorno.sancoes[].orgao.uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroNacionalEmpresasPunidasRetornoSancoesOrgao is retorno.sancoes[].orgao in the answer of CadastroNacionalEmpresasPunidas.

type CadastroNacionalImprobidadeAdministrativaParams 

type CadastroNacionalImprobidadeAdministrativaParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CadastroNacionalImprobidadeAdministrativaParams are the parameters of CadastroNacionalImprobidadeAdministrativa (CNIA - Cadastro Nacional de Condenações Cíveis por Ato de Improbidade Administrativa e Inelegibilidade).

func (CadastroNacionalImprobidadeAdministrativaParams) Request 

func (p CadastroNacionalImprobidadeAdministrativaParams) Request() (Request, error)

Request builds the Request for CadastroNacionalImprobidadeAdministrativa.

type CadastroNacionalImprobidadeAdministrativaRetorno 

type CadastroNacionalImprobidadeAdministrativaRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// Condenacoes is retorno.condenacoes, a list.
	Condenacoes []CadastroNacionalImprobidadeAdministrativaRetornoCondenacoes `json:"condenacoes"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PossuiCondenacao is retorno.possuiCondenacao, documented as a boolean.
	PossuiCondenacao Flag `json:"possuiCondenacao"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

CadastroNacionalImprobidadeAdministrativaRetorno is retorno in the answer of CadastroNacionalImprobidadeAdministrativa.

type CadastroNacionalImprobidadeAdministrativaRetornoCondenacoes 

type CadastroNacionalImprobidadeAdministrativaRetornoCondenacoes struct {
	// Comarca is retorno.condenacoes[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// CondenacaoCumprida is retorno.condenacoes[].condenacaoCumprida, documented as a boolean.
	CondenacaoCumprida Flag `json:"condenacaoCumprida"`
	// DataTransitoJulgado is retorno.condenacoes[].dataTransitoJulgado, documented as a string.
	DataTransitoJulgado Text `json:"dataTransitoJulgado"`
	// NumeroProcesso is retorno.condenacoes[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Orgao is retorno.condenacoes[].orgao, documented as a string.
	Orgao Text `json:"orgao"`
	// Tribunal is retorno.condenacoes[].tribunal, documented as a string.
	Tribunal Text `json:"tribunal"`
}

CadastroNacionalImprobidadeAdministrativaRetornoCondenacoes is retorno.condenacoes[] in the answer of CadastroNacionalImprobidadeAdministrativa.

type CadastroPessoaFisicaParams 

type CadastroPessoaFisicaParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CadastroPessoaFisicaParams are the parameters of CadastroPessoaFisica (Cadastro - Pessoa Física - Básica).

func (CadastroPessoaFisicaParams) Request 

func (p CadastroPessoaFisicaParams) Request() (Request, error)

Request builds the Request for CadastroPessoaFisica.

type CadastroPessoaFisicaPlusParams 

type CadastroPessoaFisicaPlusParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CadastroPessoaFisicaPlusParams are the parameters of CadastroPessoaFisicaPlus (Cadastro - Pessoa Física - Plus).

func (CadastroPessoaFisicaPlusParams) Request 

func (p CadastroPessoaFisicaPlusParams) Request() (Request, error)

Request builds the Request for CadastroPessoaFisicaPlus.

type CadastroPessoaFisicaPlusRetorno 

type CadastroPessoaFisicaPlusRetorno struct {
	// Cbo is retorno.cbo, documented as a string.
	Cbo Text `json:"cbo"`
	// ClasseSocial is retorno.classeSocial, documented as a string.
	ClasseSocial Text `json:"classeSocial"`
	// CodigoCBO is retorno.codigoCBO, documented as a string.
	CodigoCBO Text `json:"codigoCBO"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataSituacaoCadastral is retorno.dataSituacaoCadastral, documented as a string.
	DataSituacaoCadastral Text `json:"dataSituacaoCadastral"`
	// Emails is retorno.emails, a list.
	Emails []CadastroPessoaFisicaPlusRetornoEmails `json:"emails"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []CadastroPessoaFisicaPlusRetornoEnderecos `json:"enderecos"`
	// Idade is retorno.idade, documented as a number.
	Idade Number `json:"idade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// NomePai is retorno.nomePai, documented as a string.
	NomePai Text `json:"nomePai" pii:"name"`
	// Obito is retorno.obito, documented as a boolean.
	Obito Flag `json:"obito"`
	// Parentescos is retorno.parentescos, a list.
	Parentescos []CadastroPessoaFisicaPlusRetornoParentescos `json:"parentescos"`
	// PerfilDomiciliar is retorno.perfilDomiciliar.
	PerfilDomiciliar CadastroPessoaFisicaPlusRetornoPerfilDomiciliar `json:"perfilDomiciliar"`
	// RendaEstimada is retorno.rendaEstimada, documented as a string.
	RendaEstimada Text `json:"rendaEstimada"`
	// RendaFaixaSalarial is retorno.rendaFaixaSalarial, documented as a string.
	RendaFaixaSalarial Text `json:"rendaFaixaSalarial"`
	// Sexo is retorno.sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Signo is retorno.signo, documented as a string.
	Signo Text `json:"signo"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// Telefones is retorno.telefones, a list.
	Telefones []CadastroPessoaFisicaPlusRetornoTelefones `json:"telefones"`
}

CadastroPessoaFisicaPlusRetorno is retorno in the answer of CadastroPessoaFisicaPlus.

type CadastroPessoaFisicaPlusRetornoEmails 

type CadastroPessoaFisicaPlusRetornoEmails struct {
	// EnderecoEmail is retorno.emails[].enderecoEmail, documented as a string.
	EnderecoEmail Text `json:"enderecoEmail" pii:"email"`
}

CadastroPessoaFisicaPlusRetornoEmails is retorno.emails[] in the answer of CadastroPessoaFisicaPlus.

type CadastroPessoaFisicaPlusRetornoEnderecos 

type CadastroPessoaFisicaPlusRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroPessoaFisicaPlusRetornoEnderecos is retorno.enderecos[] in the answer of CadastroPessoaFisicaPlus.

type CadastroPessoaFisicaPlusRetornoParentescos 

type CadastroPessoaFisicaPlusRetornoParentescos struct {
	// Cpf is retorno.parentescos[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.parentescos[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.parentescos[].dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Genero is retorno.parentescos[].genero, documented as a string.
	Genero Text `json:"genero"`
	// GrauParentesco is retorno.parentescos[].grauParentesco, documented as a string.
	GrauParentesco Text `json:"grauParentesco"`
	// Nome is retorno.parentescos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.parentescos[].obito, documented as a boolean.
	Obito Flag `json:"obito"`
}

CadastroPessoaFisicaPlusRetornoParentescos is retorno.parentescos[] in the answer of CadastroPessoaFisicaPlus.

type CadastroPessoaFisicaPlusRetornoPerfilDomiciliar 

type CadastroPessoaFisicaPlusRetornoPerfilDomiciliar struct {
	// ClasseSocialFamiliar is retorno.perfilDomiciliar.classeSocialFamiliar, documented as a string.
	ClasseSocialFamiliar Text `json:"classeSocialFamiliar"`
	// Confiabilidade is retorno.perfilDomiciliar.confiabilidade, documented as a string.
	Confiabilidade Text `json:"confiabilidade"`
	// FaixaRendaPerCapita is retorno.perfilDomiciliar.faixaRendaPerCapita, documented as a string.
	FaixaRendaPerCapita Text `json:"faixaRendaPerCapita"`
	// QuantidadeAdultos is retorno.perfilDomiciliar.quantidadeAdultos, documented as a number.
	QuantidadeAdultos Number `json:"quantidadeAdultos"`
	// QuantidadeMenores is retorno.perfilDomiciliar.quantidadeMenores, documented as a number.
	QuantidadeMenores Number `json:"quantidadeMenores"`
	// QuantidadeMoradores is retorno.perfilDomiciliar.quantidadeMoradores, documented as a number.
	QuantidadeMoradores Number `json:"quantidadeMoradores"`
	// RendaDomiciliar is retorno.perfilDomiciliar.rendaDomiciliar, documented as a string.
	RendaDomiciliar Text `json:"rendaDomiciliar"`
	// RendaPerCapita is retorno.perfilDomiciliar.rendaPerCapita, documented as a string.
	RendaPerCapita Text `json:"rendaPerCapita"`
	// TipoDomicilio is retorno.perfilDomiciliar.tipoDomicilio, documented as a string.
	TipoDomicilio Text `json:"tipoDomicilio"`
}

CadastroPessoaFisicaPlusRetornoPerfilDomiciliar is retorno.perfilDomiciliar in the answer of CadastroPessoaFisicaPlus.

type CadastroPessoaFisicaPlusRetornoTelefones 

type CadastroPessoaFisicaPlusRetornoTelefones struct {
	// Operadora is retorno.telefones[].operadora, documented as a string.
	Operadora Text `json:"operadora"`
	// TelefoneComDDD is retorno.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
	// TelemarketingBloqueado is retorno.telefones[].telemarketingBloqueado, documented as a boolean.
	TelemarketingBloqueado Flag `json:"telemarketingBloqueado"`
	// TipoTelefone is retorno.telefones[].tipoTelefone, documented as a string.
	TipoTelefone Text `json:"tipoTelefone" pii:"phone"`
	// WhatsApp is retorno.telefones[].whatsApp, documented as a boolean.
	WhatsApp Flag `json:"whatsApp"`
}

CadastroPessoaFisicaPlusRetornoTelefones is retorno.telefones[] in the answer of CadastroPessoaFisicaPlus.

type CadastroPessoaFisicaRetorno 

type CadastroPessoaFisicaRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Emails is retorno.emails, a list.
	Emails []CadastroPessoaFisicaRetornoEmails `json:"emails"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []CadastroPessoaFisicaRetornoEnderecos `json:"enderecos"`
	// Idade is retorno.idade, documented as a number.
	Idade Number `json:"idade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// RendaEstimada is retorno.rendaEstimada, documented as a string.
	RendaEstimada Text `json:"rendaEstimada"`
	// RendaFaixaSalarial is retorno.rendaFaixaSalarial, documented as a string.
	RendaFaixaSalarial Text `json:"rendaFaixaSalarial"`
	// Sexo is retorno.sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Signo is retorno.signo, documented as a string.
	Signo Text `json:"signo"`
	// Telefones is retorno.telefones, a list.
	Telefones []CadastroPessoaFisicaRetornoTelefones `json:"telefones"`
}

CadastroPessoaFisicaRetorno is retorno in the answer of CadastroPessoaFisica.

type CadastroPessoaFisicaRetornoEmails 

type CadastroPessoaFisicaRetornoEmails struct {
	// EnderecoEmail is retorno.emails[].enderecoEmail, documented as a string.
	EnderecoEmail Text `json:"enderecoEmail" pii:"email"`
}

CadastroPessoaFisicaRetornoEmails is retorno.emails[] in the answer of CadastroPessoaFisica.

type CadastroPessoaFisicaRetornoEnderecos 

type CadastroPessoaFisicaRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroPessoaFisicaRetornoEnderecos is retorno.enderecos[] in the answer of CadastroPessoaFisica.

type CadastroPessoaFisicaRetornoTelefones 

type CadastroPessoaFisicaRetornoTelefones struct {
	// Operadora is retorno.telefones[].operadora, documented as a string.
	Operadora Text `json:"operadora"`
	// TelefoneComDDD is retorno.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
	// TelemarketingBloqueado is retorno.telefones[].telemarketingBloqueado, documented as a boolean.
	TelemarketingBloqueado Flag `json:"telemarketingBloqueado"`
	// TipoTelefone is retorno.telefones[].tipoTelefone, documented as a string.
	TipoTelefone Text `json:"tipoTelefone" pii:"phone"`
	// WhatsApp is retorno.telefones[].whatsApp, documented as a boolean.
	WhatsApp Flag `json:"whatsApp"`
}

CadastroPessoaFisicaRetornoTelefones is retorno.telefones[] in the answer of CadastroPessoaFisica.

type CadastroPessoaJuridicaParams 

type CadastroPessoaJuridicaParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

CadastroPessoaJuridicaParams are the parameters of CadastroPessoaJuridica (Cadastro - Pessoa Jurídica - Básica).

func (CadastroPessoaJuridicaParams) Request 

func (p CadastroPessoaJuridicaParams) Request() (Request, error)

Request builds the Request for CadastroPessoaJuridica.

type CadastroPessoaJuridicaPlusParams 

type CadastroPessoaJuridicaPlusParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

CadastroPessoaJuridicaPlusParams are the parameters of CadastroPessoaJuridicaPlus (Cadastro - Pessoa Jurídica - Plus).

func (CadastroPessoaJuridicaPlusParams) Request 

func (p CadastroPessoaJuridicaPlusParams) Request() (Request, error)

Request builds the Request for CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaPlusRetorno 

type CadastroPessoaJuridicaPlusRetorno struct {
	// CnaEsSecundarios is retorno.cnaEsSecundarios, a list.
	CnaEsSecundarios []CadastroPessoaJuridicaPlusRetornoCnaEsSecundarios `json:"cnaEsSecundarios"`
	// CnaeCodigo is retorno.cnaeCodigo, documented as a number.
	CnaeCodigo Number `json:"cnaeCodigo"`
	// CnaeDescricao is retorno.cnaeDescricao, documented as a string.
	CnaeDescricao Text `json:"cnaeDescricao"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DataFundacao is retorno.dataFundacao, documented as a string.
	DataFundacao Text `json:"dataFundacao"`
	// Emails is retorno.emails, a list.
	Emails []CadastroPessoaJuridicaPlusRetornoEmails `json:"emails"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []CadastroPessoaJuridicaPlusRetornoEnderecos `json:"enderecos"`
	// FaixaFaturamento is retorno.faixaFaturamento, documented as a string.
	FaixaFaturamento Text `json:"faixaFaturamento"`
	// FaixaFuncionarios is retorno.faixaFuncionarios, documented as a string.
	FaixaFuncionarios Text `json:"faixaFuncionarios"`
	// FaturamentoMedioCNAE is retorno.faturamentoMedioCNAE, documented as a string.
	FaturamentoMedioCNAE Text `json:"faturamentoMedioCNAE"`
	// FaturamentoPresumido is retorno.faturamentoPresumido, documented as a string.
	FaturamentoPresumido Text `json:"faturamentoPresumido"`
	// Filiais is retorno.filiais, a list.
	Filiais []CadastroPessoaJuridicaPlusRetornoFiliais `json:"filiais"`
	// Matriz is retorno.matriz, documented as a boolean.
	Matriz Flag `json:"matriz"`
	// NaturezaJuridicaCodigo is retorno.naturezaJuridicaCodigo, documented as a number.
	NaturezaJuridicaCodigo Number `json:"naturezaJuridicaCodigo"`
	// NaturezaJuridicaDescricao is retorno.naturezaJuridicaDescricao, documented as a string.
	NaturezaJuridicaDescricao Text `json:"naturezaJuridicaDescricao"`
	// NaturezaJuridicaTipo is retorno.naturezaJuridicaTipo, documented as a string.
	NaturezaJuridicaTipo Text `json:"naturezaJuridicaTipo"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// OpcaoMEI is retorno.opcaoMEI, documented as a string.
	OpcaoMEI Text `json:"opcaoMEI"`
	// OpcaoSimples is retorno.opcaoSimples, documented as a string.
	OpcaoSimples Text `json:"opcaoSimples"`
	// OrgaoPublico is retorno.orgaoPublico, documented as a string.
	OrgaoPublico Text `json:"orgaoPublico"`
	// Porte is retorno.porte, documented as a string.
	Porte Text `json:"porte"`
	// QuantidadeFiliais is retorno.quantidadeFiliais, documented as a string.
	QuantidadeFiliais Text `json:"quantidadeFiliais"`
	// QuantidadeFuncionarios is retorno.quantidadeFuncionarios, documented as a number.
	QuantidadeFuncionarios Number `json:"quantidadeFuncionarios"`
	// Ramo is retorno.ramo, documented as a string.
	Ramo Text `json:"ramo"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// SituacaoEspecial is retorno.situacaoEspecial, documented as a string.
	SituacaoEspecial Text `json:"situacaoEspecial"`
	// Socios is retorno.socios, a list.
	Socios []CadastroPessoaJuridicaPlusRetornoSocios `json:"socios"`
	// Telefones is retorno.telefones, a list.
	Telefones []CadastroPessoaJuridicaPlusRetornoTelefones `json:"telefones"`
	// TipoEmpresa is retorno.tipoEmpresa, documented as a string.
	TipoEmpresa Text `json:"tipoEmpresa"`
	// Tributacao is retorno.tributacao, documented as a string.
	Tributacao Text `json:"tributacao"`
	// UltimaAtualizacaoPJ is retorno.ultimaAtualizacaoPJ, documented as a string.
	UltimaAtualizacaoPJ Text `json:"ultimaAtualizacaoPJ"`
}

CadastroPessoaJuridicaPlusRetorno is retorno in the answer of CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaPlusRetornoCnaEsSecundarios 

type CadastroPessoaJuridicaPlusRetornoCnaEsSecundarios struct {
	// CnaeCodigoSecundario is retorno.cnaEsSecundarios[].cnaeCodigoSecundario, documented as a number.
	CnaeCodigoSecundario Number `json:"cnaeCodigoSecundario"`
	// CnaeDescricaoSecundario is retorno.cnaEsSecundarios[].cnaeDescricaoSecundario, documented as a string.
	CnaeDescricaoSecundario Text `json:"cnaeDescricaoSecundario"`
}

CadastroPessoaJuridicaPlusRetornoCnaEsSecundarios is retorno.cnaEsSecundarios[] in the answer of CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaPlusRetornoEmails 

type CadastroPessoaJuridicaPlusRetornoEmails struct {
	// EnderecoEmail is retorno.emails[].enderecoEmail, documented as a string.
	EnderecoEmail Text `json:"enderecoEmail" pii:"email"`
}

CadastroPessoaJuridicaPlusRetornoEmails is retorno.emails[] in the answer of CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaPlusRetornoEnderecos 

type CadastroPessoaJuridicaPlusRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroPessoaJuridicaPlusRetornoEnderecos is retorno.enderecos[] in the answer of CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaPlusRetornoFiliais 

type CadastroPessoaJuridicaPlusRetornoFiliais struct {
	// Cnpj is retorno.filiais[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// RazaoSocial is retorno.filiais[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Uf is retorno.filiais[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroPessoaJuridicaPlusRetornoFiliais is retorno.filiais[] in the answer of CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaPlusRetornoSocios 

type CadastroPessoaJuridicaPlusRetornoSocios struct {
	// Cargo is retorno.socios[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataEntrada is retorno.socios[].dataEntrada, documented as a string.
	DataEntrada Text `json:"dataEntrada"`
	// Documento is retorno.socios[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.socios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

CadastroPessoaJuridicaPlusRetornoSocios is retorno.socios[] in the answer of CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaPlusRetornoTelefones 

type CadastroPessoaJuridicaPlusRetornoTelefones struct {
	// Operadora is retorno.telefones[].operadora, documented as a string.
	Operadora Text `json:"operadora"`
	// TelefoneComDDD is retorno.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
	// TelemarketingBloqueado is retorno.telefones[].telemarketingBloqueado, documented as a boolean.
	TelemarketingBloqueado Flag `json:"telemarketingBloqueado"`
	// TipoTelefone is retorno.telefones[].tipoTelefone, documented as a string.
	TipoTelefone Text `json:"tipoTelefone" pii:"phone"`
	// WhatsApp is retorno.telefones[].whatsApp, documented as a boolean.
	WhatsApp Flag `json:"whatsApp"`
}

CadastroPessoaJuridicaPlusRetornoTelefones is retorno.telefones[] in the answer of CadastroPessoaJuridicaPlus.

type CadastroPessoaJuridicaRetorno 

type CadastroPessoaJuridicaRetorno struct {
	// CnaEsSecundarios is retorno.cnaEsSecundarios, a list.
	CnaEsSecundarios []CadastroPessoaJuridicaRetornoCnaEsSecundarios `json:"cnaEsSecundarios"`
	// CnaeCodigo is retorno.cnaeCodigo, documented as a number.
	CnaeCodigo Number `json:"cnaeCodigo"`
	// CnaeDescricao is retorno.cnaeDescricao, documented as a string.
	CnaeDescricao Text `json:"cnaeDescricao"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DataFundacao is retorno.dataFundacao, documented as a string.
	DataFundacao Text `json:"dataFundacao"`
	// Emails is retorno.emails, a list.
	Emails []CadastroPessoaJuridicaRetornoEmails `json:"emails"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []CadastroPessoaJuridicaRetornoEnderecos `json:"enderecos"`
	// FaixaFaturamento is retorno.faixaFaturamento, documented as a string.
	FaixaFaturamento Text `json:"faixaFaturamento"`
	// FaixaFuncionarios is retorno.faixaFuncionarios, documented as a string.
	FaixaFuncionarios Text `json:"faixaFuncionarios"`
	// Matriz is retorno.matriz, documented as a boolean.
	Matriz Flag `json:"matriz"`
	// NaturezaJuridicaCodigo is retorno.naturezaJuridicaCodigo, documented as a number.
	NaturezaJuridicaCodigo Number `json:"naturezaJuridicaCodigo"`
	// NaturezaJuridicaDescricao is retorno.naturezaJuridicaDescricao, documented as a string.
	NaturezaJuridicaDescricao Text `json:"naturezaJuridicaDescricao"`
	// NaturezaJuridicaTipo is retorno.naturezaJuridicaTipo, documented as a string.
	NaturezaJuridicaTipo Text `json:"naturezaJuridicaTipo"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// OrgaoPublico is retorno.orgaoPublico, documented as a string.
	OrgaoPublico Text `json:"orgaoPublico"`
	// Porte is retorno.porte, documented as a string.
	Porte Text `json:"porte"`
	// QuantidadeFuncionarios is retorno.quantidadeFuncionarios, documented as a number.
	QuantidadeFuncionarios Number `json:"quantidadeFuncionarios"`
	// Ramo is retorno.ramo, documented as a string.
	Ramo Text `json:"ramo"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// Socios is retorno.socios, a list.
	Socios []CadastroPessoaJuridicaRetornoSocios `json:"socios"`
	// Telefones is retorno.telefones, a list.
	Telefones []CadastroPessoaJuridicaRetornoTelefones `json:"telefones"`
	// TipoEmpresa is retorno.tipoEmpresa, documented as a string.
	TipoEmpresa Text `json:"tipoEmpresa"`
	// UltimaAtualizacaoPJ is retorno.ultimaAtualizacaoPJ, documented as a string.
	UltimaAtualizacaoPJ Text `json:"ultimaAtualizacaoPJ"`
}

CadastroPessoaJuridicaRetorno is retorno in the answer of CadastroPessoaJuridica.

type CadastroPessoaJuridicaRetornoCnaEsSecundarios 

type CadastroPessoaJuridicaRetornoCnaEsSecundarios struct {
	// CnaeCodigoSecundario is retorno.cnaEsSecundarios[].cnaeCodigoSecundario, documented as a number.
	CnaeCodigoSecundario Number `json:"cnaeCodigoSecundario"`
	// CnaeDescricaoSecundario is retorno.cnaEsSecundarios[].cnaeDescricaoSecundario, documented as a string.
	CnaeDescricaoSecundario Text `json:"cnaeDescricaoSecundario"`
}

CadastroPessoaJuridicaRetornoCnaEsSecundarios is retorno.cnaEsSecundarios[] in the answer of CadastroPessoaJuridica.

type CadastroPessoaJuridicaRetornoEmails 

type CadastroPessoaJuridicaRetornoEmails struct {
	// EnderecoEmail is retorno.emails[].enderecoEmail, documented as a string.
	EnderecoEmail Text `json:"enderecoEmail" pii:"email"`
}

CadastroPessoaJuridicaRetornoEmails is retorno.emails[] in the answer of CadastroPessoaJuridica.

type CadastroPessoaJuridicaRetornoEnderecos 

type CadastroPessoaJuridicaRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroPessoaJuridicaRetornoEnderecos is retorno.enderecos[] in the answer of CadastroPessoaJuridica.

type CadastroPessoaJuridicaRetornoSocios 

type CadastroPessoaJuridicaRetornoSocios struct {
	// Cargo is retorno.socios[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataEntrada is retorno.socios[].dataEntrada, documented as a string.
	DataEntrada Text `json:"dataEntrada"`
	// Documento is retorno.socios[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.socios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// PercentualParticipacao is retorno.socios[].percentualParticipacao, documented as a string.
	PercentualParticipacao Text `json:"percentualParticipacao"`
}

CadastroPessoaJuridicaRetornoSocios is retorno.socios[] in the answer of CadastroPessoaJuridica.

type CadastroPessoaJuridicaRetornoTelefones 

type CadastroPessoaJuridicaRetornoTelefones struct {
	// Operadora is retorno.telefones[].operadora, documented as a string.
	Operadora Text `json:"operadora"`
	// TelefoneComDDD is retorno.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
	// TelemarketingBloqueado is retorno.telefones[].telemarketingBloqueado, documented as a boolean.
	TelemarketingBloqueado Flag `json:"telemarketingBloqueado"`
	// TipoTelefone is retorno.telefones[].tipoTelefone, documented as a string.
	TipoTelefone Text `json:"tipoTelefone" pii:"phone"`
	// WhatsApp is retorno.telefones[].whatsApp, documented as a boolean.
	WhatsApp Flag `json:"whatsApp"`
}

CadastroPessoaJuridicaRetornoTelefones is retorno.telefones[] in the answer of CadastroPessoaJuridica.

type CadastroReceitaPessoaFisicaParams 

type CadastroReceitaPessoaFisicaParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// DATANASCIMENTO is sent as DATANASCIMENTO. O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.
	DATANASCIMENTO string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CadastroReceitaPessoaFisicaParams are the parameters of CadastroReceitaPessoaFisica (Cadastro + Receita Federal - Pessoa Física).

func (CadastroReceitaPessoaFisicaParams) Request 

func (p CadastroReceitaPessoaFisicaParams) Request() (Request, error)

Request builds the Request for CadastroReceitaPessoaFisica.

type CadastroReceitaPessoaFisicaRetorno 

type CadastroReceitaPessoaFisicaRetorno struct {
	// Cadastro is retorno.cadastro.
	Cadastro CadastroReceitaPessoaFisicaRetornoCadastro `json:"cadastro"`
	// Receita is retorno.receita.
	Receita CadastroReceitaPessoaFisicaRetornoReceita `json:"receita"`
}

CadastroReceitaPessoaFisicaRetorno is retorno in the answer of CadastroReceitaPessoaFisica.

type CadastroReceitaPessoaFisicaRetornoCadastro 

type CadastroReceitaPessoaFisicaRetornoCadastro struct {
	// Cpf is retorno.cadastro.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.cadastro.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Emails is retorno.cadastro.emails, a list.
	Emails []CadastroReceitaPessoaFisicaRetornoCadastroEmails `json:"emails"`
	// Enderecos is retorno.cadastro.enderecos, a list.
	Enderecos []CadastroReceitaPessoaFisicaRetornoCadastroEnderecos `json:"enderecos"`
	// Idade is retorno.cadastro.idade, documented as a number.
	Idade Number `json:"idade"`
	// Nome is retorno.cadastro.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.cadastro.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// RendaEstimada is retorno.cadastro.rendaEstimada, documented as a string.
	RendaEstimada Text `json:"rendaEstimada"`
	// RendaFaixaSalarial is retorno.cadastro.rendaFaixaSalarial, documented as a string.
	RendaFaixaSalarial Text `json:"rendaFaixaSalarial"`
	// Sexo is retorno.cadastro.sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Signo is retorno.cadastro.signo, documented as a string.
	Signo Text `json:"signo"`
	// Telefones is retorno.cadastro.telefones, a list.
	Telefones []CadastroReceitaPessoaFisicaRetornoCadastroTelefones `json:"telefones"`
}

CadastroReceitaPessoaFisicaRetornoCadastro is retorno.cadastro in the answer of CadastroReceitaPessoaFisica.

type CadastroReceitaPessoaFisicaRetornoCadastroEmails 

type CadastroReceitaPessoaFisicaRetornoCadastroEmails struct {
	// EnderecoEmail is retorno.cadastro.emails[].enderecoEmail, documented as a string.
	EnderecoEmail Text `json:"enderecoEmail" pii:"email"`
}

CadastroReceitaPessoaFisicaRetornoCadastroEmails is retorno.cadastro.emails[] in the answer of CadastroReceitaPessoaFisica.

type CadastroReceitaPessoaFisicaRetornoCadastroEnderecos 

type CadastroReceitaPessoaFisicaRetornoCadastroEnderecos struct {
	// Bairro is retorno.cadastro.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.cadastro.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.cadastro.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.cadastro.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.cadastro.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.cadastro.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.cadastro.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CadastroReceitaPessoaFisicaRetornoCadastroEnderecos is retorno.cadastro.enderecos[] in the answer of CadastroReceitaPessoaFisica.

type CadastroReceitaPessoaFisicaRetornoCadastroTelefones 

type CadastroReceitaPessoaFisicaRetornoCadastroTelefones struct {
	// Operadora is retorno.cadastro.telefones[].operadora, documented as a string.
	Operadora Text `json:"operadora"`
	// TelefoneComDDD is retorno.cadastro.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
	// TelemarketingBloqueado is retorno.cadastro.telefones[].telemarketingBloqueado, documented as a boolean.
	TelemarketingBloqueado Flag `json:"telemarketingBloqueado"`
	// TipoTelefone is retorno.cadastro.telefones[].tipoTelefone, documented as a string.
	TipoTelefone Text `json:"tipoTelefone" pii:"phone"`
	// WhatsApp is retorno.cadastro.telefones[].whatsApp, documented as a boolean.
	WhatsApp Flag `json:"whatsApp"`
}

CadastroReceitaPessoaFisicaRetornoCadastroTelefones is retorno.cadastro.telefones[] in the answer of CadastroReceitaPessoaFisica.

type CadastroReceitaPessoaFisicaRetornoReceita 

type CadastroReceitaPessoaFisicaRetornoReceita struct {
	// AnoObito is retorno.receita.anoObito, documented as a string.
	AnoObito Text `json:"anoObito"`
	// CodigoControleComprovante is retorno.receita.codigoControleComprovante, documented as a string.
	CodigoControleComprovante Text `json:"codigoControleComprovante"`
	// DataConsulta is retorno.receita.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.receita.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataInscricao is retorno.receita.dataInscricao, documented as a string.
	DataInscricao Text `json:"dataInscricao"`
	// DataInscricaoAnterior1990 is retorno.receita.dataInscricaoAnterior1990, documented as a boolean.
	DataInscricaoAnterior1990 Flag `json:"dataInscricaoAnterior1990"`
	// DataNascimento is retorno.receita.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DigitoVerificador is retorno.receita.digitoVerificador, documented as a string.
	DigitoVerificador Text `json:"digitoVerificador"`
	// NomePessoaFisica is retorno.receita.nomePessoaFisica, documented as a string.
	NomePessoaFisica Text `json:"nomePessoaFisica" pii:"name"`
	// NomeSocial is retorno.receita.nomeSocial, documented as a string.
	NomeSocial Text `json:"nomeSocial" pii:"name"`
	// NumeroCPF is retorno.receita.numeroCPF, documented as a string.
	NumeroCPF Text `json:"numeroCPF" pii:"document"`
	// PossuiObito is retorno.receita.possuiObito, documented as a boolean.
	PossuiObito Flag `json:"possuiObito"`
	// SituacaoCadastral is retorno.receita.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
}

CadastroReceitaPessoaFisicaRetornoReceita is retorno.receita in the answer of CadastroReceitaPessoaFisica.

type CaixaRegularidadeEmpregadorFGTSParams 

type CaixaRegularidadeEmpregadorFGTSParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CaixaRegularidadeEmpregadorFGTSParams are the parameters of CaixaRegularidadeEmpregadorFGTS (FGTS - Regularidade do Empregador).

func (CaixaRegularidadeEmpregadorFGTSParams) Request 

func (p CaixaRegularidadeEmpregadorFGTSParams) Request() (Request, error)

Request builds the Request for CaixaRegularidadeEmpregadorFGTS.

type CaixaRegularidadeEmpregadorFGTSRetorno 

type CaixaRegularidadeEmpregadorFGTSRetorno struct {
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Endereco is retorno.endereco.
	Endereco CaixaRegularidadeEmpregadorFGTSRetornoEndereco `json:"endereco"`
	// Historico is retorno.historico, a list.
	Historico []CaixaRegularidadeEmpregadorFGTSRetornoHistorico `json:"historico"`
	// Inscricao is retorno.inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// NumeroCertificado is retorno.numeroCertificado, documented as a string.
	NumeroCertificado Text `json:"numeroCertificado"`
	// PeriodoValidade is retorno.periodoValidade.
	PeriodoValidade CaixaRegularidadeEmpregadorFGTSRetornoPeriodoValidade `json:"periodoValidade"`
	// PossuiIrregularidade is retorno.possuiIrregularidade, documented as a boolean.
	PossuiIrregularidade Flag `json:"possuiIrregularidade"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

CaixaRegularidadeEmpregadorFGTSRetorno is retorno in the answer of CaixaRegularidadeEmpregadorFGTS.

type CaixaRegularidadeEmpregadorFGTSRetornoEndereco 

type CaixaRegularidadeEmpregadorFGTSRetornoEndereco struct {
	// Bairro is retorno.endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

CaixaRegularidadeEmpregadorFGTSRetornoEndereco is retorno.endereco in the answer of CaixaRegularidadeEmpregadorFGTS.

type CaixaRegularidadeEmpregadorFGTSRetornoHistorico 

type CaixaRegularidadeEmpregadorFGTSRetornoHistorico struct {
	// DataEmissao is retorno.historico[].dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// NumeroCrf is retorno.historico[].numeroCrf, documented as a string.
	NumeroCrf Text `json:"numeroCrf"`
	// PeriodoValidade is retorno.historico[].periodoValidade.
	PeriodoValidade CaixaRegularidadeEmpregadorFGTSRetornoHistoricoPeriodoValidade `json:"periodoValidade"`
}

CaixaRegularidadeEmpregadorFGTSRetornoHistorico is retorno.historico[] in the answer of CaixaRegularidadeEmpregadorFGTS.

type CaixaRegularidadeEmpregadorFGTSRetornoHistoricoPeriodoValidade 

type CaixaRegularidadeEmpregadorFGTSRetornoHistoricoPeriodoValidade struct {
	// Fim is retorno.historico[].periodoValidade.fim, documented as a string.
	Fim Text `json:"fim"`
	// Inicio is retorno.historico[].periodoValidade.inicio, documented as a string.
	Inicio Text `json:"inicio"`
}

CaixaRegularidadeEmpregadorFGTSRetornoHistoricoPeriodoValidade is retorno.historico[].periodoValidade in the answer of CaixaRegularidadeEmpregadorFGTS.

type CaixaRegularidadeEmpregadorFGTSRetornoPeriodoValidade 

type CaixaRegularidadeEmpregadorFGTSRetornoPeriodoValidade struct {
	// Fim is retorno.periodoValidade.fim, documented as a string.
	Fim Text `json:"fim"`
	// Inicio is retorno.periodoValidade.inicio, documented as a string.
	Inicio Text `json:"inicio"`
}

CaixaRegularidadeEmpregadorFGTSRetornoPeriodoValidade is retorno.periodoValidade in the answer of CaixaRegularidadeEmpregadorFGTS.

type CallbackRequest 

type CallbackRequest struct {
	// Product is the API's slug, when the application already knows it; it
	// selects the type Data is decoded into. CompleteAsync fills it from the
	// ticket otherwise.
	Product string
	// Header is the request's headers.
	Header http.Header
	// Query is the request's query parameters.
	Query url.Values
	// Body is the request's body.
	Body []byte
}

CallbackRequest is what the application's callback endpoint received.

type CallbackVerifier 

type CallbackVerifier interface {
	// VerifyCallback returns nil for a callback that came from Direct Data.
	VerifyCallback(r CallbackRequest) error
}

CallbackVerifier authenticates a callback before it is read.

type CanadaSEMAParams 

type CanadaSEMAParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
}

CanadaSEMAParams are the parameters of CanadaSEMA (Canada SEMA - Sanções Internacionais).

func (CanadaSEMAParams) Request 

func (p CanadaSEMAParams) Request() (Request, error)

Request builds the Request for CanadaSEMA.

type CanadaSEMARetorno 

type CanadaSEMARetorno struct {
	// DataLista is retorno.dataLista, documented as a string.
	DataLista Text `json:"dataLista"`
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []CanadaSEMARetornoSancoes `json:"sancoes"`
}

CanadaSEMARetorno is retorno in the answer of CanadaSEMA.

type CanadaSEMARetornoSancoes 

type CanadaSEMARetornoSancoes struct {
	// Apelidos is retorno.sancoes[].apelidos, a list.
	Apelidos []CanadaSEMARetornoSancoesApelidos `json:"apelidos"`
	// Atributos is retorno.sancoes[].atributos, a list.
	Atributos []CanadaSEMARetornoSancoesAtributos `json:"atributos"`
	// DataInclusaoLista is retorno.sancoes[].dataInclusaoLista, documented as a string.
	DataInclusaoLista Text `json:"dataInclusaoLista"`
	// DataNascimento is retorno.sancoes[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Identificacoes is retorno.sancoes[].identificacoes, a list.
	Identificacoes []CanadaSEMARetornoSancoesIdentificacoes `json:"identificacoes"`
	// Nome is retorno.sancoes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Programas is retorno.sancoes[].programas, documented as a string.
	Programas Text `json:"programas"`
	// Status is retorno.sancoes[].status, documented as a string.
	Status Text `json:"status"`
	// TipoRegistro is retorno.sancoes[].tipoRegistro, documented as a string.
	TipoRegistro Text `json:"tipoRegistro"`
	// Titulo is retorno.sancoes[].titulo, documented as a string.
	Titulo Text `json:"titulo"`
}

CanadaSEMARetornoSancoes is retorno.sancoes[] in the answer of CanadaSEMA.

type CanadaSEMARetornoSancoesApelidos 

type CanadaSEMARetornoSancoesApelidos struct {
	// Idioma is retorno.sancoes[].apelidos[].idioma, documented as a string.
	Idioma Text `json:"idioma"`
	// Nome is retorno.sancoes[].apelidos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Tipo is retorno.sancoes[].apelidos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

CanadaSEMARetornoSancoesApelidos is retorno.sancoes[].apelidos[] in the answer of CanadaSEMA.

type CanadaSEMARetornoSancoesAtributos 

type CanadaSEMARetornoSancoesAtributos struct {
	// Chave is retorno.sancoes[].atributos[].chave, documented as a string.
	Chave Text `json:"chave" pii:"document"`
	// Valor is retorno.sancoes[].atributos[].valor, documented as a string.
	Valor Text `json:"valor"`
}

CanadaSEMARetornoSancoesAtributos is retorno.sancoes[].atributos[] in the answer of CanadaSEMA.

type CanadaSEMARetornoSancoesIdentificacoes 

type CanadaSEMARetornoSancoesIdentificacoes struct {
	// Documento is retorno.sancoes[].identificacoes[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Tipo is retorno.sancoes[].identificacoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

CanadaSEMARetornoSancoesIdentificacoes is retorno.sancoes[].identificacoes[] in the answer of CanadaSEMA.

type CarteiraNacionalHabilitacaoParams 

type CarteiraNacionalHabilitacaoParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CarteiraNacionalHabilitacaoParams are the parameters of CarteiraNacionalHabilitacao (CNH - Carteira Nacional de Habilitação).

func (CarteiraNacionalHabilitacaoParams) Request 

func (p CarteiraNacionalHabilitacaoParams) Request() (Request, error)

Request builds the Request for CarteiraNacionalHabilitacao.

type CarteiraNacionalHabilitacaoRetorno 

type CarteiraNacionalHabilitacaoRetorno struct {
	// Cnh is retorno.cnh, documented as a string.
	Cnh Text `json:"cnh" pii:"document"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataPrimeiraCNH is retorno.dataPrimeiraCNH, documented as a string.
	DataPrimeiraCNH Text `json:"dataPrimeiraCNH"`
	// Nacionalidade is retorno.nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Permissionario is retorno.permissionario, documented as a boolean.
	Permissionario Flag `json:"permissionario"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

CarteiraNacionalHabilitacaoRetorno is retorno in the answer of CarteiraNacionalHabilitacao.

type CertidaoConjuntaDebitosPessoaFisicaParams 

type CertidaoConjuntaDebitosPessoaFisicaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// DATANASCIMENTO is sent as DATANASCIMENTO. O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.
	DATANASCIMENTO string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CertidaoConjuntaDebitosPessoaFisicaParams are the parameters of CertidaoConjuntaDebitosPessoaFisica (CCD - Certidão Conjunta de Débitos - Pessoa Física).

func (CertidaoConjuntaDebitosPessoaFisicaParams) Request 

func (p CertidaoConjuntaDebitosPessoaFisicaParams) Request() (Request, error)

Request builds the Request for CertidaoConjuntaDebitosPessoaFisica.

type CertidaoConjuntaDebitosPessoaFisicaRetorno 

type CertidaoConjuntaDebitosPessoaFisicaRetorno struct {
	// CodigoControleCertidao is retorno.codigoControleCertidao, documented as a string.
	CodigoControleCertidao Text `json:"codigoControleCertidao"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// EmitidaAs is retorno.emitidaAs, documented as a string.
	EmitidaAs Text `json:"emitidaAs"`
	// ListaDividas is retorno.listaDividas, a list.
	ListaDividas []Text `json:"listaDividas"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Portaria is retorno.portaria, documented as a string.
	Portaria Text `json:"portaria"`
	// PossuiDividas is retorno.possuiDividas, documented as a boolean.
	PossuiDividas Flag `json:"possuiDividas"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Titulo is retorno.titulo, documented as a string.
	Titulo Text `json:"titulo"`
	// ValidaAte is retorno.validaAte, documented as a string.
	ValidaAte Text `json:"validaAte"`
}

CertidaoConjuntaDebitosPessoaFisicaRetorno is retorno in the answer of CertidaoConjuntaDebitosPessoaFisica.

type CertidaoConjuntaDebitosPessoaJuridicaParams 

type CertidaoConjuntaDebitosPessoaJuridicaParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CertidaoConjuntaDebitosPessoaJuridicaParams are the parameters of CertidaoConjuntaDebitosPessoaJuridica (CCD - Certidão Conjunta de Débitos - Pessoa Jurídica).

func (CertidaoConjuntaDebitosPessoaJuridicaParams) Request 

func (p CertidaoConjuntaDebitosPessoaJuridicaParams) Request() (Request, error)

Request builds the Request for CertidaoConjuntaDebitosPessoaJuridica.

type CertidaoConjuntaDebitosPessoaJuridicaRetorno 

type CertidaoConjuntaDebitosPessoaJuridicaRetorno struct {
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// CodigoControleCertidao is retorno.codigoControleCertidao, documented as a string.
	CodigoControleCertidao Text `json:"codigoControleCertidao"`
	// EmitidaAs is retorno.emitidaAs, documented as a string.
	EmitidaAs Text `json:"emitidaAs"`
	// ListaDividas is retorno.listaDividas, a list.
	ListaDividas []Text `json:"listaDividas"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Portaria is retorno.portaria, documented as a string.
	Portaria Text `json:"portaria"`
	// PossuiDividas is retorno.possuiDividas, documented as a boolean.
	PossuiDividas Flag `json:"possuiDividas"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Titulo is retorno.titulo, documented as a string.
	Titulo Text `json:"titulo"`
	// ValidaAte is retorno.validaAte, documented as a string.
	ValidaAte Text `json:"validaAte"`
}

CertidaoConjuntaDebitosPessoaJuridicaRetorno is retorno in the answer of CertidaoConjuntaDebitosPessoaJuridica.

type CertidaoNegativaDebitosImovelRuralParams 

type CertidaoNegativaDebitosImovelRuralParams struct {
	// CIB is sent as CIB. O parâmetro CIB pode ser enviado com ou sem formatação.
	CIB string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CertidaoNegativaDebitosImovelRuralParams are the parameters of CertidaoNegativaDebitosImovelRural (CNDIR - Certidão Negativa de Débitos e Dívida Ativa da União de Imóvel Rural).

func (CertidaoNegativaDebitosImovelRuralParams) Request 

func (p CertidaoNegativaDebitosImovelRuralParams) Request() (Request, error)

Request builds the Request for CertidaoNegativaDebitosImovelRural.

type CertidaoNegativaDebitosImovelRuralRetorno 

type CertidaoNegativaDebitosImovelRuralRetorno struct {
	// AreaTotal is retorno.areaTotal, documented as a string.
	AreaTotal Text `json:"areaTotal"`
	// Cib is retorno.cib, documented as a string.
	Cib Text `json:"cib"`
	// CodigoControleCertidao is retorno.codigoControleCertidao, documented as a string.
	CodigoControleCertidao Text `json:"codigoControleCertidao"`
	// Contribuinte is retorno.contribuinte, documented as a string.
	Contribuinte Text `json:"contribuinte"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Debitos is retorno.debitos, a list.
	Debitos []Text `json:"debitos"`
	// EfeitoNegativa is retorno.efeitoNegativa, documented as a boolean.
	EfeitoNegativa Flag `json:"efeitoNegativa"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NomeImovel is retorno.nomeImovel, documented as a string.
	NomeImovel Text `json:"nomeImovel" pii:"name"`
	// PossuiDebito is retorno.possuiDebito, documented as a boolean.
	PossuiDebito Flag `json:"possuiDebito"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

CertidaoNegativaDebitosImovelRuralRetorno is retorno in the answer of CertidaoNegativaDebitosImovelRural.

type CertidaoNegativaDebitosMunicipalParams 

type CertidaoNegativaDebitosMunicipalParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// IM is sent as IM. O parâmetro IM (Inscrição Municipal) pode ser enviado com ou sem formatação.
	IM string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Municipio is sent as Municipio. O parâmetro MUNICIPIO deve ser informado juntamente com a Unidade Federativa (MUNICIPIO-UF).
	Municipio string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CertidaoNegativaDebitosMunicipalParams are the parameters of CertidaoNegativaDebitosMunicipal (CNDM - Certidão Negativa de Débitos Municipal).

func (CertidaoNegativaDebitosMunicipalParams) Request 

func (p CertidaoNegativaDebitosMunicipalParams) Request() (Request, error)

Request builds the Request for CertidaoNegativaDebitosMunicipal.

type CertidaoNegativaDebitosMunicipalRetorno 

type CertidaoNegativaDebitosMunicipalRetorno struct {
	// Cidade is retorno.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Debitos is retorno.debitos, a list.
	Debitos []Text `json:"debitos"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// EfeitoNegativa is retorno.efeitoNegativa, documented as a boolean.
	EfeitoNegativa Flag `json:"efeitoNegativa"`
	// InscricaoMunicipal is retorno.inscricaoMunicipal, documented as a string.
	InscricaoMunicipal Text `json:"inscricaoMunicipal"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// PossuiDebito is retorno.possuiDebito, documented as a boolean.
	PossuiDebito Flag `json:"possuiDebito"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

CertidaoNegativaDebitosMunicipalRetorno is retorno in the answer of CertidaoNegativaDebitosMunicipal.

type CertidaoNegativaDebitosParams 

type CertidaoNegativaDebitosParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Ie is sent as ie. O parâmetro IE pode ser enviado com ou sem formatação.
	Ie string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Uf is sent as Uf. Not described by the documentation.
	Uf string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

CertidaoNegativaDebitosParams are the parameters of CertidaoNegativaDebitos (CND - Certidão Negativa de Débitos Estaduais).

func (CertidaoNegativaDebitosParams) Request 

func (p CertidaoNegativaDebitosParams) Request() (Request, error)

Request builds the Request for CertidaoNegativaDebitos.

type CertidaoNegativaDebitosRetorno 

type CertidaoNegativaDebitosRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Debitos is retorno.debitos, a list.
	Debitos []Text `json:"debitos"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// EfeitoNegativa is retorno.efeitoNegativa, documented as a boolean.
	EfeitoNegativa Flag `json:"efeitoNegativa"`
	// InscricaoEstadual is retorno.inscricaoEstadual, documented as a string.
	InscricaoEstadual Text `json:"inscricaoEstadual" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// PossuiDebito is retorno.possuiDebito, documented as a boolean.
	PossuiDebito Flag `json:"possuiDebito"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

CertidaoNegativaDebitosRetorno is retorno in the answer of CertidaoNegativaDebitos.

type CertidaoNegativaProcessoParams 

type CertidaoNegativaProcessoParams struct {
	// CPF is sent as Cpf. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CNPJ string
}

CertidaoNegativaProcessoParams are the parameters of CertidaoNegativaProcesso (TCU - Certidão Negativa de Processo).

func (CertidaoNegativaProcessoParams) Request 

func (p CertidaoNegativaProcessoParams) Request() (Request, error)

Request builds the Request for CertidaoNegativaProcesso.

type CertidaoNegativaProcessoRetorno 

type CertidaoNegativaProcessoRetorno struct {
	// CodigoCertidao is retorno.codigoCertidao, documented as a string.
	CodigoCertidao Text `json:"codigoCertidao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PossuiProcesso is retorno.possuiProcesso, documented as a boolean.
	PossuiProcesso Flag `json:"possuiProcesso"`
	// Processos is retorno.processos, a list.
	Processos []CertidaoNegativaProcessoRetornoProcessos `json:"processos"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

CertidaoNegativaProcessoRetorno is retorno in the answer of CertidaoNegativaProcesso.

type CertidaoNegativaProcessoRetornoProcessos 

type CertidaoNegativaProcessoRetornoProcessos struct {
	// Assunto is retorno.processos[].assunto, documented as a string.
	Assunto Text `json:"assunto"`
	// EstadoProcesso is retorno.processos[].estadoProcesso, documented as a string.
	EstadoProcesso Text `json:"estadoProcesso"`
	// NumeroProcesso is retorno.processos[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Qualificacao is retorno.processos[].qualificacao, documented as a string.
	Qualificacao Text `json:"qualificacao"`
	// Tipo is retorno.processos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

CertidaoNegativaProcessoRetornoProcessos is retorno.processos[] in the answer of CertidaoNegativaProcesso.

type Charge 

type Charge struct {
	// Product is the API's slug.
	Product string
	// PriceCents is the product's configured list price.
	PriceCents int64
	// Document is the queried document, masked.
	Document string
}

Charge is what a query is about to cost, as the client asks a Ledger to hold it.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client queries Direct Data. It is safe for concurrent use.

func New 

func New(cfg Config) (*Client, error)

New returns the client, or the reason it cannot be built.

func (*Client) AML 

func (c *Client) AML(ctx context.Context, m Meter, p AMLParams) (*Result, *AMLRetorno, error)

AML queries AML: AML - Anti Money Laundering (Vínculos Societários), list price R$ 0,72 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/AML

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ANTTConsultaCodigoIdentificadorOperacaoTransporte 

func (c *Client) ANTTConsultaCodigoIdentificadorOperacaoTransporte(ctx context.Context, m Meter, p ANTTConsultaCodigoIdentificadorOperacaoTransporteParams) (*Result, *ANTTConsultaCodigoIdentificadorOperacaoTransporteRetorno, error)

ANTTConsultaCodigoIdentificadorOperacaoTransporte queries ANTTConsultaCodigoIdentificadorOperacaoTransporte: ANTT - Código Identificador Operação Transporte, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ANTTConsultaCodigoIdentificadorOperacaoTransporte

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ANTTConsultaRegularidadeTransportadora 

func (c *Client) ANTTConsultaRegularidadeTransportadora(ctx context.Context, m Meter, p ANTTConsultaRegularidadeTransportadoraParams) (*Result, *ANTTConsultaRegularidadeTransportadoraRetorno, error)

ANTTConsultaRegularidadeTransportadora queries ANTTConsultaRegularidadeTransportadora: ANTT - Consulta de Regularidade da Transportadora, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ANTTConsultaRegularidadeTransportadora

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) APFRural 

func (c *Client) APFRural(ctx context.Context, m Meter, p APFRuralParams) (*Result, *APFRuralRetorno, error)

APFRural queries APFRural: APF Rural - Autorização Provisória de Funcionamento Rural, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/APFRural

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) AcordosLeniencia 

func (c *Client) AcordosLeniencia(ctx context.Context, m Meter, p AcordosLenienciaParams) (*Result, *AcordosLenienciaRetorno, error)

AcordosLeniencia queries AcordosLeniencia: Acordos de Leniência, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/AcordosLeniencia

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) AnbimaCertificadoEDU 

func (c *Client) AnbimaCertificadoEDU(ctx context.Context, m Meter, p AnbimaCertificadoEDUParams) (*Result, *AnbimaCertificadoEDURetorno, error)

AnbimaCertificadoEDU queries AnbimaCertificadoEDU: Certificado Anbima EDU, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/AnbimaCertificadoEDU

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) AntifraudePix 

func (c *Client) AntifraudePix(ctx context.Context, m Meter, p AntifraudePixParams) (*Result, *AntifraudePixRetorno, error)

AntifraudePix queries AntifraudePix: Antifraude Chave PIX, list price R$ 1,55 per query. The documentation lists it as maintenance. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/AntifraudePix

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) AustraliaDFAT 

func (c *Client) AustraliaDFAT(ctx context.Context, m Meter, p AustraliaDFATParams) (*Result, *AustraliaDFATRetorno, error)

AustraliaDFAT queries AustraliaDFAT: Austrália DFAT - Sanções Internacionais, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/AustraliaDFAT

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) AuxilioEmergencial 

func (c *Client) AuxilioEmergencial(ctx context.Context, m Meter, p AuxilioEmergencialParams) (*Result, *AuxilioEmergencialRetorno, error)

AuxilioEmergencial queries AuxilioEmergencial: Auxílio Emergencial, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/AuxilioEmergencial

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) AuxilioReconstrucao 

func (c *Client) AuxilioReconstrucao(ctx context.Context, m Meter, p AuxilioReconstrucaoParams) (*Result, *AuxilioReconstrucaoRetorno, error)

AuxilioReconstrucao queries AuxilioReconstrucao: Auxílio Reconstrução, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/AuxilioReconstrucao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BancoCentralInabilitados 

func (c *Client) BancoCentralInabilitados(ctx context.Context, m Meter, p BancoCentralInabilitadosParams) (*Result, *BancoCentralInabilitadosRetorno, error)

BancoCentralInabilitados queries BancoCentralInabilitados: Banco Central - Quadro Geral de Inabilitados, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BancoCentralInabilitados

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BancoCentralProibidos 

func (c *Client) BancoCentralProibidos(ctx context.Context, m Meter, p BancoCentralProibidosParams) (*Result, *BancoCentralProibidosRetorno, error)

BancoCentralProibidos queries BancoCentralProibidos: Banco Central - Quadro Geral de Proibidos, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BancoCentralProibidos

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BeneficiarioFinal 

func (c *Client) BeneficiarioFinal(ctx context.Context, m Meter, p BeneficiarioFinalParams) (*Result, *BeneficiarioFinalRetorno, error)

BeneficiarioFinal queries BeneficiarioFinal: Beneficiário Final, list price R$ 1,44 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BeneficiarioFinal

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BeneficioPrestacaoContinuada 

func (c *Client) BeneficioPrestacaoContinuada(ctx context.Context, m Meter, p BeneficioPrestacaoContinuadaParams) (*Result, *BeneficioPrestacaoContinuadaRetorno, error)

BeneficioPrestacaoContinuada queries BeneficioPrestacaoContinuada: Benefício de Prestação Continuada - BPC, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BeneficioPrestacaoContinuada

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BeneficiosSociais 

func (c *Client) BeneficiosSociais(ctx context.Context, m Meter, p BeneficiosSociaisParams) (*Result, *BeneficiosSociaisRetorno, error)

BeneficiosSociais queries BeneficiosSociais: Benefícios Sociais - Pessoa Física, list price R$ 0,75 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BeneficiosSociais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BetSafeCompliance 

func (c *Client) BetSafeCompliance(ctx context.Context, m Meter, p BetSafeComplianceParams) (*Result, *BetSafeComplianceRetorno, error)

BetSafeCompliance queries BetSafeCompliance: Bet Safe Compliance, list price R$ 0,72 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BetSafeCompliance

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BoaVistaAcertaCompletoPositivoPF 

func (c *Client) BoaVistaAcertaCompletoPositivoPF(ctx context.Context, m Meter, p BoaVistaAcertaCompletoPositivoPFParams) (*Result, *BoaVistaAcertaCompletoPositivoPFRetorno, error)

BoaVistaAcertaCompletoPositivoPF queries BoaVistaAcertaCompletoPositivoPF: Boa Vista - Acerta Completo Positivo Pessoa Física, list price R$ 14,03 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BoaVistaAcertaCompletoPositivoPF

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BoaVistaAcertaMaisPositivoPF 

func (c *Client) BoaVistaAcertaMaisPositivoPF(ctx context.Context, m Meter, p BoaVistaAcertaMaisPositivoPFParams) (*Result, *BoaVistaAcertaMaisPositivoPFRetorno, error)

BoaVistaAcertaMaisPositivoPF queries BoaVistaAcertaMaisPositivoPF: Boa Vista - Acerta Mais Positivo Pessoa Física, list price R$ 11,18 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BoaVistaAcertaMaisPositivoPF

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BoaVistaDefineLimitePositivoPJ 

func (c *Client) BoaVistaDefineLimitePositivoPJ(ctx context.Context, m Meter, p BoaVistaDefineLimitePositivoPJParams) (*Result, *BoaVistaDefineLimitePositivoPJRetorno, error)

BoaVistaDefineLimitePositivoPJ queries BoaVistaDefineLimitePositivoPJ: Boa Vista - Define Limite Positivo Pessoa Jurídica, list price R$ 21,00 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BoaVistaDefineLimitePositivoPJ

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BoaVistaRiscoPositivoPJ 

func (c *Client) BoaVistaRiscoPositivoPJ(ctx context.Context, m Meter, p BoaVistaRiscoPositivoPJParams) (*Result, *BoaVistaRiscoPositivoPJRetorno, error)

BoaVistaRiscoPositivoPJ queries BoaVistaRiscoPositivoPJ: Boa Vista - Risco Positivo Pessoa Jurídica, list price R$ 14,03 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BoaVistaRiscoPositivoPJ

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BolsaFamilia 

func (c *Client) BolsaFamilia(ctx context.Context, m Meter, p BolsaFamiliaParams) (*Result, *BolsaFamiliaRetorno, error)

BolsaFamilia queries BolsaFamilia: Bolsa Família, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/BolsaFamilia

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) BreakerState 

func (c *Client) BreakerState() BreakerState

BreakerState reports where the circuit breaker is.

func (*Client) CADINSecretariaFazendaEstaduais 

func (c *Client) CADINSecretariaFazendaEstaduais(ctx context.Context, m Meter, p CADINSecretariaFazendaEstaduaisParams) (*Result, *CADINSecretariaFazendaEstaduaisRetorno, error)

CADINSecretariaFazendaEstaduais queries CADINSecretariaFazendaEstaduais: CADIN - Secretaria da Fazenda, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CADINSecretariaFazendaEstaduais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CADINSecretariaFazendaSP 

func (c *Client) CADINSecretariaFazendaSP(ctx context.Context, m Meter, p CADINSecretariaFazendaSPParams) (*Result, *CADINSecretariaFazendaSPRetorno, error)

CADINSecretariaFazendaSP queries CADINSecretariaFazendaSP: CADIN - Secretaria da Fazenda - São Paulo, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CADINSecretariaFazendaSP

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CAFCadastroNacionalAgriculturaPF 

func (c *Client) CAFCadastroNacionalAgriculturaPF(ctx context.Context, m Meter, p CAFCadastroNacionalAgriculturaPFParams) (*Result, *CAFCadastroNacionalAgriculturaPFRetorno, error)

CAFCadastroNacionalAgriculturaPF queries CAFCadastroNacionalAgriculturaPF: CAF - Cadastro Nacional de Agricultura Familiar - PF, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CAFCadastroNacionalAgriculturaPF

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CAFCadastroNacionalAgriculturaPJ 

func (c *Client) CAFCadastroNacionalAgriculturaPJ(ctx context.Context, m Meter, p CAFCadastroNacionalAgriculturaPJParams) (*Result, *CAFCadastroNacionalAgriculturaPJRetorno, error)

CAFCadastroNacionalAgriculturaPJ queries CAFCadastroNacionalAgriculturaPJ: CAF - Cadastro Nacional de Agricultura Familiar - PJ, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CAFCadastroNacionalAgriculturaPJ

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CARFConselhoAdmistrativodeRecursosFiscais 

func (c *Client) CARFConselhoAdmistrativodeRecursosFiscais(ctx context.Context, m Meter, p CARFConselhoAdmistrativodeRecursosFiscaisParams) (*Result, *CARFConselhoAdmistrativodeRecursosFiscaisRetorno, error)

CARFConselhoAdmistrativodeRecursosFiscais queries CARFConselhoAdmistrativodeRecursosFiscais: CARF - Conselho Administrativo de Recursos Fiscais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CARFConselhoAdmistrativodeRecursosFiscais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CFMConselhoFederalMedicina 

func (c *Client) CFMConselhoFederalMedicina(ctx context.Context, m Meter, p CFMConselhoFederalMedicinaParams) (*Result, *CFMConselhoFederalMedicinaRetorno, error)

CFMConselhoFederalMedicina queries CFMConselhoFederalMedicina: CFM - Conselho Federal de Medicina, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CFMConselhoFederalMedicina

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CGUConsultoriaGeralUniao 

func (c *Client) CGUConsultoriaGeralUniao(ctx context.Context, m Meter, p CGUConsultoriaGeralUniaoParams) (*Result, *CGUConsultoriaGeralUniaoRetorno, error)

CGUConsultoriaGeralUniao queries CGUConsultoriaGeralUniao: Consultoria Geral da União - CGU, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CGUConsultoriaGeralUniao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CNJMandadosPrisao 

func (c *Client) CNJMandadosPrisao(ctx context.Context, m Meter, p CNJMandadosPrisaoParams) (*Result, *CNJMandadosPrisaoRetorno, error)

CNJMandadosPrisao queries CNJMandadosPrisao: CNJ - Mandados de Prisão, list price R$ 0,72 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CNJMandadosPrisao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CONFEA 

func (c *Client) CONFEA(ctx context.Context, m Meter, p CONFEAParams) (*Result, *CONFEARetorno, error)

CONFEA queries CONFEA: CONFEA/CREA - Conselho Federal de Engenharia e Agronomia, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CONFEA

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CVMComissaodeValoresMobiliarios 

func (c *Client) CVMComissaodeValoresMobiliarios(ctx context.Context, m Meter, p CVMComissaodeValoresMobiliariosParams) (*Result, *CVMComissaodeValoresMobiliariosRetorno, error)

CVMComissaodeValoresMobiliarios queries CVMComissaodeValoresMobiliarios: CVM - Comissão de Valores Mobiliários, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CVMComissaodeValoresMobiliarios

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CVMProcessosAdministrativosSancionadores 

func (c *Client) CVMProcessosAdministrativosSancionadores(ctx context.Context, m Meter, p CVMProcessosAdministrativosSancionadoresParams) (*Result, *CVMProcessosAdministrativosSancionadoresRetorno, error)

CVMProcessosAdministrativosSancionadores queries CVMProcessosAdministrativosSancionadores: CVM - Processos Administrativos Sancionadores, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CVMProcessosAdministrativosSancionadores

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroAmbientalRural 

func (c *Client) CadastroAmbientalRural(ctx context.Context, m Meter, p CadastroAmbientalRuralParams) (*Result, *CadastroAmbientalRuralRetorno, error)

CadastroAmbientalRural queries CadastroAmbientalRural: CAR - Cadastro Ambiental Rural, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroAmbientalRural

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroEmpresasInidoneasSuspensas 

func (c *Client) CadastroEmpresasInidoneasSuspensas(ctx context.Context, m Meter, p CadastroEmpresasInidoneasSuspensasParams) (*Result, *CadastroEmpresasInidoneasSuspensasRetorno, error)

CadastroEmpresasInidoneasSuspensas queries CadastroEmpresasInidoneasSuspensas: CEIS - Cadastro de Empresas Inidôneas e Suspensas, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroEmpresasInidoneasSuspensas

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroEntidadesPrivadasImpedidas 

func (c *Client) CadastroEntidadesPrivadasImpedidas(ctx context.Context, m Meter, p CadastroEntidadesPrivadasImpedidasParams) (*Result, *CadastroEntidadesPrivadasImpedidasRetorno, error)

CadastroEntidadesPrivadasImpedidas queries CadastroEntidadesPrivadasImpedidas: CEPIM - Cadastro de Entidades Privadas Sem Fins Lucrativos Impedidas, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroEntidadesPrivadasImpedidas

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroExpulsoesAdministracaoFederal 

func (c *Client) CadastroExpulsoesAdministracaoFederal(ctx context.Context, m Meter, p CadastroExpulsoesAdministracaoFederalParams) (*Result, *CadastroExpulsoesAdministracaoFederalRetorno, error)

CadastroExpulsoesAdministracaoFederal queries CadastroExpulsoesAdministracaoFederal: CEAF - Cadastro de Expulsões da Administração Federal, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroExpulsoesAdministracaoFederal

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroImoveisRurais 

func (c *Client) CadastroImoveisRurais(ctx context.Context, m Meter, p CadastroImoveisRuraisParams) (*Result, *CadastroImoveisRuraisRetorno, error)

CadastroImoveisRurais queries CadastroImoveisRurais: CAFIR - Cadastros de Imóveis Rurais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroImoveisRurais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroNacionalEmpresasPunidas 

func (c *Client) CadastroNacionalEmpresasPunidas(ctx context.Context, m Meter, p CadastroNacionalEmpresasPunidasParams) (*Result, *CadastroNacionalEmpresasPunidasRetorno, error)

CadastroNacionalEmpresasPunidas queries CadastroNacionalEmpresasPunidas: CNEP - Cadastro Nacional de Empresas Punidas, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroNacionalEmpresasPunidas

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroNacionalImprobidadeAdministrativa 

func (c *Client) CadastroNacionalImprobidadeAdministrativa(ctx context.Context, m Meter, p CadastroNacionalImprobidadeAdministrativaParams) (*Result, *CadastroNacionalImprobidadeAdministrativaRetorno, error)

CadastroNacionalImprobidadeAdministrativa queries CadastroNacionalImprobidadeAdministrativa: CNIA - Cadastro Nacional de Condenações Cíveis por Ato de Improbidade Administrativa e Inelegibilidade, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroNacionalImprobidadeAdministrativa

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroPessoaFisica 

func (c *Client) CadastroPessoaFisica(ctx context.Context, m Meter, p CadastroPessoaFisicaParams) (*Result, *CadastroPessoaFisicaRetorno, error)

CadastroPessoaFisica queries CadastroPessoaFisica: Cadastro - Pessoa Física - Básica, list price R$ 0,16 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroPessoaFisica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroPessoaFisicaPlus 

func (c *Client) CadastroPessoaFisicaPlus(ctx context.Context, m Meter, p CadastroPessoaFisicaPlusParams) (*Result, *CadastroPessoaFisicaPlusRetorno, error)

CadastroPessoaFisicaPlus queries CadastroPessoaFisicaPlus: Cadastro - Pessoa Física - Plus, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroPessoaFisicaPlus

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroPessoaJuridica 

func (c *Client) CadastroPessoaJuridica(ctx context.Context, m Meter, p CadastroPessoaJuridicaParams) (*Result, *CadastroPessoaJuridicaRetorno, error)

CadastroPessoaJuridica queries CadastroPessoaJuridica: Cadastro - Pessoa Jurídica - Básica, list price R$ 0,16 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroPessoaJuridica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroPessoaJuridicaPlus 

func (c *Client) CadastroPessoaJuridicaPlus(ctx context.Context, m Meter, p CadastroPessoaJuridicaPlusParams) (*Result, *CadastroPessoaJuridicaPlusRetorno, error)

CadastroPessoaJuridicaPlus queries CadastroPessoaJuridicaPlus: Cadastro - Pessoa Jurídica - Plus, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroPessoaJuridicaPlus

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CadastroReceitaPessoaFisica 

func (c *Client) CadastroReceitaPessoaFisica(ctx context.Context, m Meter, p CadastroReceitaPessoaFisicaParams) (*Result, *CadastroReceitaPessoaFisicaRetorno, error)

CadastroReceitaPessoaFisica queries CadastroReceitaPessoaFisica: Cadastro + Receita Federal - Pessoa Física, list price R$ 0,42 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CadastroReceitaPessoaFisica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CaixaRegularidadeEmpregadorFGTS 

func (c *Client) CaixaRegularidadeEmpregadorFGTS(ctx context.Context, m Meter, p CaixaRegularidadeEmpregadorFGTSParams) (*Result, *CaixaRegularidadeEmpregadorFGTSRetorno, error)

CaixaRegularidadeEmpregadorFGTS queries CaixaRegularidadeEmpregadorFGTS: FGTS - Regularidade do Empregador, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CaixaRegularidadeEmpregadorFGTS

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CanadaSEMA 

func (c *Client) CanadaSEMA(ctx context.Context, m Meter, p CanadaSEMAParams) (*Result, *CanadaSEMARetorno, error)

CanadaSEMA queries CanadaSEMA: Canada SEMA - Sanções Internacionais, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CanadaSEMA

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CarteiraNacionalHabilitacao 

func (c *Client) CarteiraNacionalHabilitacao(ctx context.Context, m Meter, p CarteiraNacionalHabilitacaoParams) (*Result, *CarteiraNacionalHabilitacaoRetorno, error)

CarteiraNacionalHabilitacao queries CarteiraNacionalHabilitacao: CNH - Carteira Nacional de Habilitação, list price R$ 0,90 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CarteiraNacionalHabilitacao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CertidaoConjuntaDebitosPessoaFisica 

func (c *Client) CertidaoConjuntaDebitosPessoaFisica(ctx context.Context, m Meter, p CertidaoConjuntaDebitosPessoaFisicaParams) (*Result, *CertidaoConjuntaDebitosPessoaFisicaRetorno, error)

CertidaoConjuntaDebitosPessoaFisica queries CertidaoConjuntaDebitosPessoaFisica: CCD - Certidão Conjunta de Débitos - Pessoa Física, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CertidaoConjuntaDebitosPessoaFisica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CertidaoConjuntaDebitosPessoaJuridica 

func (c *Client) CertidaoConjuntaDebitosPessoaJuridica(ctx context.Context, m Meter, p CertidaoConjuntaDebitosPessoaJuridicaParams) (*Result, *CertidaoConjuntaDebitosPessoaJuridicaRetorno, error)

CertidaoConjuntaDebitosPessoaJuridica queries CertidaoConjuntaDebitosPessoaJuridica: CCD - Certidão Conjunta de Débitos - Pessoa Jurídica, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CertidaoConjuntaDebitosPessoaJuridica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CertidaoNegativaDebitos 

func (c *Client) CertidaoNegativaDebitos(ctx context.Context, m Meter, p CertidaoNegativaDebitosParams) (*Result, *CertidaoNegativaDebitosRetorno, error)

CertidaoNegativaDebitos queries CertidaoNegativaDebitos: CND - Certidão Negativa de Débitos Estaduais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CertidaoNegativaDebitos

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CertidaoNegativaDebitosImovelRural 

func (c *Client) CertidaoNegativaDebitosImovelRural(ctx context.Context, m Meter, p CertidaoNegativaDebitosImovelRuralParams) (*Result, *CertidaoNegativaDebitosImovelRuralRetorno, error)

CertidaoNegativaDebitosImovelRural queries CertidaoNegativaDebitosImovelRural: CNDIR - Certidão Negativa de Débitos e Dívida Ativa da União de Imóvel Rural, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CertidaoNegativaDebitosImovelRural

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CertidaoNegativaDebitosMunicipal 

func (c *Client) CertidaoNegativaDebitosMunicipal(ctx context.Context, m Meter, p CertidaoNegativaDebitosMunicipalParams) (*Result, *CertidaoNegativaDebitosMunicipalRetorno, error)

CertidaoNegativaDebitosMunicipal queries CertidaoNegativaDebitosMunicipal: CNDM - Certidão Negativa de Débitos Municipal, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CertidaoNegativaDebitosMunicipal

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CertidaoNegativaProcesso 

func (c *Client) CertidaoNegativaProcesso(ctx context.Context, m Meter, p CertidaoNegativaProcessoParams) (*Result, *CertidaoNegativaProcessoRetorno, error)

CertidaoNegativaProcesso queries CertidaoNegativaProcesso: TCU - Certidão Negativa de Processo, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CertidaoNegativaProcesso

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Check 

func (c *Client) Check(req Request) error

Check reports why a request would be refused before any request, reservation or lookup -- an unknown or disabled product, an invalid document, an undocumented parameter -- or nil. It costs nothing.

func (*Client) CnhPlus 

func (c *Client) CnhPlus(ctx context.Context, m Meter, p CnhPlusParams) (*Result, *CnhPlusRetorno, error)

CnhPlus queries CnhPlus: CNH - Carteira Nacional de Habilitação Plus, list price R$ 1,45 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CnhPlus

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CompleteAsync 

func (c *Client) CompleteAsync(ctx context.Context, l Ledger, t *Ticket, r *Result) error

CompleteAsync settles or releases the ticket's hold from the callback's result -- settled at the list price when the outcome is billable, released otherwise -- and closes the ticket. The result must carry the ticket's consultaUid.

func (*Client) ConsultaLeilaoVeicular 

func (c *Client) ConsultaLeilaoVeicular(ctx context.Context, m Meter, p ConsultaLeilaoVeicularParams) (*Result, *ConsultaLeilaoVeicularRetorno, error)

ConsultaLeilaoVeicular queries ConsultaLeilaoVeicular: Consulta Veicular - Leilão Veicular, list price R$ 12,00 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaLeilaoVeicular

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaSerproMultasRadar 

func (c *Client) ConsultaSerproMultasRadar(ctx context.Context, m Meter, p ConsultaSerproMultasRadarParams) (*Result, *ConsultaSerproMultasRadarRetorno, error)

ConsultaSerproMultasRadar queries ConsultaSerproMultasRadar: Consulta Veicular Serpro - Multas Radar, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaSerproMultasRadar

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicular 

func (c *Client) ConsultaVeicular(ctx context.Context, m Meter, p ConsultaVeicularParams) (*Result, *ConsultaVeicularRetorno, error)

ConsultaVeicular queries ConsultaVeicular: Consulta Veicular - Nacional, list price R$ 1,10 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicular

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularCrlvSP 

func (c *Client) ConsultaVeicularCrlvSP(ctx context.Context, m Meter, p ConsultaVeicularCrlvSPParams) (*Result, *ConsultaVeicularCrlvSPRetorno, error)

ConsultaVeicularCrlvSP queries ConsultaVeicularCrlvSP: Consulta Veicular - CRLV-e SP, list price R$ 12,00 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularCrlvSP

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularEstadual 

func (c *Client) ConsultaVeicularEstadual(ctx context.Context, m Meter, p ConsultaVeicularEstadualParams) (*Result, *ConsultaVeicularEstadualRetorno, error)

ConsultaVeicularEstadual queries ConsultaVeicularEstadual: Consulta Veicular - Estadual, list price R$ 1,90 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularEstadual

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularFipe 

func (c *Client) ConsultaVeicularFipe(ctx context.Context, m Meter, p ConsultaVeicularFipeParams) (*Result, *ConsultaVeicularFipeRetorno, error)

ConsultaVeicularFipe queries ConsultaVeicularFipe: Veículos - FIPE, list price R$ 3,89 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularFipe

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularFrotasNacional 

func (c *Client) ConsultaVeicularFrotasNacional(ctx context.Context, m Meter, p ConsultaVeicularFrotasNacionalParams) (*Result, *ConsultaVeicularFrotasNacionalRetorno, error)

ConsultaVeicularFrotasNacional queries ConsultaVeicularFrotasNacional: Consulta Veicular - Frotas Nacional, list price R$ 4,55 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularFrotasNacional

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularGravame 

func (c *Client) ConsultaVeicularGravame(ctx context.Context, m Meter, p ConsultaVeicularGravameParams) (*Result, *ConsultaVeicularGravameRetorno, error)

ConsultaVeicularGravame queries ConsultaVeicularGravame: Consulta Veicular - Gravame, list price R$ 1,80 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularGravame

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularHistoricoProprietarios 

func (c *Client) ConsultaVeicularHistoricoProprietarios(ctx context.Context, m Meter, p ConsultaVeicularHistoricoProprietariosParams) (*Result, *ConsultaVeicularHistoricoProprietariosRetorno, error)

ConsultaVeicularHistoricoProprietarios queries ConsultaVeicularHistoricoProprietarios: Consulta Veicular - Histórico de Proprietários, list price R$ 4,10 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularHistoricoProprietarios

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularProprietarioAtual 

func (c *Client) ConsultaVeicularProprietarioAtual(ctx context.Context, m Meter, p ConsultaVeicularProprietarioAtualParams) (*Result, *ConsultaVeicularProprietarioAtualRetorno, error)

ConsultaVeicularProprietarioAtual queries ConsultaVeicularProprietarioAtual: Consulta Veicular - Proprietário Atual, list price R$ 0,90 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularProprietarioAtual

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularRecall 

func (c *Client) ConsultaVeicularRecall(ctx context.Context, m Meter, p ConsultaVeicularRecallParams) (*Result, *ConsultaVeicularRecallRetorno, error)

ConsultaVeicularRecall queries ConsultaVeicularRecall: Consulta Veicular - Recall, list price R$ 1,20 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularRecall

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularRenainf 

func (c *Client) ConsultaVeicularRenainf(ctx context.Context, m Meter, p ConsultaVeicularRenainfParams) (*Result, *ConsultaVeicularRenainfRetorno, error)

ConsultaVeicularRenainf queries ConsultaVeicularRenainf: Consulta Veicular - Renainf, list price R$ 2,10 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularRenainf

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularRenajud 

func (c *Client) ConsultaVeicularRenajud(ctx context.Context, m Meter, p ConsultaVeicularRenajudParams) (*Result, *ConsultaVeicularRenajudRetorno, error)

ConsultaVeicularRenajud queries ConsultaVeicularRenajud: Consulta Veicular - Renajud, list price R$ 1,90 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularRenajud

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ConsultaVeicularRouboFurto 

func (c *Client) ConsultaVeicularRouboFurto(ctx context.Context, m Meter, p ConsultaVeicularRouboFurtoParams) (*Result, *ConsultaVeicularRouboFurtoRetorno, error)

ConsultaVeicularRouboFurto queries ConsultaVeicularRouboFurto: Consulta Veicular - Roubo e Furto, list price R$ 1,45 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ConsultaVeicularRouboFurto

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) CorreiosBuscaCEP 

func (c *Client) CorreiosBuscaCEP(ctx context.Context, m Meter, p CorreiosBuscaCEPParams) (*Result, *CorreiosBuscaCEPRetorno, error)

CorreiosBuscaCEP queries CorreiosBuscaCEP: Correios - Busca CEP, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/CorreiosBuscaCEP

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) DAPPessoaFisica 

func (c *Client) DAPPessoaFisica(ctx context.Context, m Meter, p DAPPessoaFisicaParams) (*Result, *DAPPessoaFisicaRetorno, error)

DAPPessoaFisica queries DAPPessoaFisica: DAP - Declaração de Aptidão ao Pronaf - Pessoa Física, list price R$ 0,72 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/DAPPessoaFisica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) DAPPessoaJuridica 

func (c *Client) DAPPessoaJuridica(ctx context.Context, m Meter, p DAPPessoaJuridicaParams) (*Result, *DAPPessoaJuridicaRetorno, error)

DAPPessoaJuridica queries DAPPessoaJuridica: DAP - Declaração de Aptidão ao Pronaf - Pessoa Jurídica, list price R$ 0,72 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/DAPPessoaJuridica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) DetalhamentoNegativo 

func (c *Client) DetalhamentoNegativo(ctx context.Context, m Meter, p DetalhamentoNegativoParams) (*Result, *DetalhamentoNegativoRetorno, error)

DetalhamentoNegativo queries DetalhamentoNegativo: Detalhamento Negativo QUOD, list price R$ 2,38 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/DetalhamentoNegativo

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) DossieCreditoCompleto 

func (c *Client) DossieCreditoCompleto(ctx context.Context, m Meter, p DossieCreditoCompletoParams) (*Result, *DossieCreditoCompletoRetorno, error)

DossieCreditoCompleto queries DossieCreditoCompleto: Dossiê QUOD - Completo, list price R$ 6,99 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/DossieCreditoCompleto

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) EUFinancialList 

func (c *Client) EUFinancialList(ctx context.Context, m Meter, p EUFinancialListParams) (*Result, *EUFinancialListRetorno, error)

EUFinancialList queries EUFinancialList: EU Financial Sanctions List, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/EUFinancialList

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) EnriquecimentoLead 

func (c *Client) EnriquecimentoLead(ctx context.Context, m Meter, p EnriquecimentoLeadParams) (*Result, *EnriquecimentoLeadRetorno, error)

EnriquecimentoLead queries EnriquecimentoLead: Enriquecimento de Lead, list price R$ 0,16 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/EnriquecimentoLead

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) FBIMostWanted 

func (c *Client) FBIMostWanted(ctx context.Context, m Meter, p FBIMostWantedParams) (*Result, *FBIMostWantedRetorno, error)

FBIMostWanted queries FBIMostWanted: FBI - Most Wanted, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/FBIMostWanted

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) FinCEN 

func (c *Client) FinCEN(ctx context.Context, m Meter, p FinCENParams) (*Result, *FinCENRetorno, error)

FinCEN queries FinCEN: FINCEN - Financial Crimes Enforcement Network, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/FinCEN

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) GarantiaSafra 

func (c *Client) GarantiaSafra(ctx context.Context, m Meter, p GarantiaSafraParams) (*Result, *GarantiaSafraRetorno, error)

GarantiaSafra queries GarantiaSafra: Garantia Safra, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/GarantiaSafra

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) GasDoPovo 

func (c *Client) GasDoPovo(ctx context.Context, m Meter, p GasDoPovoParams) (*Result, *GasDoPovoRetorno, error)

GasDoPovo queries GasDoPovo: Gás do Povo, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/GasDoPovo

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) HistoricoVeiculos 

func (c *Client) HistoricoVeiculos(ctx context.Context, m Meter, p HistoricoVeiculosParams) (*Result, *HistoricoVeiculosRetorno, error)

HistoricoVeiculos queries HistoricoVeiculos: Histórico Veicular PF e PJ - São Paulo, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/HistoricoVeiculos

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) HistoricoVeiculosNacional 

func (c *Client) HistoricoVeiculosNacional(ctx context.Context, m Meter, p HistoricoVeiculosNacionalParams) (*Result, *HistoricoVeiculosNacionalRetorno, error)

HistoricoVeiculosNacional queries HistoricoVeiculosNacional: Histórico Veicular PF e PJ - Nacional, list price R$ 1,80 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/HistoricoVeiculosNacional

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) IBAMACertidaoNegativaDebitos 

func (c *Client) IBAMACertidaoNegativaDebitos(ctx context.Context, m Meter, p IBAMACertidaoNegativaDebitosParams) (*Result, *IBAMACertidaoNegativaDebitosRetorno, error)

IBAMACertidaoNegativaDebitos queries IBAMACertidaoNegativaDebitos: IBAMA - Certidão Negativa de Débitos, list price R$ 0,36 per query. The source is queried at call time (origin Online). The documentation lists it as maintenance. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/IBAMACertidaoNegativaDebitos

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) IBAMACertidaoNegativaEmbargos 

func (c *Client) IBAMACertidaoNegativaEmbargos(ctx context.Context, m Meter, p IBAMACertidaoNegativaEmbargosParams) (*Result, *IBAMACertidaoNegativaEmbargosRetorno, error)

IBAMACertidaoNegativaEmbargos queries IBAMACertidaoNegativaEmbargos: IBAMA - Certidão Negativa de Embargo, list price R$ 0,36 per query. The source is queried at call time (origin Online). The documentation lists it as maintenance. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/IBAMACertidaoNegativaEmbargos

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) IBAMACertificadoRegularidade 

func (c *Client) IBAMACertificadoRegularidade(ctx context.Context, m Meter, p IBAMACertificadoRegularidadeParams) (*Result, *IBAMACertificadoRegularidadeRetorno, error)

IBAMACertificadoRegularidade queries IBAMACertificadoRegularidade: IBAMA - Certificado de Regularidade, list price R$ 0,36 per query. The source is queried at call time (origin Online). The documentation lists it as maintenance. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/IBAMACertificadoRegularidade

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) IBAMAConsultaAutuacoesAmbientais 

func (c *Client) IBAMAConsultaAutuacoesAmbientais(ctx context.Context, m Meter, p IBAMAConsultaAutuacoesAmbientaisParams) (*Result, *IBAMAConsultaAutuacoesAmbientaisRetorno, error)

IBAMAConsultaAutuacoesAmbientais queries IBAMAConsultaAutuacoesAmbientais: IBAMA - Consulta de Autuações Ambientais, list price R$ 0,36 per query. The source is queried at call time (origin Online). The documentation lists it as maintenance. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/IBAMAConsultaAutuacoesAmbientais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) IdentityVerificationArgentina 

func (c *Client) IdentityVerificationArgentina(ctx context.Context, m Meter, p IdentityVerificationArgentinaParams) (*Result, *IdentityVerificationArgentinaRetorno, error)

IdentityVerificationArgentina queries IdentityVerificationArgentina: Identity Verification - Argentina, list price R$ 0,72 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/IdentityVerificationArgentina

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Interpol 

func (c *Client) Interpol(ctx context.Context, m Meter, p InterpolParams) (*Result, *InterpolRetorno, error)

Interpol queries Interpol: INTERPOL, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/Interpol

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) MPFCertidaoNegativa 

func (c *Client) MPFCertidaoNegativa(ctx context.Context, m Meter, p MPFCertidaoNegativaParams) (*Result, *MPFCertidaoNegativaRetorno, error)

MPFCertidaoNegativa queries MPFCertidaoNegativa: Ministério Público Federal - Certidão Negativa, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/MPFCertidaoNegativa

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) MPMTMinisterioPublicoMatoGrosso 

func (c *Client) MPMTMinisterioPublicoMatoGrosso(ctx context.Context, m Meter, p MPMTMinisterioPublicoMatoGrossoParams) (*Result, *MPMTMinisterioPublicoMatoGrossoRetorno, error)

MPMTMinisterioPublicoMatoGrosso queries MPMTMinisterioPublicoMatoGrosso: Ministério Público do Estado de Mato Grosso (MPMT) - Procedimentos Investigatórios Extrajudiciais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/MPMTMinisterioPublicoMatoGrosso

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) MTEInfracoesTrabalhistas 

func (c *Client) MTEInfracoesTrabalhistas(ctx context.Context, m Meter, p MTEInfracoesTrabalhistasParams) (*Result, *MTEInfracoesTrabalhistasRetorno, error)

MTEInfracoesTrabalhistas queries MTEInfracoesTrabalhistas: Ministério do Trabalho e do Emprego (MTE) - Infrações Trabalhistas, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/MTEInfracoesTrabalhistas

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) MinisterioPublicoTrabalho 

func (c *Client) MinisterioPublicoTrabalho(ctx context.Context, m Meter, p MinisterioPublicoTrabalhoParams) (*Result, *MinisterioPublicoTrabalhoRetorno, error)

MinisterioPublicoTrabalho queries MinisterioPublicoTrabalho: MPT - Ministério Público do Trabalho, list price R$ 1,30 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/MinisterioPublicoTrabalho

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) MinisterioTrabalhoPIS 

func (c *Client) MinisterioTrabalhoPIS(ctx context.Context, m Meter, p MinisterioTrabalhoPISParams) (*Result, *MinisterioTrabalhoPISRetorno, error)

MinisterioTrabalhoPIS queries MinisterioTrabalhoPIS: Ministério do Trabalho - PIS, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/MinisterioTrabalhoPIS

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Name 

func (c *Client) Name() string

Name is the module identifier: a lowercase slug, stable, no spaces.

func (*Client) NivelSocioeconomico 

func (c *Client) NivelSocioeconomico(ctx context.Context, m Meter, p NivelSocioeconomicoParams) (*Result, *NivelSocioeconomicoRetorno, error)

NivelSocioeconomico queries nivelSocioeconomico: Nível Socioeconômico e Renda Estimada, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/nivelSocioeconomico

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) NotaFiscalEletronicaCompleta 

func (c *Client) NotaFiscalEletronicaCompleta(ctx context.Context, m Meter, p NotaFiscalEletronicaCompletaParams) (*Result, *NotaFiscalEletronicaCompletaRetorno, error)

NotaFiscalEletronicaCompleta queries NotaFiscalEletronicaCompleta: NFe - Nota Fiscal Eletrônica - Completa, list price R$ 1,30 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/NotaFiscalEletronicaCompleta

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) NotaFiscalEletronicaInutilizacao 

func (c *Client) NotaFiscalEletronicaInutilizacao(ctx context.Context, m Meter, p NotaFiscalEletronicaInutilizacaoParams) (*Result, *NotaFiscalEletronicaInutilizacaoRetorno, error)

NotaFiscalEletronicaInutilizacao queries NotaFiscalEletronicaInutilizacao: NFe - Nota Fiscal Eletrônica - Inutilizações, list price R$ 1,30 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/NotaFiscalEletronicaInutilizacao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) OABCadastroNacionalAdvogados 

func (c *Client) OABCadastroNacionalAdvogados(ctx context.Context, m Meter, p OABCadastroNacionalAdvogadosParams) (*Result, *OABCadastroNacionalAdvogadosRetorno, error)

OABCadastroNacionalAdvogados queries OABCadastroNacionalAdvogados: OAB - Cadastro Nacional dos Advogados, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/OABCadastroNacionalAdvogados

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) OFAC 

func (c *Client) OFAC(ctx context.Context, m Meter, p OFACParams) (*Result, *OFACRetorno, error)

OFAC queries OFAC: OFAC - Sanctions List (SND and Non-SDN), list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/OFAC

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Obito 

func (c *Client) Obito(ctx context.Context, m Meter, p ObitoParams) (*Result, *ObitoRetorno, error)

Obito queries Obito: Óbito, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/Obito

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) OffshoreLeaks 

func (c *Client) OffshoreLeaks(ctx context.Context, m Meter, p OffshoreLeaksParams) (*Result, *OffshoreLeaksRetorno, error)

OffshoreLeaks queries OffshoreLeaks: Offshore Leaks - ICIJ, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/OffshoreLeaks

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PEPParentescos 

func (c *Client) PEPParentescos(ctx context.Context, m Meter, p PEPParentescosParams) (*Result, *PEPParentescosRetorno, error)

PEPParentescos queries PEPParentescos: PEP Estendida - Pessoa Exposta Politicamente + Parentescos, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PEPParentescos

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PETITrabalhoInfantil 

func (c *Client) PETITrabalhoInfantil(ctx context.Context, m Meter, p PETITrabalhoInfantilParams) (*Result, *PETITrabalhoInfantilRetorno, error)

PETITrabalhoInfantil queries PETITrabalhoInfantil: PETI - Programa de Erradicação do Trabalho Infantil, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PETITrabalhoInfantil

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PGFNListaDevedoresUniao 

func (c *Client) PGFNListaDevedoresUniao(ctx context.Context, m Meter, p PGFNListaDevedoresUniaoParams) (*Result, *PGFNListaDevedoresUniaoRetorno, error)

PGFNListaDevedoresUniao queries PGFNListaDevedoresUniao: PGFN - Lista de Devedores da União, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PGFNListaDevedoresUniao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PRFInfracoes 

func (c *Client) PRFInfracoes(ctx context.Context, m Meter, p PRFInfracoesParams) (*Result, *PRFInfracoesRetorno, error)

PRFInfracoes queries PRFInfracoes: Polícia Rodoviária Federal - Infrações, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PRFInfracoes

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ParseCallback 

func (c *Client) ParseCallback(r CallbackRequest) (*Result, error)

ParseCallback verifies a callback with Config.CallbackVerifier and reads it into a Result marked Async. It refuses every callback when no verifier is configured. It settles nothing: CompleteAsync does, with the ticket.

func (*Client) PessoaExpostaPoliticamente 

func (c *Client) PessoaExpostaPoliticamente(ctx context.Context, m Meter, p PessoaExpostaPoliticamenteParams) (*Result, *PessoaExpostaPoliticamenteRetorno, error)

PessoaExpostaPoliticamente queries PessoaExpostaPoliticamente: PEP - Pessoa Exposta Politicamente, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PessoaExpostaPoliticamente

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PoliciaCivilAntecedentesCriminais 

func (c *Client) PoliciaCivilAntecedentesCriminais(ctx context.Context, m Meter, p PoliciaCivilAntecedentesCriminaisParams) (*Result, *PoliciaCivilAntecedentesCriminaisRetorno, error)

PoliciaCivilAntecedentesCriminais queries PoliciaCivilAntecedentesCriminais: Polícia Civil - Antecedentes Criminais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PoliciaCivilAntecedentesCriminais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PoliciaFederalAntecedentesCriminais 

func (c *Client) PoliciaFederalAntecedentesCriminais(ctx context.Context, m Meter, p PoliciaFederalAntecedentesCriminaisParams) (*Result, *PoliciaFederalAntecedentesCriminaisRetorno, error)

PoliciaFederalAntecedentesCriminais queries PoliciaFederalAntecedentesCriminais: Polícia Federal - Antecedentes Criminais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PoliciaFederalAntecedentesCriminais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PortalTransparenciaIndicadoresPessoaFisica 

func (c *Client) PortalTransparenciaIndicadoresPessoaFisica(ctx context.Context, m Meter, p PortalTransparenciaIndicadoresPessoaFisicaParams) (*Result, *PortalTransparenciaIndicadoresPessoaFisicaRetorno, error)

PortalTransparenciaIndicadoresPessoaFisica queries PortalTransparenciaIndicadoresPessoaFisica: Portal da Transparência - Indicadores Pessoa Física, list price R$ 1,30 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PortalTransparenciaIndicadoresPessoaFisica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PortalTransparenciaIndicadoresPessoaJuridica 

func (c *Client) PortalTransparenciaIndicadoresPessoaJuridica(ctx context.Context, m Meter, p PortalTransparenciaIndicadoresPessoaJuridicaParams) (*Result, *PortalTransparenciaIndicadoresPessoaJuridicaRetorno, error)

PortalTransparenciaIndicadoresPessoaJuridica queries PortalTransparenciaIndicadoresPessoaJuridica: Portal da Transparência - Indicadores Pessoa Jurídica, list price R$ 1,30 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PortalTransparenciaIndicadoresPessoaJuridica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PortalTransparenciaServidores 

func (c *Client) PortalTransparenciaServidores(ctx context.Context, m Meter, p PortalTransparenciaServidoresParams) (*Result, *PortalTransparenciaServidoresRetorno, error)

PortalTransparenciaServidores queries PortalTransparenciaServidores: Portal da Transparência - Servidores do Poder Executivo Federal, list price R$ 0,72 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PortalTransparenciaServidores

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PortalTransparenciaServidoresCompleta 

func (c *Client) PortalTransparenciaServidoresCompleta(ctx context.Context, m Meter, p PortalTransparenciaServidoresCompletaParams) (*Result, *PortalTransparenciaServidoresCompletaRetorno, error)

PortalTransparenciaServidoresCompleta queries PortalTransparenciaServidoresCompleta: Portal da Transparência - Servidores - Completa, list price R$ 2,30 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PortalTransparenciaServidoresCompleta

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PortalTransparenciaServidoresRemuneracao 

func (c *Client) PortalTransparenciaServidoresRemuneracao(ctx context.Context, m Meter, p PortalTransparenciaServidoresRemuneracaoParams) (*Result, *PortalTransparenciaServidoresRemuneracaoRetorno, error)

PortalTransparenciaServidoresRemuneracao queries PortalTransparenciaServidoresRemuneracao: Portal da Transparência - Servidores - Remuneração, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PortalTransparenciaServidoresRemuneracao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) PortalTransparenciaServidoresViagens 

func (c *Client) PortalTransparenciaServidoresViagens(ctx context.Context, m Meter, p PortalTransparenciaServidoresViagensParams) (*Result, *PortalTransparenciaServidoresViagensRetorno, error)

PortalTransparenciaServidoresViagens queries PortalTransparenciaServidoresViagens: Portal da Transparência - Servidores Viagens e despesas, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/PortalTransparenciaServidoresViagens

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ProcessosJudiciaisAgrupada 

func (c *Client) ProcessosJudiciaisAgrupada(ctx context.Context, m Meter, p ProcessosJudiciaisAgrupadaParams) (*Result, *ProcessosJudiciaisAgrupadaRetorno, error)

ProcessosJudiciaisAgrupada queries ProcessosJudiciaisAgrupada: Processos Judiciais - Agrupada (Base), list price R$ 1,10 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ProcessosJudiciaisAgrupada

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ProcessosJudiciaisCompleta 

func (c *Client) ProcessosJudiciaisCompleta(ctx context.Context, m Meter, p ProcessosJudiciaisCompletaParams) (*Result, *ProcessosJudiciaisCompletaRetorno, error)

ProcessosJudiciaisCompleta queries ProcessosJudiciaisCompleta: Processos Judiciais - Completa (Base), list price R$ 3,30 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ProcessosJudiciaisCompleta

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ProcessosJudiciaisSimplificada 

func (c *Client) ProcessosJudiciaisSimplificada(ctx context.Context, m Meter, p ProcessosJudiciaisSimplificadaParams) (*Result, *ProcessosJudiciaisSimplificadaRetorno, error)

ProcessosJudiciaisSimplificada queries ProcessosJudiciaisSimplificada: Processos Judiciais - Simplificada (Base), list price R$ 1,50 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ProcessosJudiciaisSimplificada

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Product 

func (c *Client) Product(slug string) (Product, bool)

Product returns the product with the slug, as the client uses it.

func (*Client) Products 

func (c *Client) Products() map[string]Product

Products returns every product the client knows, by slug. The map is a copy.

func (*Client) ProtestosNacionalBasica 

func (c *Client) ProtestosNacionalBasica(ctx context.Context, m Meter, p ProtestosNacionalBasicaParams) (*Result, *ProtestosNacionalBasicaRetorno, error)

ProtestosNacionalBasica queries ProtestosNacionalBasica: Protestos Nacional - IEPTB Básica, list price R$ 2,95 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ProtestosNacionalBasica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ProtestosOnline 

func (c *Client) ProtestosOnline(ctx context.Context, m Meter, p ProtestosOnlineParams) (*Result, *ProtestosOnlineRetorno, error)

ProtestosOnline queries ProtestosOnline: Protestos Nacional - IEPTB Online, list price R$ 3,50 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ProtestosOnline

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Query 

func (c *Client) Query(ctx context.Context, m Meter, req Request) (*Result, error)

Query makes one synchronous query and returns its result as evidence.

In order: the product and the document are checked (an invalid one is refused with ErrInvalidDocument before anything else); m.Dedupe may answer with a result remembered for the day, marked Cached, and no request is made; the circuit breaker may refuse with ErrUnavailable; m.Ledger holds the price, and a refusal (ErrBudgetExceeded) means no request; the request is made; the hold is settled when the outcome is billable and released otherwise; a billable result is remembered in m.Dedupe.

The error is non-nil when no answer could be read (transport, timeout) or the Ledger failed. A query Direct Data answered comes back with a nil error whatever its Outcome: not_found is an answer.

func (*Client) QueryAsync 

func (c *Client) QueryAsync(ctx context.Context, m Meter, req Request, opts AsyncOptions) (*Ticket, error)

QueryAsync submits a query in asynchronous mode (ASync=habilitar, which the documentation offers at no extra cost) and returns its ticket.

The checks, the Dedupe lookup aside, and the Ledger hold are those of Query. When Direct Data accepts the query to run in the background, the hold stays open and the ticket carries it; CompleteAsync settles or releases it when the callback arrives. When Direct Data answers or refuses at once, the hold is settled or released here and the ticket carries the Result.

func (*Client) ReceitaFederalPessoaFisica 

func (c *Client) ReceitaFederalPessoaFisica(ctx context.Context, m Meter, p ReceitaFederalPessoaFisicaParams) (*Result, *ReceitaFederalPessoaFisicaRetorno, error)

ReceitaFederalPessoaFisica queries ReceitaFederalPessoaFisica: Receita Federal - Pessoa Física, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ReceitaFederalPessoaFisica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ReceitaFederalPessoaJuridica 

func (c *Client) ReceitaFederalPessoaJuridica(ctx context.Context, m Meter, p ReceitaFederalPessoaJuridicaParams) (*Result, *ReceitaFederalPessoaJuridicaRetorno, error)

ReceitaFederalPessoaJuridica queries ReceitaFederalPessoaJuridica: Receita Federal - Pessoa Jurídica, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ReceitaFederalPessoaJuridica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) ReceitaPJParticipacaoSocietaria 

func (c *Client) ReceitaPJParticipacaoSocietaria(ctx context.Context, m Meter, p ReceitaPJParticipacaoSocietariaParams) (*Result, *ReceitaPJParticipacaoSocietariaRetorno, error)

ReceitaPJParticipacaoSocietaria queries ReceitaPJParticipacaoSocietaria: Receita Federal - Pessoa Jurídica - QSA + Participação Societária, list price R$ 2,80 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/ReceitaPJParticipacaoSocietaria

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) RegistrationDataArgentina 

func (c *Client) RegistrationDataArgentina(ctx context.Context, m Meter, p RegistrationDataArgentinaParams) (*Result, *RegistrationDataArgentinaRetorno, error)

RegistrationDataArgentina queries RegistrationDataArgentina: Registration Data - Argentina, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/RegistrationDataArgentina

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) RegistrationDataBrazil 

func (c *Client) RegistrationDataBrazil(ctx context.Context, m Meter, p RegistrationDataBrazilParams) (*Result, *RegistrationDataBrazilRetorno, error)

RegistrationDataBrazil queries RegistrationDataBrazil: Registration Data - Brazil, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/RegistrationDataBrazil

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) RegistrationDataMexico 

func (c *Client) RegistrationDataMexico(ctx context.Context, m Meter, p RegistrationDataMexicoParams) (*Result, *RegistrationDataMexicoRetorno, error)

RegistrationDataMexico queries RegistrationDataMexico: Registration Data - México, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/RegistrationDataMexico

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) RestituicaoIRPF 

func (c *Client) RestituicaoIRPF(ctx context.Context, m Meter, p RestituicaoIRPFParams) (*Result, *RestituicaoIRPFRetorno, error)

RestituicaoIRPF queries RestituicaoIRPF: Restituição Imposto de Renda - IRPF, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/RestituicaoIRPF

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Routes 

func (c *Client) Routes(*fhttp.Router)

Routes registers nothing.

A query costs money and returns personal data, so it is made through the application's own controllers, behind its Grants and Policies, with a Meter bound to the tenant the Grant names. A route here would query any document for anybody who sent one, on the application's balance. The asynchronous callback is the application's route too: it calls ParseCallback and CompleteAsync.

func (*Client) SCRBacen 

func (c *Client) SCRBacen(ctx context.Context, m Meter, p SCRBacenParams) (*Result, *SCRBacenRetorno, error)

SCRBacen queries SCRBacen: SCR Analítico - Resumo BACEN, list price R$ 3,90 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SCRBacen

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SCRBacenDetalhada 

func (c *Client) SCRBacenDetalhada(ctx context.Context, m Meter, p SCRBacenDetalhadaParams) (*Result, *SCRBacenDetalhadaRetorno, error)

SCRBacenDetalhada queries SCRBacenDetalhada: SCR Detalhada - Resumo BACEN, list price R$ 4,90 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SCRBacenDetalhada

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) STMCertidaoNegativauniao 

func (c *Client) STMCertidaoNegativauniao(ctx context.Context, m Meter, p STMCertidaoNegativauniaoParams) (*Result, *STMCertidaoNegativauniaoRetorno, error)

STMCertidaoNegativauniao queries STMCertidaoNegativauniao: STM - Certidão Negativa da União, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/STMCertidaoNegativauniao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Score 

func (c *Client) Score(ctx context.Context, m Meter, p ScoreParams) (*Result, *ScoreRetorno, error)

Score queries Score: Score de Crédito - QUOD, list price R$ 1,98 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/Score

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SeguroDefeso 

func (c *Client) SeguroDefeso(ctx context.Context, m Meter, p SeguroDefesoParams) (*Result, *SeguroDefesoRetorno, error)

SeguroDefeso queries SeguroDefeso: Seguro Defeso, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SeguroDefeso

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Similarity 

func (c *Client) Similarity(ctx context.Context, m Meter, p SimilarityParams) (*Result, *SimilarityRetorno, error)

Similarity queries Similarity: Similarity - Brazil, list price R$ 0,72 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/Similarity

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SimilarityArgentina 

func (c *Client) SimilarityArgentina(ctx context.Context, m Meter, p SimilarityArgentinaParams) (*Result, *SimilarityArgentinaRetorno, error)

SimilarityArgentina queries SimilarityArgentina: Similarity - Argentina, list price R$ 0,72 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SimilarityArgentina

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SimilarityMexico 

func (c *Client) SimilarityMexico(ctx context.Context, m Meter, p SimilarityMexicoParams) (*Result, *SimilarityMexicoRetorno, error)

SimilarityMexico queries SimilarityMexico: Similarity - México, list price R$ 0,72 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SimilarityMexico

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SimplesNacional 

func (c *Client) SimplesNacional(ctx context.Context, m Meter, p SimplesNacionalParams) (*Result, *SimplesNacionalRetorno, error)

SimplesNacional queries SimplesNacional: Simples Nacional, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SimplesNacional

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) Sintegra 

func (c *Client) Sintegra(ctx context.Context, m Meter, p SintegraParams) (*Result, *SintegraRetorno, error)

Sintegra queries Sintegra: Sintegra - Cadastros Estaduais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/Sintegra

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SintegraCCC 

func (c *Client) SintegraCCC(ctx context.Context, m Meter, p SintegraCCCParams) (*Result, *SintegraCCCRetorno, error)

SintegraCCC queries SintegraCCC: Sintegra - Cadastro Centralizado de Contribuinte - CCC, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SintegraCCC

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SintegraCCCCompleta 

func (c *Client) SintegraCCCCompleta(ctx context.Context, m Meter, p SintegraCCCCompletaParams) (*Result, *SintegraCCCCompletaRetorno, error)

SintegraCCCCompleta queries SintegraCCC-Completa: Sintegra - CCC - Completa, list price R$ 1,80 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SintegraCCC-Completa

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SituacaoEleitoral 

func (c *Client) SituacaoEleitoral(ctx context.Context, m Meter, p SituacaoEleitoralParams) (*Result, *SituacaoEleitoralRetorno, error)

SituacaoEleitoral queries SituacaoEleitoral: TSE - Situação Eleitoral, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SituacaoEleitoral

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SuframaCNPJ 

func (c *Client) SuframaCNPJ(ctx context.Context, m Meter, p SuframaCNPJParams) (*Result, *SuframaCNPJRetorno, error)

SuframaCNPJ queries SuframaCNPJ: Suframa - CNPJ, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SuframaCNPJ

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) SuicaSECO 

func (c *Client) SuicaSECO(ctx context.Context, m Meter, p SuicaSECOParams) (*Result, *SuicaSECORetorno, error)

SuicaSECO queries SuicaSECO: Suíça SECO - Sanções Internacionais, list price R$ 0,36 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/SuicaSECO

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TCUCertidaoNegativaLicitanteInidoneo 

func (c *Client) TCUCertidaoNegativaLicitanteInidoneo(ctx context.Context, m Meter, p TCUCertidaoNegativaLicitanteInidoneoParams) (*Result, *TCUCertidaoNegativaLicitanteInidoneoRetorno, error)

TCUCertidaoNegativaLicitanteInidoneo queries TCUCertidaoNegativaLicitanteInidoneo: TCU - Certidão Negativa de Licitante Inidôneo, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TCUCertidaoNegativaLicitanteInidoneo

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TCUConsultaConsolidadaPessoaJuridica 

func (c *Client) TCUConsultaConsolidadaPessoaJuridica(ctx context.Context, m Meter, p TCUConsultaConsolidadaPessoaJuridicaParams) (*Result, *TCUConsultaConsolidadaPessoaJuridicaRetorno, error)

TCUConsultaConsolidadaPessoaJuridica queries TCUConsultaConsolidadaPessoaJuridica: TCU - Consulta Consolidada de Pessoa Jurídica - APF, list price R$ 0,72 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TCUConsultaConsolidadaPessoaJuridica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TJCertidaoCivelCriminalFiscal 

func (c *Client) TJCertidaoCivelCriminalFiscal(ctx context.Context, m Meter, p TJCertidaoCivelCriminalFiscalParams) (*Result, *TJCertidaoCivelCriminalFiscalRetorno, error)

TJCertidaoCivelCriminalFiscal queries TJCertidaoCivelCriminalFiscal: TJ - Certidão Cível, Criminal e Fiscal - Tribunal de Justiça, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TJCertidaoCivelCriminalFiscal

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TSECertidaoCrimesEleitorais 

func (c *Client) TSECertidaoCrimesEleitorais(ctx context.Context, m Meter, p TSECertidaoCrimesEleitoraisParams) (*Result, *TSECertidaoCrimesEleitoraisRetorno, error)

TSECertidaoCrimesEleitorais queries TSECertidaoCrimesEleitorais: TSE - Certidão de Crimes Eleitorais, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TSECertidaoCrimesEleitorais

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TSECertidaodeQuitacaoEleitoral 

func (c *Client) TSECertidaodeQuitacaoEleitoral(ctx context.Context, m Meter, p TSECertidaodeQuitacaoEleitoralParams) (*Result, *TSECertidaodeQuitacaoEleitoralRetorno, error)

TSECertidaodeQuitacaoEleitoral queries TSECertidaodeQuitacaoEleitoral: TSE - Certidão de Quitação Eleitoral, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TSECertidaodeQuitacaoEleitoral

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TSTCertidaoNegativaDebitosTrabalhistas 

func (c *Client) TSTCertidaoNegativaDebitosTrabalhistas(ctx context.Context, m Meter, p TSTCertidaoNegativaDebitosTrabalhistasParams) (*Result, *TSTCertidaoNegativaDebitosTrabalhistasRetorno, error)

TSTCertidaoNegativaDebitosTrabalhistas queries TSTCertidaoNegativaDebitosTrabalhistas: TST - Certidão Negativa de Débitos Trabalhistas, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TSTCertidaoNegativaDebitosTrabalhistas

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TituloLocalVotacao 

func (c *Client) TituloLocalVotacao(ctx context.Context, m Meter, p TituloLocalVotacaoParams) (*Result, *TituloLocalVotacaoRetorno, error)

TituloLocalVotacao queries TituloLocalVotacao: TSE - Título e Local de Votação, list price R$ 0,72 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TituloLocalVotacao

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TribunalJustica 

func (c *Client) TribunalJustica(ctx context.Context, m Meter, p TribunalJusticaParams) (*Result, *TribunalJusticaRetorno, error)

TribunalJustica queries TribunalJustica: TJ - Tribunal de Justiça - Processos, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TribunalJustica

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TribunalRegionalFederal 

func (c *Client) TribunalRegionalFederal(ctx context.Context, m Meter, p TribunalRegionalFederalParams) (*Result, *TribunalRegionalFederalRetorno, error)

TribunalRegionalFederal queries TribunalRegionalFederal: TRF - Tribunal Regional Federal (Certidão Cível, Eleitoral ou Criminal), list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TribunalRegionalFederal

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) TribunalRegionalTrabalho 

func (c *Client) TribunalRegionalTrabalho(ctx context.Context, m Meter, p TribunalRegionalTrabalhoParams) (*Result, *TribunalRegionalTrabalhoRetorno, error)

TribunalRegionalTrabalho queries TribunalRegionalTrabalho: TRT - Tribunal Regional do Trabalho, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/TribunalRegionalTrabalho

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) UKHmTreasury 

func (c *Client) UKHmTreasury(ctx context.Context, m Meter, p UKHmTreasuryParams) (*Result, *UKHmTreasuryRetorno, error)

UKHmTreasury queries UKHmTreasury: UK Hm Treasury - Financial Sanctions, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/UKHmTreasury

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) UnitedNationsSecurityList 

func (c *Client) UnitedNationsSecurityList(ctx context.Context, m Meter, p UnitedNationsSecurityListParams) (*Result, *UnitedNationsSecurityListRetorno, error)

UnitedNationsSecurityList queries UnitedNationsSecurityList: UNSCCL - United Nations Security Council Consolidated List, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/UnitedNationsSecurityList

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) VerificacaoEmpregadorTrabalhoForcado 

func (c *Client) VerificacaoEmpregadorTrabalhoForcado(ctx context.Context, m Meter, p VerificacaoEmpregadorTrabalhoForcadoParams) (*Result, *VerificacaoEmpregadorTrabalhoForcadoRetorno, error)

VerificacaoEmpregadorTrabalhoForcado queries VerificacaoEmpregadorTrabalhoForcado: Verificação de Empregador - Trabalho Forçado, list price R$ 0,36 per query. The source is queried at call time (origin Online). Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/VerificacaoEmpregadorTrabalhoForcado

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) VinculoEmpregaticio 

func (c *Client) VinculoEmpregaticio(ctx context.Context, m Meter, p VinculoEmpregaticioParams) (*Result, *VinculoEmpregaticioRetorno, error)

VinculoEmpregaticio queries VinculoEmpregaticio: Vínculo Empregatício, list price R$ 0,72 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/VinculoEmpregaticio

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

func (*Client) VinculosSocietarios 

func (c *Client) VinculosSocietarios(ctx context.Context, m Meter, p VinculosSocietariosParams) (*Result, *VinculosSocietariosRetorno, error)

VinculosSocietarios queries VinculosSocietarios: Vínculos Societários, list price R$ 1,84 per query. Documentation: https://directd.com.br/central-de-ajuda/apis/catalogo/VinculosSocietarios

The data is the Result's Data, typed; it is nil when the answer carried no retorno or it did not decode (Result.DataError says why).

type CnhPlusParams 

type CnhPlusParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

CnhPlusParams are the parameters of CnhPlus (CNH - Carteira Nacional de Habilitação Plus).

func (CnhPlusParams) Request 

func (p CnhPlusParams) Request() (Request, error)

Request builds the Request for CnhPlus.

type CnhPlusRetorno 

type CnhPlusRetorno struct {
	// Bloqueios is retorno.bloqueios, a list.
	Bloqueios []CnhPlusRetornoBloqueios `json:"bloqueios"`
	// Categoria is retorno.categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataPrimeiraCNH is retorno.dataPrimeiraCNH, documented as a string.
	DataPrimeiraCNH Text `json:"dataPrimeiraCNH"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// NomePai is retorno.nomePai, documented as a string.
	NomePai Text `json:"nomePai" pii:"name"`
	// NumeroCNH is retorno.numeroCNH, documented as a string.
	NumeroCNH Text `json:"numeroCNH"`
	// NumeroRegistro is retorno.numeroRegistro, documented as a string.
	NumeroRegistro Text `json:"numeroRegistro"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// OrgaoEmissorRG is retorno.orgaoEmissorRG, documented as a string.
	OrgaoEmissorRG Text `json:"orgaoEmissorRG"`
	// QuantidadeDebitos is retorno.quantidadeDebitos, documented as a number.
	QuantidadeDebitos Number `json:"quantidadeDebitos"`
	// Renach is retorno.renach, documented as a string.
	Renach Text `json:"renach"`
	// Rg is retorno.rg, documented as a string.
	Rg Text `json:"rg" pii:"document"`
	// TiposDebito is retorno.tiposDebito, a list.
	TiposDebito []CnhPlusRetornoTiposDebito `json:"tiposDebito"`
	// Ufrg is retorno.ufrg, documented as a string.
	Ufrg Text `json:"ufrg"`
}

CnhPlusRetorno is retorno in the answer of CnhPlus.

type CnhPlusRetornoBloqueios 

type CnhPlusRetornoBloqueios struct {
	// Data is retorno.bloqueios[].data, documented as a string.
	Data Text `json:"data"`
	// DataFimPenalidade is retorno.bloqueios[].dataFimPenalidade, documented as a string.
	DataFimPenalidade Text `json:"dataFimPenalidade"`
	// DataInicioPenalidade is retorno.bloqueios[].dataInicioPenalidade, documented as a string.
	DataInicioPenalidade Text `json:"dataInicioPenalidade"`
	// Descricao is retorno.bloqueios[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// DiasPenalidade is retorno.bloqueios[].diasPenalidade, documented as a string.
	DiasPenalidade Text `json:"diasPenalidade"`
	// Uf is retorno.bloqueios[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CnhPlusRetornoBloqueios is retorno.bloqueios[] in the answer of CnhPlus.

type CnhPlusRetornoTiposDebito 

type CnhPlusRetornoTiposDebito struct {
	// IdRegistro is retorno.tiposDebito[].idRegistro, documented as a string.
	IdRegistro Text `json:"idRegistro"`
	// Placa is retorno.tiposDebito[].placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
}

CnhPlusRetornoTiposDebito is retorno.tiposDebito[] in the answer of CnhPlus.

type Config 

type Config struct {
	// BaseURL is the API host. Default DefaultBaseURL. It must be https,
	// except on a loopback address, which is what a test double listens on.
	BaseURL string
	// Token is the API token, sent as the TOKEN query parameter, as the
	// documentation's introduction says. Required.
	Token Token
	// HTTPClient makes the requests. Default a new http.Client. The client
	// copies it and refuses every redirect, so the token in the URL never
	// travels to another address.
	HTTPClient *http.Client
	// Timeout bounds one request, on top of the context's own deadline.
	// Default DefaultTimeout.
	Timeout time.Duration
	// Products overrides or adds products by slug over DefaultProducts: a
	// contract price, a disabled API, an API published after the catalogue.
	Products map[string]Product
	// Breaker configures the circuit breaker.
	Breaker BreakerConfig
	// Location is where a day begins and ends for Dedupe, since Direct Data
	// bills a same-day repeat. Default UTC-3 (Brasília).
	Location *time.Location
	// Logger receives one record per call, with the product, the masked
	// document, the outcome, the HTTP status, the elapsed time and the
	// consultaUid. Never the token, the URL or a response value. Default: no
	// logging.
	Logger *slog.Logger
	// ResultCodes maps metaDados.resultadoId values to outcomes. The public
	// documentation lists none, so it is empty by default; the application
	// fills it from what it observes.
	ResultCodes map[int]Outcome
	// CallbackVerifier authenticates an asynchronous callback before
	// ParseCallback reads it. The documentation does not say how Direct Data
	// authenticates callbacks, so without one ParseCallback refuses every
	// callback.
	CallbackVerifier CallbackVerifier
	// CallbackURLParam is the query parameter that carries a per-request
	// callback URL. The documentation names none -- the callback appears to be
	// configured in the portal -- so it is empty by default and
	// AsyncOptions.CallbackURL is refused while it is.
	CallbackURLParam string
	// MaxBodyBytes bounds the answer the client reads. Default
	// DefaultMaxBodyBytes.
	MaxBodyBytes int64
	// Now is the clock. Default time.Now.
	Now func() time.Time
}

Config is what the application passes when it wires this package.

Every value comes from the application's own typed configuration. This package reads no environment variable and no file. A field left at its zero value takes the default named beside it.

func (Config) LogValue 

func (c Config) LogValue() slog.Value

LogValue writes the configuration without the token.

func (Config) Validate 

func (c Config) Validate() error

Validate reports what the configuration cannot be used with. New calls it, so a setting that cannot work fails where it is wired.

func (Config) WithDefaults 

func (c Config) WithDefaults() Config

WithDefaults returns the configuration with every zero field set to its default. It does not validate.

type ConsultaLeilaoVeicularParams 

type ConsultaLeilaoVeicularParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
	// Chassi is sent as Chassi. O parâmetro CHASSI pode ser enviado com ou sem formatação.
	Chassi string
}

ConsultaLeilaoVeicularParams are the parameters of ConsultaLeilaoVeicular (Consulta Veicular - Leilão Veicular).

func (ConsultaLeilaoVeicularParams) Request 

func (p ConsultaLeilaoVeicularParams) Request() (Request, error)

Request builds the Request for ConsultaLeilaoVeicular.

type ConsultaLeilaoVeicularRetorno 

type ConsultaLeilaoVeicularRetorno struct {
	// AnaliseRisco is retorno.analiseRisco, documented as a string.
	AnaliseRisco Text `json:"analiseRisco"`
	// AnoFabricacaoModelo is retorno.anoFabricacaoModelo, documented as a string.
	AnoFabricacaoModelo Text `json:"anoFabricacaoModelo"`
	// Chassi is retorno.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// Cor is retorno.cor, documented as a string.
	Cor Text `json:"cor"`
	// MarcaModelo is retorno.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// PossuiRegistro is retorno.possuiRegistro, documented as a boolean.
	PossuiRegistro Flag `json:"possuiRegistro"`
	// Registros is retorno.registros, a list.
	Registros []ConsultaLeilaoVeicularRetornoRegistros `json:"registros"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TotalRegistros is retorno.totalRegistros, documented as a number.
	TotalRegistros Number `json:"totalRegistros"`
}

ConsultaLeilaoVeicularRetorno is retorno in the answer of ConsultaLeilaoVeicular.

type ConsultaLeilaoVeicularRetornoRegistros 

type ConsultaLeilaoVeicularRetornoRegistros struct {
	// Classificacao is retorno.registros[].classificacao, documented as a string.
	Classificacao Text `json:"classificacao"`
	// Comitente is retorno.registros[].comitente, documented as a string.
	Comitente Text `json:"comitente"`
	// DataLeilao is retorno.registros[].dataLeilao, documented as a string.
	DataLeilao Text `json:"dataLeilao"`
	// Leiloeiro is retorno.registros[].leiloeiro, documented as a string.
	Leiloeiro Text `json:"leiloeiro"`
	// Lote is retorno.registros[].lote, documented as a string.
	Lote Text `json:"lote"`
	// Patio is retorno.registros[].patio, documented as a string.
	Patio Text `json:"patio"`
}

ConsultaLeilaoVeicularRetornoRegistros is retorno.registros[] in the answer of ConsultaLeilaoVeicular.

type ConsultaSerproMultasRadarParams 

type ConsultaSerproMultasRadarParams struct {
	// Placa is sent as Placa. Named by the endpoint template only; the parameter table does not list it.
	Placa string
	// Renavam is sent as Renavam. Named by the endpoint template only; the parameter table does not list it.
	Renavam string
}

ConsultaSerproMultasRadarParams are the parameters of ConsultaSerproMultasRadar (Consulta Veicular Serpro - Multas Radar).

func (ConsultaSerproMultasRadarParams) Request 

func (p ConsultaSerproMultasRadarParams) Request() (Request, error)

Request builds the Request for ConsultaSerproMultasRadar.

type ConsultaSerproMultasRadarRetorno 

type ConsultaSerproMultasRadarRetorno struct {
	// DocumentoProprietario is retorno.documentoProprietario, documented as a string.
	DocumentoProprietario Text `json:"documentoProprietario"`
	// Infracoes is retorno.infracoes, a list.
	Infracoes []ConsultaSerproMultasRadarRetornoInfracoes `json:"infracoes"`
	// MarcaModelo is retorno.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// NomeProprietario is retorno.nomeProprietario, documented as a string.
	NomeProprietario Text `json:"nomeProprietario" pii:"name"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// QuantidadeInfracoes is retorno.quantidadeInfracoes, documented as a number.
	QuantidadeInfracoes Number `json:"quantidadeInfracoes"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaSerproMultasRadarRetorno is retorno in the answer of ConsultaSerproMultasRadar.

type ConsultaSerproMultasRadarRetornoInfracoes 

type ConsultaSerproMultasRadarRetornoInfracoes struct {
	// DataInfracao is retorno.infracoes[].dataInfracao, documented as a string.
	DataInfracao Text `json:"dataInfracao"`
	// DescricaoInfracao is retorno.infracoes[].descricaoInfracao, documented as a string.
	DescricaoInfracao Text `json:"descricaoInfracao"`
	// Detalhes is retorno.infracoes[].detalhes.
	Detalhes ConsultaSerproMultasRadarRetornoInfracoesDetalhes `json:"detalhes"`
	// Situacao is retorno.infracoes[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
}

ConsultaSerproMultasRadarRetornoInfracoes is retorno.infracoes[] in the answer of ConsultaSerproMultasRadar.

type ConsultaSerproMultasRadarRetornoInfracoesDetalhes 

type ConsultaSerproMultasRadarRetornoInfracoesDetalhes struct {
	// AmparoLegal is retorno.infracoes[].detalhes.amparoLegal, documented as a string.
	AmparoLegal Text `json:"amparoLegal"`
	// CodigoRenainf is retorno.infracoes[].detalhes.codigoRenainf, documented as a string.
	CodigoRenainf Text `json:"codigoRenainf"`
	// DataHora is retorno.infracoes[].detalhes.dataHora, documented as a string.
	DataHora Text `json:"dataHora"`
	// Descricao is retorno.infracoes[].detalhes.descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Gravidade is retorno.infracoes[].detalhes.gravidade, documented as a string.
	Gravidade Text `json:"gravidade"`
	// Infracao is retorno.infracoes[].detalhes.infracao, documented as a string.
	Infracao Text `json:"infracao"`
	// LimitePermitido is retorno.infracoes[].detalhes.limitePermitido, documented as a string.
	LimitePermitido Text `json:"limitePermitido"`
	// Local is retorno.infracoes[].detalhes.local, documented as a string.
	Local Text `json:"local"`
	// MarcaModelo is retorno.infracoes[].detalhes.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// MedicaoConsiderada is retorno.infracoes[].detalhes.medicaoConsiderada, documented as a string.
	MedicaoConsiderada Text `json:"medicaoConsiderada"`
	// MedicaoReal is retorno.infracoes[].detalhes.medicaoReal, documented as a string.
	MedicaoReal Text `json:"medicaoReal"`
	// Municipio is retorno.infracoes[].detalhes.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroAutoInfracao is retorno.infracoes[].detalhes.numeroAutoInfracao, documented as a string.
	NumeroAutoInfracao Text `json:"numeroAutoInfracao"`
	// Observacoes is retorno.infracoes[].detalhes.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// OrgaoAutuador is retorno.infracoes[].detalhes.orgaoAutuador, documented as a string.
	OrgaoAutuador Text `json:"orgaoAutuador"`
	// Placa is retorno.infracoes[].detalhes.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Pontos is retorno.infracoes[].detalhes.pontos, documented as a number.
	Pontos Number `json:"pontos"`
	// Uf is retorno.infracoes[].detalhes.uf, documented as a string.
	Uf Text `json:"uf"`
	// UfCometimento is retorno.infracoes[].detalhes.ufCometimento, documented as a string.
	UfCometimento Text `json:"ufCometimento"`
	// UnidadeMedida is retorno.infracoes[].detalhes.unidadeMedida, documented as a string.
	UnidadeMedida Text `json:"unidadeMedida"`
	// Valor is retorno.infracoes[].detalhes.valor, documented as a string.
	Valor Text `json:"valor"`
}

ConsultaSerproMultasRadarRetornoInfracoesDetalhes is retorno.infracoes[].detalhes in the answer of ConsultaSerproMultasRadar.

type ConsultaVeicularCrlvSPParams 

type ConsultaVeicularCrlvSPParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

ConsultaVeicularCrlvSPParams are the parameters of ConsultaVeicularCrlvSP (Consulta Veicular - CRLV-e SP).

func (ConsultaVeicularCrlvSPParams) Request 

func (p ConsultaVeicularCrlvSPParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularCrlvSP.

type ConsultaVeicularCrlvSPRetorno 

type ConsultaVeicularCrlvSPRetorno struct {
	// AnoFabricacao is retorno.anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// Chassi is retorno.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// Cidade is retorno.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Combustivel is retorno.combustivel, documented as a string.
	Combustivel Text `json:"combustivel"`
	// Cor is retorno.cor, documented as a string.
	Cor Text `json:"cor"`
	// MarcaModelo is retorno.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularCrlvSPRetorno is retorno in the answer of ConsultaVeicularCrlvSP.

type ConsultaVeicularEstadualParams 

type ConsultaVeicularEstadualParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
	// Chassi is sent as Chassi. O parâmetro CHASSI pode ser enviado com ou sem formatação.
	Chassi string
}

ConsultaVeicularEstadualParams are the parameters of ConsultaVeicularEstadual (Consulta Veicular - Estadual).

func (ConsultaVeicularEstadualParams) Request 

func (p ConsultaVeicularEstadualParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularEstadual.

type ConsultaVeicularEstadualRetorno 

type ConsultaVeicularEstadualRetorno struct {
	// Chassi is retorno.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// ComunicacaoVenda is retorno.comunicacaoVenda.
	ComunicacaoVenda ConsultaVeicularEstadualRetornoComunicacaoVenda `json:"comunicacaoVenda"`
	// DataEmissaoCrv is retorno.dataEmissaoCrv, documented as a string.
	DataEmissaoCrv Text `json:"dataEmissaoCrv"`
	// Debitos is retorno.debitos.
	Debitos ConsultaVeicularEstadualRetornoDebitos `json:"debitos"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// LicenciamentoData is retorno.licenciamentoData, documented as a string.
	LicenciamentoData Text `json:"licenciamentoData"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NomeRazaoSocial is retorno.nomeRazaoSocial, documented as a string.
	NomeRazaoSocial Text `json:"nomeRazaoSocial" pii:"name"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// Restricoes is retorno.restricoes.
	Restricoes ConsultaVeicularEstadualRetornoRestricoes `json:"restricoes"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoDocumento is retorno.tipoDocumento, documented as a string.
	TipoDocumento Text `json:"tipoDocumento"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Veiculo is retorno.veiculo.
	Veiculo ConsultaVeicularEstadualRetornoVeiculo `json:"veiculo"`
}

ConsultaVeicularEstadualRetorno is retorno in the answer of ConsultaVeicularEstadual.

type ConsultaVeicularEstadualRetornoComunicacaoVenda 

type ConsultaVeicularEstadualRetornoComunicacaoVenda struct {
	// DataInclusao is retorno.comunicacaoVenda.dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataVenda is retorno.comunicacaoVenda.dataVenda, documented as a string.
	DataVenda Text `json:"dataVenda"`
	// DocumentoComprador is retorno.comunicacaoVenda.documentoComprador, documented as a string.
	DocumentoComprador Text `json:"documentoComprador"`
	// NumeroIdentificacaoFaturado is retorno.comunicacaoVenda.numeroIdentificacaoFaturado, documented as a string.
	NumeroIdentificacaoFaturado Text `json:"numeroIdentificacaoFaturado"`
	// ProprietarioAnterior is retorno.comunicacaoVenda.proprietarioAnterior, documented as a string.
	ProprietarioAnterior Text `json:"proprietarioAnterior"`
	// Situacao is retorno.comunicacaoVenda.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoDocumentoComprador is retorno.comunicacaoVenda.tipoDocumentoComprador, documented as a string.
	TipoDocumentoComprador Text `json:"tipoDocumentoComprador"`
	// TipoDocumentoFaturado is retorno.comunicacaoVenda.tipoDocumentoFaturado, documented as a string.
	TipoDocumentoFaturado Text `json:"tipoDocumentoFaturado"`
	// TipoRemarcacaoChassi is retorno.comunicacaoVenda.tipoRemarcacaoChassi, documented as a string.
	TipoRemarcacaoChassi Text `json:"tipoRemarcacaoChassi"`
	// UfDestinoFaturamento is retorno.comunicacaoVenda.ufDestinoFaturamento, documented as a string.
	UfDestinoFaturamento Text `json:"ufDestinoFaturamento"`
}

ConsultaVeicularEstadualRetornoComunicacaoVenda is retorno.comunicacaoVenda in the answer of ConsultaVeicularEstadual.

type ConsultaVeicularEstadualRetornoDebitos 

type ConsultaVeicularEstadualRetornoDebitos struct {
	// SituacaoDpvat is retorno.debitos.situacaoDpvat, documented as a string.
	SituacaoDpvat Text `json:"situacaoDpvat"`
	// SituacaoIpva is retorno.debitos.situacaoIpva, documented as a string.
	SituacaoIpva Text `json:"situacaoIpva"`
	// SituacaoLicenciamento is retorno.debitos.situacaoLicenciamento, documented as a string.
	SituacaoLicenciamento Text `json:"situacaoLicenciamento"`
	// SituacaoMulta is retorno.debitos.situacaoMulta, documented as a string.
	SituacaoMulta Text `json:"situacaoMulta"`
	// ValorCetesb is retorno.debitos.valorCetesb, documented as a string.
	ValorCetesb Text `json:"valorCetesb"`
	// ValorDer is retorno.debitos.valorDer, documented as a string.
	ValorDer Text `json:"valorDer"`
	// ValorDersa is retorno.debitos.valorDersa, documented as a string.
	ValorDersa Text `json:"valorDersa"`
	// ValorDetran is retorno.debitos.valorDetran, documented as a string.
	ValorDetran Text `json:"valorDetran"`
	// ValorDpvat is retorno.debitos.valorDpvat, documented as a string.
	ValorDpvat Text `json:"valorDpvat"`
	// ValorIpva is retorno.debitos.valorIpva, documented as a string.
	ValorIpva Text `json:"valorIpva"`
	// ValorLicenciamento is retorno.debitos.valorLicenciamento, documented as a string.
	ValorLicenciamento Text `json:"valorLicenciamento"`
	// ValorMulta is retorno.debitos.valorMulta, documented as a string.
	ValorMulta Text `json:"valorMulta"`
	// ValorMunicipais is retorno.debitos.valorMunicipais, documented as a string.
	ValorMunicipais Text `json:"valorMunicipais"`
	// ValorPoliciaRodoviariaFederal is retorno.debitos.valorPoliciaRodoviariaFederal, documented as a string.
	ValorPoliciaRodoviariaFederal Text `json:"valorPoliciaRodoviariaFederal"`
	// ValorRenainf is retorno.debitos.valorRenainf, documented as a string.
	ValorRenainf Text `json:"valorRenainf"`
}

ConsultaVeicularEstadualRetornoDebitos is retorno.debitos in the answer of ConsultaVeicularEstadual.

type ConsultaVeicularEstadualRetornoRestricoes 

type ConsultaVeicularEstadualRetornoRestricoes struct {
	// Administrativa is retorno.restricoes.administrativa, documented as a string.
	Administrativa Text `json:"administrativa"`
	// Ambiental is retorno.restricoes.ambiental, documented as a string.
	Ambiental Text `json:"ambiental"`
	// Financeira is retorno.restricoes.financeira, documented as a string.
	Financeira Text `json:"financeira"`
	// Furto is retorno.restricoes.furto, documented as a string.
	Furto Text `json:"furto"`
	// Guincho is retorno.restricoes.guincho, documented as a string.
	Guincho Text `json:"guincho"`
	// Judicial is retorno.restricoes.judicial, documented as a string.
	Judicial Text `json:"judicial"`
	// Renajud is retorno.restricoes.renajud, documented as a string.
	Renajud Text `json:"renajud"`
	// Tributaria is retorno.restricoes.tributaria, documented as a string.
	Tributaria Text `json:"tributaria"`
}

ConsultaVeicularEstadualRetornoRestricoes is retorno.restricoes in the answer of ConsultaVeicularEstadual.

type ConsultaVeicularEstadualRetornoVeiculo 

type ConsultaVeicularEstadualRetornoVeiculo struct {
	// AnoFabricacao is retorno.veiculo.anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.veiculo.anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// CapacidadeCarga is retorno.veiculo.capacidadeCarga, documented as a string.
	CapacidadeCarga Text `json:"capacidadeCarga"`
	// CapacidadePassageiros is retorno.veiculo.capacidadePassageiros, documented as a string.
	CapacidadePassageiros Text `json:"capacidadePassageiros"`
	// Carroceria is retorno.veiculo.carroceria, documented as a string.
	Carroceria Text `json:"carroceria"`
	// Categoria is retorno.veiculo.categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// Cilindrada is retorno.veiculo.cilindrada, documented as a string.
	Cilindrada Text `json:"cilindrada"`
	// Cmt is retorno.veiculo.cmt, documented as a string.
	Cmt Text `json:"cmt"`
	// Combustivel is retorno.veiculo.combustivel, documented as a string.
	Combustivel Text `json:"combustivel"`
	// Cor is retorno.veiculo.cor, documented as a string.
	Cor Text `json:"cor"`
	// Eixos is retorno.veiculo.eixos, documented as a number.
	Eixos Number `json:"eixos"`
	// Especie is retorno.veiculo.especie, documented as a string.
	Especie Text `json:"especie"`
	// Marca is retorno.veiculo.marca, documented as a string.
	Marca Text `json:"marca"`
	// MarcaModelo is retorno.veiculo.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Modelo is retorno.veiculo.modelo, documented as a string.
	Modelo Text `json:"modelo"`
	// Motor is retorno.veiculo.motor, documented as a string.
	Motor Text `json:"motor" pii:"vehicle"`
	// NumeroCambio is retorno.veiculo.numeroCambio, documented as a string.
	NumeroCambio Text `json:"numeroCambio"`
	// NumeroCarroceria is retorno.veiculo.numeroCarroceria, documented as a string.
	NumeroCarroceria Text `json:"numeroCarroceria"`
	// NumeroEixoTerceiro is retorno.veiculo.numeroEixoTerceiro, documented as a string.
	NumeroEixoTerceiro Text `json:"numeroEixoTerceiro"`
	// NumeroEixoTraseiro is retorno.veiculo.numeroEixoTraseiro, documented as a string.
	NumeroEixoTraseiro Text `json:"numeroEixoTraseiro"`
	// Pbt is retorno.veiculo.pbt, documented as a string.
	Pbt Text `json:"pbt"`
	// Potencia is retorno.veiculo.potencia, documented as a number.
	Potencia Number `json:"potencia"`
	// Procedencia is retorno.veiculo.procedencia, documented as a string.
	Procedencia Text `json:"procedencia"`
	// Tipo is retorno.veiculo.tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

ConsultaVeicularEstadualRetornoVeiculo is retorno.veiculo in the answer of ConsultaVeicularEstadual.

type ConsultaVeicularFipeParams 

type ConsultaVeicularFipeParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
	// Chassi is sent as Chassi. O parâmetro CHASSI pode ser enviado com ou sem formatação.
	Chassi string
}

ConsultaVeicularFipeParams are the parameters of ConsultaVeicularFipe (Veículos - FIPE).

func (ConsultaVeicularFipeParams) Request 

func (p ConsultaVeicularFipeParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularFipe.

type ConsultaVeicularFipeRetorno 

type ConsultaVeicularFipeRetorno struct {
	// AnoExercicio is retorno.anoExercicio, documented as a string.
	AnoExercicio Text `json:"anoExercicio"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Proprietario is retorno.proprietario, documented as a string.
	Proprietario Text `json:"proprietario"`
	// Veiculo is retorno.veiculo.
	Veiculo ConsultaVeicularFipeRetornoVeiculo `json:"veiculo"`
}

ConsultaVeicularFipeRetorno is retorno in the answer of ConsultaVeicularFipe.

type ConsultaVeicularFipeRetornoVeiculo 

type ConsultaVeicularFipeRetornoVeiculo struct {
	// AnoFabricacao is retorno.veiculo.anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.veiculo.anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// CapacidaDeCarga is retorno.veiculo.capacidaDeCarga, documented as a string.
	CapacidaDeCarga Text `json:"capacidaDeCarga"`
	// CapacidadedePassageiros is retorno.veiculo.capacidadedePassageiros, documented as a string.
	CapacidadedePassageiros Text `json:"capacidadedePassageiros"`
	// Chassi is retorno.veiculo.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// Cilindrada is retorno.veiculo.cilindrada, documented as a string.
	Cilindrada Text `json:"cilindrada"`
	// Combustivel is retorno.veiculo.combustivel, documented as a string.
	Combustivel Text `json:"combustivel"`
	// Cor is retorno.veiculo.cor, documented as a string.
	Cor Text `json:"cor"`
	// Especie is retorno.veiculo.especie, documented as a string.
	Especie Text `json:"especie"`
	// Fipe is retorno.veiculo.fipe.
	Fipe ConsultaVeicularFipeRetornoVeiculoFipe `json:"fipe"`
	// Marca is retorno.veiculo.marca, documented as a string.
	Marca Text `json:"marca"`
	// Modelo is retorno.veiculo.modelo, documented as a string.
	Modelo Text `json:"modelo"`
	// Municipio is retorno.veiculo.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroCambio is retorno.veiculo.numeroCambio, documented as a string.
	NumeroCambio Text `json:"numeroCambio"`
	// NumeroCarroceria is retorno.veiculo.numeroCarroceria, documented as a string.
	NumeroCarroceria Text `json:"numeroCarroceria"`
	// NumeroDoEixoAuxiliar is retorno.veiculo.numeroDoEixoAuxiliar, documented as a string.
	NumeroDoEixoAuxiliar Text `json:"numeroDoEixoAuxiliar"`
	// NumeroEixoTraseiro is retorno.veiculo.numeroEixoTraseiro, documented as a string.
	NumeroEixoTraseiro Text `json:"numeroEixoTraseiro"`
	// NumeroEixos is retorno.veiculo.numeroEixos, documented as a string.
	NumeroEixos Text `json:"numeroEixos"`
	// NumeroMotor is retorno.veiculo.numeroMotor, documented as a string.
	NumeroMotor Text `json:"numeroMotor"`
	// Placa is retorno.veiculo.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// ProcedenciaVeiculo is retorno.veiculo.procedenciaVeiculo, documented as a string.
	ProcedenciaVeiculo Text `json:"procedenciaVeiculo"`
	// Renavam is retorno.veiculo.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// SituacaoVeiculo is retorno.veiculo.situacaoVeiculo, documented as a string.
	SituacaoVeiculo Text `json:"situacaoVeiculo"`
	// Tipo is retorno.veiculo.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Uf is retorno.veiculo.uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularFipeRetornoVeiculo is retorno.veiculo in the answer of ConsultaVeicularFipe.

type ConsultaVeicularFipeRetornoVeiculoFipe 

type ConsultaVeicularFipeRetornoVeiculoFipe struct {
	// Ano is retorno.veiculo.fipe.ano, documented as a string.
	Ano Text `json:"ano"`
	// Mes is retorno.veiculo.fipe.mes, documented as a string.
	Mes Text `json:"mes"`
	// Valor is retorno.veiculo.fipe.valor, documented as a string.
	Valor Text `json:"valor"`
}

ConsultaVeicularFipeRetornoVeiculoFipe is retorno.veiculo.fipe in the answer of ConsultaVeicularFipe.

type ConsultaVeicularFrotasNacionalParams 

type ConsultaVeicularFrotasNacionalParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

ConsultaVeicularFrotasNacionalParams are the parameters of ConsultaVeicularFrotasNacional (Consulta Veicular - Frotas Nacional).

func (ConsultaVeicularFrotasNacionalParams) Request 

func (p ConsultaVeicularFrotasNacionalParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularFrotasNacional.

type ConsultaVeicularFrotasNacionalRetorno 

type ConsultaVeicularFrotasNacionalRetorno struct {
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeProprietario is retorno.nomeProprietario, documented as a string.
	NomeProprietario Text `json:"nomeProprietario" pii:"name"`
	// QuantidadeVeiculos is retorno.quantidadeVeiculos, documented as a number.
	QuantidadeVeiculos Number `json:"quantidadeVeiculos"`
	// Veiculos is retorno.veiculos, a list.
	Veiculos []ConsultaVeicularFrotasNacionalRetornoVeiculos `json:"veiculos"`
}

ConsultaVeicularFrotasNacionalRetorno is retorno in the answer of ConsultaVeicularFrotasNacional.

type ConsultaVeicularFrotasNacionalRetornoVeiculos 

type ConsultaVeicularFrotasNacionalRetornoVeiculos struct {
	// AnoFabricacao is retorno.veiculos[].anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.veiculos[].anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// Chassi is retorno.veiculos[].chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// Cor is retorno.veiculos[].cor, documented as a string.
	Cor Text `json:"cor"`
	// MarcaModelo is retorno.veiculos[].marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Motor is retorno.veiculos[].motor, documented as a string.
	Motor Text `json:"motor" pii:"vehicle"`
	// Placa is retorno.veiculos[].placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Renavam is retorno.veiculos[].renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// TipoVeiculo is retorno.veiculos[].tipoVeiculo, documented as a string.
	TipoVeiculo Text `json:"tipoVeiculo"`
	// Uf is retorno.veiculos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularFrotasNacionalRetornoVeiculos is retorno.veiculos[] in the answer of ConsultaVeicularFrotasNacional.

type ConsultaVeicularGravameParams 

type ConsultaVeicularGravameParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
	// Chassi is sent as Chassi. O parâmetro CHASSI pode ser enviado com ou sem formatação.
	Chassi string
}

ConsultaVeicularGravameParams are the parameters of ConsultaVeicularGravame (Consulta Veicular - Gravame).

func (ConsultaVeicularGravameParams) Request 

func (p ConsultaVeicularGravameParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularGravame.

type ConsultaVeicularGravameRetorno 

type ConsultaVeicularGravameRetorno struct {
	// Chassi is retorno.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// DescricaoStatus is retorno.descricaoStatus, documented as a string.
	DescricaoStatus Text `json:"descricaoStatus"`
	// Gravame is retorno.gravame.
	Gravame ConsultaVeicularGravameRetornoGravame `json:"gravame"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// StatusDoVeiculo is retorno.statusDoVeiculo, documented as a string.
	StatusDoVeiculo Text `json:"statusDoVeiculo"`
	// UfPlaca is retorno.ufPlaca, documented as a string.
	UfPlaca Text `json:"ufPlaca"`
	// Veiculo is retorno.veiculo.
	Veiculo ConsultaVeicularGravameRetornoVeiculo `json:"veiculo"`
}

ConsultaVeicularGravameRetorno is retorno in the answer of ConsultaVeicularGravame.

type ConsultaVeicularGravameRetornoGravame 

type ConsultaVeicularGravameRetornoGravame struct {
	// CodigoFinanceira is retorno.gravame.codigoFinanceira, documented as a string.
	CodigoFinanceira Text `json:"codigoFinanceira"`
	// DataGravame is retorno.gravame.dataGravame, documented as a string.
	DataGravame Text `json:"dataGravame"`
	// DataGravameVigencia is retorno.gravame.dataGravameVigencia, documented as a string.
	DataGravameVigencia Text `json:"dataGravameVigencia"`
	// DataLimiteRestricaoTributaria is retorno.gravame.dataLimiteRestricaoTributaria, documented as a string.
	DataLimiteRestricaoTributaria Text `json:"dataLimiteRestricaoTributaria"`
	// DocumentoFinanceira is retorno.gravame.documentoFinanceira, documented as a string.
	DocumentoFinanceira Text `json:"documentoFinanceira"`
	// DocumentoProprietarioAtual is retorno.gravame.documentoProprietarioAtual, documented as a string.
	DocumentoProprietarioAtual Text `json:"documentoProprietarioAtual"`
	// FinanceiraNome is retorno.gravame.financeiraNome, documented as a string.
	FinanceiraNome Text `json:"financeiraNome"`
	// NomeFinanciado is retorno.gravame.nomeFinanciado, documented as a string.
	NomeFinanciado Text `json:"nomeFinanciado" pii:"name"`
	// NumeroContrato is retorno.gravame.numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// UfGravame is retorno.gravame.ufGravame, documented as a string.
	UfGravame Text `json:"ufGravame"`
}

ConsultaVeicularGravameRetornoGravame is retorno.gravame in the answer of ConsultaVeicularGravame.

type ConsultaVeicularGravameRetornoVeiculo 

type ConsultaVeicularGravameRetornoVeiculo struct {
	// AnoFabricacao is retorno.veiculo.anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.veiculo.anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// Cambio is retorno.veiculo.cambio, documented as a string.
	Cambio Text `json:"cambio"`
	// CapacidadeCarga is retorno.veiculo.capacidadeCarga, documented as a string.
	CapacidadeCarga Text `json:"capacidadeCarga"`
	// CapacidadeCilindrada is retorno.veiculo.capacidadeCilindrada, documented as a string.
	CapacidadeCilindrada Text `json:"capacidadeCilindrada"`
	// Cmt is retorno.veiculo.cmt, documented as a string.
	Cmt Text `json:"cmt"`
	// Combustivel is retorno.veiculo.combustivel, documented as a string.
	Combustivel Text `json:"combustivel"`
	// Cor is retorno.veiculo.cor, documented as a string.
	Cor Text `json:"cor"`
	// DocImportador is retorno.veiculo.docImportador, documented as a string.
	DocImportador Text `json:"docImportador"`
	// EixoAuxiliar is retorno.veiculo.eixoAuxiliar, documented as a string.
	EixoAuxiliar Text `json:"eixoAuxiliar"`
	// EixoQuantidade is retorno.veiculo.eixoQuantidade, documented as a string.
	EixoQuantidade Text `json:"eixoQuantidade"`
	// EixoTraseiro is retorno.veiculo.eixoTraseiro, documented as a string.
	EixoTraseiro Text `json:"eixoTraseiro"`
	// Especie is retorno.veiculo.especie, documented as a string.
	Especie Text `json:"especie"`
	// MarcaModelo is retorno.veiculo.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Motor is retorno.veiculo.motor, documented as a string.
	Motor Text `json:"motor" pii:"vehicle"`
	// Pbt is retorno.veiculo.pbt, documented as a string.
	Pbt Text `json:"pbt"`
	// Potencia is retorno.veiculo.potencia, documented as a string.
	Potencia Text `json:"potencia"`
	// Procedencia is retorno.veiculo.procedencia, documented as a string.
	Procedencia Text `json:"procedencia"`
	// QuantidadePassageiros is retorno.veiculo.quantidadePassageiros, documented as a string.
	QuantidadePassageiros Text `json:"quantidadePassageiros"`
	// SituacaoChassi is retorno.veiculo.situacaoChassi, documented as a string.
	SituacaoChassi Text `json:"situacaoChassi"`
	// Tipo is retorno.veiculo.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// TipoCarroceria is retorno.veiculo.tipoCarroceria, documented as a string.
	TipoCarroceria Text `json:"tipoCarroceria"`
	// TipoMontagem is retorno.veiculo.tipoMontagem, documented as a string.
	TipoMontagem Text `json:"tipoMontagem"`
}

ConsultaVeicularGravameRetornoVeiculo is retorno.veiculo in the answer of ConsultaVeicularGravame.

type ConsultaVeicularHistoricoProprietariosParams 

type ConsultaVeicularHistoricoProprietariosParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
}

ConsultaVeicularHistoricoProprietariosParams are the parameters of ConsultaVeicularHistoricoProprietarios (Consulta Veicular - Histórico de Proprietários).

func (ConsultaVeicularHistoricoProprietariosParams) Request 

func (p ConsultaVeicularHistoricoProprietariosParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularHistoricoProprietarios.

type ConsultaVeicularHistoricoProprietariosRetorno 

type ConsultaVeicularHistoricoProprietariosRetorno struct {
	// PlacaConsultada is retorno.placaConsultada, documented as a string.
	PlacaConsultada Text `json:"placaConsultada"`
	// Registros is retorno.registros, a list.
	Registros []ConsultaVeicularHistoricoProprietariosRetornoRegistros `json:"registros"`
	// TotalRegistros is retorno.totalRegistros, documented as a number.
	TotalRegistros Number `json:"totalRegistros"`
}

ConsultaVeicularHistoricoProprietariosRetorno is retorno in the answer of ConsultaVeicularHistoricoProprietarios.

type ConsultaVeicularHistoricoProprietariosRetornoRegistros 

type ConsultaVeicularHistoricoProprietariosRetornoRegistros struct {
	// Ano is retorno.registros[].ano, documented as a number.
	Ano Number `json:"ano"`
	// Chassi is retorno.registros[].chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// DataTransferencia is retorno.registros[].dataTransferencia, documented as a string.
	DataTransferencia Text `json:"dataTransferencia"`
	// Documento is retorno.registros[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// MarcaModelo is retorno.registros[].marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Municipio is retorno.registros[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NomeRazaoSocial is retorno.registros[].nomeRazaoSocial, documented as a string.
	NomeRazaoSocial Text `json:"nomeRazaoSocial" pii:"name"`
	// Placa is retorno.registros[].placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// PlacaMercosul is retorno.registros[].placaMercosul, documented as a string.
	PlacaMercosul Text `json:"placaMercosul"`
	// TipoDocumento is retorno.registros[].tipoDocumento, documented as a string.
	TipoDocumento Text `json:"tipoDocumento"`
	// Uf is retorno.registros[].uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularHistoricoProprietariosRetornoRegistros is retorno.registros[] in the answer of ConsultaVeicularHistoricoProprietarios.

type ConsultaVeicularParams 

type ConsultaVeicularParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
}

ConsultaVeicularParams are the parameters of ConsultaVeicular (Consulta Veicular - Nacional).

func (ConsultaVeicularParams) Request 

func (p ConsultaVeicularParams) Request() (Request, error)

Request builds the Request for ConsultaVeicular.

type ConsultaVeicularProprietarioAtualParams 

type ConsultaVeicularProprietarioAtualParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
}

ConsultaVeicularProprietarioAtualParams are the parameters of ConsultaVeicularProprietarioAtual (Consulta Veicular - Proprietário Atual).

func (ConsultaVeicularProprietarioAtualParams) Request 

func (p ConsultaVeicularProprietarioAtualParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularProprietarioAtual.

type ConsultaVeicularProprietarioAtualRetorno 

type ConsultaVeicularProprietarioAtualRetorno struct {
	// AnoFabricacao is retorno.anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// Chassi is retorno.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// Combustivel is retorno.combustivel, documented as a string.
	Combustivel Text `json:"combustivel"`
	// Cor is retorno.cor, documented as a string.
	Cor Text `json:"cor"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// MarcaModelo is retorno.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Motor is retorno.motor, documented as a string.
	Motor Text `json:"motor" pii:"vehicle"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// TipoVeiculo is retorno.tipoVeiculo, documented as a string.
	TipoVeiculo Text `json:"tipoVeiculo"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularProprietarioAtualRetorno is retorno in the answer of ConsultaVeicularProprietarioAtual.

type ConsultaVeicularRecallParams 

type ConsultaVeicularRecallParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
}

ConsultaVeicularRecallParams are the parameters of ConsultaVeicularRecall (Consulta Veicular - Recall).

func (ConsultaVeicularRecallParams) Request 

func (p ConsultaVeicularRecallParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularRecall.

type ConsultaVeicularRecallRetorno 

type ConsultaVeicularRecallRetorno struct {
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// PossuiRecallPendente is retorno.possuiRecallPendente, documented as a boolean.
	PossuiRecallPendente Flag `json:"possuiRecallPendente"`
	// QuantidadeRecallsPendentes is retorno.quantidadeRecallsPendentes, documented as a number.
	QuantidadeRecallsPendentes Number `json:"quantidadeRecallsPendentes"`
	// RecallsPendentes is retorno.recallsPendentes, a list.
	RecallsPendentes []ConsultaVeicularRecallRetornoRecallsPendentes `json:"recallsPendentes"`
}

ConsultaVeicularRecallRetorno is retorno in the answer of ConsultaVeicularRecall.

type ConsultaVeicularRecallRetornoRecallsPendentes 

type ConsultaVeicularRecallRetornoRecallsPendentes struct {
	// AnoFabricacao is retorno.recallsPendentes[].anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.recallsPendentes[].anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// Chassi is retorno.recallsPendentes[].chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// DataOcorrencia is retorno.recallsPendentes[].dataOcorrencia, documented as a string.
	DataOcorrencia Text `json:"dataOcorrencia"`
	// DataRegistro is retorno.recallsPendentes[].dataRegistro, documented as a string.
	DataRegistro Text `json:"dataRegistro"`
	// DescricaoRecall is retorno.recallsPendentes[].descricaoRecall, documented as a string.
	DescricaoRecall Text `json:"descricaoRecall"`
	// MarcaModelo is retorno.recallsPendentes[].marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Montadora is retorno.recallsPendentes[].montadora, documented as a string.
	Montadora Text `json:"montadora"`
	// NomeRecall is retorno.recallsPendentes[].nomeRecall, documented as a string.
	NomeRecall Text `json:"nomeRecall" pii:"name"`
	// Tipo is retorno.recallsPendentes[].tipo, documented as a number.
	Tipo Number `json:"tipo"`
}

ConsultaVeicularRecallRetornoRecallsPendentes is retorno.recallsPendentes[] in the answer of ConsultaVeicularRecall.

type ConsultaVeicularRenainfParams 

type ConsultaVeicularRenainfParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
}

ConsultaVeicularRenainfParams are the parameters of ConsultaVeicularRenainf (Consulta Veicular - Renainf).

func (ConsultaVeicularRenainfParams) Request 

func (p ConsultaVeicularRenainfParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularRenainf.

type ConsultaVeicularRenainfRetorno 

type ConsultaVeicularRenainfRetorno struct {
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// QuantidadeOcorrencias is retorno.quantidadeOcorrencias, documented as a number.
	QuantidadeOcorrencias Number `json:"quantidadeOcorrencias"`
	// Registros is retorno.registros, a list.
	Registros []ConsultaVeicularRenainfRetornoRegistros `json:"registros"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

ConsultaVeicularRenainfRetorno is retorno in the answer of ConsultaVeicularRenainf.

type ConsultaVeicularRenainfRetornoRegistros 

type ConsultaVeicularRenainfRetornoRegistros struct {
	// AutoInfracao is retorno.registros[].autoInfracao, documented as a string.
	AutoInfracao Text `json:"autoInfracao"`
	// DataInfracao is retorno.registros[].dataInfracao, documented as a string.
	DataInfracao Text `json:"dataInfracao"`
	// Detalhes is retorno.registros[].detalhes.
	Detalhes ConsultaVeicularRenainfRetornoRegistrosDetalhes `json:"detalhes"`
	// Exigibilidade is retorno.registros[].exigibilidade, documented as a string.
	Exigibilidade Text `json:"exigibilidade"`
	// Infracao is retorno.registros[].infracao, documented as a string.
	Infracao Text `json:"infracao"`
	// OrgaoAutuador is retorno.registros[].orgaoAutuador, documented as a string.
	OrgaoAutuador Text `json:"orgaoAutuador"`
}

ConsultaVeicularRenainfRetornoRegistros is retorno.registros[] in the answer of ConsultaVeicularRenainf.

type ConsultaVeicularRenainfRetornoRegistrosDetalhes 

type ConsultaVeicularRenainfRetornoRegistrosDetalhes struct {
	// CadastroInfracao is retorno.registros[].detalhes.cadastroInfracao, documented as a string.
	CadastroInfracao Text `json:"cadastroInfracao"`
	// CodigoInfracao is retorno.registros[].detalhes.codigoInfracao, documented as a string.
	CodigoInfracao Text `json:"codigoInfracao"`
	// CodigoMunicipalEmplacamento is retorno.registros[].detalhes.codigoMunicipalEmplacamento, documented as a string.
	CodigoMunicipalEmplacamento Text `json:"codigoMunicipalEmplacamento"`
	// CodigoMunicipalInfracao is retorno.registros[].detalhes.codigoMunicipalInfracao, documented as a string.
	CodigoMunicipalInfracao Text `json:"codigoMunicipalInfracao"`
	// DataEmissaoPenalidade is retorno.registros[].detalhes.dataEmissaoPenalidade, documented as a string.
	DataEmissaoPenalidade Text `json:"dataEmissaoPenalidade"`
	// DataInfracao is retorno.registros[].detalhes.dataInfracao, documented as a string.
	DataInfracao Text `json:"dataInfracao"`
	// DataNotificacaoInfracao is retorno.registros[].detalhes.dataNotificacaoInfracao, documented as a string.
	DataNotificacaoInfracao Text `json:"dataNotificacaoInfracao"`
	// HoraInfracao is retorno.registros[].detalhes.horaInfracao, documented as a string.
	HoraInfracao Text `json:"horaInfracao"`
	// LimitePermitido is retorno.registros[].detalhes.limitePermitido, documented as a string.
	LimitePermitido Text `json:"limitePermitido"`
	// LocalInfracao is retorno.registros[].detalhes.localInfracao, documented as a string.
	LocalInfracao Text `json:"localInfracao"`
	// MarcaModelo is retorno.registros[].detalhes.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// MedicaoConsiderada is retorno.registros[].detalhes.medicaoConsiderada, documented as a string.
	MedicaoConsiderada Text `json:"medicaoConsiderada"`
	// MedicaoReal is retorno.registros[].detalhes.medicaoReal, documented as a string.
	MedicaoReal Text `json:"medicaoReal"`
	// NumeroAutoInfracao is retorno.registros[].detalhes.numeroAutoInfracao, documented as a string.
	NumeroAutoInfracao Text `json:"numeroAutoInfracao"`
	// OrgaoAutuador is retorno.registros[].detalhes.orgaoAutuador, documented as a string.
	OrgaoAutuador Text `json:"orgaoAutuador"`
	// Placa is retorno.registros[].detalhes.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// TipoAutoInfracao is retorno.registros[].detalhes.tipoAutoInfracao, documented as a string.
	TipoAutoInfracao Text `json:"tipoAutoInfracao"`
	// UfJurisdicaoVeiculo is retorno.registros[].detalhes.ufJurisdicaoVeiculo, documented as a string.
	UfJurisdicaoVeiculo Text `json:"ufJurisdicaoVeiculo"`
	// UfOrgaoAutuador is retorno.registros[].detalhes.ufOrgaoAutuador, documented as a string.
	UfOrgaoAutuador Text `json:"ufOrgaoAutuador"`
	// UfPlaca is retorno.registros[].detalhes.ufPlaca, documented as a string.
	UfPlaca Text `json:"ufPlaca"`
	// UnidadeMedida is retorno.registros[].detalhes.unidadeMedida, documented as a string.
	UnidadeMedida Text `json:"unidadeMedida"`
	// ValorInfracao is retorno.registros[].detalhes.valorInfracao, documented as a string.
	ValorInfracao Text `json:"valorInfracao"`
}

ConsultaVeicularRenainfRetornoRegistrosDetalhes is retorno.registros[].detalhes in the answer of ConsultaVeicularRenainf.

type ConsultaVeicularRenajudParams 

type ConsultaVeicularRenajudParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
}

ConsultaVeicularRenajudParams are the parameters of ConsultaVeicularRenajud (Consulta Veicular - Renajud).

func (ConsultaVeicularRenajudParams) Request 

func (p ConsultaVeicularRenajudParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularRenajud.

type ConsultaVeicularRenajudRetorno 

type ConsultaVeicularRenajudRetorno struct {
	// AnoFabricacao is retorno.anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// Chassi is retorno.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// MarcaModelo is retorno.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Mensagem is retorno.mensagem, documented as a string.
	Mensagem Text `json:"mensagem"`
	// Ocorrencias is retorno.ocorrencias, a list.
	Ocorrencias []ConsultaVeicularRenajudRetornoOcorrencias `json:"ocorrencias"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// PlacaAnterior is retorno.placaAnterior, documented as a string.
	PlacaAnterior Text `json:"placaAnterior"`
	// Proprietario is retorno.proprietario.
	Proprietario ConsultaVeicularRenajudRetornoProprietario `json:"proprietario"`
	// QuantidadeBaixadas is retorno.quantidadeBaixadas, documented as a number.
	QuantidadeBaixadas Number `json:"quantidadeBaixadas"`
	// QuantidadeBloqueioAtivo is retorno.quantidadeBloqueioAtivo, documented as a number.
	QuantidadeBloqueioAtivo Number `json:"quantidadeBloqueioAtivo"`
	// QuantidadeOcorrenciasTotal is retorno.quantidadeOcorrenciasTotal, documented as a number.
	QuantidadeOcorrenciasTotal Number `json:"quantidadeOcorrenciasTotal"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularRenajudRetorno is retorno in the answer of ConsultaVeicularRenajud.

type ConsultaVeicularRenajudRetornoOcorrencias 

type ConsultaVeicularRenajudRetornoOcorrencias struct {
	// DataExclusao is retorno.ocorrencias[].dataExclusao, documented as a string.
	DataExclusao Text `json:"dataExclusao"`
	// DataInclusao is retorno.ocorrencias[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// MagistradoExclusao is retorno.ocorrencias[].magistradoExclusao, documented as a string.
	MagistradoExclusao Text `json:"magistradoExclusao"`
	// MagistradoInclusao is retorno.ocorrencias[].magistradoInclusao, documented as a string.
	MagistradoInclusao Text `json:"magistradoInclusao"`
	// NumeroProcesso is retorno.ocorrencias[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// OrgaoJulgador is retorno.ocorrencias[].orgaoJulgador, documented as a string.
	OrgaoJulgador Text `json:"orgaoJulgador"`
	// OrgaoJulgadorMunicipio is retorno.ocorrencias[].orgaoJulgadorMunicipio, documented as a string.
	OrgaoJulgadorMunicipio Text `json:"orgaoJulgadorMunicipio"`
	// OrgaoJulgadorUf is retorno.ocorrencias[].orgaoJulgadorUf, documented as a string.
	OrgaoJulgadorUf Text `json:"orgaoJulgadorUf"`
	// Status is retorno.ocorrencias[].status, documented as a string.
	Status Text `json:"status"`
	// TipoRestricao is retorno.ocorrencias[].tipoRestricao, documented as a string.
	TipoRestricao Text `json:"tipoRestricao"`
	// Tribunal is retorno.ocorrencias[].tribunal, documented as a string.
	Tribunal Text `json:"tribunal"`
}

ConsultaVeicularRenajudRetornoOcorrencias is retorno.ocorrencias[] in the answer of ConsultaVeicularRenajud.

type ConsultaVeicularRenajudRetornoProprietario 

type ConsultaVeicularRenajudRetornoProprietario struct {
	// Documento is retorno.proprietario.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Endereco is retorno.proprietario.endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.proprietario.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

ConsultaVeicularRenajudRetornoProprietario is retorno.proprietario in the answer of ConsultaVeicularRenajud.

type ConsultaVeicularRetorno 

type ConsultaVeicularRetorno struct {
	// AnoExercicio is retorno.anoExercicio, documented as a string.
	AnoExercicio Text `json:"anoExercicio"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Proprietario is retorno.proprietario, documented as a string.
	Proprietario Text `json:"proprietario"`
	// Veiculo is retorno.veiculo.
	Veiculo ConsultaVeicularRetornoVeiculo `json:"veiculo"`
}

ConsultaVeicularRetorno is retorno in the answer of ConsultaVeicular.

type ConsultaVeicularRetornoVeiculo 

type ConsultaVeicularRetornoVeiculo struct {
	// AnoFabricacao is retorno.veiculo.anoFabricacao, documented as a string.
	AnoFabricacao Text `json:"anoFabricacao"`
	// AnoModelo is retorno.veiculo.anoModelo, documented as a string.
	AnoModelo Text `json:"anoModelo"`
	// CapacidaDeCarga is retorno.veiculo.capacidaDeCarga, documented as a string.
	CapacidaDeCarga Text `json:"capacidaDeCarga"`
	// CapacidadeMaximaCarga is retorno.veiculo.capacidadeMaximaCarga, documented as a string.
	CapacidadeMaximaCarga Text `json:"capacidadeMaximaCarga"`
	// CapacidadeMaximaTracao is retorno.veiculo.capacidadeMaximaTracao, documented as a string.
	CapacidadeMaximaTracao Text `json:"capacidadeMaximaTracao"`
	// CapacidadedePassageiros is retorno.veiculo.capacidadedePassageiros, documented as a string.
	CapacidadedePassageiros Text `json:"capacidadedePassageiros"`
	// Categoria is retorno.veiculo.categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// Chassi is retorno.veiculo.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// Cilindrada is retorno.veiculo.cilindrada, documented as a string.
	Cilindrada Text `json:"cilindrada"`
	// Combustivel is retorno.veiculo.combustivel, documented as a string.
	Combustivel Text `json:"combustivel"`
	// Cor is retorno.veiculo.cor, documented as a string.
	Cor Text `json:"cor"`
	// DataEmissaoCrlv is retorno.veiculo.dataEmissaoCrlv, documented as a string.
	DataEmissaoCrlv Text `json:"dataEmissaoCrlv"`
	// DataEmissaoCrv is retorno.veiculo.dataEmissaoCrv, documented as a string.
	DataEmissaoCrv Text `json:"dataEmissaoCrv"`
	// DescricaoRemarcacaoChassi is retorno.veiculo.descricaoRemarcacaoChassi, documented as a string.
	DescricaoRemarcacaoChassi Text `json:"descricaoRemarcacaoChassi"`
	// Especie is retorno.veiculo.especie, documented as a string.
	Especie Text `json:"especie"`
	// Faturado is retorno.veiculo.faturado.
	Faturado ConsultaVeicularRetornoVeiculoFaturado `json:"faturado"`
	// Importacao is retorno.veiculo.importacao.
	Importacao ConsultaVeicularRetornoVeiculoImportacao `json:"importacao"`
	// IndicadorRemarcacaoChassi is retorno.veiculo.indicadorRemarcacaoChassi, documented as a boolean.
	IndicadorRemarcacaoChassi Flag `json:"indicadorRemarcacaoChassi"`
	// Indicadores is retorno.veiculo.indicadores.
	Indicadores ConsultaVeicularRetornoVeiculoIndicadores `json:"indicadores"`
	// Marca is retorno.veiculo.marca, documented as a string.
	Marca Text `json:"marca"`
	// Modelo is retorno.veiculo.modelo, documented as a string.
	Modelo Text `json:"modelo"`
	// Municipio is retorno.veiculo.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroCambio is retorno.veiculo.numeroCambio, documented as a string.
	NumeroCambio Text `json:"numeroCambio"`
	// NumeroCarroceria is retorno.veiculo.numeroCarroceria, documented as a string.
	NumeroCarroceria Text `json:"numeroCarroceria"`
	// NumeroDoEixoAuxiliar is retorno.veiculo.numeroDoEixoAuxiliar, documented as a string.
	NumeroDoEixoAuxiliar Text `json:"numeroDoEixoAuxiliar"`
	// NumeroEixoTraseiro is retorno.veiculo.numeroEixoTraseiro, documented as a string.
	NumeroEixoTraseiro Text `json:"numeroEixoTraseiro"`
	// NumeroEixos is retorno.veiculo.numeroEixos, documented as a string.
	NumeroEixos Text `json:"numeroEixos"`
	// NumeroMotor is retorno.veiculo.numeroMotor, documented as a string.
	NumeroMotor Text `json:"numeroMotor"`
	// PesoBrutoTotal is retorno.veiculo.pesoBrutoTotal, documented as a string.
	PesoBrutoTotal Text `json:"pesoBrutoTotal"`
	// Placa is retorno.veiculo.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Potencia is retorno.veiculo.potencia, documented as a number.
	Potencia Number `json:"potencia"`
	// ProcedenciaVeiculo is retorno.veiculo.procedenciaVeiculo, documented as a string.
	ProcedenciaVeiculo Text `json:"procedenciaVeiculo"`
	// Renavam is retorno.veiculo.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// Restricoes is retorno.veiculo.restricoes, a list.
	Restricoes []Text `json:"restricoes"`
	// SituacaoVeiculo is retorno.veiculo.situacaoVeiculo, documented as a string.
	SituacaoVeiculo Text `json:"situacaoVeiculo"`
	// Tipo is retorno.veiculo.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// TipoCarroceria is retorno.veiculo.tipoCarroceria, documented as a string.
	TipoCarroceria Text `json:"tipoCarroceria"`
	// Uf is retorno.veiculo.uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularRetornoVeiculo is retorno.veiculo in the answer of ConsultaVeicular.

type ConsultaVeicularRetornoVeiculoFaturado 

type ConsultaVeicularRetornoVeiculoFaturado struct {
	// Documento is retorno.veiculo.faturado.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Tipo is retorno.veiculo.faturado.tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

ConsultaVeicularRetornoVeiculoFaturado is retorno.veiculo.faturado in the answer of ConsultaVeicular.

type ConsultaVeicularRetornoVeiculoImportacao 

type ConsultaVeicularRetornoVeiculoImportacao struct {
	// Data is retorno.veiculo.importacao.data, documented as a string.
	Data Text `json:"data"`
	// NumeroDeclaracao is retorno.veiculo.importacao.numeroDeclaracao, documented as a string.
	NumeroDeclaracao Text `json:"numeroDeclaracao"`
}

ConsultaVeicularRetornoVeiculoImportacao is retorno.veiculo.importacao in the answer of ConsultaVeicular.

type ConsultaVeicularRetornoVeiculoIndicadores 

type ConsultaVeicularRetornoVeiculoIndicadores struct {
	// Alarme is retorno.veiculo.indicadores.alarme, documented as a boolean.
	Alarme Flag `json:"alarme"`
	// ComunicadoVenda is retorno.veiculo.indicadores.comunicadoVenda, documented as a boolean.
	ComunicadoVenda Flag `json:"comunicadoVenda"`
	// Leilao is retorno.veiculo.indicadores.leilao, documented as a boolean.
	Leilao Flag `json:"leilao"`
	// PendenciaEmissao is retorno.veiculo.indicadores.pendenciaEmissao, documented as a boolean.
	PendenciaEmissao Flag `json:"pendenciaEmissao"`
	// Recall is retorno.veiculo.indicadores.recall, documented as a boolean.
	Recall Flag `json:"recall"`
	// Renainf is retorno.veiculo.indicadores.renainf, documented as a boolean.
	Renainf Flag `json:"renainf"`
	// Renajud is retorno.veiculo.indicadores.renajud, documented as a boolean.
	Renajud Flag `json:"renajud"`
	// Rfb is retorno.veiculo.indicadores.rfb, documented as a boolean.
	Rfb Flag `json:"rfb"`
	// RouboFurto is retorno.veiculo.indicadores.rouboFurto, documented as a boolean.
	RouboFurto Flag `json:"rouboFurto"`
	// Siniav is retorno.veiculo.indicadores.siniav, documented as a boolean.
	Siniav Flag `json:"siniav"`
}

ConsultaVeicularRetornoVeiculoIndicadores is retorno.veiculo.indicadores in the answer of ConsultaVeicular.

type ConsultaVeicularRouboFurtoParams 

type ConsultaVeicularRouboFurtoParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
	// Chassi is sent as Chassi. O parâmetro CHASSI pode ser enviado com ou sem formatação.
	Chassi string
}

ConsultaVeicularRouboFurtoParams are the parameters of ConsultaVeicularRouboFurto (Consulta Veicular - Roubo e Furto).

func (ConsultaVeicularRouboFurtoParams) Request 

func (p ConsultaVeicularRouboFurtoParams) Request() (Request, error)

Request builds the Request for ConsultaVeicularRouboFurto.

type ConsultaVeicularRouboFurtoRetorno 

type ConsultaVeicularRouboFurtoRetorno struct {
	// Chassi is retorno.chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// Indicadores is retorno.indicadores.
	Indicadores ConsultaVeicularRouboFurtoRetornoIndicadores `json:"indicadores"`
	// OcorrenciaAtual is retorno.ocorrenciaAtual, documented as a string.
	OcorrenciaAtual Text `json:"ocorrenciaAtual"`
	// Ocorrencias is retorno.ocorrencias, a list.
	Ocorrencias []ConsultaVeicularRouboFurtoRetornoOcorrencias `json:"ocorrencias"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TotalOcorrencias is retorno.totalOcorrencias, documented as a number.
	TotalOcorrencias Number `json:"totalOcorrencias"`
	// Veiculo is retorno.veiculo.
	Veiculo ConsultaVeicularRouboFurtoRetornoVeiculo `json:"veiculo"`
}

ConsultaVeicularRouboFurtoRetorno is retorno in the answer of ConsultaVeicularRouboFurto.

type ConsultaVeicularRouboFurtoRetornoIndicadores 

type ConsultaVeicularRouboFurtoRetornoIndicadores struct {
	// HouveDevolucao is retorno.indicadores.houveDevolucao, documented as a boolean.
	HouveDevolucao Flag `json:"houveDevolucao"`
	// HouveRecuperacao is retorno.indicadores.houveRecuperacao, documented as a boolean.
	HouveRecuperacao Flag `json:"houveRecuperacao"`
	// HouveRouboFurto is retorno.indicadores.houveRouboFurto, documented as a boolean.
	HouveRouboFurto Flag `json:"houveRouboFurto"`
}

ConsultaVeicularRouboFurtoRetornoIndicadores is retorno.indicadores in the answer of ConsultaVeicularRouboFurto.

type ConsultaVeicularRouboFurtoRetornoOcorrencias 

type ConsultaVeicularRouboFurtoRetornoOcorrencias struct {
	// Alarme is retorno.ocorrencias[].alarme, documented as a string.
	Alarme Text `json:"alarme"`
	// Ano is retorno.ocorrencias[].ano, documented as a number.
	Ano Number `json:"ano"`
	// Boletim is retorno.ocorrencias[].boletim, documented as a string.
	Boletim Text `json:"boletim"`
	// Categoria is retorno.ocorrencias[].categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// DataOcorrencia is retorno.ocorrencias[].dataOcorrencia, documented as a string.
	DataOcorrencia Text `json:"dataOcorrencia"`
	// NumeroOcorrencia is retorno.ocorrencias[].numeroOcorrencia, documented as a string.
	NumeroOcorrencia Text `json:"numeroOcorrencia"`
	// OrgaoSeguranca is retorno.ocorrencias[].orgaoSeguranca, documented as a string.
	OrgaoSeguranca Text `json:"orgaoSeguranca"`
	// TipoDeclaracao is retorno.ocorrencias[].tipoDeclaracao, documented as a string.
	TipoDeclaracao Text `json:"tipoDeclaracao"`
}

ConsultaVeicularRouboFurtoRetornoOcorrencias is retorno.ocorrencias[] in the answer of ConsultaVeicularRouboFurto.

type ConsultaVeicularRouboFurtoRetornoVeiculo 

type ConsultaVeicularRouboFurtoRetornoVeiculo struct {
	// AnoFabricacao is retorno.veiculo.anoFabricacao, documented as a number.
	AnoFabricacao Number `json:"anoFabricacao"`
	// AnoModelo is retorno.veiculo.anoModelo, documented as a number.
	AnoModelo Number `json:"anoModelo"`
	// CaixaCambio is retorno.veiculo.caixaCambio, documented as a string.
	CaixaCambio Text `json:"caixaCambio"`
	// CapacidadeCarga is retorno.veiculo.capacidadeCarga, documented as a number.
	CapacidadeCarga Number `json:"capacidadeCarga"`
	// CapacidadePassageiros is retorno.veiculo.capacidadePassageiros, documented as a number.
	CapacidadePassageiros Number `json:"capacidadePassageiros"`
	// Cilindrada is retorno.veiculo.cilindrada, documented as a number.
	Cilindrada Number `json:"cilindrada"`
	// Cmt is retorno.veiculo.cmt, documented as a number.
	Cmt Number `json:"cmt"`
	// Combustivel is retorno.veiculo.combustivel, documented as a string.
	Combustivel Text `json:"combustivel"`
	// Cor is retorno.veiculo.cor, documented as a string.
	Cor Text `json:"cor"`
	// Especie is retorno.veiculo.especie, documented as a string.
	Especie Text `json:"especie"`
	// MarcaModelo is retorno.veiculo.marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Montagem is retorno.veiculo.montagem, documented as a string.
	Montagem Text `json:"montagem"`
	// Motor is retorno.veiculo.motor, documented as a string.
	Motor Text `json:"motor" pii:"vehicle"`
	// Municipio is retorno.veiculo.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumCarroceria is retorno.veiculo.numCarroceria, documented as a string.
	NumCarroceria Text `json:"numCarroceria"`
	// NumEixo is retorno.veiculo.numEixo, documented as a number.
	NumEixo Number `json:"numEixo"`
	// NumEixoAux is retorno.veiculo.numEixoAux, documented as a number.
	NumEixoAux Number `json:"numEixoAux"`
	// Pbt is retorno.veiculo.pbt, documented as a number.
	Pbt Number `json:"pbt"`
	// Potencia is retorno.veiculo.potencia, documented as a number.
	Potencia Number `json:"potencia"`
	// Procedencia is retorno.veiculo.procedencia, documented as a string.
	Procedencia Text `json:"procedencia"`
	// RemarcacaoChassi is retorno.veiculo.remarcacaoChassi, documented as a string.
	RemarcacaoChassi Text `json:"remarcacaoChassi"`
	// Restricoes is retorno.veiculo.restricoes, a list.
	Restricoes []Text `json:"restricoes"`
	// TipoVeiculo is retorno.veiculo.tipoVeiculo, documented as a string.
	TipoVeiculo Text `json:"tipoVeiculo"`
	// Uf is retorno.veiculo.uf, documented as a string.
	Uf Text `json:"uf"`
}

ConsultaVeicularRouboFurtoRetornoVeiculo is retorno.veiculo in the answer of ConsultaVeicularRouboFurto.

type CorreiosBuscaCEPParams 

type CorreiosBuscaCEPParams struct {
	// Endereco is sent as Endereco. Digite um CEP ou um Endereço. Não utilize nº de casa/apto/lote/prédio ou abreviação.
	Endereco string
}

CorreiosBuscaCEPParams are the parameters of CorreiosBuscaCEP (Correios - Busca CEP).

func (CorreiosBuscaCEPParams) Request 

func (p CorreiosBuscaCEPParams) Request() (Request, error)

Request builds the Request for CorreiosBuscaCEP.

type CorreiosBuscaCEPRetorno 

type CorreiosBuscaCEPRetorno struct {
	// EnderecoConsultado is retorno.enderecoConsultado, documented as a string.
	EnderecoConsultado Text `json:"enderecoConsultado" pii:"address"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []CorreiosBuscaCEPRetornoEnderecos `json:"enderecos"`
	// QuantidadeEnderecos is retorno.quantidadeEnderecos, documented as a number.
	QuantidadeEnderecos Number `json:"quantidadeEnderecos"`
}

CorreiosBuscaCEPRetorno is retorno in the answer of CorreiosBuscaCEP.

type CorreiosBuscaCEPRetornoEnderecos 

type CorreiosBuscaCEPRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// NomeUnidade is retorno.enderecos[].nomeUnidade, documented as a string.
	NomeUnidade Text `json:"nomeUnidade" pii:"name"`
	// ObservacaoCEP is retorno.enderecos[].observacaoCEP, documented as a string.
	ObservacaoCEP Text `json:"observacaoCEP"`
	// TipoCEP is retorno.enderecos[].tipoCEP, documented as a string.
	TipoCEP Text `json:"tipoCEP"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

CorreiosBuscaCEPRetornoEnderecos is retorno.enderecos[] in the answer of CorreiosBuscaCEP.

type DAPPessoaFisicaParams 

type DAPPessoaFisicaParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
	// DataNascimento is sent as DataNascimento. Named by the endpoint template only; the parameter table does not list it.
	DataNascimento string
}

DAPPessoaFisicaParams are the parameters of DAPPessoaFisica (DAP - Declaração de Aptidão ao Pronaf - Pessoa Física).

func (DAPPessoaFisicaParams) Request 

func (p DAPPessoaFisicaParams) Request() (Request, error)

Request builds the Request for DAPPessoaFisica.

type DAPPessoaFisicaRetorno 

type DAPPessoaFisicaRetorno struct {
	// Caf is retorno.caf, documented as a string.
	Caf Text `json:"caf"`
	// CaracterizacaoBeneficiario is retorno.caracterizacaoBeneficiario, a list.
	CaracterizacaoBeneficiario []Text `json:"caracterizacaoBeneficiario"`
	// Categorias is retorno.categorias, a list.
	Categorias []Text `json:"categorias"`
	// DataDesativacao is retorno.dataDesativacao, documented as a string.
	DataDesativacao Text `json:"dataDesativacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Emissor is retorno.emissor.
	Emissor DAPPessoaFisicaRetornoEmissor `json:"emissor"`
	// Enquadramento is retorno.enquadramento, documented as a string.
	Enquadramento Text `json:"enquadramento"`
	// Imovel is retorno.imovel.
	Imovel DAPPessoaFisicaRetornoImovel `json:"imovel"`
	// MotivoDesativacao is retorno.motivoDesativacao, documented as a string.
	MotivoDesativacao Text `json:"motivoDesativacao"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroDAP is retorno.numeroDAP, documented as a string.
	NumeroDAP Text `json:"numeroDAP"`
	// Renda is retorno.renda.
	Renda DAPPessoaFisicaRetornoRenda `json:"renda"`
	// TipoDAP is retorno.tipoDAP, documented as a string.
	TipoDAP Text `json:"tipoDAP"`
	// Titulares is retorno.titulares, a list.
	Titulares []DAPPessoaFisicaRetornoTitulares `json:"titulares"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// UsoTerra is retorno.usoTerra, a list.
	UsoTerra []Text `json:"usoTerra"`
	// Versao is retorno.versao, documented as a string.
	Versao Text `json:"versao"`
}

DAPPessoaFisicaRetorno is retorno in the answer of DAPPessoaFisica.

type DAPPessoaFisicaRetornoEmissor 

type DAPPessoaFisicaRetornoEmissor struct {
	// Cnpj is retorno.emissor.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Cpf is retorno.emissor.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Emissor is retorno.emissor.emissor, documented as a string.
	Emissor Text `json:"emissor"`
	// Nome is retorno.emissor.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

DAPPessoaFisicaRetornoEmissor is retorno.emissor in the answer of DAPPessoaFisica.

type DAPPessoaFisicaRetornoImovel 

type DAPPessoaFisicaRetornoImovel struct {
	// Area is retorno.imovel.area, documented as a string.
	Area Text `json:"area"`
	// AreaEstabelecimento is retorno.imovel.areaEstabelecimento, documented as a string.
	AreaEstabelecimento Text `json:"areaEstabelecimento"`
	// DocumentoProprietario is retorno.imovel.documentoProprietario, documented as a string.
	DocumentoProprietario Text `json:"documentoProprietario"`
	// Empregados is retorno.imovel.empregados, documented as a number.
	Empregados Number `json:"empregados"`
	// ImoveisExplorados is retorno.imovel.imoveisExplorados, documented as a number.
	ImoveisExplorados Number `json:"imoveisExplorados"`
	// Localizacao is retorno.imovel.localizacao, documented as a string.
	Localizacao Text `json:"localizacao"`
	// MembrosFamilia is retorno.imovel.membrosFamilia, documented as a number.
	MembrosFamilia Number `json:"membrosFamilia"`
	// Nome is retorno.imovel.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeProprietario is retorno.imovel.nomeProprietario, documented as a string.
	NomeProprietario Text `json:"nomeProprietario" pii:"name"`
	// Tipo is retorno.imovel.tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

DAPPessoaFisicaRetornoImovel is retorno.imovel in the answer of DAPPessoaFisica.

type DAPPessoaFisicaRetornoRenda 

type DAPPessoaFisicaRetornoRenda struct {
	// Produtos is retorno.renda.produtos, a list.
	Produtos []DAPPessoaFisicaRetornoRendaProdutos `json:"produtos"`
	// ValorAgroIndustrial is retorno.renda.valorAgroIndustrial, documented as a string.
	ValorAgroIndustrial Text `json:"valorAgroIndustrial"`
	// ValorEstabelecimento is retorno.renda.valorEstabelecimento, documented as a string.
	ValorEstabelecimento Text `json:"valorEstabelecimento"`
	// ValorForaEstabelecimento is retorno.renda.valorForaEstabelecimento, documented as a string.
	ValorForaEstabelecimento Text `json:"valorForaEstabelecimento"`
	// ValorPrevidenciario is retorno.renda.valorPrevidenciario, documented as a string.
	ValorPrevidenciario Text `json:"valorPrevidenciario"`
	// ValorTotal is retorno.renda.valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
}

DAPPessoaFisicaRetornoRenda is retorno.renda in the answer of DAPPessoaFisica.

type DAPPessoaFisicaRetornoRendaProdutos 

type DAPPessoaFisicaRetornoRendaProdutos struct {
	// Codigo is retorno.renda.produtos[].codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// Nome is retorno.renda.produtos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Observacao is retorno.renda.produtos[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// ValorAuferido is retorno.renda.produtos[].valorAuferido, documented as a string.
	ValorAuferido Text `json:"valorAuferido"`
	// ValorEstimada is retorno.renda.produtos[].valorEstimada, documented as a string.
	ValorEstimada Text `json:"valorEstimada"`
}

DAPPessoaFisicaRetornoRendaProdutos is retorno.renda.produtos[] in the answer of DAPPessoaFisica.

type DAPPessoaFisicaRetornoTitulares 

type DAPPessoaFisicaRetornoTitulares struct {
	// Cpf is retorno.titulares[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.titulares[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Endereco is retorno.titulares[].endereco.
	Endereco DAPPessoaFisicaRetornoTitularesEndereco `json:"endereco"`
	// Escolaridade is retorno.titulares[].escolaridade, documented as a string.
	Escolaridade Text `json:"escolaridade"`
	// EstadoCivil is retorno.titulares[].estadoCivil, documented as a string.
	EstadoCivil Text `json:"estadoCivil"`
	// Naturalidade is retorno.titulares[].naturalidade, documented as a string.
	Naturalidade Text `json:"naturalidade"`
	// Nis is retorno.titulares[].nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.titulares[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.titulares[].nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// NumeroTitular is retorno.titulares[].numeroTitular, documented as a number.
	NumeroTitular Number `json:"numeroTitular"`
	// RegimeCasamento is retorno.titulares[].regimeCasamento, documented as a string.
	RegimeCasamento Text `json:"regimeCasamento"`
	// Rg is retorno.titulares[].rg, documented as a string.
	Rg Text `json:"rg" pii:"document"`
	// Sexo is retorno.titulares[].sexo, documented as a string.
	Sexo Text `json:"sexo"`
}

DAPPessoaFisicaRetornoTitulares is retorno.titulares[] in the answer of DAPPessoaFisica.

type DAPPessoaFisicaRetornoTitularesEndereco 

type DAPPessoaFisicaRetornoTitularesEndereco struct {
	// Bairro is retorno.titulares[].endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.titulares[].endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Logradouro is retorno.titulares[].endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Municipio is retorno.titulares[].endereco.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Numero is retorno.titulares[].endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Tipo is retorno.titulares[].endereco.tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

DAPPessoaFisicaRetornoTitularesEndereco is retorno.titulares[].endereco in the answer of DAPPessoaFisica.

type DAPPessoaJuridicaParams 

type DAPPessoaJuridicaParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

DAPPessoaJuridicaParams are the parameters of DAPPessoaJuridica (DAP - Declaração de Aptidão ao Pronaf - Pessoa Jurídica).

func (DAPPessoaJuridicaParams) Request 

func (p DAPPessoaJuridicaParams) Request() (Request, error)

Request builds the Request for DAPPessoaJuridica.

type DAPPessoaJuridicaRetorno 

type DAPPessoaJuridicaRetorno struct {
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// ComposicaoSocietaria is retorno.composicaoSocietaria, a list.
	ComposicaoSocietaria []DAPPessoaJuridicaRetornoComposicaoSocietaria `json:"composicaoSocietaria"`
	// CpfRepresentanteLegal is retorno.cpfRepresentanteLegal, documented as a string.
	CpfRepresentanteLegal Text `json:"cpfRepresentanteLegal" pii:"document"`
	// DaPsPorMunicipios is retorno.daPsPorMunicipios, a list.
	DaPsPorMunicipios []DAPPessoaJuridicaRetornoDaPsPorMunicipios `json:"daPsPorMunicipios"`
	// DataConstituicao is retorno.dataConstituicao, documented as a string.
	DataConstituicao Text `json:"dataConstituicao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Emissor is retorno.emissor.
	Emissor DAPPessoaJuridicaRetornoEmissor `json:"emissor"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NomeRepresentanteLegal is retorno.nomeRepresentanteLegal, documented as a string.
	NomeRepresentanteLegal Text `json:"nomeRepresentanteLegal" pii:"name"`
	// NumeroDAP is retorno.numeroDAP, documented as a string.
	NumeroDAP Text `json:"numeroDAP"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// ResultadoAssociados is retorno.resultadoAssociados, a list.
	ResultadoAssociados []DAPPessoaJuridicaRetornoResultadoAssociados `json:"resultadoAssociados"`
	// Tipo is retorno.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Versao is retorno.versao, documented as a string.
	Versao Text `json:"versao"`
}

DAPPessoaJuridicaRetorno is retorno in the answer of DAPPessoaJuridica.

type DAPPessoaJuridicaRetornoComposicaoSocietaria 

type DAPPessoaJuridicaRetornoComposicaoSocietaria struct {
	// Categoria is retorno.composicaoSocietaria[].categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// ParticipacaoRelativa is retorno.composicaoSocietaria[].participacaoRelativa, documented as a string.
	ParticipacaoRelativa Text `json:"participacaoRelativa"`
	// Quantidade is retorno.composicaoSocietaria[].quantidade, documented as a number.
	Quantidade Number `json:"quantidade"`
}

DAPPessoaJuridicaRetornoComposicaoSocietaria is retorno.composicaoSocietaria[] in the answer of DAPPessoaJuridica.

type DAPPessoaJuridicaRetornoDaPsPorMunicipios 

type DAPPessoaJuridicaRetornoDaPsPorMunicipios struct {
	// Municipio is retorno.daPsPorMunicipios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Quantidade is retorno.daPsPorMunicipios[].quantidade, documented as a number.
	Quantidade Number `json:"quantidade"`
	// Uf is retorno.daPsPorMunicipios[].uf, documented as a string.
	Uf Text `json:"uf"`
}

DAPPessoaJuridicaRetornoDaPsPorMunicipios is retorno.daPsPorMunicipios[] in the answer of DAPPessoaJuridica.

type DAPPessoaJuridicaRetornoEmissor 

type DAPPessoaJuridicaRetornoEmissor struct {
	// Cnpj is retorno.emissor.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Cpf is retorno.emissor.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Emissor is retorno.emissor.emissor, documented as a string.
	Emissor Text `json:"emissor"`
	// Nome is retorno.emissor.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

DAPPessoaJuridicaRetornoEmissor is retorno.emissor in the answer of DAPPessoaJuridica.

type DAPPessoaJuridicaRetornoResultadoAssociados 

type DAPPessoaJuridicaRetornoResultadoAssociados struct {
	// Categoria is retorno.resultadoAssociados[].categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// ParticipacaoRelativa is retorno.resultadoAssociados[].participacaoRelativa, documented as a string.
	ParticipacaoRelativa Text `json:"participacaoRelativa"`
	// Quantidade is retorno.resultadoAssociados[].quantidade, documented as a number.
	Quantidade Number `json:"quantidade"`
}

DAPPessoaJuridicaRetornoResultadoAssociados is retorno.resultadoAssociados[] in the answer of DAPPessoaJuridica.

type Dedupe 

type Dedupe interface {
	// Seen returns the result remembered under the key, and false on a miss.
	Seen(ctx context.Context, key DedupeKey) (*Result, bool, error)
	// Remember stores a billable result under the key.
	Remember(ctx context.Context, key DedupeKey, r *Result) error
}

Dedupe remembers billable results for the day. The application implements it over its own storage, bound to the tenant like the Ledger, and keeps what it stores encrypted: a result is personal data. Optional: a Meter without one queries every time.

type DedupeKey 

type DedupeKey struct {
	// Product is the API's slug.
	Product string
	// Document is the document, bare (digits, or the CNPJ's characters), or
	// "" when the query had none.
	Document string
	// ParamsDigest is the SHA-256, in hex, of every other parameter, so a
	// query with other inputs is a different key.
	ParamsDigest string
	// Day is the query's date in the configured location, YYYY-MM-DD.
	Day string
}

DedupeKey identifies a query for Dedupe. Direct Data bills the same document on the same API on the same day again (terms clause 2.5), so a result remembered under this key saves a charge.

type DetalhamentoNegativoParams 

type DetalhamentoNegativoParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

DetalhamentoNegativoParams are the parameters of DetalhamentoNegativo (Detalhamento Negativo QUOD).

func (DetalhamentoNegativoParams) Request 

func (p DetalhamentoNegativoParams) Request() (Request, error)

Request builds the Request for DetalhamentoNegativo.

type DetalhamentoNegativoRetorno 

type DetalhamentoNegativoRetorno struct {
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// PessoaFisica is retorno.pessoaFisica.
	PessoaFisica DetalhamentoNegativoRetornoPessoaFisica `json:"pessoaFisica"`
	// PessoaJuridica is retorno.pessoaJuridica.
	PessoaJuridica DetalhamentoNegativoRetornoPessoaJuridica `json:"pessoaJuridica"`
}

DetalhamentoNegativoRetorno is retorno in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisica 

type DetalhamentoNegativoRetornoPessoaFisica struct {
	// PendenciaFinanceira is retorno.pessoaFisica.pendenciaFinanceira.
	PendenciaFinanceira DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceira `json:"pendenciaFinanceira"`
}

DetalhamentoNegativoRetornoPessoaFisica is retorno.pessoaFisica in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceira 

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceira struct {
	// AcoesJudiciais is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais, a list.
	AcoesJudiciais []DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraAcoesJudiciais `json:"acoesJudiciais"`
	// ChequesSemFundo is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo, a list.
	ChequesSemFundo []DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraChequesSemFundo `json:"chequesSemFundo"`
	// Protestos is retorno.pessoaFisica.pendenciaFinanceira.protestos, a list.
	Protestos []DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestos `json:"protestos"`
	// RecuperacoesJudiciaisFalencia is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia, a list.
	RecuperacoesJudiciaisFalencia []DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia `json:"recuperacoesJudiciaisFalencia"`
	// Status is retorno.pessoaFisica.pendenciaFinanceira.status, documented as a string.
	Status Text `json:"status"`
	// TotalPendencia is retorno.pessoaFisica.pendenciaFinanceira.totalPendencia, documented as a number.
	TotalPendencia Number `json:"totalPendencia"`
}

DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceira is retorno.pessoaFisica.pendenciaFinanceira in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraAcoesJudiciais 

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraAcoesJudiciais struct {
	// AutorProcesso is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].autorProcesso, documented as a string.
	AutorProcesso Text `json:"autorProcesso"`
	// Cidade is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Comarca is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataAjuizamento is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].dataAjuizamento, documented as a string.
	DataAjuizamento Text `json:"dataAjuizamento"`
	// Documento is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Forum is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].forum, documented as a string.
	Forum Text `json:"forum"`
	// NumeroProcessoAntigo is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoAntigo, documented as a string.
	NumeroProcessoAntigo Text `json:"numeroProcessoAntigo"`
	// NumeroProcessoPrincipal is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoPrincipal, documented as a string.
	NumeroProcessoPrincipal Text `json:"numeroProcessoPrincipal"`
	// ParteAcusada is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].parteAcusada, documented as a string.
	ParteAcusada Text `json:"parteAcusada"`
	// Status is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].status, documented as a string.
	Status Text `json:"status"`
	// TipoProcesso is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].tipoProcesso, documented as a string.
	TipoProcesso Text `json:"tipoProcesso"`
	// TipoTribunal is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].tipoTribunal, documented as a string.
	TipoTribunal Text `json:"tipoTribunal"`
	// Valor is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].valor, documented as a number.
	Valor Number `json:"valor"`
	// Vara is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[].vara, documented as a string.
	Vara Text `json:"vara"`
}

DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraAcoesJudiciais is retorno.pessoaFisica.pendenciaFinanceira.acoesJudiciais[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraChequesSemFundo 

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraChequesSemFundo struct {
	// CodigoBanco is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[].codigoBanco, documented as a string.
	CodigoBanco Text `json:"codigoBanco"`
	// DataUltimaOcorrencia is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[].dataUltimaOcorrencia, documented as a string.
	DataUltimaOcorrencia Text `json:"dataUltimaOcorrencia"`
	// Documento is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeAgencia is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[].nomeAgencia, documented as a string.
	NomeAgencia Text `json:"nomeAgencia" pii:"name"`
	// NumeroAgencia is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[].numeroAgencia, documented as a string.
	NumeroAgencia Text `json:"numeroAgencia"`
	// QuantidadeOcorrencia is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[].quantidadeOcorrencia, documented as a number.
	QuantidadeOcorrencia Number `json:"quantidadeOcorrencia"`
	// TipoPessoa is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[].tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraChequesSemFundo is retorno.pessoaFisica.pendenciaFinanceira.chequesSemFundo[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestos 

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestos struct {
	// Cartorios is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios, a list.
	Cartorios []DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestosCartorios `json:"cartorios"`
	// Observacao is retorno.pessoaFisica.pendenciaFinanceira.protestos[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Situacao is retorno.pessoaFisica.pendenciaFinanceira.protestos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// ValorTotal is retorno.pessoaFisica.pendenciaFinanceira.protestos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestos is retorno.pessoaFisica.pendenciaFinanceira.protestos[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestosCartorios 

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestosCartorios struct {
	// Cidade is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoCartorio is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].codigoCartorio, documented as a string.
	CodigoCartorio Text `json:"codigoCartorio"`
	// CodigoCidade is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].codigoCidade, documented as a string.
	CodigoCidade Text `json:"codigoCidade"`
	// Endereco is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// QuantidadeProtestos is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].quantidadeProtestos, documented as a number.
	QuantidadeProtestos Number `json:"quantidadeProtestos"`
	// Telefone is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// ValorProtestado is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[].valorProtestado, documented as a number.
	ValorProtestado Number `json:"valorProtestado"`
}

DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraProtestosCartorios is retorno.pessoaFisica.pendenciaFinanceira.protestos[].cartorios[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia 

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia struct {
	// DataInclusao is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataModificacao is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataModificacao, documented as a string.
	DataModificacao Text `json:"dataModificacao"`
	// DataOcorrencia is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataOcorrencia, documented as a string.
	DataOcorrencia Text `json:"dataOcorrencia"`
	// Documento is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Endereco is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.
	Endereco DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco `json:"endereco"`
	// Motivo is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].motivo, documented as a string.
	Motivo Text `json:"motivo"`
	// NomeEmpresa is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].nomeEmpresa, documented as a string.
	NomeEmpresa Text `json:"nomeEmpresa" pii:"name"`
	// NumeroContrato is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// Status is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].status, documented as a string.
	Status Text `json:"status"`
	// TipoParticipacao is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].tipoParticipacao, documented as a string.
	TipoParticipacao Text `json:"tipoParticipacao"`
	// Valor is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].valor, documented as a number.
	Valor Number `json:"valor"`
}

DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco 

type DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco struct {
	// Bairro is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

DetalhamentoNegativoRetornoPessoaFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco is retorno.pessoaFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridica 

type DetalhamentoNegativoRetornoPessoaJuridica struct {
	// PendenciaFinanceira is retorno.pessoaJuridica.pendenciaFinanceira.
	PendenciaFinanceira DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceira `json:"pendenciaFinanceira"`
}

DetalhamentoNegativoRetornoPessoaJuridica is retorno.pessoaJuridica in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceira 

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceira struct {
	// AcoesJudiciais is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais, a list.
	AcoesJudiciais []DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraAcoesJudiciais `json:"acoesJudiciais"`
	// ChequesSemFundo is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo, a list.
	ChequesSemFundo []DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraChequesSemFundo `json:"chequesSemFundo"`
	// Protestos is retorno.pessoaJuridica.pendenciaFinanceira.protestos, a list.
	Protestos []DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestos `json:"protestos"`
	// RecuperacoesJudiciaisFalencia is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia, a list.
	RecuperacoesJudiciaisFalencia []DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia `json:"recuperacoesJudiciaisFalencia"`
	// Status is retorno.pessoaJuridica.pendenciaFinanceira.status, documented as a string.
	Status Text `json:"status"`
	// TotalPendencia is retorno.pessoaJuridica.pendenciaFinanceira.totalPendencia, documented as a number.
	TotalPendencia Number `json:"totalPendencia"`
}

DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceira is retorno.pessoaJuridica.pendenciaFinanceira in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraAcoesJudiciais 

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraAcoesJudiciais struct {
	// AutorProcesso is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].autorProcesso, documented as a string.
	AutorProcesso Text `json:"autorProcesso"`
	// Cidade is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Comarca is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataAjuizamento is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].dataAjuizamento, documented as a string.
	DataAjuizamento Text `json:"dataAjuizamento"`
	// Documento is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Forum is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].forum, documented as a string.
	Forum Text `json:"forum"`
	// NumeroProcessoAntigo is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoAntigo, documented as a string.
	NumeroProcessoAntigo Text `json:"numeroProcessoAntigo"`
	// NumeroProcessoPrincipal is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoPrincipal, documented as a string.
	NumeroProcessoPrincipal Text `json:"numeroProcessoPrincipal"`
	// ParteAcusada is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].parteAcusada, documented as a string.
	ParteAcusada Text `json:"parteAcusada"`
	// Status is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].status, documented as a string.
	Status Text `json:"status"`
	// TipoProcesso is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].tipoProcesso, documented as a string.
	TipoProcesso Text `json:"tipoProcesso"`
	// TipoTribunal is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].tipoTribunal, documented as a string.
	TipoTribunal Text `json:"tipoTribunal"`
	// Valor is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].valor, documented as a number.
	Valor Number `json:"valor"`
	// Vara is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[].vara, documented as a string.
	Vara Text `json:"vara"`
}

DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraAcoesJudiciais is retorno.pessoaJuridica.pendenciaFinanceira.acoesJudiciais[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraChequesSemFundo 

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraChequesSemFundo struct {
	// CodigoBanco is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[].codigoBanco, documented as a string.
	CodigoBanco Text `json:"codigoBanco"`
	// DataUltimaOcorrencia is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[].dataUltimaOcorrencia, documented as a string.
	DataUltimaOcorrencia Text `json:"dataUltimaOcorrencia"`
	// Documento is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeAgencia is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[].nomeAgencia, documented as a string.
	NomeAgencia Text `json:"nomeAgencia" pii:"name"`
	// NumeroAgencia is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[].numeroAgencia, documented as a string.
	NumeroAgencia Text `json:"numeroAgencia"`
	// QuantidadeOcorrencia is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[].quantidadeOcorrencia, documented as a number.
	QuantidadeOcorrencia Number `json:"quantidadeOcorrencia"`
	// TipoPessoa is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[].tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraChequesSemFundo is retorno.pessoaJuridica.pendenciaFinanceira.chequesSemFundo[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestos 

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestos struct {
	// Cartorios is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios, a list.
	Cartorios []DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestosCartorios `json:"cartorios"`
	// Observacao is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Situacao is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// ValorTotal is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestos is retorno.pessoaJuridica.pendenciaFinanceira.protestos[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestosCartorios 

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestosCartorios struct {
	// Cidade is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoCartorio is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].codigoCartorio, documented as a string.
	CodigoCartorio Text `json:"codigoCartorio"`
	// CodigoCidade is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].codigoCidade, documented as a string.
	CodigoCidade Text `json:"codigoCidade"`
	// Endereco is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// QuantidadeProtestos is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].quantidadeProtestos, documented as a number.
	QuantidadeProtestos Number `json:"quantidadeProtestos"`
	// Telefone is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// ValorProtestado is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[].valorProtestado, documented as a number.
	ValorProtestado Number `json:"valorProtestado"`
}

DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraProtestosCartorios is retorno.pessoaJuridica.pendenciaFinanceira.protestos[].cartorios[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia 

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia struct {
	// DataInclusao is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataModificacao is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataModificacao, documented as a string.
	DataModificacao Text `json:"dataModificacao"`
	// DataOcorrencia is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataOcorrencia, documented as a string.
	DataOcorrencia Text `json:"dataOcorrencia"`
	// Documento is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Endereco is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.
	Endereco DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco `json:"endereco"`
	// Motivo is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].motivo, documented as a string.
	Motivo Text `json:"motivo"`
	// NomeEmpresa is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].nomeEmpresa, documented as a string.
	NomeEmpresa Text `json:"nomeEmpresa" pii:"name"`
	// NumeroContrato is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// Status is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].status, documented as a string.
	Status Text `json:"status"`
	// TipoParticipacao is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].tipoParticipacao, documented as a string.
	TipoParticipacao Text `json:"tipoParticipacao"`
	// Valor is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].valor, documented as a number.
	Valor Number `json:"valor"`
}

DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[] in the answer of DetalhamentoNegativo.

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco 

type DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco struct {
	// Bairro is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

DetalhamentoNegativoRetornoPessoaJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco is retorno.pessoaJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco in the answer of DetalhamentoNegativo.

type DocumentKind 

type DocumentKind string

DocumentKind is what a document is. 

const (
	// KindCPF is a CPF.
	KindCPF DocumentKind = "cpf"
	// KindCNPJ is a CNPJ, numeric or alphanumeric.
	KindCNPJ DocumentKind = "cnpj"
)

The document kinds.

type DossieCreditoCompletoParams 

type DossieCreditoCompletoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

DossieCreditoCompletoParams are the parameters of DossieCreditoCompleto (Dossiê QUOD - Completo).

func (DossieCreditoCompletoParams) Request 

func (p DossieCreditoCompletoParams) Request() (Request, error)

Request builds the Request for DossieCreditoCompleto.

type DossieCreditoCompletoRetorno 

type DossieCreditoCompletoRetorno struct {
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// EntidadeFisica is retorno.entidadeFisica.
	EntidadeFisica DossieCreditoCompletoRetornoEntidadeFisica `json:"entidadeFisica"`
	// EntidadeJuridica is retorno.entidadeJuridica.
	EntidadeJuridica DossieCreditoCompletoRetornoEntidadeJuridica `json:"entidadeJuridica"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
}

DossieCreditoCompletoRetorno is retorno in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisica 

type DossieCreditoCompletoRetornoEntidadeFisica struct {
	// Consulta is retorno.entidadeFisica.consulta.
	Consulta DossieCreditoCompletoRetornoEntidadeFisicaConsulta `json:"consulta"`
	// DadosCadastrais is retorno.entidadeFisica.dadosCadastrais.
	DadosCadastrais DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastrais `json:"dadosCadastrais"`
	// DadosEmpresariais is retorno.entidadeFisica.dadosEmpresariais, a list.
	DadosEmpresariais []DossieCreditoCompletoRetornoEntidadeFisicaDadosEmpresariais `json:"dadosEmpresariais"`
	// FrequenciaPagamentos is retorno.entidadeFisica.frequenciaPagamentos, a list.
	FrequenciaPagamentos []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentos `json:"frequenciaPagamentos"`
	// PendenciaFinanceira is retorno.entidadeFisica.pendenciaFinanceira.
	PendenciaFinanceira DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceira `json:"pendenciaFinanceira"`
	// ScoreEntidade is retorno.entidadeFisica.scoreEntidade.
	ScoreEntidade DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidade `json:"scoreEntidade"`
	// SegmentoCadastroPositivo is retorno.entidadeFisica.segmentoCadastroPositivo, documented as a string.
	SegmentoCadastroPositivo Text `json:"segmentoCadastroPositivo"`
	// StatusCadastroPositivo is retorno.entidadeFisica.statusCadastroPositivo, documented as a string.
	StatusCadastroPositivo Text `json:"statusCadastroPositivo"`
}

DossieCreditoCompletoRetornoEntidadeFisica is retorno.entidadeFisica in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaConsulta 

type DossieCreditoCompletoRetornoEntidadeFisicaConsulta struct {
	// Cnpj is retorno.entidadeFisica.consulta.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DetalhesConsulta is retorno.entidadeFisica.consulta.detalhesConsulta, a list.
	DetalhesConsulta []DossieCreditoCompletoRetornoEntidadeFisicaConsultaDetalhesConsulta `json:"detalhesConsulta"`
	// Mais90Dias is retorno.entidadeFisica.consulta.mais90Dias, documented as a number.
	Mais90Dias Number `json:"mais90Dias"`
	// Ultimos30Dias is retorno.entidadeFisica.consulta.ultimos30Dias, documented as a number.
	Ultimos30Dias Number `json:"ultimos30Dias"`
	// Ultimos60Dias is retorno.entidadeFisica.consulta.ultimos60Dias, documented as a number.
	Ultimos60Dias Number `json:"ultimos60Dias"`
	// Ultimos90Dias is retorno.entidadeFisica.consulta.ultimos90Dias, documented as a number.
	Ultimos90Dias Number `json:"ultimos90Dias"`
}

DossieCreditoCompletoRetornoEntidadeFisicaConsulta is retorno.entidadeFisica.consulta in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaConsultaDetalhesConsulta 

type DossieCreditoCompletoRetornoEntidadeFisicaConsultaDetalhesConsulta struct {
	// Data is retorno.entidadeFisica.consulta.detalhesConsulta[].data, documented as a string.
	Data Text `json:"data"`
	// QuantidadeConsultada is retorno.entidadeFisica.consulta.detalhesConsulta[].quantidadeConsultada, documented as a number.
	QuantidadeConsultada Number `json:"quantidadeConsultada"`
	// SegmentoEmpresa is retorno.entidadeFisica.consulta.detalhesConsulta[].segmentoEmpresa, documented as a string.
	SegmentoEmpresa Text `json:"segmentoEmpresa"`
}

DossieCreditoCompletoRetornoEntidadeFisicaConsultaDetalhesConsulta is retorno.entidadeFisica.consulta.detalhesConsulta[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastrais 

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastrais struct {
	// DadosAtuais is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.
	DadosAtuais DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuais `json:"dadosAtuais"`
	// DataNascimento is retorno.entidadeFisica.dadosCadastrais.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.entidadeFisica.dadosCadastrais.dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Idade is retorno.entidadeFisica.dadosCadastrais.idade, documented as a number.
	Idade Number `json:"idade"`
	// Nome is retorno.entidadeFisica.dadosCadastrais.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.entidadeFisica.dadosCadastrais.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// OutrosCelulares is retorno.entidadeFisica.dadosCadastrais.outrosCelulares, a list.
	OutrosCelulares []Text `json:"outrosCelulares" pii:"phone"`
	// OutrosEmails is retorno.entidadeFisica.dadosCadastrais.outrosEmails, a list.
	OutrosEmails []Text `json:"outrosEmails" pii:"email"`
	// OutrosEnderecos is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos, a list.
	OutrosEnderecos []DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisOutrosEnderecos `json:"outrosEnderecos"`
	// OutrosNomes is retorno.entidadeFisica.dadosCadastrais.outrosNomes, a list.
	OutrosNomes []Text `json:"outrosNomes"`
	// OutrosTelefonesFixos is retorno.entidadeFisica.dadosCadastrais.outrosTelefonesFixos, a list.
	OutrosTelefonesFixos []Text `json:"outrosTelefonesFixos" pii:"phone"`
	// PossuiObito is retorno.entidadeFisica.dadosCadastrais.possuiObito, documented as a boolean.
	PossuiObito Flag `json:"possuiObito"`
	// Sexo is retorno.entidadeFisica.dadosCadastrais.sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Status is retorno.entidadeFisica.dadosCadastrais.status, documented as a string.
	Status Text `json:"status"`
}

DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastrais is retorno.entidadeFisica.dadosCadastrais in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuais 

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuais struct {
	// Celular is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.celular, documented as a string.
	Celular Text `json:"celular" pii:"phone"`
	// Email is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Endereco is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.
	Endereco DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuaisEndereco `json:"endereco"`
	// TelefoneFixo is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.telefoneFixo, documented as a string.
	TelefoneFixo Text `json:"telefoneFixo" pii:"phone"`
}

DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuais is retorno.entidadeFisica.dadosCadastrais.dadosAtuais in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuaisEndereco 

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuaisEndereco struct {
	// Bairro is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisDadosAtuaisEndereco is retorno.entidadeFisica.dadosCadastrais.dadosAtuais.endereco in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisOutrosEnderecos 

type DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisOutrosEnderecos struct {
	// Bairro is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

DossieCreditoCompletoRetornoEntidadeFisicaDadosCadastraisOutrosEnderecos is retorno.entidadeFisica.dadosCadastrais.outrosEnderecos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaDadosEmpresariais 

type DossieCreditoCompletoRetornoEntidadeFisicaDadosEmpresariais struct {
	// DataInicioEntrada is retorno.entidadeFisica.dadosEmpresariais[].dataInicioEntrada, documented as a string.
	DataInicioEntrada Text `json:"dataInicioEntrada"`
	// DataInicioSociedade is retorno.entidadeFisica.dadosEmpresariais[].dataInicioSociedade, documented as a string.
	DataInicioSociedade Text `json:"dataInicioSociedade"`
	// DataSaida is retorno.entidadeFisica.dadosEmpresariais[].dataSaida, documented as a string.
	DataSaida Text `json:"dataSaida"`
	// Documento is retorno.entidadeFisica.dadosEmpresariais[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Entidade is retorno.entidadeFisica.dadosEmpresariais[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// FuncaoSocio is retorno.entidadeFisica.dadosEmpresariais[].funcaoSocio, documented as a string.
	FuncaoSocio Text `json:"funcaoSocio"`
	// NomeEmpresa is retorno.entidadeFisica.dadosEmpresariais[].nomeEmpresa, documented as a string.
	NomeEmpresa Text `json:"nomeEmpresa" pii:"name"`
	// PercentualParticipacao is retorno.entidadeFisica.dadosEmpresariais[].percentualParticipacao, documented as a number.
	PercentualParticipacao Number `json:"percentualParticipacao"`
	// SocioAdministrador is retorno.entidadeFisica.dadosEmpresariais[].socioAdministrador, documented as a boolean.
	SocioAdministrador Flag `json:"socioAdministrador"`
	// Status is retorno.entidadeFisica.dadosEmpresariais[].status, documented as a string.
	Status Text `json:"status"`
	// ValorFinanceiro is retorno.entidadeFisica.dadosEmpresariais[].valorFinanceiro, documented as a number.
	ValorFinanceiro Number `json:"valorFinanceiro"`
}

DossieCreditoCompletoRetornoEntidadeFisicaDadosEmpresariais is retorno.entidadeFisica.dadosEmpresariais[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentos 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentos struct {
	// CartoesCredito is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito, a list.
	CartoesCredito []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCredito `json:"cartoesCredito"`
	// Consorcios is retorno.entidadeFisica.frequenciaPagamentos[].consorcios, a list.
	Consorcios []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorcios `json:"consorcios"`
	// Emprestimos is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos, a list.
	Emprestimos []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimos `json:"emprestimos"`
	// Rotativos is retorno.entidadeFisica.frequenciaPagamentos[].rotativos, a list.
	Rotativos []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativos `json:"rotativos"`
	// UnicoCNPJCartoesCredito is retorno.entidadeFisica.frequenciaPagamentos[].unicoCNPJCartoesCredito, documented as a number.
	UnicoCNPJCartoesCredito Number `json:"unicoCNPJCartoesCredito" pii:"document"`
	// UnicoCNPJConsorcios is retorno.entidadeFisica.frequenciaPagamentos[].unicoCNPJConsorcios, documented as a number.
	UnicoCNPJConsorcios Number `json:"unicoCNPJConsorcios" pii:"document"`
	// UnicoCNPJEmprestimos is retorno.entidadeFisica.frequenciaPagamentos[].unicoCNPJEmprestimos, documented as a number.
	UnicoCNPJEmprestimos Number `json:"unicoCNPJEmprestimos" pii:"document"`
	// UnicoCNPJRotativo is retorno.entidadeFisica.frequenciaPagamentos[].unicoCNPJRotativo, documented as a number.
	UnicoCNPJRotativo Number `json:"unicoCNPJRotativo" pii:"document"`
	// UnicoCNPJTotal is retorno.entidadeFisica.frequenciaPagamentos[].unicoCNPJTotal, documented as a number.
	UnicoCNPJTotal Number `json:"unicoCNPJTotal" pii:"document"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentos is retorno.entidadeFisica.frequenciaPagamentos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCredito 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCredito struct {
	// DataContratacao is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].dataContratacao, documented as a string.
	DataContratacao Text `json:"dataContratacao"`
	// DataReferencia is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// DetalheEmprestimo is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.
	DetalheEmprestimo DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimo `json:"detalheEmprestimo"`
	// NumeroCartao is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].numeroCartao, documented as a string.
	NumeroCartao Text `json:"numeroCartao"`
	// NumeroContrato is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// ParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.
	ParcelaFutura DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelaFutura `json:"parcelaFutura"`
	// ParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores, a list.
	ParcelasAnteriores []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnteriores `json:"parcelasAnteriores"`
	// SaldoTotal is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].saldoTotal, documented as a number.
	SaldoTotal Number `json:"saldoTotal"`
	// TipoContrato is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].tipoContrato, documented as a string.
	TipoContrato Text `json:"tipoContrato"`
	// TipoRelacionamento is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].tipoRelacionamento, documented as a string.
	TipoRelacionamento Text `json:"tipoRelacionamento"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCredito is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimo 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimo struct {
	// Total is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.total, documented as a number.
	Total Number `json:"total"`
	// VencimentoDevedor is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoDevedor.
	VencimentoDevedor DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoDevedor `json:"vencimentoDevedor"`
	// VencimentoExpirado is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoExpirado.
	VencimentoExpirado DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoExpirado `json:"vencimentoExpirado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimo is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoDevedor 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoDevedor struct {
	// Vencido15Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoDevedor.vencido15Dias, documented as a string.
	Vencido15Dias Text `json:"vencido15Dias"`
	// Vencido16A30Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoDevedor.vencido16A30Dias, documented as a string.
	Vencido16A30Dias Text `json:"vencido16A30Dias"`
	// Vencido31A60Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoDevedor.vencido31A60Dias, documented as a string.
	Vencido31A60Dias Text `json:"vencido31A60Dias"`
	// Vencido61A90Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoDevedor.vencido61A90Dias, documented as a string.
	Vencido61A90Dias Text `json:"vencido61A90Dias"`
	// VencidoMais91Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoDevedor.vencidoMais91Dias, documented as a string.
	VencidoMais91Dias Text `json:"vencidoMais91Dias"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoDevedor is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoDevedor in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoExpirado 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoExpirado struct {
	// Vencido15Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoExpirado.vencido15Dias, documented as a string.
	Vencido15Dias Text `json:"vencido15Dias"`
	// Vencido16A30Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoExpirado.vencido16A30Dias, documented as a string.
	Vencido16A30Dias Text `json:"vencido16A30Dias"`
	// Vencido31A60Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoExpirado.vencido31A60Dias, documented as a string.
	Vencido31A60Dias Text `json:"vencido31A60Dias"`
	// Vencido61A90Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoExpirado.vencido61A90Dias, documented as a string.
	Vencido61A90Dias Text `json:"vencido61A90Dias"`
	// VencidoMais91Dias is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoExpirado.vencidoMais91Dias, documented as a string.
	VencidoMais91Dias Text `json:"vencidoMais91Dias"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoDetalheEmprestimoVencimentoExpirado is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].detalheEmprestimo.vencimentoExpirado in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelaFutura 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelaFutura struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataParcelaAnterior is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.dataParcelaAnterior, documented as a string.
	DataParcelaAnterior Text `json:"dataParcelaAnterior"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Periodicidade is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.periodicidade, documented as a string.
	Periodicidade Text `json:"periodicidade"`
	// QuantidadeParcelasNaoPagas is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.quantidadeParcelasNaoPagas, documented as a number.
	QuantidadeParcelasNaoPagas Number `json:"quantidadeParcelasNaoPagas"`
	// QuantidadeParcelasRemanescentes is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.quantidadeParcelasRemanescentes, documented as a number.
	QuantidadeParcelasRemanescentes Number `json:"quantidadeParcelasRemanescentes"`
	// TotalParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.totalParcelaFutura, documented as a number.
	TotalParcelaFutura Number `json:"totalParcelaFutura"`
	// ValorUsado is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura.valorUsado, documented as a number.
	ValorUsado Number `json:"valorUsado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelaFutura in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnteriores 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnteriores struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataVencimento is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Pagamentos is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].pagamentos, a list.
	Pagamentos []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnterioresPagamentos `json:"pagamentos"`
	// PeriodicidadeParcela is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].periodicidadeParcela, documented as a string.
	PeriodicidadeParcela Text `json:"periodicidadeParcela"`
	// SaldoTotal is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].saldoTotal, documented as a number.
	SaldoTotal Number `json:"saldoTotal"`
	// StatusPagamento is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].statusPagamento, documented as a string.
	StatusPagamento Text `json:"statusPagamento"`
	// ValorUtilizado is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].valorUtilizado, documented as a number.
	ValorUtilizado Number `json:"valorUtilizado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnterioresPagamentos 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnterioresPagamentos struct {
	// Data is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].pagamentos[].data, documented as a string.
	Data Text `json:"data"`
	// ValorTotal is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].pagamentos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosCartoesCreditoParcelasAnterioresPagamentos is retorno.entidadeFisica.frequenciaPagamentos[].cartoesCredito[].parcelasAnteriores[].pagamentos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorcios 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorcios struct {
	// CodigoCota is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].codigoCota, documented as a string.
	CodigoCota Text `json:"codigoCota"`
	// DataContemplacao is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].dataContemplacao, documented as a string.
	DataContemplacao Text `json:"dataContemplacao"`
	// DataContratacao is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].dataContratacao, documented as a string.
	DataContratacao Text `json:"dataContratacao"`
	// DataReferencia is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// DataVencimento is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// DetalheEmprestimo is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.
	DetalheEmprestimo DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimo `json:"detalheEmprestimo"`
	// NumeroContrato is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// NumeroGrupo is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].numeroGrupo, documented as a string.
	NumeroGrupo Text `json:"numeroGrupo"`
	// PagamentosDesanexados is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].pagamentosDesanexados, a list.
	PagamentosDesanexados []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosPagamentosDesanexados `json:"pagamentosDesanexados"`
	// ParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores, a list.
	ParcelasAnteriores []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnteriores `json:"parcelasAnteriores"`
	// ParcelasFuturas is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas, a list.
	ParcelasFuturas []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasFuturas `json:"parcelasFuturas"`
	// QuantidadeTotalParcela is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].quantidadeTotalParcela, documented as a number.
	QuantidadeTotalParcela Number `json:"quantidadeTotalParcela"`
	// SequenciaCota is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].sequenciaCota, documented as a string.
	SequenciaCota Text `json:"sequenciaCota"`
	// StatusCota is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].statusCota, documented as a string.
	StatusCota Text `json:"statusCota"`
	// TipoContrato is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].tipoContrato, documented as a string.
	TipoContrato Text `json:"tipoContrato"`
	// TipoRelacionamento is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].tipoRelacionamento, documented as a string.
	TipoRelacionamento Text `json:"tipoRelacionamento"`
	// TotalDevedor is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].totalDevedor, documented as a number.
	TotalDevedor Number `json:"totalDevedor"`
	// ValorContrato is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].valorContrato, documented as a number.
	ValorContrato Number `json:"valorContrato"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorcios is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimo 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimo struct {
	// Total is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.total, documented as a number.
	Total Number `json:"total"`
	// VencimentoDevedor is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoDevedor.
	VencimentoDevedor DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoDevedor `json:"vencimentoDevedor"`
	// VencimentoExpirado is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoExpirado.
	VencimentoExpirado DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoExpirado `json:"vencimentoExpirado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimo is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoDevedor 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoDevedor struct {
	// Vencido15Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoDevedor.vencido15Dias, documented as a string.
	Vencido15Dias Text `json:"vencido15Dias"`
	// Vencido16A30Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoDevedor.vencido16A30Dias, documented as a string.
	Vencido16A30Dias Text `json:"vencido16A30Dias"`
	// Vencido31A60Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoDevedor.vencido31A60Dias, documented as a string.
	Vencido31A60Dias Text `json:"vencido31A60Dias"`
	// Vencido61A90Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoDevedor.vencido61A90Dias, documented as a string.
	Vencido61A90Dias Text `json:"vencido61A90Dias"`
	// VencidoMais91Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoDevedor.vencidoMais91Dias, documented as a string.
	VencidoMais91Dias Text `json:"vencidoMais91Dias"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoDevedor is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoDevedor in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoExpirado 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoExpirado struct {
	// Vencido15Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoExpirado.vencido15Dias, documented as a string.
	Vencido15Dias Text `json:"vencido15Dias"`
	// Vencido16A30Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoExpirado.vencido16A30Dias, documented as a string.
	Vencido16A30Dias Text `json:"vencido16A30Dias"`
	// Vencido31A60Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoExpirado.vencido31A60Dias, documented as a string.
	Vencido31A60Dias Text `json:"vencido31A60Dias"`
	// Vencido61A90Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoExpirado.vencido61A90Dias, documented as a string.
	Vencido61A90Dias Text `json:"vencido61A90Dias"`
	// VencidoMais91Dias is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoExpirado.vencidoMais91Dias, documented as a string.
	VencidoMais91Dias Text `json:"vencidoMais91Dias"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosDetalheEmprestimoVencimentoExpirado is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].detalheEmprestimo.vencimentoExpirado in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosPagamentosDesanexados 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosPagamentosDesanexados struct {
	// Data is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].pagamentosDesanexados[].data, documented as a string.
	Data Text `json:"data"`
	// TipoPagamento is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].pagamentosDesanexados[].tipoPagamento, documented as a string.
	TipoPagamento Text `json:"tipoPagamento"`
	// TotalPago is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].pagamentosDesanexados[].totalPago, documented as a number.
	TotalPago Number `json:"totalPago"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosPagamentosDesanexados is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].pagamentosDesanexados[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnteriores 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnteriores struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataVencimento is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Pagamentos is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].pagamentos, a list.
	Pagamentos []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnterioresPagamentos `json:"pagamentos"`
	// PeriodicidadeParcela is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].periodicidadeParcela, documented as a string.
	PeriodicidadeParcela Text `json:"periodicidadeParcela"`
	// SaldoTotal is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].saldoTotal, documented as a number.
	SaldoTotal Number `json:"saldoTotal"`
	// StatusPagamento is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].statusPagamento, documented as a string.
	StatusPagamento Text `json:"statusPagamento"`
	// ValorUtilizado is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].valorUtilizado, documented as a number.
	ValorUtilizado Number `json:"valorUtilizado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnterioresPagamentos 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnterioresPagamentos struct {
	// Data is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].pagamentos[].data, documented as a string.
	Data Text `json:"data"`
	// ValorTotal is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].pagamentos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasAnterioresPagamentos is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasAnteriores[].pagamentos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasFuturas 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasFuturas struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataParcelaAnterior is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].dataParcelaAnterior, documented as a string.
	DataParcelaAnterior Text `json:"dataParcelaAnterior"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Periodicidade is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].periodicidade, documented as a string.
	Periodicidade Text `json:"periodicidade"`
	// QuantidadeParcelasNaoPagas is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].quantidadeParcelasNaoPagas, documented as a number.
	QuantidadeParcelasNaoPagas Number `json:"quantidadeParcelasNaoPagas"`
	// QuantidadeParcelasRemanescentes is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].quantidadeParcelasRemanescentes, documented as a number.
	QuantidadeParcelasRemanescentes Number `json:"quantidadeParcelasRemanescentes"`
	// TotalParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].totalParcelaFutura, documented as a number.
	TotalParcelaFutura Number `json:"totalParcelaFutura"`
	// ValorUsado is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[].valorUsado, documented as a number.
	ValorUsado Number `json:"valorUsado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosConsorciosParcelasFuturas is retorno.entidadeFisica.frequenciaPagamentos[].consorcios[].parcelasFuturas[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimos 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimos struct {
	// DataAtualizacao is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].dataAtualizacao, documented as a string.
	DataAtualizacao Text `json:"dataAtualizacao"`
	// DataContratacao is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].dataContratacao, documented as a string.
	DataContratacao Text `json:"dataContratacao"`
	// DataVencimento is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// DetalheEmprestimo is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.
	DetalheEmprestimo DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimo `json:"detalheEmprestimo"`
	// NumeroContrato is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// PagamentosDesanexados is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].pagamentosDesanexados, a list.
	PagamentosDesanexados []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosPagamentosDesanexados `json:"pagamentosDesanexados"`
	// ParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores, a list.
	ParcelasAnteriores []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnteriores `json:"parcelasAnteriores"`
	// ParcelasFuturas is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas, a list.
	ParcelasFuturas []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasFuturas `json:"parcelasFuturas"`
	// QuantidadeParcelas is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].quantidadeParcelas, documented as a number.
	QuantidadeParcelas Number `json:"quantidadeParcelas"`
	// TipoContratacao is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].tipoContratacao, documented as a string.
	TipoContratacao Text `json:"tipoContratacao"`
	// TipoRelacionamento is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].tipoRelacionamento, documented as a string.
	TipoRelacionamento Text `json:"tipoRelacionamento"`
	// ValorTotal is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimos is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimo 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimo struct {
	// Total is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.total, documented as a number.
	Total Number `json:"total"`
	// VencimentoDevedor is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoDevedor.
	VencimentoDevedor DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoDevedor `json:"vencimentoDevedor"`
	// VencimentoExpirado is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoExpirado.
	VencimentoExpirado DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoExpirado `json:"vencimentoExpirado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimo is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoDevedor 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoDevedor struct {
	// Vencido15Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoDevedor.vencido15Dias, documented as a string.
	Vencido15Dias Text `json:"vencido15Dias"`
	// Vencido16A30Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoDevedor.vencido16A30Dias, documented as a string.
	Vencido16A30Dias Text `json:"vencido16A30Dias"`
	// Vencido31A60Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoDevedor.vencido31A60Dias, documented as a string.
	Vencido31A60Dias Text `json:"vencido31A60Dias"`
	// Vencido61A90Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoDevedor.vencido61A90Dias, documented as a string.
	Vencido61A90Dias Text `json:"vencido61A90Dias"`
	// VencidoMais91Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoDevedor.vencidoMais91Dias, documented as a string.
	VencidoMais91Dias Text `json:"vencidoMais91Dias"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoDevedor is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoDevedor in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoExpirado 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoExpirado struct {
	// Vencido15Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoExpirado.vencido15Dias, documented as a string.
	Vencido15Dias Text `json:"vencido15Dias"`
	// Vencido16A30Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoExpirado.vencido16A30Dias, documented as a string.
	Vencido16A30Dias Text `json:"vencido16A30Dias"`
	// Vencido31A60Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoExpirado.vencido31A60Dias, documented as a string.
	Vencido31A60Dias Text `json:"vencido31A60Dias"`
	// Vencido61A90Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoExpirado.vencido61A90Dias, documented as a string.
	Vencido61A90Dias Text `json:"vencido61A90Dias"`
	// VencidoMais91Dias is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoExpirado.vencidoMais91Dias, documented as a string.
	VencidoMais91Dias Text `json:"vencidoMais91Dias"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosDetalheEmprestimoVencimentoExpirado is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].detalheEmprestimo.vencimentoExpirado in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosPagamentosDesanexados 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosPagamentosDesanexados struct {
	// Data is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].pagamentosDesanexados[].data, documented as a string.
	Data Text `json:"data"`
	// TipoPagamento is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].pagamentosDesanexados[].tipoPagamento, documented as a string.
	TipoPagamento Text `json:"tipoPagamento"`
	// TotalPago is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].pagamentosDesanexados[].totalPago, documented as a number.
	TotalPago Number `json:"totalPago"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosPagamentosDesanexados is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].pagamentosDesanexados[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnteriores 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnteriores struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataVencimento is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Pagamentos is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].pagamentos, a list.
	Pagamentos []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnterioresPagamentos `json:"pagamentos"`
	// PeriodicidadeParcela is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].periodicidadeParcela, documented as a string.
	PeriodicidadeParcela Text `json:"periodicidadeParcela"`
	// SaldoTotal is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].saldoTotal, documented as a number.
	SaldoTotal Number `json:"saldoTotal"`
	// StatusPagamento is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].statusPagamento, documented as a string.
	StatusPagamento Text `json:"statusPagamento"`
	// ValorUtilizado is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].valorUtilizado, documented as a number.
	ValorUtilizado Number `json:"valorUtilizado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnterioresPagamentos 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnterioresPagamentos struct {
	// Data is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].pagamentos[].data, documented as a string.
	Data Text `json:"data"`
	// ValorTotal is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].pagamentos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasAnterioresPagamentos is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasAnteriores[].pagamentos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasFuturas 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasFuturas struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataParcelaAnterior is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].dataParcelaAnterior, documented as a string.
	DataParcelaAnterior Text `json:"dataParcelaAnterior"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Periodicidade is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].periodicidade, documented as a string.
	Periodicidade Text `json:"periodicidade"`
	// QuantidadeParcelasNaoPagas is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].quantidadeParcelasNaoPagas, documented as a number.
	QuantidadeParcelasNaoPagas Number `json:"quantidadeParcelasNaoPagas"`
	// QuantidadeParcelasRemanescentes is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].quantidadeParcelasRemanescentes, documented as a number.
	QuantidadeParcelasRemanescentes Number `json:"quantidadeParcelasRemanescentes"`
	// TotalParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].totalParcelaFutura, documented as a number.
	TotalParcelaFutura Number `json:"totalParcelaFutura"`
	// ValorUsado is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[].valorUsado, documented as a number.
	ValorUsado Number `json:"valorUsado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosEmprestimosParcelasFuturas is retorno.entidadeFisica.frequenciaPagamentos[].emprestimos[].parcelasFuturas[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativos 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativos struct {
	// DataContratacao is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].dataContratacao, documented as a string.
	DataContratacao Text `json:"dataContratacao"`
	// DataFechamento is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].dataFechamento, documented as a string.
	DataFechamento Text `json:"dataFechamento"`
	// DataReferencia is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].dataReferencia, documented as a string.
	DataReferencia Text `json:"dataReferencia"`
	// NumeroContrato is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// ParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.
	ParcelaFutura DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelaFutura `json:"parcelaFutura"`
	// ParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores, a list.
	ParcelasAnteriores []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnteriores `json:"parcelasAnteriores"`
	// TipoContratacao is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].tipoContratacao, documented as a string.
	TipoContratacao Text `json:"tipoContratacao"`
	// TipoRelacionamento is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].tipoRelacionamento, documented as a string.
	TipoRelacionamento Text `json:"tipoRelacionamento"`
	// ValorUsado is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].valorUsado, documented as a number.
	ValorUsado Number `json:"valorUsado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativos is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelaFutura 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelaFutura struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataParcelaAnterior is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.dataParcelaAnterior, documented as a string.
	DataParcelaAnterior Text `json:"dataParcelaAnterior"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Periodicidade is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.periodicidade, documented as a string.
	Periodicidade Text `json:"periodicidade"`
	// QuantidadeParcelasNaoPagas is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.quantidadeParcelasNaoPagas, documented as a number.
	QuantidadeParcelasNaoPagas Number `json:"quantidadeParcelasNaoPagas"`
	// QuantidadeParcelasRemanescentes is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.quantidadeParcelasRemanescentes, documented as a number.
	QuantidadeParcelasRemanescentes Number `json:"quantidadeParcelasRemanescentes"`
	// TotalParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.totalParcelaFutura, documented as a number.
	TotalParcelaFutura Number `json:"totalParcelaFutura"`
	// ValorUsado is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura.valorUsado, documented as a number.
	ValorUsado Number `json:"valorUsado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelaFutura is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelaFutura in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnteriores 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnteriores struct {
	// DataEncerramento is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].dataEncerramento, documented as a string.
	DataEncerramento Text `json:"dataEncerramento"`
	// DataVencimento is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].dataVencimento, documented as a string.
	DataVencimento Text `json:"dataVencimento"`
	// PagamentoMinimo is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].pagamentoMinimo, documented as a number.
	PagamentoMinimo Number `json:"pagamentoMinimo"`
	// Pagamentos is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].pagamentos, a list.
	Pagamentos []DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnterioresPagamentos `json:"pagamentos"`
	// PeriodicidadeParcela is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].periodicidadeParcela, documented as a string.
	PeriodicidadeParcela Text `json:"periodicidadeParcela"`
	// SaldoTotal is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].saldoTotal, documented as a number.
	SaldoTotal Number `json:"saldoTotal"`
	// StatusPagamento is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].statusPagamento, documented as a string.
	StatusPagamento Text `json:"statusPagamento"`
	// ValorUtilizado is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].valorUtilizado, documented as a number.
	ValorUtilizado Number `json:"valorUtilizado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnteriores is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnterioresPagamentos 

type DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnterioresPagamentos struct {
	// Data is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].pagamentos[].data, documented as a string.
	Data Text `json:"data"`
	// ValorTotal is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].pagamentos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DossieCreditoCompletoRetornoEntidadeFisicaFrequenciaPagamentosRotativosParcelasAnterioresPagamentos is retorno.entidadeFisica.frequenciaPagamentos[].rotativos[].parcelasAnteriores[].pagamentos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceira 

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceira struct {
	// AcoesJudiciais is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais, a list.
	AcoesJudiciais []DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraAcoesJudiciais `json:"acoesJudiciais"`
	// ChequesSemFundo is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo, a list.
	ChequesSemFundo []DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraChequesSemFundo `json:"chequesSemFundo"`
	// Protestos is retorno.entidadeFisica.pendenciaFinanceira.protestos, a list.
	Protestos []DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestos `json:"protestos"`
	// RecuperacoesJudiciaisFalencia is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia, a list.
	RecuperacoesJudiciaisFalencia []DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia `json:"recuperacoesJudiciaisFalencia"`
	// Status is retorno.entidadeFisica.pendenciaFinanceira.status, documented as a string.
	Status Text `json:"status"`
	// TotalPendencia is retorno.entidadeFisica.pendenciaFinanceira.totalPendencia, documented as a number.
	TotalPendencia Number `json:"totalPendencia"`
}

DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceira is retorno.entidadeFisica.pendenciaFinanceira in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraAcoesJudiciais 

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraAcoesJudiciais struct {
	// AutorProcesso is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].autorProcesso, documented as a string.
	AutorProcesso Text `json:"autorProcesso"`
	// Cidade is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Comarca is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataAjuizamento is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].dataAjuizamento, documented as a string.
	DataAjuizamento Text `json:"dataAjuizamento"`
	// Documento is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Forum is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].forum, documented as a string.
	Forum Text `json:"forum"`
	// NumeroProcessoAntigo is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoAntigo, documented as a string.
	NumeroProcessoAntigo Text `json:"numeroProcessoAntigo"`
	// NumeroProcessoPrincipal is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoPrincipal, documented as a string.
	NumeroProcessoPrincipal Text `json:"numeroProcessoPrincipal"`
	// ParteAcusada is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].parteAcusada, documented as a string.
	ParteAcusada Text `json:"parteAcusada"`
	// Status is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].status, documented as a string.
	Status Text `json:"status"`
	// TipoProcesso is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].tipoProcesso, documented as a string.
	TipoProcesso Text `json:"tipoProcesso"`
	// TipoTribunal is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].tipoTribunal, documented as a string.
	TipoTribunal Text `json:"tipoTribunal"`
	// Valor is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].valor, documented as a number.
	Valor Number `json:"valor"`
	// Vara is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[].vara, documented as a string.
	Vara Text `json:"vara"`
}

DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraAcoesJudiciais is retorno.entidadeFisica.pendenciaFinanceira.acoesJudiciais[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraChequesSemFundo 

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraChequesSemFundo struct {
	// CodigoBanco is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[].codigoBanco, documented as a string.
	CodigoBanco Text `json:"codigoBanco"`
	// DataUltimaOcorrencia is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[].dataUltimaOcorrencia, documented as a string.
	DataUltimaOcorrencia Text `json:"dataUltimaOcorrencia"`
	// Documento is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Entidade is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// NomeAgencia is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[].nomeAgencia, documented as a string.
	NomeAgencia Text `json:"nomeAgencia" pii:"name"`
	// NumeroAgencia is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[].numeroAgencia, documented as a string.
	NumeroAgencia Text `json:"numeroAgencia"`
	// QuantidadeOcorrencia is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[].quantidadeOcorrencia, documented as a number.
	QuantidadeOcorrencia Number `json:"quantidadeOcorrencia"`
}

DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraChequesSemFundo is retorno.entidadeFisica.pendenciaFinanceira.chequesSemFundo[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestos 

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestos struct {
	// Cartorios is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios, a list.
	Cartorios []DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestosCartorios `json:"cartorios"`
	// Observacao is retorno.entidadeFisica.pendenciaFinanceira.protestos[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Situacao is retorno.entidadeFisica.pendenciaFinanceira.protestos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// ValorTotal is retorno.entidadeFisica.pendenciaFinanceira.protestos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestos is retorno.entidadeFisica.pendenciaFinanceira.protestos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestosCartorios 

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestosCartorios struct {
	// Cidade is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoCartorio is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].codigoCartorio, documented as a string.
	CodigoCartorio Text `json:"codigoCartorio"`
	// CodigoCidade is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].codigoCidade, documented as a string.
	CodigoCidade Text `json:"codigoCidade"`
	// Endereco is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// QuantidadeProtestos is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].quantidadeProtestos, documented as a number.
	QuantidadeProtestos Number `json:"quantidadeProtestos"`
	// Telefone is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// ValorProtestado is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[].valorProtestado, documented as a number.
	ValorProtestado Number `json:"valorProtestado"`
}

DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraProtestosCartorios is retorno.entidadeFisica.pendenciaFinanceira.protestos[].cartorios[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia 

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia struct {
	// DataInclusao is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataModificacao is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataModificacao, documented as a string.
	DataModificacao Text `json:"dataModificacao"`
	// DataOcorrencia is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataOcorrencia, documented as a string.
	DataOcorrencia Text `json:"dataOcorrencia"`
	// Documento is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Endereco is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.
	Endereco DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco `json:"endereco"`
	// Motivo is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].motivo, documented as a string.
	Motivo Text `json:"motivo"`
	// NomeEmpresa is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].nomeEmpresa, documented as a string.
	NomeEmpresa Text `json:"nomeEmpresa" pii:"name"`
	// NumeroContrato is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// Status is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].status, documented as a string.
	Status Text `json:"status"`
	// TipoParticipacao is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].tipoParticipacao, documented as a string.
	TipoParticipacao Text `json:"tipoParticipacao"`
	// Valor is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].valor, documented as a number.
	Valor Number `json:"valor"`
}

DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco 

type DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco struct {
	// Bairro is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

DossieCreditoCompletoRetornoEntidadeFisicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco is retorno.entidadeFisica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidade 

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidade struct {
	// EntidadeFisica is retorno.entidadeFisica.scoreEntidade.entidadeFisica.
	EntidadeFisica DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeFisica `json:"entidadeFisica"`
	// EntidadeJuridica is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.
	EntidadeJuridica DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridica `json:"entidadeJuridica"`
	// Observacao is retorno.entidadeFisica.scoreEntidade.observacao, documented as a string.
	Observacao Text `json:"observacao"`
}

DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidade is retorno.entidadeFisica.scoreEntidade in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeFisica 

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeFisica struct {
	// CapacidadePagamento is retorno.entidadeFisica.scoreEntidade.entidadeFisica.capacidadePagamento, documented as a string.
	CapacidadePagamento Text `json:"capacidadePagamento"`
	// Perfil is retorno.entidadeFisica.scoreEntidade.entidadeFisica.perfil, documented as a string.
	Perfil Text `json:"perfil"`
	// Score is retorno.entidadeFisica.scoreEntidade.entidadeFisica.score, documented as a number.
	Score Number `json:"score"`
}

DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeFisica is retorno.entidadeFisica.scoreEntidade.entidadeFisica in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridica 

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridica struct {
	// IndicadoresNegocio is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.indicadoresNegocio, a list.
	IndicadoresNegocio []DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridicaIndicadoresNegocio `json:"indicadoresNegocio"`
	// Motivos is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.motivos, a list.
	Motivos []Text `json:"motivos"`
	// Score is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.score, documented as a number.
	Score Number `json:"score"`
}

DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridica is retorno.entidadeFisica.scoreEntidade.entidadeJuridica in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridicaIndicadoresNegocio 

type DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridicaIndicadoresNegocio struct {
	// Indicador is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.indicadoresNegocio[].indicador, documented as a string.
	Indicador Text `json:"indicador"`
	// Observacao is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.indicadoresNegocio[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Risco is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.indicadoresNegocio[].risco, documented as a string.
	Risco Text `json:"risco"`
	// Status is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.indicadoresNegocio[].status, documented as a string.
	Status Text `json:"status"`
}

DossieCreditoCompletoRetornoEntidadeFisicaScoreEntidadeEntidadeJuridicaIndicadoresNegocio is retorno.entidadeFisica.scoreEntidade.entidadeJuridica.indicadoresNegocio[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridica 

type DossieCreditoCompletoRetornoEntidadeJuridica struct {
	// Conglomerado is retorno.entidadeJuridica.conglomerado.
	Conglomerado DossieCreditoCompletoRetornoEntidadeJuridicaConglomerado `json:"conglomerado"`
	// Consulta is retorno.entidadeJuridica.consulta.
	Consulta DossieCreditoCompletoRetornoEntidadeJuridicaConsulta `json:"consulta"`
	// DadosCadastrais is retorno.entidadeJuridica.dadosCadastrais.
	DadosCadastrais DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastrais `json:"dadosCadastrais"`
	// DadosEmpresariais is retorno.entidadeJuridica.dadosEmpresariais, a list.
	DadosEmpresariais []DossieCreditoCompletoRetornoEntidadeJuridicaDadosEmpresariais `json:"dadosEmpresariais"`
	// Indicadores is retorno.entidadeJuridica.indicadores.
	Indicadores DossieCreditoCompletoRetornoEntidadeJuridicaIndicadores `json:"indicadores"`
	// PendenciaFinanceira is retorno.entidadeJuridica.pendenciaFinanceira.
	PendenciaFinanceira DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceira `json:"pendenciaFinanceira"`
	// QuadroSocietario is retorno.entidadeJuridica.quadroSocietario.
	QuadroSocietario DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietario `json:"quadroSocietario"`
	// ScoreEntidades is retorno.entidadeJuridica.scoreEntidades.
	ScoreEntidades DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidades `json:"scoreEntidades"`
	// StatusCadastroPositivo is retorno.entidadeJuridica.statusCadastroPositivo, documented as a string.
	StatusCadastroPositivo Text `json:"statusCadastroPositivo"`
}

DossieCreditoCompletoRetornoEntidadeJuridica is retorno.entidadeJuridica in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaConglomerado 

type DossieCreditoCompletoRetornoEntidadeJuridicaConglomerado struct {
	// Consultas is retorno.entidadeJuridica.conglomerado.consultas, a list.
	Consultas []DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultas `json:"consultas"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaConglomerado is retorno.entidadeJuridica.conglomerado in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultas 

type DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultas struct {
	// Cnpj is retorno.entidadeJuridica.conglomerado.consultas[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DetalhesConsulta is retorno.entidadeJuridica.conglomerado.consultas[].detalhesConsulta, a list.
	DetalhesConsulta []DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultasDetalhesConsulta `json:"detalhesConsulta"`
	// Mais90Dias is retorno.entidadeJuridica.conglomerado.consultas[].mais90Dias, documented as a number.
	Mais90Dias Number `json:"mais90Dias"`
	// Ultimos30Dias is retorno.entidadeJuridica.conglomerado.consultas[].ultimos30Dias, documented as a number.
	Ultimos30Dias Number `json:"ultimos30Dias"`
	// Ultimos60Dias is retorno.entidadeJuridica.conglomerado.consultas[].ultimos60Dias, documented as a number.
	Ultimos60Dias Number `json:"ultimos60Dias"`
	// Ultimos90Dias is retorno.entidadeJuridica.conglomerado.consultas[].ultimos90Dias, documented as a number.
	Ultimos90Dias Number `json:"ultimos90Dias"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultas is retorno.entidadeJuridica.conglomerado.consultas[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultasDetalhesConsulta 

type DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultasDetalhesConsulta struct {
	// Data is retorno.entidadeJuridica.conglomerado.consultas[].detalhesConsulta[].data, documented as a string.
	Data Text `json:"data"`
	// QuantidadeConsultada is retorno.entidadeJuridica.conglomerado.consultas[].detalhesConsulta[].quantidadeConsultada, documented as a number.
	QuantidadeConsultada Number `json:"quantidadeConsultada"`
	// SegmentoEmpresa is retorno.entidadeJuridica.conglomerado.consultas[].detalhesConsulta[].segmentoEmpresa, documented as a string.
	SegmentoEmpresa Text `json:"segmentoEmpresa"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaConglomeradoConsultasDetalhesConsulta is retorno.entidadeJuridica.conglomerado.consultas[].detalhesConsulta[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaConsulta 

type DossieCreditoCompletoRetornoEntidadeJuridicaConsulta struct {
	// Cnpj is retorno.entidadeJuridica.consulta.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DetalhesConsulta is retorno.entidadeJuridica.consulta.detalhesConsulta, a list.
	DetalhesConsulta []DossieCreditoCompletoRetornoEntidadeJuridicaConsultaDetalhesConsulta `json:"detalhesConsulta"`
	// Mais90Dias is retorno.entidadeJuridica.consulta.mais90Dias, documented as a number.
	Mais90Dias Number `json:"mais90Dias"`
	// Ultimos30Dias is retorno.entidadeJuridica.consulta.ultimos30Dias, documented as a number.
	Ultimos30Dias Number `json:"ultimos30Dias"`
	// Ultimos60Dias is retorno.entidadeJuridica.consulta.ultimos60Dias, documented as a number.
	Ultimos60Dias Number `json:"ultimos60Dias"`
	// Ultimos90Dias is retorno.entidadeJuridica.consulta.ultimos90Dias, documented as a number.
	Ultimos90Dias Number `json:"ultimos90Dias"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaConsulta is retorno.entidadeJuridica.consulta in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaConsultaDetalhesConsulta 

type DossieCreditoCompletoRetornoEntidadeJuridicaConsultaDetalhesConsulta struct {
	// Data is retorno.entidadeJuridica.consulta.detalhesConsulta[].data, documented as a string.
	Data Text `json:"data"`
	// QuantidadeConsultada is retorno.entidadeJuridica.consulta.detalhesConsulta[].quantidadeConsultada, documented as a number.
	QuantidadeConsultada Number `json:"quantidadeConsultada"`
	// SegmentoEmpresa is retorno.entidadeJuridica.consulta.detalhesConsulta[].segmentoEmpresa, documented as a string.
	SegmentoEmpresa Text `json:"segmentoEmpresa"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaConsultaDetalhesConsulta is retorno.entidadeJuridica.consulta.detalhesConsulta[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastrais 

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastrais struct {
	// CodigoAtividadePrincipal is retorno.entidadeJuridica.dadosCadastrais.codigoAtividadePrincipal, documented as a string.
	CodigoAtividadePrincipal Text `json:"codigoAtividadePrincipal"`
	// CodigoAtividadeSecundaria is retorno.entidadeJuridica.dadosCadastrais.codigoAtividadeSecundaria, documented as a string.
	CodigoAtividadeSecundaria Text `json:"codigoAtividadeSecundaria"`
	// DataFundacao is retorno.entidadeJuridica.dadosCadastrais.dataFundacao, documented as a string.
	DataFundacao Text `json:"dataFundacao"`
	// DescricaoAtividadePrincipal is retorno.entidadeJuridica.dadosCadastrais.descricaoAtividadePrincipal, documented as a string.
	DescricaoAtividadePrincipal Text `json:"descricaoAtividadePrincipal"`
	// DescricaoAtividadeSecundaria is retorno.entidadeJuridica.dadosCadastrais.descricaoAtividadeSecundaria, documented as a string.
	DescricaoAtividadeSecundaria Text `json:"descricaoAtividadeSecundaria"`
	// Email is retorno.entidadeJuridica.dadosCadastrais.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Endereco is retorno.entidadeJuridica.dadosCadastrais.endereco.
	Endereco DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisEndereco `json:"endereco"`
	// NaturezaJuridica is retorno.entidadeJuridica.dadosCadastrais.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// Nire is retorno.entidadeJuridica.dadosCadastrais.nire, documented as a number.
	Nire Number `json:"nire"`
	// NomeFantasia is retorno.entidadeJuridica.dadosCadastrais.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// OutrasEmpresas is retorno.entidadeJuridica.dadosCadastrais.outrasEmpresas, a list.
	OutrasEmpresas []DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrasEmpresas `json:"outrasEmpresas"`
	// OutrosEmails is retorno.entidadeJuridica.dadosCadastrais.outrosEmails, a list.
	OutrosEmails []Text `json:"outrosEmails" pii:"email"`
	// OutrosEnderecos is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos, a list.
	OutrosEnderecos []DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrosEnderecos `json:"outrosEnderecos"`
	// OutrosTelefones is retorno.entidadeJuridica.dadosCadastrais.outrosTelefones, a list.
	OutrosTelefones []Text `json:"outrosTelefones" pii:"phone"`
	// QuantidadeFilial is retorno.entidadeJuridica.dadosCadastrais.quantidadeFilial, documented as a number.
	QuantidadeFilial Number `json:"quantidadeFilial"`
	// RazaoSocial is retorno.entidadeJuridica.dadosCadastrais.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// SituacaoCadastral is retorno.entidadeJuridica.dadosCadastrais.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// Telefone is retorno.entidadeJuridica.dadosCadastrais.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastrais is retorno.entidadeJuridica.dadosCadastrais in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisEndereco 

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisEndereco struct {
	// Bairro is retorno.entidadeJuridica.dadosCadastrais.endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.entidadeJuridica.dadosCadastrais.endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.entidadeJuridica.dadosCadastrais.endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.entidadeJuridica.dadosCadastrais.endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.entidadeJuridica.dadosCadastrais.endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.entidadeJuridica.dadosCadastrais.endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.entidadeJuridica.dadosCadastrais.endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisEndereco is retorno.entidadeJuridica.dadosCadastrais.endereco in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrasEmpresas 

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrasEmpresas struct {
	// DataFundacao is retorno.entidadeJuridica.dadosCadastrais.outrasEmpresas[].dataFundacao, documented as a string.
	DataFundacao Text `json:"dataFundacao"`
	// Documento is retorno.entidadeJuridica.dadosCadastrais.outrasEmpresas[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrasEmpresas is retorno.entidadeJuridica.dadosCadastrais.outrasEmpresas[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrosEnderecos 

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrosEnderecos struct {
	// Bairro is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaDadosCadastraisOutrosEnderecos is retorno.entidadeJuridica.dadosCadastrais.outrosEnderecos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosEmpresariais 

type DossieCreditoCompletoRetornoEntidadeJuridicaDadosEmpresariais struct {
	// DataInicioEntrada is retorno.entidadeJuridica.dadosEmpresariais[].dataInicioEntrada, documented as a string.
	DataInicioEntrada Text `json:"dataInicioEntrada"`
	// DataInicioSociedade is retorno.entidadeJuridica.dadosEmpresariais[].dataInicioSociedade, documented as a string.
	DataInicioSociedade Text `json:"dataInicioSociedade"`
	// DataSaida is retorno.entidadeJuridica.dadosEmpresariais[].dataSaida, documented as a string.
	DataSaida Text `json:"dataSaida"`
	// Documento is retorno.entidadeJuridica.dadosEmpresariais[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Entidade is retorno.entidadeJuridica.dadosEmpresariais[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// FuncaoSocio is retorno.entidadeJuridica.dadosEmpresariais[].funcaoSocio, documented as a string.
	FuncaoSocio Text `json:"funcaoSocio"`
	// NomeEmpresa is retorno.entidadeJuridica.dadosEmpresariais[].nomeEmpresa, documented as a string.
	NomeEmpresa Text `json:"nomeEmpresa" pii:"name"`
	// PercentualParticipacao is retorno.entidadeJuridica.dadosEmpresariais[].percentualParticipacao, documented as a number.
	PercentualParticipacao Number `json:"percentualParticipacao"`
	// SocioAdministrador is retorno.entidadeJuridica.dadosEmpresariais[].socioAdministrador, documented as a boolean.
	SocioAdministrador Flag `json:"socioAdministrador"`
	// Status is retorno.entidadeJuridica.dadosEmpresariais[].status, documented as a string.
	Status Text `json:"status"`
	// ValorFinanceiro is retorno.entidadeJuridica.dadosEmpresariais[].valorFinanceiro, documented as a number.
	ValorFinanceiro Number `json:"valorFinanceiro"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaDadosEmpresariais is retorno.entidadeJuridica.dadosEmpresariais[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaIndicadores 

type DossieCreditoCompletoRetornoEntidadeJuridicaIndicadores struct {
	// Indicacoes is retorno.entidadeJuridica.indicadores.indicacoes, a list.
	Indicacoes []DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoes `json:"indicacoes"`
	// Observacao is retorno.entidadeJuridica.indicadores.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// QuantidadeIndicadores is retorno.entidadeJuridica.indicadores.quantidadeIndicadores, documented as a number.
	QuantidadeIndicadores Number `json:"quantidadeIndicadores"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaIndicadores is retorno.entidadeJuridica.indicadores in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoes 

type DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoes struct {
	// Conceito is retorno.entidadeJuridica.indicadores.indicacoes[].conceito, documented as a string.
	Conceito Text `json:"conceito"`
	// IndicadoresNegocio is retorno.entidadeJuridica.indicadores.indicacoes[].indicadoresNegocio, a list.
	IndicadoresNegocio []DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoesIndicadoresNegocio `json:"indicadoresNegocio"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoes is retorno.entidadeJuridica.indicadores.indicacoes[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoesIndicadoresNegocio 

type DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoesIndicadoresNegocio struct {
	// Faixa is retorno.entidadeJuridica.indicadores.indicacoes[].indicadoresNegocio[].faixa, documented as a string.
	Faixa Text `json:"faixa"`
	// Risco is retorno.entidadeJuridica.indicadores.indicacoes[].indicadoresNegocio[].risco, documented as a string.
	Risco Text `json:"risco"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaIndicadoresIndicacoesIndicadoresNegocio is retorno.entidadeJuridica.indicadores.indicacoes[].indicadoresNegocio[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceira 

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceira struct {
	// AcoesJudiciais is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais, a list.
	AcoesJudiciais []DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraAcoesJudiciais `json:"acoesJudiciais"`
	// ChequesSemFundo is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo, a list.
	ChequesSemFundo []DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraChequesSemFundo `json:"chequesSemFundo"`
	// Protestos is retorno.entidadeJuridica.pendenciaFinanceira.protestos, a list.
	Protestos []DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestos `json:"protestos"`
	// RecuperacoesJudiciaisFalencia is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia, a list.
	RecuperacoesJudiciaisFalencia []DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia `json:"recuperacoesJudiciaisFalencia"`
	// Status is retorno.entidadeJuridica.pendenciaFinanceira.status, documented as a string.
	Status Text `json:"status"`
	// TotalPendencia is retorno.entidadeJuridica.pendenciaFinanceira.totalPendencia, documented as a number.
	TotalPendencia Number `json:"totalPendencia"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceira is retorno.entidadeJuridica.pendenciaFinanceira in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraAcoesJudiciais 

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraAcoesJudiciais struct {
	// AutorProcesso is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].autorProcesso, documented as a string.
	AutorProcesso Text `json:"autorProcesso"`
	// Cidade is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Comarca is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// DataAjuizamento is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].dataAjuizamento, documented as a string.
	DataAjuizamento Text `json:"dataAjuizamento"`
	// Documento is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Forum is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].forum, documented as a string.
	Forum Text `json:"forum"`
	// NumeroProcessoAntigo is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoAntigo, documented as a string.
	NumeroProcessoAntigo Text `json:"numeroProcessoAntigo"`
	// NumeroProcessoPrincipal is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].numeroProcessoPrincipal, documented as a string.
	NumeroProcessoPrincipal Text `json:"numeroProcessoPrincipal"`
	// ParteAcusada is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].parteAcusada, documented as a string.
	ParteAcusada Text `json:"parteAcusada"`
	// Status is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].status, documented as a string.
	Status Text `json:"status"`
	// TipoProcesso is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].tipoProcesso, documented as a string.
	TipoProcesso Text `json:"tipoProcesso"`
	// TipoTribunal is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].tipoTribunal, documented as a string.
	TipoTribunal Text `json:"tipoTribunal"`
	// Valor is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].valor, documented as a number.
	Valor Number `json:"valor"`
	// Vara is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[].vara, documented as a string.
	Vara Text `json:"vara"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraAcoesJudiciais is retorno.entidadeJuridica.pendenciaFinanceira.acoesJudiciais[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraChequesSemFundo 

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraChequesSemFundo struct {
	// CodigoBanco is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[].codigoBanco, documented as a string.
	CodigoBanco Text `json:"codigoBanco"`
	// DataUltimaOcorrencia is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[].dataUltimaOcorrencia, documented as a string.
	DataUltimaOcorrencia Text `json:"dataUltimaOcorrencia"`
	// Documento is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Entidade is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// NomeAgencia is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[].nomeAgencia, documented as a string.
	NomeAgencia Text `json:"nomeAgencia" pii:"name"`
	// NumeroAgencia is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[].numeroAgencia, documented as a string.
	NumeroAgencia Text `json:"numeroAgencia"`
	// QuantidadeOcorrencia is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[].quantidadeOcorrencia, documented as a number.
	QuantidadeOcorrencia Number `json:"quantidadeOcorrencia"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraChequesSemFundo is retorno.entidadeJuridica.pendenciaFinanceira.chequesSemFundo[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestos 

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestos struct {
	// Cartorios is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios, a list.
	Cartorios []DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestosCartorios `json:"cartorios"`
	// Observacao is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Situacao is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// ValorTotal is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].valorTotal, documented as a number.
	ValorTotal Number `json:"valorTotal"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestos is retorno.entidadeJuridica.pendenciaFinanceira.protestos[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestosCartorios 

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestosCartorios struct {
	// Cidade is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoCartorio is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].codigoCartorio, documented as a string.
	CodigoCartorio Text `json:"codigoCartorio"`
	// CodigoCidade is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].codigoCidade, documented as a string.
	CodigoCidade Text `json:"codigoCidade"`
	// Endereco is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// QuantidadeProtestos is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].quantidadeProtestos, documented as a number.
	QuantidadeProtestos Number `json:"quantidadeProtestos"`
	// Telefone is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// ValorProtestado is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[].valorProtestado, documented as a number.
	ValorProtestado Number `json:"valorProtestado"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraProtestosCartorios is retorno.entidadeJuridica.pendenciaFinanceira.protestos[].cartorios[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia 

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia struct {
	// DataInclusao is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataModificacao is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataModificacao, documented as a string.
	DataModificacao Text `json:"dataModificacao"`
	// DataOcorrencia is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].dataOcorrencia, documented as a string.
	DataOcorrencia Text `json:"dataOcorrencia"`
	// Documento is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Endereco is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.
	Endereco DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco `json:"endereco"`
	// Motivo is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].motivo, documented as a string.
	Motivo Text `json:"motivo"`
	// NomeEmpresa is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].nomeEmpresa, documented as a string.
	NomeEmpresa Text `json:"nomeEmpresa" pii:"name"`
	// NumeroContrato is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].numeroContrato, documented as a string.
	NumeroContrato Text `json:"numeroContrato"`
	// Status is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].status, documented as a string.
	Status Text `json:"status"`
	// TipoParticipacao is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].tipoParticipacao, documented as a string.
	TipoParticipacao Text `json:"tipoParticipacao"`
	// Valor is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].valor, documented as a number.
	Valor Number `json:"valor"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalencia is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco 

type DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco struct {
	// Bairro is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaPendenciaFinanceiraRecuperacoesJudiciaisFalenciaEndereco is retorno.entidadeJuridica.pendenciaFinanceira.recuperacoesJudiciaisFalencia[].endereco in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietario 

type DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietario struct {
	// CapitalSocial is retorno.entidadeJuridica.quadroSocietario.capitalSocial, documented as a number.
	CapitalSocial Number `json:"capitalSocial"`
	// Informacoes is retorno.entidadeJuridica.quadroSocietario.informacoes, a list.
	Informacoes []DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietarioInformacoes `json:"informacoes"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietario is retorno.entidadeJuridica.quadroSocietario in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietarioInformacoes 

type DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietarioInformacoes struct {
	// DataInicioEntrada is retorno.entidadeJuridica.quadroSocietario.informacoes[].dataInicioEntrada, documented as a string.
	DataInicioEntrada Text `json:"dataInicioEntrada"`
	// DataInicioSociedade is retorno.entidadeJuridica.quadroSocietario.informacoes[].dataInicioSociedade, documented as a string.
	DataInicioSociedade Text `json:"dataInicioSociedade"`
	// DataSaida is retorno.entidadeJuridica.quadroSocietario.informacoes[].dataSaida, documented as a string.
	DataSaida Text `json:"dataSaida"`
	// Documento is retorno.entidadeJuridica.quadroSocietario.informacoes[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Entidade is retorno.entidadeJuridica.quadroSocietario.informacoes[].entidade, documented as a string.
	Entidade Text `json:"entidade"`
	// FuncaoSocio is retorno.entidadeJuridica.quadroSocietario.informacoes[].funcaoSocio, documented as a string.
	FuncaoSocio Text `json:"funcaoSocio"`
	// NomeEmpresa is retorno.entidadeJuridica.quadroSocietario.informacoes[].nomeEmpresa, documented as a string.
	NomeEmpresa Text `json:"nomeEmpresa" pii:"name"`
	// PercentualParticipacao is retorno.entidadeJuridica.quadroSocietario.informacoes[].percentualParticipacao, documented as a number.
	PercentualParticipacao Number `json:"percentualParticipacao"`
	// SocioAdministrador is retorno.entidadeJuridica.quadroSocietario.informacoes[].socioAdministrador, documented as a boolean.
	SocioAdministrador Flag `json:"socioAdministrador"`
	// Status is retorno.entidadeJuridica.quadroSocietario.informacoes[].status, documented as a string.
	Status Text `json:"status"`
	// ValorFinanceiro is retorno.entidadeJuridica.quadroSocietario.informacoes[].valorFinanceiro, documented as a number.
	ValorFinanceiro Number `json:"valorFinanceiro"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaQuadroSocietarioInformacoes is retorno.entidadeJuridica.quadroSocietario.informacoes[] in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidades 

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidades struct {
	// EntidadeFisica is retorno.entidadeJuridica.scoreEntidades.entidadeFisica.
	EntidadeFisica DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeFisica `json:"entidadeFisica"`
	// EntidadeJuridica is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.
	EntidadeJuridica DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridica `json:"entidadeJuridica"`
	// Observacao is retorno.entidadeJuridica.scoreEntidades.observacao, documented as a string.
	Observacao Text `json:"observacao"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidades is retorno.entidadeJuridica.scoreEntidades in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeFisica 

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeFisica struct {
	// CapacidadePagamento is retorno.entidadeJuridica.scoreEntidades.entidadeFisica.capacidadePagamento, documented as a string.
	CapacidadePagamento Text `json:"capacidadePagamento"`
	// Perfil is retorno.entidadeJuridica.scoreEntidades.entidadeFisica.perfil, documented as a string.
	Perfil Text `json:"perfil"`
	// Score is retorno.entidadeJuridica.scoreEntidades.entidadeFisica.score, documented as a number.
	Score Number `json:"score"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeFisica is retorno.entidadeJuridica.scoreEntidades.entidadeFisica in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridica 

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridica struct {
	// IndicadoresNegocio is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.indicadoresNegocio, a list.
	IndicadoresNegocio []DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridicaIndicadoresNegocio `json:"indicadoresNegocio"`
	// Motivos is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.motivos, a list.
	Motivos []Text `json:"motivos"`
	// Score is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.score, documented as a number.
	Score Number `json:"score"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridica is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica in the answer of DossieCreditoCompleto.

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridicaIndicadoresNegocio 

type DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridicaIndicadoresNegocio struct {
	// Indicador is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.indicadoresNegocio[].indicador, documented as a string.
	Indicador Text `json:"indicador"`
	// Observacao is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.indicadoresNegocio[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Risco is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.indicadoresNegocio[].risco, documented as a string.
	Risco Text `json:"risco"`
	// Status is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.indicadoresNegocio[].status, documented as a string.
	Status Text `json:"status"`
}

DossieCreditoCompletoRetornoEntidadeJuridicaScoreEntidadesEntidadeJuridicaIndicadoresNegocio is retorno.entidadeJuridica.scoreEntidades.entidadeJuridica.indicadoresNegocio[] in the answer of DossieCreditoCompleto.

type EUFinancialListParams 

type EUFinancialListParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.
	Nome string
}

EUFinancialListParams are the parameters of EUFinancialList (EU Financial Sanctions List).

func (EUFinancialListParams) Request 

func (p EUFinancialListParams) Request() (Request, error)

Request builds the Request for EUFinancialList.

type EUFinancialListRetorno 

type EUFinancialListRetorno struct {
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []EUFinancialListRetornoSancoes `json:"sancoes"`
}

EUFinancialListRetorno is retorno in the answer of EUFinancialList.

type EUFinancialListRetornoSancoes 

type EUFinancialListRetornoSancoes struct {
	// Alcunhas is retorno.sancoes[].alcunhas, a list.
	Alcunhas []Text `json:"alcunhas"`
	// BaseLegal is retorno.sancoes[].baseLegal, documented as a string.
	BaseLegal Text `json:"baseLegal"`
	// Contatos is retorno.sancoes[].contatos, a list.
	Contatos []EUFinancialListRetornoSancoesContatos `json:"contatos"`
	// DataNascimento is retorno.sancoes[].dataNascimento, a list.
	DataNascimento []Text `json:"dataNascimento" pii:"birthdate"`
	// DataRegistro is retorno.sancoes[].dataRegistro, documented as a string.
	DataRegistro Text `json:"dataRegistro"`
	// Documentos is retorno.sancoes[].documentos, a list.
	Documentos []EUFinancialListRetornoSancoesDocumentos `json:"documentos"`
	// Enderecos is retorno.sancoes[].enderecos, a list.
	Enderecos []EUFinancialListRetornoSancoesEnderecos `json:"enderecos"`
	// EntiadadesAssociadas is retorno.sancoes[].entiadadesAssociadas, a list.
	EntiadadesAssociadas []Text `json:"entiadadesAssociadas"`
	// Funcao is retorno.sancoes[].funcao, a list.
	Funcao []Text `json:"funcao"`
	// IndividuosAssociados is retorno.sancoes[].individuosAssociados, a list.
	IndividuosAssociados []Text `json:"individuosAssociados"`
	// LocalNascimento is retorno.sancoes[].localNascimento, a list.
	LocalNascimento []Text `json:"localNascimento"`
	// LocalPrincipalNegocios is retorno.sancoes[].localPrincipalNegocios, documented as a string.
	LocalPrincipalNegocios Text `json:"localPrincipalNegocios"`
	// LocalRegistro is retorno.sancoes[].localRegistro, documented as a string.
	LocalRegistro Text `json:"localRegistro"`
	// Nacionalidades is retorno.sancoes[].nacionalidades, a list.
	Nacionalidades []Text `json:"nacionalidades"`
	// Nome is retorno.sancoes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NumeroReferenciaEU is retorno.sancoes[].numeroReferenciaEU, documented as a string.
	NumeroReferenciaEU Text `json:"numeroReferenciaEU"`
	// Programa is retorno.sancoes[].programa, documented as a string.
	Programa Text `json:"programa"`
	// TipoEntidade is retorno.sancoes[].tipoEntidade, documented as a string.
	TipoEntidade Text `json:"tipoEntidade"`
	// TipoEntidadeCompanhia is retorno.sancoes[].tipoEntidadeCompanhia, documented as a string.
	TipoEntidadeCompanhia Text `json:"tipoEntidadeCompanhia"`
}

EUFinancialListRetornoSancoes is retorno.sancoes[] in the answer of EUFinancialList.

type EUFinancialListRetornoSancoesContatos 

type EUFinancialListRetornoSancoesContatos struct {
	// Email is retorno.sancoes[].contatos[].email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Fax is retorno.sancoes[].contatos[].fax, documented as a string.
	Fax Text `json:"fax"`
	// Phone is retorno.sancoes[].contatos[].phone, documented as a string.
	Phone Text `json:"phone" pii:"phone"`
	// Web is retorno.sancoes[].contatos[].web, documented as a string.
	Web Text `json:"web"`
}

EUFinancialListRetornoSancoesContatos is retorno.sancoes[].contatos[] in the answer of EUFinancialList.

type EUFinancialListRetornoSancoesDocumentos 

type EUFinancialListRetornoSancoesDocumentos struct {
	// DataEmissao is retorno.sancoes[].documentos[].dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// Documento is retorno.sancoes[].documentos[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Fonte is retorno.sancoes[].documentos[].fonte, documented as a string.
	Fonte Text `json:"fonte"`
	// Observacao is retorno.sancoes[].documentos[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Tipo is retorno.sancoes[].documentos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Validade is retorno.sancoes[].documentos[].validade, documented as a string.
	Validade Text `json:"validade"`
}

EUFinancialListRetornoSancoesDocumentos is retorno.sancoes[].documentos[] in the answer of EUFinancialList.

type EUFinancialListRetornoSancoesEnderecos 

type EUFinancialListRetornoSancoesEnderecos struct {
	// Cidade is retorno.sancoes[].enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Endereco is retorno.sancoes[].enderecos[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Pais is retorno.sancoes[].enderecos[].pais, documented as a string.
	Pais Text `json:"pais"`
}

EUFinancialListRetornoSancoesEnderecos is retorno.sancoes[].enderecos[] in the answer of EUFinancialList.

type EnriquecimentoLeadParams 

type EnriquecimentoLeadParams struct {
	// Celular is sent as Celular. O parâmetro CELULAR pode ser enviado com ou sem formatação.
	Celular string
	// Email is sent as Email. O parâmetro EMAIL deve possuir formatação válida.
	Email string
}

EnriquecimentoLeadParams are the parameters of EnriquecimentoLead (Enriquecimento de Lead).

func (EnriquecimentoLeadParams) Request 

func (p EnriquecimentoLeadParams) Request() (Request, error)

Request builds the Request for EnriquecimentoLead.

type EnriquecimentoLeadRetorno 

type EnriquecimentoLeadRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Emails is retorno.emails, a list.
	Emails []EnriquecimentoLeadRetornoEmails `json:"emails"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []EnriquecimentoLeadRetornoEnderecos `json:"enderecos"`
	// Idade is retorno.idade, documented as a number.
	Idade Number `json:"idade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// RendaEstimada is retorno.rendaEstimada, documented as a string.
	RendaEstimada Text `json:"rendaEstimada"`
	// RendaFaixaSalarial is retorno.rendaFaixaSalarial, documented as a string.
	RendaFaixaSalarial Text `json:"rendaFaixaSalarial"`
	// Sexo is retorno.sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Signo is retorno.signo, documented as a string.
	Signo Text `json:"signo"`
	// Telefones is retorno.telefones, a list.
	Telefones []EnriquecimentoLeadRetornoTelefones `json:"telefones"`
}

EnriquecimentoLeadRetorno is retorno in the answer of EnriquecimentoLead.

type EnriquecimentoLeadRetornoEmails 

type EnriquecimentoLeadRetornoEmails struct {
	// EnderecoEmail is retorno.emails[].enderecoEmail, documented as a string.
	EnderecoEmail Text `json:"enderecoEmail" pii:"email"`
}

EnriquecimentoLeadRetornoEmails is retorno.emails[] in the answer of EnriquecimentoLead.

type EnriquecimentoLeadRetornoEnderecos 

type EnriquecimentoLeadRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

EnriquecimentoLeadRetornoEnderecos is retorno.enderecos[] in the answer of EnriquecimentoLead.

type EnriquecimentoLeadRetornoTelefones 

type EnriquecimentoLeadRetornoTelefones struct {
	// Operadora is retorno.telefones[].operadora, documented as a string.
	Operadora Text `json:"operadora"`
	// TelefoneComDDD is retorno.telefones[].telefoneComDDD, documented as a string.
	TelefoneComDDD Text `json:"telefoneComDDD" pii:"phone"`
	// TelemarketingBloqueado is retorno.telefones[].telemarketingBloqueado, documented as a boolean.
	TelemarketingBloqueado Flag `json:"telemarketingBloqueado"`
	// TipoTelefone is retorno.telefones[].tipoTelefone, documented as a string.
	TipoTelefone Text `json:"tipoTelefone" pii:"phone"`
	// WhatsApp is retorno.telefones[].whatsApp, documented as a boolean.
	WhatsApp Flag `json:"whatsApp"`
}

EnriquecimentoLeadRetornoTelefones is retorno.telefones[] in the answer of EnriquecimentoLead.

type FBIMostWantedParams 

type FBIMostWantedParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.
	Nome string
	// Sobrenome is sent as Sobrenome. Named by the endpoint template only; the parameter table does not list it.
	Sobrenome string
}

FBIMostWantedParams are the parameters of FBIMostWanted (FBI - Most Wanted).

func (FBIMostWantedParams) Request 

func (p FBIMostWantedParams) Request() (Request, error)

Request builds the Request for FBIMostWanted.

type FBIMostWantedRetorno 

type FBIMostWantedRetorno struct {
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Pessoas is retorno.pessoas, a list.
	Pessoas []FBIMostWantedRetornoPessoas `json:"pessoas"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
}

FBIMostWantedRetorno is retorno in the answer of FBIMostWanted.

type FBIMostWantedRetornoPessoas 

type FBIMostWantedRetornoPessoas struct {
	// Alcunha is retorno.pessoas[].alcunha, a list.
	Alcunha []Text `json:"alcunha" pii:"name"`
	// Atencao is retorno.pessoas[].atencao, documented as a string.
	Atencao Text `json:"atencao"`
	// Cautela is retorno.pessoas[].cautela, documented as a string.
	Cautela Text `json:"cautela"`
	// DatasNascimentoUsadas is retorno.pessoas[].datasNascimentoUsadas, a list.
	DatasNascimentoUsadas []Text `json:"datasNascimentoUsadas"`
	// Descricao is retorno.pessoas[].descricao.
	Descricao FBIMostWantedRetornoPessoasDescricao `json:"descricao"`
	// Detalhes is retorno.pessoas[].detalhes, documented as a string.
	Detalhes Text `json:"detalhes"`
	// Fotos is retorno.pessoas[].fotos, a list.
	Fotos []Text `json:"fotos"`
	// LinguasFaladas is retorno.pessoas[].linguasFaladas, a list.
	LinguasFaladas []Text `json:"linguasFaladas"`
	// LocalNascimento is retorno.pessoas[].localNascimento, documented as a string.
	LocalNascimento Text `json:"localNascimento"`
	// Nacionalidade is retorno.pessoas[].nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// NomeCompleto is retorno.pessoas[].nomeCompleto, documented as a string.
	NomeCompleto Text `json:"nomeCompleto" pii:"name"`
	// Observacao is retorno.pessoas[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Ocupacao is retorno.pessoas[].ocupacao, documented as a string.
	Ocupacao Text `json:"ocupacao"`
	// Poster is retorno.pessoas[].poster, documented as a string.
	Poster Text `json:"poster"`
	// Recompensa is retorno.pessoas[].recompensa, documented as a string.
	Recompensa Text `json:"recompensa"`
	// Sexo is retorno.pessoas[].sexo, documented as a string.
	Sexo Text `json:"sexo"`
}

FBIMostWantedRetornoPessoas is retorno.pessoas[] in the answer of FBIMostWanted.

type FBIMostWantedRetornoPessoasDescricao 

type FBIMostWantedRetornoPessoasDescricao struct {
	// Altura is retorno.pessoas[].descricao.altura, documented as a string.
	Altura Text `json:"altura"`
	// Cabelo is retorno.pessoas[].descricao.cabelo, documented as a string.
	Cabelo Text `json:"cabelo"`
	// Cicatrizes is retorno.pessoas[].descricao.cicatrizes, documented as a string.
	Cicatrizes Text `json:"cicatrizes"`
	// CorPele is retorno.pessoas[].descricao.corPele, documented as a string.
	CorPele Text `json:"corPele"`
	// Olhos is retorno.pessoas[].descricao.olhos, documented as a string.
	Olhos Text `json:"olhos"`
	// Peso is retorno.pessoas[].descricao.peso, documented as a string.
	Peso Text `json:"peso"`
}

FBIMostWantedRetornoPessoasDescricao is retorno.pessoas[].descricao in the answer of FBIMostWanted.

type FinCENParams 

type FinCENParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.
	Nome string
}

FinCENParams are the parameters of FinCEN (FINCEN - Financial Crimes Enforcement Network).

func (FinCENParams) Request 

func (p FinCENParams) Request() (Request, error)

Request builds the Request for FinCEN.

type FinCENRetorno 

type FinCENRetorno struct {
	// Empresas is retorno.empresas, a list.
	Empresas []FinCENRetornoEmpresas `json:"empresas"`
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
}

FinCENRetorno is retorno in the answer of FinCEN.

type FinCENRetornoEmpresas 

type FinCENRetornoEmpresas struct {
	// DataAssinaturaAutorizada is retorno.empresas[].dataAssinaturaAutorizada, documented as a string.
	DataAssinaturaAutorizada Text `json:"dataAssinaturaAutorizada"`
	// DataRecebimento is retorno.empresas[].dataRecebimento, documented as a string.
	DataRecebimento Text `json:"dataRecebimento"`
	// Localizacao is retorno.empresas[].localizacao.
	Localizacao FinCENRetornoEmpresasLocalizacao `json:"localizacao"`
	// NomeFantasia is retorno.empresas[].nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// NumeroMSB is retorno.empresas[].numeroMSB, documented as a string.
	NumeroMSB Text `json:"numeroMSB"`
	// QuantidadeFiliais is retorno.empresas[].quantidadeFiliais, documented as a number.
	QuantidadeFiliais Number `json:"quantidadeFiliais"`
	// RazaoSocial is retorno.empresas[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// ServicoMonetario is retorno.empresas[].servicoMonetario.
	ServicoMonetario FinCENRetornoEmpresasServicoMonetario `json:"servicoMonetario"`
}

FinCENRetornoEmpresas is retorno.empresas[] in the answer of FinCEN.

type FinCENRetornoEmpresasLocalizacao 

type FinCENRetornoEmpresasLocalizacao struct {
	// Cidade is retorno.empresas[].localizacao.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoPostal is retorno.empresas[].localizacao.codigoPostal, documented as a string.
	CodigoPostal Text `json:"codigoPostal"`
	// Endereco is retorno.empresas[].localizacao.endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Estado is retorno.empresas[].localizacao.estado, documented as a string.
	Estado Text `json:"estado"`
	// Pais is retorno.empresas[].localizacao.pais, documented as a string.
	Pais Text `json:"pais"`
}

FinCENRetornoEmpresasLocalizacao is retorno.empresas[].localizacao in the answer of FinCEN.

type FinCENRetornoEmpresasServicoMonetario 

type FinCENRetornoEmpresasServicoMonetario struct {
	// Atividades is retorno.empresas[].servicoMonetario.atividades, a list.
	Atividades []Text `json:"atividades"`
	// Estados is retorno.empresas[].servicoMonetario.estados, a list.
	Estados []Text `json:"estados"`
	// EstadosTerritorios is retorno.empresas[].servicoMonetario.estadosTerritorios, a list.
	EstadosTerritorios []Text `json:"estadosTerritorios"`
	// Numero is retorno.empresas[].servicoMonetario.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
}

FinCENRetornoEmpresasServicoMonetario is retorno.empresas[].servicoMonetario in the answer of FinCEN.

type Flag 

type Flag bool

Flag is a boolean field of a response: true, false, null (false), or the strings "true" and "false".

func (*Flag) UnmarshalJSON 

func (f *Flag) UnmarshalJSON(b []byte) error

UnmarshalJSON reads a boolean, null, or the strings "true" and "false".

type GarantiaSafraParams 

type GarantiaSafraParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NIS is sent as NIS. O parâmetro NIS pode ser enviado com ou sem formatação.
	NIS string
}

GarantiaSafraParams are the parameters of GarantiaSafra (Garantia Safra).

func (GarantiaSafraParams) Request 

func (p GarantiaSafraParams) Request() (Request, error)

Request builds the Request for GarantiaSafra.

type GarantiaSafraRetorno 

type GarantiaSafraRetorno struct {
	// Beneficios is retorno.beneficios, a list.
	Beneficios []GarantiaSafraRetornoBeneficios `json:"beneficios"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

GarantiaSafraRetorno is retorno in the answer of GarantiaSafra.

type GarantiaSafraRetornoBeneficios 

type GarantiaSafraRetornoBeneficios struct {
	// Data is retorno.beneficios[].data, documented as a string.
	Data Text `json:"data"`
	// Municipio is retorno.beneficios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroRegistro is retorno.beneficios[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Uf is retorno.beneficios[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.beneficios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

GarantiaSafraRetornoBeneficios is retorno.beneficios[] in the answer of GarantiaSafra.

type GasDoPovoParams 

type GasDoPovoParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

GasDoPovoParams are the parameters of GasDoPovo (Gás do Povo).

func (GasDoPovoParams) Request 

func (p GasDoPovoParams) Request() (Request, error)

Request builds the Request for GasDoPovo.

type GasDoPovoRetorno 

type GasDoPovoRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Vales is retorno.vales, a list.
	Vales []GasDoPovoRetornoVales `json:"vales"`
}

GasDoPovoRetorno is retorno in the answer of GasDoPovo.

type GasDoPovoRetornoVales 

type GasDoPovoRetornoVales struct {
	// CnpjEstabelecimento is retorno.vales[].cnpjEstabelecimento, documented as a string.
	CnpjEstabelecimento Text `json:"cnpjEstabelecimento" pii:"document"`
	// Competencia is retorno.vales[].competencia, documented as a string.
	Competencia Text `json:"competencia"`
	// DataFimVigencia is retorno.vales[].dataFimVigencia, documented as a string.
	DataFimVigencia Text `json:"dataFimVigencia"`
	// DataInicioVigencia is retorno.vales[].dataInicioVigencia, documented as a string.
	DataInicioVigencia Text `json:"dataInicioVigencia"`
	// DataRetirada is retorno.vales[].dataRetirada, documented as a string.
	DataRetirada Text `json:"dataRetirada"`
	// Estabelecimento is retorno.vales[].estabelecimento, documented as a string.
	Estabelecimento Text `json:"estabelecimento"`
	// Municipio is retorno.vales[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// PeriodoValidadeMeses is retorno.vales[].periodoValidadeMeses, documented as a number.
	PeriodoValidadeMeses Number `json:"periodoValidadeMeses"`
	// QuantidadePessoasFamilia is retorno.vales[].quantidadePessoasFamilia, documented as a number.
	QuantidadePessoasFamilia Number `json:"quantidadePessoasFamilia"`
	// Uf is retorno.vales[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.vales[].valor, documented as a string.
	Valor Text `json:"valor"`
}

GasDoPovoRetornoVales is retorno.vales[] in the answer of GasDoPovo.

type HistoricoVeiculosNacionalParams 

type HistoricoVeiculosNacionalParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

HistoricoVeiculosNacionalParams are the parameters of HistoricoVeiculosNacional (Histórico Veicular PF e PJ - Nacional).

func (HistoricoVeiculosNacionalParams) Request 

func (p HistoricoVeiculosNacionalParams) Request() (Request, error)

Request builds the Request for HistoricoVeiculosNacional.

type HistoricoVeiculosNacionalRetorno 

type HistoricoVeiculosNacionalRetorno struct {
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Proprietario is retorno.proprietario, documented as a string.
	Proprietario Text `json:"proprietario"`
	// QuantidadeVeiculos is retorno.quantidadeVeiculos, documented as a number.
	QuantidadeVeiculos Number `json:"quantidadeVeiculos"`
	// Veiculos is retorno.veiculos, a list.
	Veiculos []HistoricoVeiculosNacionalRetornoVeiculos `json:"veiculos"`
}

HistoricoVeiculosNacionalRetorno is retorno in the answer of HistoricoVeiculosNacional.

type HistoricoVeiculosNacionalRetornoVeiculos 

type HistoricoVeiculosNacionalRetornoVeiculos struct {
	// Ano is retorno.veiculos[].ano, documented as a number.
	Ano Number `json:"ano"`
	// Chassi is retorno.veiculos[].chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// MarcaModelo is retorno.veiculos[].marcaModelo, documented as a string.
	MarcaModelo Text `json:"marcaModelo"`
	// Municipio is retorno.veiculos[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Placa is retorno.veiculos[].placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Uf is retorno.veiculos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

HistoricoVeiculosNacionalRetornoVeiculos is retorno.veiculos[] in the answer of HistoricoVeiculosNacional.

type HistoricoVeiculosParams 

type HistoricoVeiculosParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

HistoricoVeiculosParams are the parameters of HistoricoVeiculos (Histórico Veicular PF e PJ - São Paulo).

func (HistoricoVeiculosParams) Request 

func (p HistoricoVeiculosParams) Request() (Request, error)

Request builds the Request for HistoricoVeiculos.

type HistoricoVeiculosRetorno 

type HistoricoVeiculosRetorno struct {
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Enderecos is retorno.enderecos, a list.
	Enderecos []HistoricoVeiculosRetornoEnderecos `json:"enderecos"`
	// Proprietario is retorno.proprietario, documented as a string.
	Proprietario Text `json:"proprietario"`
	// Veiculos is retorno.veiculos, a list.
	Veiculos []HistoricoVeiculosRetornoVeiculos `json:"veiculos"`
}

HistoricoVeiculosRetorno is retorno in the answer of HistoricoVeiculos.

type HistoricoVeiculosRetornoEnderecos 

type HistoricoVeiculosRetornoEnderecos struct {
	// Bairro is retorno.enderecos[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.enderecos[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.enderecos[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.enderecos[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.enderecos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Uf is retorno.enderecos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

HistoricoVeiculosRetornoEnderecos is retorno.enderecos[] in the answer of HistoricoVeiculos.

type HistoricoVeiculosRetornoVeiculos 

type HistoricoVeiculosRetornoVeiculos struct {
	// Chassi is retorno.veiculos[].chassi, documented as a string.
	Chassi Text `json:"chassi" pii:"vehicle"`
	// DataAquisicao is retorno.veiculos[].dataAquisicao, documented as a string.
	DataAquisicao Text `json:"dataAquisicao"`
	// Marca is retorno.veiculos[].marca, documented as a string.
	Marca Text `json:"marca"`
	// Modelo is retorno.veiculos[].modelo, documented as a string.
	Modelo Text `json:"modelo"`
	// Placa is retorno.veiculos[].placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// Renavam is retorno.veiculos[].renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// Veiculo is retorno.veiculos[].veiculo, documented as a string.
	Veiculo Text `json:"veiculo"`
}

HistoricoVeiculosRetornoVeiculos is retorno.veiculos[] in the answer of HistoricoVeiculos.

type IBAMACertidaoNegativaDebitosParams 

type IBAMACertidaoNegativaDebitosParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

IBAMACertidaoNegativaDebitosParams are the parameters of IBAMACertidaoNegativaDebitos (IBAMA - Certidão Negativa de Débitos).

func (IBAMACertidaoNegativaDebitosParams) Request 

func (p IBAMACertidaoNegativaDebitosParams) Request() (Request, error)

Request builds the Request for IBAMACertidaoNegativaDebitos.

type IBAMACertidaoNegativaDebitosRetorno 

type IBAMACertidaoNegativaDebitosRetorno struct {
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Debitos is retorno.debitos, a list.
	Debitos []IBAMACertidaoNegativaDebitosRetornoDebitos `json:"debitos"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// EfeitoNegativo is retorno.efeitoNegativo, documented as a boolean.
	EfeitoNegativo Flag `json:"efeitoNegativo"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Numero is retorno.numero, documented as a number.
	Numero Number `json:"numero" pii:"address"`
	// PossuiDebito is retorno.possuiDebito, documented as a boolean.
	PossuiDebito Flag `json:"possuiDebito"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

IBAMACertidaoNegativaDebitosRetorno is retorno in the answer of IBAMACertidaoNegativaDebitos.

type IBAMACertidaoNegativaDebitosRetornoDebitos 

type IBAMACertidaoNegativaDebitosRetornoDebitos struct {
	// Numero is retorno.debitos[].numero, documented as a number.
	Numero Number `json:"numero" pii:"address"`
	// Situacao is retorno.debitos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Tipo is retorno.debitos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// ValorOriginal is retorno.debitos[].valorOriginal, documented as a number.
	ValorOriginal Number `json:"valorOriginal"`
}

IBAMACertidaoNegativaDebitosRetornoDebitos is retorno.debitos[] in the answer of IBAMACertidaoNegativaDebitos.

type IBAMACertidaoNegativaEmbargosParams 

type IBAMACertidaoNegativaEmbargosParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

IBAMACertidaoNegativaEmbargosParams are the parameters of IBAMACertidaoNegativaEmbargos (IBAMA - Certidão Negativa de Embargo).

func (IBAMACertidaoNegativaEmbargosParams) Request 

func (p IBAMACertidaoNegativaEmbargosParams) Request() (Request, error)

Request builds the Request for IBAMACertidaoNegativaEmbargos.

type IBAMACertidaoNegativaEmbargosRetorno 

type IBAMACertidaoNegativaEmbargosRetorno struct {
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Embargos is retorno.embargos, a list.
	Embargos []IBAMACertidaoNegativaEmbargosRetornoEmbargos `json:"embargos"`
	// Endereco is retorno.endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// Observacoes is retorno.observacoes, a list.
	Observacoes []Text `json:"observacoes"`
	// PossuiEmbargo is retorno.possuiEmbargo, documented as a boolean.
	PossuiEmbargo Flag `json:"possuiEmbargo"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

IBAMACertidaoNegativaEmbargosRetorno is retorno in the answer of IBAMACertidaoNegativaEmbargos.

type IBAMACertidaoNegativaEmbargosRetornoEmbargos 

type IBAMACertidaoNegativaEmbargosRetornoEmbargos struct {
	// AreaDesmatada is retorno.embargos[].areaDesmatada, documented as a string.
	AreaDesmatada Text `json:"areaDesmatada"`
	// AreaEmbargada is retorno.embargos[].areaEmbargada, documented as a string.
	AreaEmbargada Text `json:"areaEmbargada"`
	// DataEmbargo is retorno.embargos[].dataEmbargo, documented as a string.
	DataEmbargo Text `json:"dataEmbargo"`
	// DataInsercaoLista is retorno.embargos[].dataInsercaoLista, documented as a string.
	DataInsercaoLista Text `json:"dataInsercaoLista"`
	// Municipio is retorno.embargos[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroAI is retorno.embargos[].numeroAI, documented as a string.
	NumeroAI Text `json:"numeroAI"`
	// NumeroTAD is retorno.embargos[].numeroTAD, documented as a string.
	NumeroTAD Text `json:"numeroTAD"`
	// SequenciaTAD is retorno.embargos[].sequenciaTAD, documented as a string.
	SequenciaTAD Text `json:"sequenciaTAD"`
	// SerieAI is retorno.embargos[].serieAI, documented as a string.
	SerieAI Text `json:"serieAI"`
	// SerieTAD is retorno.embargos[].serieTAD, documented as a string.
	SerieTAD Text `json:"serieTAD"`
	// Uf is retorno.embargos[].uf, documented as a string.
	Uf Text `json:"uf"`
}

IBAMACertidaoNegativaEmbargosRetornoEmbargos is retorno.embargos[] in the answer of IBAMACertidaoNegativaEmbargos.

type IBAMACertificadoRegularidadeParams 

type IBAMACertificadoRegularidadeParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

IBAMACertificadoRegularidadeParams are the parameters of IBAMACertificadoRegularidade (IBAMA - Certificado de Regularidade).

func (IBAMACertificadoRegularidadeParams) Request 

func (p IBAMACertificadoRegularidadeParams) Request() (Request, error)

Request builds the Request for IBAMACertificadoRegularidade.

type IBAMACertificadoRegularidadeRetorno 

type IBAMACertificadoRegularidadeRetorno struct {
	// Atividades is retorno.atividades.
	Atividades IBAMACertificadoRegularidadeRetornoAtividades `json:"atividades"`
	// Bairro is retorno.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Categorias is retorno.categorias.
	Categorias IBAMACertificadoRegularidadeRetornoCategorias `json:"categorias"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Complemento is retorno.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// ConstaCertificado is retorno.constaCertificado, documented as a boolean.
	ConstaCertificado Flag `json:"constaCertificado"`
	// DataAbertura is retorno.dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Logradouro is retorno.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NomeEmpresarial is retorno.nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// Numero is retorno.numero, documented as a number.
	Numero Number `json:"numero" pii:"address"`
	// NumeroRegistro is retorno.numeroRegistro, documented as a string.
	NumeroRegistro Text `json:"numeroRegistro"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

IBAMACertificadoRegularidadeRetorno is retorno in the answer of IBAMACertificadoRegularidade.

type IBAMACertificadoRegularidadeRetornoAtividades 

type IBAMACertificadoRegularidadeRetornoAtividades struct {
	// ListaAtividades is retorno.atividades.listaAtividades, a list.
	ListaAtividades []Text `json:"listaAtividades"`
	// ObservacaoAtividade is retorno.atividades.observacaoAtividade, documented as a string.
	ObservacaoAtividade Text `json:"observacaoAtividade"`
}

IBAMACertificadoRegularidadeRetornoAtividades is retorno.atividades in the answer of IBAMACertificadoRegularidade.

type IBAMACertificadoRegularidadeRetornoCategorias 

type IBAMACertificadoRegularidadeRetornoCategorias struct {
	// ListaCategorias is retorno.categorias.listaCategorias, a list.
	ListaCategorias []IBAMACertificadoRegularidadeRetornoCategoriasListaCategorias `json:"listaCategorias"`
	// ObservacaoCategoria is retorno.categorias.observacaoCategoria, documented as a string.
	ObservacaoCategoria Text `json:"observacaoCategoria"`
}

IBAMACertificadoRegularidadeRetornoCategorias is retorno.categorias in the answer of IBAMACertificadoRegularidade.

type IBAMACertificadoRegularidadeRetornoCategoriasListaCategorias 

type IBAMACertificadoRegularidadeRetornoCategoriasListaCategorias struct {
	// Categoria is retorno.categorias.listaCategorias[].categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// Detalhe is retorno.categorias.listaCategorias[].detalhe, documented as a string.
	Detalhe Text `json:"detalhe"`
}

IBAMACertificadoRegularidadeRetornoCategoriasListaCategorias is retorno.categorias.listaCategorias[] in the answer of IBAMACertificadoRegularidade.

type IBAMAConsultaAutuacoesAmbientaisParams 

type IBAMAConsultaAutuacoesAmbientaisParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

IBAMAConsultaAutuacoesAmbientaisParams are the parameters of IBAMAConsultaAutuacoesAmbientais (IBAMA - Consulta de Autuações Ambientais).

func (IBAMAConsultaAutuacoesAmbientaisParams) Request 

func (p IBAMAConsultaAutuacoesAmbientaisParams) Request() (Request, error)

Request builds the Request for IBAMAConsultaAutuacoesAmbientais.

type IBAMAConsultaAutuacoesAmbientaisRetorno 

type IBAMAConsultaAutuacoesAmbientaisRetorno struct {
	// Autuacoes is retorno.autuacoes, a list.
	Autuacoes []IBAMAConsultaAutuacoesAmbientaisRetornoAutuacoes `json:"autuacoes"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiAutuacao is retorno.possuiAutuacao, documented as a boolean.
	PossuiAutuacao Flag `json:"possuiAutuacao"`
	// TotalAutuacoes is retorno.totalAutuacoes, documented as a number.
	TotalAutuacoes Number `json:"totalAutuacoes"`
	// ValorTotalMultas is retorno.valorTotalMultas, documented as a string.
	ValorTotalMultas Text `json:"valorTotalMultas"`
}

IBAMAConsultaAutuacoesAmbientaisRetorno is retorno in the answer of IBAMAConsultaAutuacoesAmbientais.

type IBAMAConsultaAutuacoesAmbientaisRetornoAutuacoes 

type IBAMAConsultaAutuacoesAmbientaisRetornoAutuacoes struct {
	// Bioma is retorno.autuacoes[].bioma, documented as a string.
	Bioma Text `json:"bioma"`
	// DataInfracao is retorno.autuacoes[].dataInfracao, documented as a string.
	DataInfracao Text `json:"dataInfracao"`
	// Estado is retorno.autuacoes[].estado, documented as a string.
	Estado Text `json:"estado"`
	// Municipio is retorno.autuacoes[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Numero is retorno.autuacoes[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// NumeroProcesso is retorno.autuacoes[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// SancoesAplicadas is retorno.autuacoes[].sancoesAplicadas, documented as a string.
	SancoesAplicadas Text `json:"sancoesAplicadas"`
	// Serie is retorno.autuacoes[].serie, documented as a string.
	Serie Text `json:"serie"`
	// StatusDebito is retorno.autuacoes[].statusDebito, documented as a string.
	StatusDebito Text `json:"statusDebito"`
	// TipoInfracao is retorno.autuacoes[].tipoInfracao, documented as a string.
	TipoInfracao Text `json:"tipoInfracao"`
	// ValorMulta is retorno.autuacoes[].valorMulta, documented as a string.
	ValorMulta Text `json:"valorMulta"`
}

IBAMAConsultaAutuacoesAmbientaisRetornoAutuacoes is retorno.autuacoes[] in the answer of IBAMAConsultaAutuacoesAmbientais.

type IdentityVerificationArgentinaParams 

type IdentityVerificationArgentinaParams struct {
	// DNI is sent as DNI. O parâmetro DNI pode ser enviado com ou sem formatação.
	DNI string
	// Name is sent as Name. O parâmetro NAME pode ser enviado com qualquer outro.
	Name string
	// Surname is sent as Surname. O parâmetro SURNAME pode ser enviado com qualquer outro.
	Surname string
	// DOB is sent as DOB. O parâmetro DOB deve ser fornecido, com ou sem formatação.
	DOB string
	// GENDER is sent as GENDER. Not described by the documentation.
	GENDER string
	// Address is sent as Address. Not described by the documentation.
	Address string
	// City is sent as City. Not described by the documentation.
	City string
	// State is sent as State. Not described by the documentation.
	State string
	// PostCode is sent as PostCode. Not described by the documentation.
	PostCode string
	// Phone is sent as Phone. O parâmetro PHONE pode ser enviado com ou sem formatação.
	Phone string
	// Country is sent as Country. Not described by the documentation.
	Country string
}

IdentityVerificationArgentinaParams are the parameters of IdentityVerificationArgentina (Identity Verification - Argentina).

func (IdentityVerificationArgentinaParams) Request 

func (p IdentityVerificationArgentinaParams) Request() (Request, error)

Request builds the Request for IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetorno 

type IdentityVerificationArgentinaRetorno struct {
	// Address is retorno.address.
	Address IdentityVerificationArgentinaRetornoAddress `json:"address"`
	// City is retorno.city.
	City IdentityVerificationArgentinaRetornoCity `json:"city"`
	// Country is retorno.country.
	Country IdentityVerificationArgentinaRetornoCountry `json:"country"`
	// Dni is retorno.dni.
	Dni IdentityVerificationArgentinaRetornoDni `json:"dni"`
	// Dob is retorno.dob.
	Dob IdentityVerificationArgentinaRetornoDob `json:"dob"`
	// Gender is retorno.gender.
	Gender IdentityVerificationArgentinaRetornoGender `json:"gender"`
	// Name is retorno.name.
	Name IdentityVerificationArgentinaRetornoName `json:"name"`
	// Phone is retorno.phone, a list.
	Phone []IdentityVerificationArgentinaRetornoPhone `json:"phone"`
	// PostCode is retorno.postCode.
	PostCode IdentityVerificationArgentinaRetornoPostCode `json:"postCode"`
	// State is retorno.state.
	State IdentityVerificationArgentinaRetornoState `json:"state"`
	// Surname is retorno.surname.
	Surname IdentityVerificationArgentinaRetornoSurname `json:"surname"`
}

IdentityVerificationArgentinaRetorno is retorno in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoAddress 

type IdentityVerificationArgentinaRetornoAddress struct {
	// Confidence is retorno.address.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.address.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.address.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoAddress is retorno.address in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoCity 

type IdentityVerificationArgentinaRetornoCity struct {
	// Confidence is retorno.city.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.city.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.city.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoCity is retorno.city in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoCountry 

type IdentityVerificationArgentinaRetornoCountry struct {
	// Confidence is retorno.country.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.country.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.country.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoCountry is retorno.country in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoDni 

type IdentityVerificationArgentinaRetornoDni struct {
	// Confidence is retorno.dni.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.dni.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.dni.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoDni is retorno.dni in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoDob 

type IdentityVerificationArgentinaRetornoDob struct {
	// Confidence is retorno.dob.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.dob.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.dob.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoDob is retorno.dob in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoGender 

type IdentityVerificationArgentinaRetornoGender struct {
	// Confidence is retorno.gender.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.gender.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.gender.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoGender is retorno.gender in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoName 

type IdentityVerificationArgentinaRetornoName struct {
	// Confidence is retorno.name.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.name.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.name.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoName is retorno.name in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoPhone 

type IdentityVerificationArgentinaRetornoPhone struct {
	// Confidence is retorno.phone[].confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.phone[].description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.phone[].provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoPhone is retorno.phone[] in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoPostCode 

type IdentityVerificationArgentinaRetornoPostCode struct {
	// Confidence is retorno.postCode.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.postCode.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.postCode.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoPostCode is retorno.postCode in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoState 

type IdentityVerificationArgentinaRetornoState struct {
	// Confidence is retorno.state.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.state.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.state.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoState is retorno.state in the answer of IdentityVerificationArgentina.

type IdentityVerificationArgentinaRetornoSurname 

type IdentityVerificationArgentinaRetornoSurname struct {
	// Confidence is retorno.surname.confidence, documented as a number.
	Confidence Number `json:"confidence"`
	// Description is retorno.surname.description, documented as a string.
	Description Text `json:"description"`
	// Provided is retorno.surname.provided, documented as a string.
	Provided Text `json:"provided"`
}

IdentityVerificationArgentinaRetornoSurname is retorno.surname in the answer of IdentityVerificationArgentina.

type InterpolParams 

type InterpolParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.
	Nome string
	// Sobrenome is sent as Sobrenome. O parâmetro SOBRENOME pode ser enviado em maiúsculo ou minúsculo.
	Sobrenome string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.
	DataNascimento string
}

InterpolParams are the parameters of Interpol (INTERPOL).

func (InterpolParams) Request 

func (p InterpolParams) Request() (Request, error)

Request builds the Request for Interpol.

type InterpolRetorno 

type InterpolRetorno struct {
	// Interpol is retorno.interpol.
	Interpol InterpolRetornoInterpol `json:"interpol"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
}

InterpolRetorno is retorno in the answer of Interpol.

type InterpolRetornoInterpol 

type InterpolRetornoInterpol struct {
	// DataConsulta is retorno.interpol.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Nome is retorno.interpol.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Pessoas is retorno.interpol.pessoas, a list.
	Pessoas []InterpolRetornoInterpolPessoas `json:"pessoas"`
	// Sobrenome is retorno.interpol.sobrenome, documented as a string.
	Sobrenome Text `json:"sobrenome" pii:"name"`
}

InterpolRetornoInterpol is retorno.interpol in the answer of Interpol.

type InterpolRetornoInterpolPessoas 

type InterpolRetornoInterpolPessoas struct {
	// Altura is retorno.interpol.pessoas[].altura, documented as a string.
	Altura Text `json:"altura"`
	// DataNascimento is retorno.interpol.pessoas[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Fotos is retorno.interpol.pessoas[].fotos, a list.
	Fotos []Text `json:"fotos"`
	// LinguasFaladas is retorno.interpol.pessoas[].linguasFaladas, a list.
	LinguasFaladas []Text `json:"linguasFaladas"`
	// LocalNascimento is retorno.interpol.pessoas[].localNascimento, documented as a string.
	LocalNascimento Text `json:"localNascimento"`
	// MarcasDistintivas is retorno.interpol.pessoas[].marcasDistintivas, documented as a string.
	MarcasDistintivas Text `json:"marcasDistintivas"`
	// Nacionalidades is retorno.interpol.pessoas[].nacionalidades, a list.
	Nacionalidades []Text `json:"nacionalidades"`
	// Ocorrencias is retorno.interpol.pessoas[].ocorrencias, a list.
	Ocorrencias []InterpolRetornoInterpolPessoasOcorrencias `json:"ocorrencias"`
	// Sexo is retorno.interpol.pessoas[].sexo, documented as a string.
	Sexo Text `json:"sexo"`
}

InterpolRetornoInterpolPessoas is retorno.interpol.pessoas[] in the answer of Interpol.

type InterpolRetornoInterpolPessoasOcorrencias 

type InterpolRetornoInterpolPessoasOcorrencias struct {
	// Cobranca is retorno.interpol.pessoas[].ocorrencias[].cobranca, documented as a string.
	Cobranca Text `json:"cobranca"`
	// Pais is retorno.interpol.pessoas[].ocorrencias[].pais, documented as a string.
	Pais Text `json:"pais"`
}

InterpolRetornoInterpolPessoasOcorrencias is retorno.interpol.pessoas[].ocorrencias[] in the answer of Interpol.

type Ledger 

type Ledger interface {
	// Reserve holds the charge and returns the hold's identifier, or an error
	// wrapping ErrBudgetExceeded when it does not fit.
	Reserve(ctx context.Context, c Charge) (holdID string, err error)
	// Settle turns the hold into a spend of cents.
	Settle(ctx context.Context, holdID string, cents int64) error
	// Release gives the hold back.
	Release(ctx context.Context, holdID string) error
}

Ledger holds, settles and releases the cost of queries. The application implements it -- normally over its wallet (arandu-wallet), bound to the tenant of the Grant the query is made under -- and passes it in the Meter of each call. This package keeps no balance.

The client calls Reserve before the request and makes none when Reserve fails; then exactly one of Settle or Release for the hold: Settle with the price when the outcome is billable under terms clause 2.5, Release otherwise. An asynchronous query keeps its hold open until CompleteAsync.

type MPFCertidaoNegativaParams 

type MPFCertidaoNegativaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

MPFCertidaoNegativaParams are the parameters of MPFCertidaoNegativa (Ministério Público Federal - Certidão Negativa).

func (MPFCertidaoNegativaParams) Request 

func (p MPFCertidaoNegativaParams) Request() (Request, error)

Request builds the Request for MPFCertidaoNegativa.

type MPFCertidaoNegativaRetorno 

type MPFCertidaoNegativaRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PossuiProcedimentoExtrajudicial is retorno.possuiProcedimentoExtrajudicial, documented as a boolean.
	PossuiProcedimentoExtrajudicial Flag `json:"possuiProcedimentoExtrajudicial"`
	// ProcedimentosExtrajudiciais is retorno.procedimentosExtrajudiciais, a list.
	ProcedimentosExtrajudiciais []MPFCertidaoNegativaRetornoProcedimentosExtrajudiciais `json:"procedimentosExtrajudiciais"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

MPFCertidaoNegativaRetorno is retorno in the answer of MPFCertidaoNegativa.

type MPFCertidaoNegativaRetornoProcedimentosExtrajudiciais 

type MPFCertidaoNegativaRetornoProcedimentosExtrajudiciais struct {
	// Etiqueta is retorno.procedimentosExtrajudiciais[].etiqueta, documented as a string.
	Etiqueta Text `json:"etiqueta"`
	// Localizacao is retorno.procedimentosExtrajudiciais[].localizacao, documented as a string.
	Localizacao Text `json:"localizacao"`
}

MPFCertidaoNegativaRetornoProcedimentosExtrajudiciais is retorno.procedimentosExtrajudiciais[] in the answer of MPFCertidaoNegativa.

type MPMTMinisterioPublicoMatoGrossoParams 

type MPMTMinisterioPublicoMatoGrossoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

MPMTMinisterioPublicoMatoGrossoParams are the parameters of MPMTMinisterioPublicoMatoGrosso (Ministério Público do Estado de Mato Grosso (MPMT) - Procedimentos Investigatórios Extrajudiciais).

func (MPMTMinisterioPublicoMatoGrossoParams) Request 

func (p MPMTMinisterioPublicoMatoGrossoParams) Request() (Request, error)

Request builds the Request for MPMTMinisterioPublicoMatoGrosso.

type MPMTMinisterioPublicoMatoGrossoRetorno 

type MPMTMinisterioPublicoMatoGrossoRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// PossuiProcedimentoExtrajudicial is retorno.possuiProcedimentoExtrajudicial, documented as a boolean.
	PossuiProcedimentoExtrajudicial Flag `json:"possuiProcedimentoExtrajudicial"`
	// ProcedimentosInvestigatoriosExtrajudiciais is retorno.procedimentosInvestigatoriosExtrajudiciais, a list.
	ProcedimentosInvestigatoriosExtrajudiciais []MPMTMinisterioPublicoMatoGrossoRetornoProcedimentosInvestigatoriosExtrajudiciais `json:"procedimentosInvestigatoriosExtrajudiciais"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

MPMTMinisterioPublicoMatoGrossoRetorno is retorno in the answer of MPMTMinisterioPublicoMatoGrosso.

type MPMTMinisterioPublicoMatoGrossoRetornoProcedimentosInvestigatoriosExtrajudiciais 

type MPMTMinisterioPublicoMatoGrossoRetornoProcedimentosInvestigatoriosExtrajudiciais struct {
	// Classe is retorno.procedimentosInvestigatoriosExtrajudiciais[].classe, documented as a string.
	Classe Text `json:"classe"`
	// Comarca is retorno.procedimentosInvestigatoriosExtrajudiciais[].comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// NumeroSIMP is retorno.procedimentosInvestigatoriosExtrajudiciais[].numeroSIMP, documented as a string.
	NumeroSIMP Text `json:"numeroSIMP"`
	// Observacao is retorno.procedimentosInvestigatoriosExtrajudiciais[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// PromotoriaResponsavel is retorno.procedimentosInvestigatoriosExtrajudiciais[].promotoriaResponsavel, documented as a string.
	PromotoriaResponsavel Text `json:"promotoriaResponsavel"`
}

MPMTMinisterioPublicoMatoGrossoRetornoProcedimentosInvestigatoriosExtrajudiciais is retorno.procedimentosInvestigatoriosExtrajudiciais[] in the answer of MPMTMinisterioPublicoMatoGrosso.

type MTEInfracoesTrabalhistasParams 

type MTEInfracoesTrabalhistasParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// TIPO is sent as TIPO. Not described by the documentation.
	TIPO string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

MTEInfracoesTrabalhistasParams are the parameters of MTEInfracoesTrabalhistas (Ministério do Trabalho e do Emprego (MTE) - Infrações Trabalhistas).

func (MTEInfracoesTrabalhistasParams) Request 

func (p MTEInfracoesTrabalhistasParams) Request() (Request, error)

Request builds the Request for MTEInfracoesTrabalhistas.

type MTEInfracoesTrabalhistasRetorno 

type MTEInfracoesTrabalhistasRetorno struct {
	// ConstamProcessos is retorno.constamProcessos, documented as a boolean.
	ConstamProcessos Flag `json:"constamProcessos"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// InfracoesTrabalhistas is retorno.infracoesTrabalhistas, a list.
	InfracoesTrabalhistas []MTEInfracoesTrabalhistasRetornoInfracoesTrabalhistas `json:"infracoesTrabalhistas"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TipoConsultado is retorno.tipoConsultado, documented as a string.
	TipoConsultado Text `json:"tipoConsultado"`
	// TotalProcessos is retorno.totalProcessos, documented as a string.
	TotalProcessos Text `json:"totalProcessos"`
}

MTEInfracoesTrabalhistasRetorno is retorno in the answer of MTEInfracoesTrabalhistas.

type MTEInfracoesTrabalhistasRetornoInfracoesTrabalhistas 

type MTEInfracoesTrabalhistasRetornoInfracoesTrabalhistas struct {
	// NumeroInscricao is retorno.infracoesTrabalhistas[].numeroInscricao, documented as a string.
	NumeroInscricao Text `json:"numeroInscricao"`
	// NumeroProcesso is retorno.infracoesTrabalhistas[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Situacao is retorno.infracoesTrabalhistas[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Tipo is retorno.infracoesTrabalhistas[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Uf is retorno.infracoesTrabalhistas[].uf, documented as a string.
	Uf Text `json:"uf"`
	// UltimoMovimento is retorno.infracoesTrabalhistas[].ultimoMovimento, documented as a string.
	UltimoMovimento Text `json:"ultimoMovimento"`
}

MTEInfracoesTrabalhistasRetornoInfracoesTrabalhistas is retorno.infracoesTrabalhistas[] in the answer of MTEInfracoesTrabalhistas.

type MemoryDedupe 

type MemoryDedupe struct {
	// contains filtered or unexported fields
}

MemoryDedupe is a Dedupe in memory, for tests and commands. It is not storage.

func NewMemoryDedupe 

func NewMemoryDedupe() *MemoryDedupe

NewMemoryDedupe returns an empty MemoryDedupe.

func (*MemoryDedupe) Remember 

func (d *MemoryDedupe) Remember(_ context.Context, key DedupeKey, r *Result) error

Remember stores the result under the key.

func (*MemoryDedupe) Seen 

func (d *MemoryDedupe) Seen(_ context.Context, key DedupeKey) (*Result, bool, error)

Seen returns the result remembered under the key.

type MemoryLedger 

type MemoryLedger struct {
	// contains filtered or unexported fields
}

MemoryLedger is a Ledger in memory with a cap, for tests and commands. It is not storage: what it holds is gone with the process.

func NewMemoryLedger 

func NewMemoryLedger(capCents int64) *MemoryLedger

NewMemoryLedger returns a MemoryLedger whose holds and spends together may not pass capCents.

func (*MemoryLedger) HeldCents 

func (l *MemoryLedger) HeldCents() int64

HeldCents is what is held and not yet settled or released.

func (*MemoryLedger) Release 

func (l *MemoryLedger) Release(_ context.Context, holdID string) error

Release frees the hold.

func (*MemoryLedger) RemainingCents 

func (l *MemoryLedger) RemainingCents() int64

RemainingCents is what the cap still allows.

func (*MemoryLedger) Reserve 

func (l *MemoryLedger) Reserve(_ context.Context, c Charge) (string, error)

Reserve holds the price, or returns ErrBudgetExceeded when it does not fit in what the cap leaves.

func (*MemoryLedger) Settle 

func (l *MemoryLedger) Settle(_ context.Context, holdID string, cents int64) error

Settle spends cents from the hold and frees the rest.

func (*MemoryLedger) SpentCents 

func (l *MemoryLedger) SpentCents() int64

SpentCents is what was settled.

type MetaData 

type MetaData struct {
	// ConsultaNome is the name of the API that answered.
	ConsultaNome string `json:"consultaNome"`
	// ConsultaUID is Direct Data's identifier of the query: the reference to
	// record as evidence and to reconcile the statement with.
	ConsultaUID string `json:"consultaUid"`
	// Chave is the key the query was made with, as Direct Data echoes it. It
	// may hold the queried document.
	Chave string `json:"chave"`
	// Usuario is the account that made the query.
	Usuario string `json:"usuario"`
	// Mensagem is Direct Data's message about the query.
	Mensagem string `json:"mensagem"`
	// IP is the address the query came from, as Direct Data saw it.
	IP string `json:"ip"`
	// ResultadoID is Direct Data's numeric status code. The public
	// documentation lists no values.
	ResultadoID int `json:"resultadoId"`
	// Resultado is Direct Data's status text, such as "Sucesso" or "Sucesso
	// com Ressalvas" (terms clause 2.5).
	Resultado string `json:"resultado"`
	// APIVersao is the API version, "v3".
	APIVersao string `json:"apiVersao"`
	// EnviarCallback says whether Direct Data will call the configured
	// callback.
	EnviarCallback bool `json:"enviarCallback"`
	// GerarComprovante says whether a PDF receipt was asked for.
	GerarComprovante bool `json:"gerarComprovante"`
	// URLComprovante is where the PDF receipt can be downloaded.
	URLComprovante string `json:"urlComprovante"`
	// Assincrono says whether the query runs asynchronously.
	Assincrono bool `json:"assincrono"`
	// Data is when Direct Data ran the query, as it writes it
	// (dd/MM/yyyy HH:mm:ss).
	Data string `json:"data"`
	// TempoExecucaoMs is Direct Data's own execution time, in milliseconds.
	TempoExecucaoMs int64 `json:"tempoExecucaoMs"`
}

MetaData is the metaDados object Direct Data puts beside every answer.

type Meter 

type Meter struct {
	// Ledger accounts for the call. Required.
	Ledger Ledger
	// Dedupe may answer the call from a result remembered for the day.
	Dedupe Dedupe
}

Meter is the accounting a call is made under: the Ledger that pays for it and, optionally, the Dedupe that may answer it for free. The application builds one per tenant from the authorized Grant; the client never reads a tenant itself.

type MinisterioPublicoTrabalhoParams 

type MinisterioPublicoTrabalhoParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Regiao is sent as Regiao. O parâmetro REGIAO deve ser enviado.
	Regiao string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

MinisterioPublicoTrabalhoParams are the parameters of MinisterioPublicoTrabalho (MPT - Ministério Público do Trabalho).

func (MinisterioPublicoTrabalhoParams) Request 

func (p MinisterioPublicoTrabalhoParams) Request() (Request, error)

Request builds the Request for MinisterioPublicoTrabalho.

type MinisterioPublicoTrabalhoRetorno 

type MinisterioPublicoTrabalhoRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Ocorrencias is retorno.ocorrencias, a list.
	Ocorrencias []MinisterioPublicoTrabalhoRetornoOcorrencias `json:"ocorrencias"`
	// PossuiOcorrencia is retorno.possuiOcorrencia, documented as a boolean.
	PossuiOcorrencia Flag `json:"possuiOcorrencia"`
	// Regiao is retorno.regiao, documented as a string.
	Regiao Text `json:"regiao"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

MinisterioPublicoTrabalhoRetorno is retorno in the answer of MinisterioPublicoTrabalho.

type MinisterioPublicoTrabalhoRetornoOcorrencias 

type MinisterioPublicoTrabalhoRetornoOcorrencias struct {
	// AnoAutuacao is retorno.ocorrencias[].anoAutuacao, documented as a string.
	AnoAutuacao Text `json:"anoAutuacao"`
	// Classe is retorno.ocorrencias[].classe, documented as a string.
	Classe Text `json:"classe"`
	// Numero is retorno.ocorrencias[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Partes is retorno.ocorrencias[].partes, a list.
	Partes []Text `json:"partes"`
	// Situacao is retorno.ocorrencias[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
}

MinisterioPublicoTrabalhoRetornoOcorrencias is retorno.ocorrencias[] in the answer of MinisterioPublicoTrabalho.

type MinisterioTrabalhoPISParams 

type MinisterioTrabalhoPISParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

MinisterioTrabalhoPISParams are the parameters of MinisterioTrabalhoPIS (Ministério do Trabalho - PIS).

func (MinisterioTrabalhoPISParams) Request 

func (p MinisterioTrabalhoPISParams) Request() (Request, error)

Request builds the Request for MinisterioTrabalhoPIS.

type MinisterioTrabalhoPISRetorno 

type MinisterioTrabalhoPISRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// Pis is retorno.pis, documented as a string.
	Pis Text `json:"pis" pii:"document"`
}

MinisterioTrabalhoPISRetorno is retorno in the answer of MinisterioTrabalhoPIS.

type NivelSocioeconomicoParams 

type NivelSocioeconomicoParams struct {
	// CPF is sent as CPF. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CPF string
}

NivelSocioeconomicoParams are the parameters of nivelSocioeconomico (Nível Socioeconômico e Renda Estimada).

func (NivelSocioeconomicoParams) Request 

func (p NivelSocioeconomicoParams) Request() (Request, error)

Request builds the Request for nivelSocioeconomico.

type NivelSocioeconomicoRetorno 

type NivelSocioeconomicoRetorno struct {
	// Cbo is retorno.cbo, documented as a string.
	Cbo Text `json:"cbo"`
	// ClasseSocial is retorno.classeSocial, documented as a string.
	ClasseSocial Text `json:"classeSocial"`
	// CodigoCBO is retorno.codigoCBO, documented as a string.
	CodigoCBO Text `json:"codigoCBO"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Escolaridade is retorno.escolaridade, documented as a string.
	Escolaridade Text `json:"escolaridade"`
	// PerfilDomiciliar is retorno.perfilDomiciliar.
	PerfilDomiciliar NivelSocioeconomicoRetornoPerfilDomiciliar `json:"perfilDomiciliar"`
	// RendaEstimada is retorno.rendaEstimada, documented as a string.
	RendaEstimada Text `json:"rendaEstimada"`
	// RendaFaixaSalarial is retorno.rendaFaixaSalarial, documented as a string.
	RendaFaixaSalarial Text `json:"rendaFaixaSalarial"`
	// RendaIBGE is retorno.rendaIBGE, documented as a string.
	RendaIBGE Text `json:"rendaIBGE"`
	// RendaMaximaCBO is retorno.rendaMaximaCBO, documented as a string.
	RendaMaximaCBO Text `json:"rendaMaximaCBO"`
	// RendaMediaCBO is retorno.rendaMediaCBO, documented as a string.
	RendaMediaCBO Text `json:"rendaMediaCBO"`
	// RendaMinimaCBO is retorno.rendaMinimaCBO, documented as a string.
	RendaMinimaCBO Text `json:"rendaMinimaCBO"`
}

NivelSocioeconomicoRetorno is retorno in the answer of nivelSocioeconomico.

type NivelSocioeconomicoRetornoPerfilDomiciliar 

type NivelSocioeconomicoRetornoPerfilDomiciliar struct {
	// ClasseSocialFamiliar is retorno.perfilDomiciliar.classeSocialFamiliar, documented as a string.
	ClasseSocialFamiliar Text `json:"classeSocialFamiliar"`
	// Confiabilidade is retorno.perfilDomiciliar.confiabilidade, documented as a string.
	Confiabilidade Text `json:"confiabilidade"`
	// FaixaRendaPerCapita is retorno.perfilDomiciliar.faixaRendaPerCapita, documented as a string.
	FaixaRendaPerCapita Text `json:"faixaRendaPerCapita"`
	// QuantidadeAdultos is retorno.perfilDomiciliar.quantidadeAdultos, documented as a number.
	QuantidadeAdultos Number `json:"quantidadeAdultos"`
	// QuantidadeMenores is retorno.perfilDomiciliar.quantidadeMenores, documented as a number.
	QuantidadeMenores Number `json:"quantidadeMenores"`
	// QuantidadeMoradores is retorno.perfilDomiciliar.quantidadeMoradores, documented as a number.
	QuantidadeMoradores Number `json:"quantidadeMoradores"`
	// RendaDomiciliar is retorno.perfilDomiciliar.rendaDomiciliar, documented as a string.
	RendaDomiciliar Text `json:"rendaDomiciliar"`
	// RendaPerCapita is retorno.perfilDomiciliar.rendaPerCapita, documented as a string.
	RendaPerCapita Text `json:"rendaPerCapita"`
	// TipoDomicilio is retorno.perfilDomiciliar.tipoDomicilio, documented as a string.
	TipoDomicilio Text `json:"tipoDomicilio"`
}

NivelSocioeconomicoRetornoPerfilDomiciliar is retorno.perfilDomiciliar in the answer of nivelSocioeconomico.

type NotaFiscalEletronicaCompletaParams 

type NotaFiscalEletronicaCompletaParams struct {
	// Chave is sent as Chave. O parâmetro CHAVE pode ser enviado com qualquer outro.
	Chave string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

NotaFiscalEletronicaCompletaParams are the parameters of NotaFiscalEletronicaCompleta (NFe - Nota Fiscal Eletrônica - Completa).

func (NotaFiscalEletronicaCompletaParams) Request 

func (p NotaFiscalEletronicaCompletaParams) Request() (Request, error)

Request builds the Request for NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetorno 

type NotaFiscalEletronicaCompletaRetorno struct {
	// ChaveNFe is retorno.chaveNFe, documented as a string.
	ChaveNFe Text `json:"chaveNFe"`
	// Destinatario is retorno.destinatario.
	Destinatario NotaFiscalEletronicaCompletaRetornoDestinatario `json:"destinatario"`
	// Emitente is retorno.emitente.
	Emitente NotaFiscalEletronicaCompletaRetornoEmitente `json:"emitente"`
	// FormasPagamento is retorno.formasPagamento, a list.
	FormasPagamento []NotaFiscalEletronicaCompletaRetornoFormasPagamento `json:"formasPagamento"`
	// Identificacao is retorno.identificacao.
	Identificacao NotaFiscalEletronicaCompletaRetornoIdentificacao `json:"identificacao"`
	// InformacoesComplementares is retorno.informacoesComplementares, documented as a string.
	InformacoesComplementares Text `json:"informacoesComplementares"`
	// Itens is retorno.itens, a list.
	Itens []NotaFiscalEletronicaCompletaRetornoItens `json:"itens"`
	// Totais is retorno.totais.
	Totais NotaFiscalEletronicaCompletaRetornoTotais `json:"totais"`
	// Transporte is retorno.transporte.
	Transporte NotaFiscalEletronicaCompletaRetornoTransporte `json:"transporte"`
}

NotaFiscalEletronicaCompletaRetorno is retorno in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoDestinatario 

type NotaFiscalEletronicaCompletaRetornoDestinatario struct {
	// Documento is retorno.destinatario.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Email is retorno.destinatario.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Endereco is retorno.destinatario.endereco.
	Endereco NotaFiscalEletronicaCompletaRetornoDestinatarioEndereco `json:"endereco"`
	// IndicadorIE is retorno.destinatario.indicadorIE, documented as a string.
	IndicadorIE Text `json:"indicadorIE"`
	// InscricaoEstadual is retorno.destinatario.inscricaoEstadual, documented as a string.
	InscricaoEstadual Text `json:"inscricaoEstadual" pii:"document"`
	// NomeEntidade is retorno.destinatario.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
}

NotaFiscalEletronicaCompletaRetornoDestinatario is retorno.destinatario in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoDestinatarioEndereco 

type NotaFiscalEletronicaCompletaRetornoDestinatarioEndereco struct {
	// Bairro is retorno.destinatario.endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.destinatario.endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Logradouro is retorno.destinatario.endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Municipio is retorno.destinatario.endereco.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Numero is retorno.destinatario.endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Telefone is retorno.destinatario.endereco.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// Uf is retorno.destinatario.endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

NotaFiscalEletronicaCompletaRetornoDestinatarioEndereco is retorno.destinatario.endereco in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoEmitente 

type NotaFiscalEletronicaCompletaRetornoEmitente struct {
	// Cnpj is retorno.emitente.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Endereco is retorno.emitente.endereco.
	Endereco NotaFiscalEletronicaCompletaRetornoEmitenteEndereco `json:"endereco"`
	// InscricaoEstadual is retorno.emitente.inscricaoEstadual, documented as a string.
	InscricaoEstadual Text `json:"inscricaoEstadual" pii:"document"`
	// NomeFantasia is retorno.emitente.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// RazaoSocial is retorno.emitente.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

NotaFiscalEletronicaCompletaRetornoEmitente is retorno.emitente in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoEmitenteEndereco 

type NotaFiscalEletronicaCompletaRetornoEmitenteEndereco struct {
	// Bairro is retorno.emitente.endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.emitente.endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Logradouro is retorno.emitente.endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Municipio is retorno.emitente.endereco.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Numero is retorno.emitente.endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Telefone is retorno.emitente.endereco.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// Uf is retorno.emitente.endereco.uf, documented as a string.
	Uf Text `json:"uf"`
}

NotaFiscalEletronicaCompletaRetornoEmitenteEndereco is retorno.emitente.endereco in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoFormasPagamento 

type NotaFiscalEletronicaCompletaRetornoFormasPagamento struct {
	// DataPagamento is retorno.formasPagamento[].dataPagamento, documented as a string.
	DataPagamento Text `json:"dataPagamento"`
	// Descricao is retorno.formasPagamento[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// FormaPagamento is retorno.formasPagamento[].formaPagamento, documented as a string.
	FormaPagamento Text `json:"formaPagamento"`
	// Indicador is retorno.formasPagamento[].indicador, documented as a string.
	Indicador Text `json:"indicador"`
	// Valor is retorno.formasPagamento[].valor, documented as a string.
	Valor Text `json:"valor"`
}

NotaFiscalEletronicaCompletaRetornoFormasPagamento is retorno.formasPagamento[] in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoIdentificacao 

type NotaFiscalEletronicaCompletaRetornoIdentificacao struct {
	// DataEmissao is retorno.identificacao.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// Modelo is retorno.identificacao.modelo, documented as a number.
	Modelo Number `json:"modelo"`
	// NaturezaOperacao is retorno.identificacao.naturezaOperacao, documented as a string.
	NaturezaOperacao Text `json:"naturezaOperacao"`
	// NumeroNFe is retorno.identificacao.numeroNFe, documented as a number.
	NumeroNFe Number `json:"numeroNFe"`
	// Serie is retorno.identificacao.serie, documented as a number.
	Serie Number `json:"serie"`
	// TipoNFe is retorno.identificacao.tipoNFe, documented as a string.
	TipoNFe Text `json:"tipoNFe"`
}

NotaFiscalEletronicaCompletaRetornoIdentificacao is retorno.identificacao in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoItens 

type NotaFiscalEletronicaCompletaRetornoItens struct {
	// Cest is retorno.itens[].cest, documented as a string.
	Cest Text `json:"cest"`
	// Cfop is retorno.itens[].cfop, documented as a string.
	Cfop Text `json:"cfop"`
	// CodigoProduto is retorno.itens[].codigoProduto, documented as a string.
	CodigoProduto Text `json:"codigoProduto"`
	// DescricaoProduto is retorno.itens[].descricaoProduto, documented as a string.
	DescricaoProduto Text `json:"descricaoProduto"`
	// Impostos is retorno.itens[].impostos.
	Impostos NotaFiscalEletronicaCompletaRetornoItensImpostos `json:"impostos"`
	// Ncm is retorno.itens[].ncm, documented as a string.
	Ncm Text `json:"ncm"`
	// NumeroItem is retorno.itens[].numeroItem, documented as a number.
	NumeroItem Number `json:"numeroItem"`
	// Quantidade is retorno.itens[].quantidade, documented as a string.
	Quantidade Text `json:"quantidade"`
	// UnidadeComercial is retorno.itens[].unidadeComercial, documented as a string.
	UnidadeComercial Text `json:"unidadeComercial"`
	// ValorTotal is retorno.itens[].valorTotal, documented as a string.
	ValorTotal Text `json:"valorTotal"`
	// ValorUnitario is retorno.itens[].valorUnitario, documented as a string.
	ValorUnitario Text `json:"valorUnitario"`
}

NotaFiscalEletronicaCompletaRetornoItens is retorno.itens[] in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoItensImpostos 

type NotaFiscalEletronicaCompletaRetornoItensImpostos struct {
	// AliquotaICMS is retorno.itens[].impostos.aliquotaICMS, documented as a string.
	AliquotaICMS Text `json:"aliquotaICMS"`
	// BaseICMS is retorno.itens[].impostos.baseICMS, documented as a string.
	BaseICMS Text `json:"baseICMS"`
	// Cofins is retorno.itens[].impostos.cofins.
	Cofins NotaFiscalEletronicaCompletaRetornoItensImpostosCofins `json:"cofins"`
	// Pis is retorno.itens[].impostos.pis.
	Pis NotaFiscalEletronicaCompletaRetornoItensImpostosPis `json:"pis"`
	// ValorICMS is retorno.itens[].impostos.valorICMS, documented as a string.
	ValorICMS Text `json:"valorICMS"`
}

NotaFiscalEletronicaCompletaRetornoItensImpostos is retorno.itens[].impostos in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoItensImpostosCofins 

type NotaFiscalEletronicaCompletaRetornoItensImpostosCofins struct {
	// Aliquota is retorno.itens[].impostos.cofins.aliquota, documented as a string.
	Aliquota Text `json:"aliquota"`
	// BaseCalculo is retorno.itens[].impostos.cofins.baseCalculo, documented as a string.
	BaseCalculo Text `json:"baseCalculo"`
	// Cst is retorno.itens[].impostos.cofins.cst, documented as a string.
	Cst Text `json:"cst"`
	// Valor is retorno.itens[].impostos.cofins.valor, documented as a string.
	Valor Text `json:"valor"`
}

NotaFiscalEletronicaCompletaRetornoItensImpostosCofins is retorno.itens[].impostos.cofins in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoItensImpostosPis 

type NotaFiscalEletronicaCompletaRetornoItensImpostosPis struct {
	// Aliquota is retorno.itens[].impostos.pis.aliquota, documented as a string.
	Aliquota Text `json:"aliquota"`
	// BaseCalculo is retorno.itens[].impostos.pis.baseCalculo, documented as a string.
	BaseCalculo Text `json:"baseCalculo"`
	// Cst is retorno.itens[].impostos.pis.cst, documented as a string.
	Cst Text `json:"cst"`
	// Valor is retorno.itens[].impostos.pis.valor, documented as a string.
	Valor Text `json:"valor"`
}

NotaFiscalEletronicaCompletaRetornoItensImpostosPis is retorno.itens[].impostos.pis in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoTotais 

type NotaFiscalEletronicaCompletaRetornoTotais struct {
	// BaseCBS is retorno.totais.baseCBS, documented as a string.
	BaseCBS Text `json:"baseCBS"`
	// BaseIBS is retorno.totais.baseIBS, documented as a string.
	BaseIBS Text `json:"baseIBS"`
	// BaseICMS is retorno.totais.baseICMS, documented as a string.
	BaseICMS Text `json:"baseICMS"`
	// ValorCBS is retorno.totais.valorCBS, documented as a string.
	ValorCBS Text `json:"valorCBS"`
	// ValorCOFINS is retorno.totais.valorCOFINS, documented as a string.
	ValorCOFINS Text `json:"valorCOFINS"`
	// ValorDesconto is retorno.totais.valorDesconto, documented as a string.
	ValorDesconto Text `json:"valorDesconto"`
	// ValorFrete is retorno.totais.valorFrete, documented as a string.
	ValorFrete Text `json:"valorFrete"`
	// ValorIBS is retorno.totais.valorIBS, documented as a string.
	ValorIBS Text `json:"valorIBS"`
	// ValorICMS is retorno.totais.valorICMS, documented as a string.
	ValorICMS Text `json:"valorICMS"`
	// ValorIPI is retorno.totais.valorIPI, documented as a string.
	ValorIPI Text `json:"valorIPI"`
	// ValorOutros is retorno.totais.valorOutros, documented as a string.
	ValorOutros Text `json:"valorOutros"`
	// ValorPIS is retorno.totais.valorPIS, documented as a string.
	ValorPIS Text `json:"valorPIS"`
	// ValorProdutos is retorno.totais.valorProdutos, documented as a string.
	ValorProdutos Text `json:"valorProdutos"`
	// ValorSeguro is retorno.totais.valorSeguro, documented as a string.
	ValorSeguro Text `json:"valorSeguro"`
	// ValorTotalNFe is retorno.totais.valorTotalNFe, documented as a string.
	ValorTotalNFe Text `json:"valorTotalNFe"`
	// ValorTotalTributos is retorno.totais.valorTotalTributos, documented as a string.
	ValorTotalTributos Text `json:"valorTotalTributos"`
}

NotaFiscalEletronicaCompletaRetornoTotais is retorno.totais in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoTransporte 

type NotaFiscalEletronicaCompletaRetornoTransporte struct {
	// Cnpj is retorno.transporte.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// ModalidadeFrete is retorno.transporte.modalidadeFrete, documented as a string.
	ModalidadeFrete Text `json:"modalidadeFrete"`
	// RazaoSocial is retorno.transporte.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Volume is retorno.transporte.volume.
	Volume NotaFiscalEletronicaCompletaRetornoTransporteVolume `json:"volume"`
}

NotaFiscalEletronicaCompletaRetornoTransporte is retorno.transporte in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaCompletaRetornoTransporteVolume 

type NotaFiscalEletronicaCompletaRetornoTransporteVolume struct {
	// Especie is retorno.transporte.volume.especie, documented as a string.
	Especie Text `json:"especie"`
	// PesoBruto is retorno.transporte.volume.pesoBruto, documented as a string.
	PesoBruto Text `json:"pesoBruto"`
	// PesoLiquido is retorno.transporte.volume.pesoLiquido, documented as a string.
	PesoLiquido Text `json:"pesoLiquido"`
	// Quantidade is retorno.transporte.volume.quantidade, documented as a number.
	Quantidade Number `json:"quantidade"`
}

NotaFiscalEletronicaCompletaRetornoTransporteVolume is retorno.transporte.volume in the answer of NotaFiscalEletronicaCompleta.

type NotaFiscalEletronicaInutilizacaoParams 

type NotaFiscalEletronicaInutilizacaoParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Ano is sent as Ano. Not described by the documentation.
	Ano string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

NotaFiscalEletronicaInutilizacaoParams are the parameters of NotaFiscalEletronicaInutilizacao (NFe - Nota Fiscal Eletrônica - Inutilizações).

func (NotaFiscalEletronicaInutilizacaoParams) Request 

func (p NotaFiscalEletronicaInutilizacaoParams) Request() (Request, error)

Request builds the Request for NotaFiscalEletronicaInutilizacao.

type NotaFiscalEletronicaInutilizacaoRetorno 

type NotaFiscalEletronicaInutilizacaoRetorno struct {
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Inutilizacoes is retorno.inutilizacoes, a list.
	Inutilizacoes []NotaFiscalEletronicaInutilizacaoRetornoInutilizacoes `json:"inutilizacoes"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

NotaFiscalEletronicaInutilizacaoRetorno is retorno in the answer of NotaFiscalEletronicaInutilizacao.

type NotaFiscalEletronicaInutilizacaoRetornoInutilizacoes 

type NotaFiscalEletronicaInutilizacaoRetornoInutilizacoes struct {
	// Ano is retorno.inutilizacoes[].ano, documented as a number.
	Ano Number `json:"ano"`
	// DataAutorizacao is retorno.inutilizacoes[].dataAutorizacao, documented as a string.
	DataAutorizacao Text `json:"dataAutorizacao"`
	// DataRecebimentoAN is retorno.inutilizacoes[].dataRecebimentoAN, documented as a string.
	DataRecebimentoAN Text `json:"dataRecebimentoAN"`
	// Modelo is retorno.inutilizacoes[].modelo, documented as a number.
	Modelo Number `json:"modelo"`
	// NumeroFinal is retorno.inutilizacoes[].numeroFinal, documented as a number.
	NumeroFinal Number `json:"numeroFinal"`
	// NumeroInicial is retorno.inutilizacoes[].numeroInicial, documented as a number.
	NumeroInicial Number `json:"numeroInicial"`
	// Protocolo is retorno.inutilizacoes[].protocolo, documented as a string.
	Protocolo Text `json:"protocolo"`
	// Serie is retorno.inutilizacoes[].serie, documented as a number.
	Serie Number `json:"serie"`
}

NotaFiscalEletronicaInutilizacaoRetornoInutilizacoes is retorno.inutilizacoes[] in the answer of NotaFiscalEletronicaInutilizacao.

type Number 

type Number string

Number is a numeric field of a response, kept as the text it arrived as so that no digit is lost: a number, or a string holding one, reads; null reads as "".

func (Number) Float64 

func (n Number) Float64() (float64, bool)

Float64 returns the number, and false when it is empty or not a number. A decimal comma is read as a point.

func (Number) Int64 

func (n Number) Int64() (int64, bool)

Int64 returns the number as an integer, and false when it is empty or not an integer.

func (Number) String 

func (n Number) String() string

String returns the number as it arrived.

func (*Number) UnmarshalJSON 

func (n *Number) UnmarshalJSON(b []byte) error

UnmarshalJSON reads a number, a string or null.

type OABCadastroNacionalAdvogadosParams 

type OABCadastroNacionalAdvogadosParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
	// INSCRICAO is sent as INSCRICAO. Not described by the documentation.
	INSCRICAO string
	// UF is sent as UF. Not described by the documentation.
	UF string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
	// IE is sent as IE. Named by the endpoint template only; the parameter table does not list it.
	IE string
}

OABCadastroNacionalAdvogadosParams are the parameters of OABCadastroNacionalAdvogados (OAB - Cadastro Nacional dos Advogados).

func (OABCadastroNacionalAdvogadosParams) Request 

func (p OABCadastroNacionalAdvogadosParams) Request() (Request, error)

Request builds the Request for OABCadastroNacionalAdvogados.

type OABCadastroNacionalAdvogadosRetorno 

type OABCadastroNacionalAdvogadosRetorno struct {
	// Advogados is retorno.advogados, a list.
	Advogados []OABCadastroNacionalAdvogadosRetornoAdvogados `json:"advogados"`
	// Inscricao is retorno.inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
	// NomePesquisado is retorno.nomePesquisado, documented as a string.
	NomePesquisado Text `json:"nomePesquisado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiRegistros is retorno.possuiRegistros, documented as a boolean.
	PossuiRegistros Flag `json:"possuiRegistros"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

OABCadastroNacionalAdvogadosRetorno is retorno in the answer of OABCadastroNacionalAdvogados.

type OABCadastroNacionalAdvogadosRetornoAdvogados 

type OABCadastroNacionalAdvogadosRetornoAdvogados struct {
	// Endereco is retorno.advogados[].endereco.
	Endereco OABCadastroNacionalAdvogadosRetornoAdvogadosEndereco `json:"endereco"`
	// Foto is retorno.advogados[].foto, documented as a string.
	Foto Text `json:"foto"`
	// Inscricao is retorno.advogados[].inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
	// Nome is retorno.advogados[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeSocial is retorno.advogados[].nomeSocial, documented as a string.
	NomeSocial Text `json:"nomeSocial" pii:"name"`
	// Organizacao is retorno.advogados[].organizacao, documented as a string.
	Organizacao Text `json:"organizacao"`
	// Situacao is retorno.advogados[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Telefone is retorno.advogados[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TipoInscricao is retorno.advogados[].tipoInscricao, documented as a string.
	TipoInscricao Text `json:"tipoInscricao"`
	// Uf is retorno.advogados[].uf, documented as a string.
	Uf Text `json:"uf"`
}

OABCadastroNacionalAdvogadosRetornoAdvogados is retorno.advogados[] in the answer of OABCadastroNacionalAdvogados.

type OABCadastroNacionalAdvogadosRetornoAdvogadosEndereco 

type OABCadastroNacionalAdvogadosRetornoAdvogadosEndereco struct {
	// Bairro is retorno.advogados[].endereco.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.advogados[].endereco.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cidade is retorno.advogados[].endereco.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Complemento is retorno.advogados[].endereco.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Logradouro is retorno.advogados[].endereco.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Numero is retorno.advogados[].endereco.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
}

OABCadastroNacionalAdvogadosRetornoAdvogadosEndereco is retorno.advogados[].endereco in the answer of OABCadastroNacionalAdvogados.

type OFACParams 

type OFACParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.
	Nome string
	// Sobrenome is sent as Sobrenome. Named by the endpoint template only; the parameter table does not list it.
	Sobrenome string
}

OFACParams are the parameters of OFAC (OFAC - Sanctions List (SND and Non-SDN)).

func (OFACParams) Request 

func (p OFACParams) Request() (Request, error)

Request builds the Request for OFAC.

type OFACRetorno 

type OFACRetorno struct {
	// DataListaNONSDN is retorno.dataListaNONSDN, documented as a string.
	DataListaNONSDN Text `json:"dataListaNONSDN"`
	// DataListaSDN is retorno.dataListaSDN, documented as a string.
	DataListaSDN Text `json:"dataListaSDN"`
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []OFACRetornoSancoes `json:"sancoes"`
}

OFACRetorno is retorno in the answer of OFAC.

type OFACRetornoSancoes 

type OFACRetornoSancoes struct {
	// Apelidos is retorno.sancoes[].apelidos, a list.
	Apelidos []OFACRetornoSancoesApelidos `json:"apelidos"`
	// Cidadania is retorno.sancoes[].cidadania, documented as a string.
	Cidadania Text `json:"cidadania"`
	// DataNascimento is retorno.sancoes[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Enderecos is retorno.sancoes[].enderecos, a list.
	Enderecos []OFACRetornoSancoesEnderecos `json:"enderecos"`
	// Identificacoes is retorno.sancoes[].identificacoes, a list.
	Identificacoes []OFACRetornoSancoesIdentificacoes `json:"identificacoes"`
	// Lista is retorno.sancoes[].lista, documented as a string.
	Lista Text `json:"lista"`
	// LocalNascimento is retorno.sancoes[].localNascimento, documented as a string.
	LocalNascimento Text `json:"localNascimento"`
	// Nacionalidade is retorno.sancoes[].nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Nome is retorno.sancoes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Programa is retorno.sancoes[].programa, documented as a string.
	Programa Text `json:"programa"`
	// Sobrenome is retorno.sancoes[].sobrenome, documented as a string.
	Sobrenome Text `json:"sobrenome" pii:"name"`
}

OFACRetornoSancoes is retorno.sancoes[] in the answer of OFAC.

type OFACRetornoSancoesApelidos 

type OFACRetornoSancoesApelidos struct {
	// Categoria is retorno.sancoes[].apelidos[].categoria, documented as a string.
	Categoria Text `json:"categoria"`
	// Nome is retorno.sancoes[].apelidos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Tipo is retorno.sancoes[].apelidos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

OFACRetornoSancoesApelidos is retorno.sancoes[].apelidos[] in the answer of OFAC.

type OFACRetornoSancoesEnderecos 

type OFACRetornoSancoesEnderecos struct {
	// Cidade is retorno.sancoes[].enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoPostal is retorno.sancoes[].enderecos[].codigoPostal, documented as a string.
	CodigoPostal Text `json:"codigoPostal"`
	// Endereco is retorno.sancoes[].enderecos[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Estado is retorno.sancoes[].enderecos[].estado, documented as a string.
	Estado Text `json:"estado"`
	// Pais is retorno.sancoes[].enderecos[].pais, documented as a string.
	Pais Text `json:"pais"`
}

OFACRetornoSancoesEnderecos is retorno.sancoes[].enderecos[] in the answer of OFAC.

type OFACRetornoSancoesIdentificacoes 

type OFACRetornoSancoesIdentificacoes struct {
	// DataEmissao is retorno.sancoes[].identificacoes[].dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataExpiracao is retorno.sancoes[].identificacoes[].dataExpiracao, documented as a string.
	DataExpiracao Text `json:"dataExpiracao"`
	// Descricao is retorno.sancoes[].identificacoes[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Pais is retorno.sancoes[].identificacoes[].pais, documented as a string.
	Pais Text `json:"pais"`
	// Tipo is retorno.sancoes[].identificacoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

OFACRetornoSancoesIdentificacoes is retorno.sancoes[].identificacoes[] in the answer of OFAC.

type ObitoParams 

type ObitoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

ObitoParams are the parameters of Obito (Óbito).

func (ObitoParams) Request 

func (p ObitoParams) Request() (Request, error)

Request builds the Request for Obito.

type ObitoRetorno 

type ObitoRetorno struct {
	// ConstaObito is retorno.constaObito, documented as a boolean.
	ConstaObito Flag `json:"constaObito"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

ObitoRetorno is retorno in the answer of Obito.

type OffshoreLeaksParams 

type OffshoreLeaksParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
	// NodeID is sent as NodeID. Not described by the documentation.
	NodeID string
}

OffshoreLeaksParams are the parameters of OffshoreLeaks (Offshore Leaks - ICIJ).

func (OffshoreLeaksParams) Request 

func (p OffshoreLeaksParams) Request() (Request, error)

Request builds the Request for OffshoreLeaks.

type OffshoreLeaksRetorno 

type OffshoreLeaksRetorno struct {
	// FonteAtribuicao is retorno.fonteAtribuicao, documented as a string.
	FonteAtribuicao Text `json:"fonteAtribuicao"`
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ReferenciaBase is retorno.referenciaBase, documented as a string.
	ReferenciaBase Text `json:"referenciaBase"`
	// Registros is retorno.registros, a list.
	Registros []OffshoreLeaksRetornoRegistros `json:"registros"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// TotalRegistrosBase is retorno.totalRegistrosBase, documented as a number.
	TotalRegistrosBase Number `json:"totalRegistrosBase"`
}

OffshoreLeaksRetorno is retorno in the answer of OffshoreLeaks.

type OffshoreLeaksRetornoRegistros 

type OffshoreLeaksRetornoRegistros struct {
	// DataIncorporacao is retorno.registros[].dataIncorporacao, documented as a string.
	DataIncorporacao Text `json:"dataIncorporacao"`
	// Jurisdicao is retorno.registros[].jurisdicao, documented as a string.
	Jurisdicao Text `json:"jurisdicao"`
	// NodeId is retorno.registros[].nodeId, documented as a string.
	NodeId Text `json:"nodeId"`
	// Nome is retorno.registros[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Pais is retorno.registros[].pais, a list.
	Pais []Text `json:"pais"`
	// Situacao is retorno.registros[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoMatch is retorno.registros[].tipoMatch, documented as a string.
	TipoMatch Text `json:"tipoMatch"`
	// TipoNo is retorno.registros[].tipoNo, documented as a string.
	TipoNo Text `json:"tipoNo"`
	// Vazamento is retorno.registros[].vazamento, documented as a string.
	Vazamento Text `json:"vazamento"`
}

OffshoreLeaksRetornoRegistros is retorno.registros[] in the answer of OffshoreLeaks.

type Outcome 

type Outcome string

Outcome is what a query came to, as far as the transport and Direct Data's own status say. It describes the query, never the person or company queried: "found" says the source returned a record, not that the record is regular, alive or trustworthy. 

const (
	// OutcomeFound is a query Direct Data answered with status "Sucesso".
	OutcomeFound Outcome = "found"
	// OutcomeFoundWithCaveats is a query answered with status "Sucesso com
	// Ressalvas": data came back, and part of the query did not complete.
	OutcomeFoundWithCaveats Outcome = "found_with_caveats"
	// OutcomeNotFound is a query for which the source holds no record.
	OutcomeNotFound Outcome = "not_found"
	// OutcomeInvalidDocument is a parameter Direct Data refused (HTTP 400). A
	// document that fails its check digits never reaches Direct Data: the
	// client refuses it with ErrInvalidDocument instead.
	OutcomeInvalidDocument Outcome = "invalid_document"
	// OutcomeUnavailable is a transport failure, a 5xx, a source that did not
	// answer, or the circuit breaker refusing the call.
	OutcomeUnavailable Outcome = "unavailable"
	// OutcomeInsufficientBalance is a query refused for lack of balance.
	OutcomeInsufficientBalance Outcome = "insufficient_balance"
	// OutcomeUnauthorized is a token Direct Data refused (HTTP 401 or 403).
	OutcomeUnauthorized Outcome = "unauthorized"
	// OutcomeRateLimited is a query refused for its rate (HTTP 429).
	OutcomeRateLimited Outcome = "rate_limited"
	// OutcomeError is every other answer. The message is kept on the result.
	OutcomeError Outcome = "error"
)

The outcomes.

func Classify 

func Classify(httpStatus int, meta *MetaData, codes map[int]Outcome) Outcome

Classify maps an answer to its Outcome.

The order is: a resultadoId the application mapped in Config.ResultCodes; the HTTP status, as the public documentation lists it (400 invalid parameter, 401 invalid token, 404 not found, 5xx internal error) plus 402, 403 and 429; the status text, where "Sucesso" and "Sucesso com Ressalvas" are named by the terms of use; and, last, words in the status and message that the documentation does not define but that say what happened ("não encontrado", "saldo insuficiente", "token inválido", "indisponível"). Anything else is OutcomeError.

meta is nil when the answer carried no metaDados object. The public documentation lists no resultadoId values, so none is mapped by default; the application fills Config.ResultCodes from what it observes.

func (Outcome) Billable 

func (o Outcome) Billable() bool

Billable reports whether Direct Data bills a query that came to o. Terms clause 2.5: "As consultas serão cobradas quando o status de retorno seja 'Sucesso' ou 'Sucesso com Ressalvas'." A duplicate query -- the same document on the same API on the same day -- is billed again under the same clause.

type PEPParentescosParams 

type PEPParentescosParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

PEPParentescosParams are the parameters of PEPParentescos (PEP Estendida - Pessoa Exposta Politicamente + Parentescos).

func (PEPParentescosParams) Request 

func (p PEPParentescosParams) Request() (Request, error)

Request builds the Request for PEPParentescos.

type PEPParentescosRetorno 

type PEPParentescosRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Funcao is retorno.funcao, documented as a string.
	Funcao Text `json:"funcao"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Orgao is retorno.orgao, documented as a string.
	Orgao Text `json:"orgao"`
	// Parentescos is retorno.parentescos, a list.
	Parentescos []PEPParentescosRetornoParentescos `json:"parentescos"`
	// Pep is retorno.pep, documented as a boolean.
	Pep Flag `json:"pep"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

PEPParentescosRetorno is retorno in the answer of PEPParentescos.

type PEPParentescosRetornoParentescos 

type PEPParentescosRetornoParentescos struct {
	// Cpf is retorno.parentescos[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.parentescos[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.parentescos[].dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Genero is retorno.parentescos[].genero, documented as a string.
	Genero Text `json:"genero"`
	// GrauParentesco is retorno.parentescos[].grauParentesco, documented as a string.
	GrauParentesco Text `json:"grauParentesco"`
	// Nome is retorno.parentescos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.parentescos[].obito, documented as a boolean.
	Obito Flag `json:"obito"`
}

PEPParentescosRetornoParentescos is retorno.parentescos[] in the answer of PEPParentescos.

type PETITrabalhoInfantilParams 

type PETITrabalhoInfantilParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NIS is sent as NIS. O parâmetro NIS pode ser enviado com ou sem formatação.
	NIS string
}

PETITrabalhoInfantilParams are the parameters of PETITrabalhoInfantil (PETI - Programa de Erradicação do Trabalho Infantil).

func (PETITrabalhoInfantilParams) Request 

func (p PETITrabalhoInfantilParams) Request() (Request, error)

Request builds the Request for PETITrabalhoInfantil.

type PETITrabalhoInfantilRetorno 

type PETITrabalhoInfantilRetorno struct {
	// Beneficios is retorno.beneficios, a list.
	Beneficios []PETITrabalhoInfantilRetornoBeneficios `json:"beneficios"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

PETITrabalhoInfantilRetorno is retorno in the answer of PETITrabalhoInfantil.

type PETITrabalhoInfantilRetornoBeneficios 

type PETITrabalhoInfantilRetornoBeneficios struct {
	// Data is retorno.beneficios[].data, documented as a string.
	Data Text `json:"data"`
	// Municipio is retorno.beneficios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroRegistro is retorno.beneficios[].numeroRegistro, documented as a number.
	NumeroRegistro Number `json:"numeroRegistro"`
	// Situacao is retorno.beneficios[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Uf is retorno.beneficios[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.beneficios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

PETITrabalhoInfantilRetornoBeneficios is retorno.beneficios[] in the answer of PETITrabalhoInfantil.

type PGFNListaDevedoresUniaoParams 

type PGFNListaDevedoresUniaoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

PGFNListaDevedoresUniaoParams are the parameters of PGFNListaDevedoresUniao (PGFN - Lista de Devedores da União).

func (PGFNListaDevedoresUniaoParams) Request 

func (p PGFNListaDevedoresUniaoParams) Request() (Request, error)

Request builds the Request for PGFNListaDevedoresUniao.

type PGFNListaDevedoresUniaoRetorno 

type PGFNListaDevedoresUniaoRetorno struct {
	// Cnae is retorno.cnae, documented as a string.
	Cnae Text `json:"cnae"`
	// CnaeDescricao is retorno.cnaeDescricao, documented as a string.
	CnaeDescricao Text `json:"cnaeDescricao"`
	// CodigoMunicipio is retorno.codigoMunicipio, documented as a number.
	CodigoMunicipio Number `json:"codigoMunicipio"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Naturezas is retorno.naturezas, a list.
	Naturezas []PGFNListaDevedoresUniaoRetornoNaturezas `json:"naturezas"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMunicipio is retorno.nomeMunicipio, documented as a string.
	NomeMunicipio Text `json:"nomeMunicipio" pii:"name"`
	// PossuiDivida is retorno.possuiDivida, documented as a boolean.
	PossuiDivida Flag `json:"possuiDivida"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TipoDevedor is retorno.tipoDevedor, documented as a string.
	TipoDevedor Text `json:"tipoDevedor"`
	// TipoPessoa is retorno.tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
	// TotalDivida is retorno.totalDivida, documented as a number.
	TotalDivida Number `json:"totalDivida"`
	// TotalPrevidenciario is retorno.totalPrevidenciario, documented as a number.
	TotalPrevidenciario Number `json:"totalPrevidenciario"`
	// TotalTributario is retorno.totalTributario, documented as a number.
	TotalTributario Number `json:"totalTributario"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// UnidadeResponsavel is retorno.unidadeResponsavel, documented as a string.
	UnidadeResponsavel Text `json:"unidadeResponsavel"`
}

PGFNListaDevedoresUniaoRetorno is retorno in the answer of PGFNListaDevedoresUniao.

type PGFNListaDevedoresUniaoRetornoNaturezas 

type PGFNListaDevedoresUniaoRetornoNaturezas struct {
	// DataInscricao is retorno.naturezas[].dataInscricao, documented as a string.
	DataInscricao Text `json:"dataInscricao"`
	// Debitos is retorno.naturezas[].debitos, a list.
	Debitos []PGFNListaDevedoresUniaoRetornoNaturezasDebitos `json:"debitos"`
	// EntidadeResponsavel is retorno.naturezas[].entidadeResponsavel, documented as a string.
	EntidadeResponsavel Text `json:"entidadeResponsavel"`
	// Natureza is retorno.naturezas[].natureza, documented as a number.
	Natureza Number `json:"natureza"`
	// NumeroInscricao is retorno.naturezas[].numeroInscricao, documented as a string.
	NumeroInscricao Text `json:"numeroInscricao"`
	// ReceitaPrincipal is retorno.naturezas[].receitaPrincipal, documented as a string.
	ReceitaPrincipal Text `json:"receitaPrincipal"`
	// SituacaoInscricao is retorno.naturezas[].situacaoInscricao, documented as a string.
	SituacaoInscricao Text `json:"situacaoInscricao"`
	// Status is retorno.naturezas[].status, documented as a string.
	Status Text `json:"status"`
	// TipoCredito is retorno.naturezas[].tipoCredito, documented as a string.
	TipoCredito Text `json:"tipoCredito"`
	// TipoDivida is retorno.naturezas[].tipoDivida, documented as a string.
	TipoDivida Text `json:"tipoDivida"`
	// Total is retorno.naturezas[].total, documented as a number.
	Total Number `json:"total"`
	// UnidadeInscricao is retorno.naturezas[].unidadeInscricao, documented as a string.
	UnidadeInscricao Text `json:"unidadeInscricao"`
}

PGFNListaDevedoresUniaoRetornoNaturezas is retorno.naturezas[] in the answer of PGFNListaDevedoresUniao.

type PGFNListaDevedoresUniaoRetornoNaturezasDebitos 

type PGFNListaDevedoresUniaoRetornoNaturezasDebitos struct {
	// Valor is retorno.naturezas[].debitos[].valor, documented as a number.
	Valor Number `json:"valor"`
}

PGFNListaDevedoresUniaoRetornoNaturezasDebitos is retorno.naturezas[].debitos[] in the answer of PGFNListaDevedoresUniao.

type PRFInfracoesParams 

type PRFInfracoesParams struct {
	// Placa is sent as Placa. O parâmetro PLACA pode ser enviado com ou sem formatação.
	Placa string
	// Renavam is sent as Renavam. O parâmetro RENAVAM deve ser informado juntamente com seus 11 dígitos numéricos.
	Renavam string
	// TIPO is sent as TIPO. O parâmetro TIPO deve ser escolhido.
	TIPO string
}

PRFInfracoesParams are the parameters of PRFInfracoes (Polícia Rodoviária Federal - Infrações).

func (PRFInfracoesParams) Request 

func (p PRFInfracoesParams) Request() (Request, error)

Request builds the Request for PRFInfracoes.

type PRFInfracoesRetorno 

type PRFInfracoesRetorno struct {
	// Infracoes is retorno.infracoes, a list.
	Infracoes []PRFInfracoesRetornoInfracoes `json:"infracoes"`
	// LicenciadoExterior is retorno.licenciadoExterior, documented as a boolean.
	LicenciadoExterior Flag `json:"licenciadoExterior"`
	// NomeDestinatario is retorno.nomeDestinatario, documented as a string.
	NomeDestinatario Text `json:"nomeDestinatario" pii:"name"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Placa is retorno.placa, documented as a string.
	Placa Text `json:"placa" pii:"vehicle"`
	// PossuiInfracao is retorno.possuiInfracao, documented as a boolean.
	PossuiInfracao Flag `json:"possuiInfracao"`
	// Renavam is retorno.renavam, documented as a string.
	Renavam Text `json:"renavam" pii:"vehicle"`
	// TipoConsultado is retorno.tipoConsultado, documented as a string.
	TipoConsultado Text `json:"tipoConsultado"`
	// UfPlaca is retorno.ufPlaca, documented as a string.
	UfPlaca Text `json:"ufPlaca"`
}

PRFInfracoesRetorno is retorno in the answer of PRFInfracoes.

type PRFInfracoesRetornoInfracoes 

type PRFInfracoesRetornoInfracoes struct {
	// AmparoLegal is retorno.infracoes[].amparoLegal, documented as a string.
	AmparoLegal Text `json:"amparoLegal"`
	// AutoInfracao is retorno.infracoes[].autoInfracao, documented as a string.
	AutoInfracao Text `json:"autoInfracao"`
	// CodigoInfracao is retorno.infracoes[].codigoInfracao, documented as a string.
	CodigoInfracao Text `json:"codigoInfracao"`
	// CodigoMulta is retorno.infracoes[].codigoMulta, documented as a string.
	CodigoMulta Text `json:"codigoMulta"`
	// DataInfracao is retorno.infracoes[].dataInfracao, documented as a string.
	DataInfracao Text `json:"dataInfracao"`
	// DataLimiteDefesaAutuacao is retorno.infracoes[].dataLimiteDefesaAutuacao, documented as a string.
	DataLimiteDefesaAutuacao Text `json:"dataLimiteDefesaAutuacao"`
	// DataLimiteRecursoVencimentoPenalidade is retorno.infracoes[].dataLimiteRecursoVencimentoPenalidade, documented as a string.
	DataLimiteRecursoVencimentoPenalidade Text `json:"dataLimiteRecursoVencimentoPenalidade"`
	// DescricaoInfracao is retorno.infracoes[].descricaoInfracao, documented as a string.
	DescricaoInfracao Text `json:"descricaoInfracao"`
	// DividaQuitada is retorno.infracoes[].dividaQuitada, documented as a string.
	DividaQuitada Text `json:"dividaQuitada"`
	// Enquadramento is retorno.infracoes[].enquadramento, documented as a string.
	Enquadramento Text `json:"enquadramento"`
	// Exigivel is retorno.infracoes[].exigivel, documented as a boolean.
	Exigivel Flag `json:"exigivel"`
	// FaseAutuacao is retorno.infracoes[].faseAutuacao, documented as a string.
	FaseAutuacao Text `json:"faseAutuacao"`
	// GuiaRecolhimento is retorno.infracoes[].guiaRecolhimento, a list.
	GuiaRecolhimento []PRFInfracoesRetornoInfracoesGuiaRecolhimento `json:"guiaRecolhimento"`
	// LocalInfracao is retorno.infracoes[].localInfracao, documented as a string.
	LocalInfracao Text `json:"localInfracao"`
	// Pontos is retorno.infracoes[].pontos, documented as a string.
	Pontos Text `json:"pontos"`
	// StatusInfracao is retorno.infracoes[].statusInfracao, documented as a string.
	StatusInfracao Text `json:"statusInfracao"`
	// TaxaJuros is retorno.infracoes[].taxaJuros, documented as a string.
	TaxaJuros Text `json:"taxaJuros"`
	// ValorDevido is retorno.infracoes[].valorDevido, documented as a string.
	ValorDevido Text `json:"valorDevido"`
	// ValorDoJuros is retorno.infracoes[].valorDoJuros, documented as a string.
	ValorDoJuros Text `json:"valorDoJuros"`
	// ValorFinal is retorno.infracoes[].valorFinal, documented as a string.
	ValorFinal Text `json:"valorFinal"`
	// ValorMulta is retorno.infracoes[].valorMulta, documented as a string.
	ValorMulta Text `json:"valorMulta"`
}

PRFInfracoesRetornoInfracoes is retorno.infracoes[] in the answer of PRFInfracoes.

type PRFInfracoesRetornoInfracoesGuiaRecolhimento 

type PRFInfracoesRetornoInfracoesGuiaRecolhimento struct {
	// CodigoPagamento is retorno.infracoes[].guiaRecolhimento[].codigoPagamento, documented as a string.
	CodigoPagamento Text `json:"codigoPagamento"`
	// DataPagamento is retorno.infracoes[].guiaRecolhimento[].dataPagamento, documented as a string.
	DataPagamento Text `json:"dataPagamento"`
	// Numero is retorno.infracoes[].guiaRecolhimento[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// OrigemPagamento is retorno.infracoes[].guiaRecolhimento[].origemPagamento, documented as a string.
	OrigemPagamento Text `json:"origemPagamento"`
	// Situacao is retorno.infracoes[].guiaRecolhimento[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// ValorPago is retorno.infracoes[].guiaRecolhimento[].valorPago, documented as a string.
	ValorPago Text `json:"valorPago"`
}

PRFInfracoesRetornoInfracoesGuiaRecolhimento is retorno.infracoes[].guiaRecolhimento[] in the answer of PRFInfracoes.

type Param 

type Param struct {
	// Name is the parameter as the request spells it.
	Name string
	// Description is the documentation's description.
	Description string
	// Role is what the parameter carries.
	Role ParamRole
}

Param is one query parameter of a product.

type ParamRole 

type ParamRole string

ParamRole is what a parameter carries, which decides how the client fills and checks it. 

const (
	// RoleCPF carries a CPF. The client fills it from Request.Document after
	// checking the check digits.
	RoleCPF ParamRole = "cpf"
	// RoleCNPJ carries a CNPJ, numeric or alphanumeric. The client fills it
	// from Request.Document after checking the check digits.
	RoleCNPJ ParamRole = "cnpj"
	// RoleDocument carries a CPF or a CNPJ in one parameter.
	RoleDocument ParamRole = "cpf_or_cnpj"
	// RoleReceipt asks for the PDF receipt (GERARCOMPROVANTE). The
	// documentation names its schema but not its values, so the client sends
	// only what Request.Params gives it.
	RoleReceipt ParamRole = "receipt"
	// RoleInput is any other input, sent as Request.Params gives it.
	RoleInput ParamRole = "input"
)

The parameter roles.

type PessoaExpostaPoliticamenteParams 

type PessoaExpostaPoliticamenteParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

PessoaExpostaPoliticamenteParams are the parameters of PessoaExpostaPoliticamente (PEP - Pessoa Exposta Politicamente).

func (PessoaExpostaPoliticamenteParams) Request 

func (p PessoaExpostaPoliticamenteParams) Request() (Request, error)

Request builds the Request for PessoaExpostaPoliticamente.

type PessoaExpostaPoliticamenteRetorno 

type PessoaExpostaPoliticamenteRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Funcao is retorno.funcao, documented as a string.
	Funcao Text `json:"funcao"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Orgao is retorno.orgao, documented as a string.
	Orgao Text `json:"orgao"`
	// ParentescosPEP is retorno.parentescosPEP, a list.
	ParentescosPEP []PessoaExpostaPoliticamenteRetornoParentescosPEP `json:"parentescosPEP"`
	// Pep is retorno.pep, documented as a boolean.
	Pep Flag `json:"pep"`
	// RelacionadoComPEP is retorno.relacionadoComPEP, documented as a boolean.
	RelacionadoComPEP Flag `json:"relacionadoComPEP"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

PessoaExpostaPoliticamenteRetorno is retorno in the answer of PessoaExpostaPoliticamente.

type PessoaExpostaPoliticamenteRetornoParentescosPEP 

type PessoaExpostaPoliticamenteRetornoParentescosPEP struct {
	// CodigoGrauParentesco is retorno.parentescosPEP[].codigoGrauParentesco, documented as a number.
	CodigoGrauParentesco Number `json:"codigoGrauParentesco"`
	// Cpf is retorno.parentescosPEP[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataNascimento is retorno.parentescosPEP[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataObito is retorno.parentescosPEP[].dataObito, documented as a string.
	DataObito Text `json:"dataObito"`
	// Genero is retorno.parentescosPEP[].genero, documented as a string.
	Genero Text `json:"genero"`
	// GrauParentesco is retorno.parentescosPEP[].grauParentesco, documented as a string.
	GrauParentesco Text `json:"grauParentesco"`
	// Nome is retorno.parentescosPEP[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Obito is retorno.parentescosPEP[].obito, documented as a boolean.
	Obito Flag `json:"obito"`
}

PessoaExpostaPoliticamenteRetornoParentescosPEP is retorno.parentescosPEP[] in the answer of PessoaExpostaPoliticamente.

type PoliciaCivilAntecedentesCriminaisParams 

type PoliciaCivilAntecedentesCriminaisParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Rg is sent as Rg. O parâmetro RG pode ser enviado com ou sem formatação.
	Rg string
	// NomeMae is sent as NomeMae. O parâmetro NOMEMAE pode ser enviado com qualquer outro.
	NomeMae string
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.
	DataNascimento string
	// GENERO is sent as GENERO. Not described by the documentation.
	GENERO string
	// Uf is sent as Uf. Not described by the documentation.
	Uf string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

PoliciaCivilAntecedentesCriminaisParams are the parameters of PoliciaCivilAntecedentesCriminais (Polícia Civil - Antecedentes Criminais).

func (PoliciaCivilAntecedentesCriminaisParams) Request 

func (p PoliciaCivilAntecedentesCriminaisParams) Request() (Request, error)

Request builds the Request for PoliciaCivilAntecedentesCriminais.

type PoliciaCivilAntecedentesCriminaisRetorno 

type PoliciaCivilAntecedentesCriminaisRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Genero is retorno.genero, documented as a string.
	Genero Text `json:"genero"`
	// Idade is retorno.idade, documented as a number.
	Idade Number `json:"idade"`
	// Nacionalidade is retorno.nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Naturalidade is retorno.naturalidade, documented as a string.
	Naturalidade Text `json:"naturalidade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// NomePai is retorno.nomePai, documented as a string.
	NomePai Text `json:"nomePai" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// PossuiAntecedentesCriminais is retorno.possuiAntecedentesCriminais, documented as a boolean.
	PossuiAntecedentesCriminais Flag `json:"possuiAntecedentesCriminais"`
	// Rg is retorno.rg, documented as a string.
	Rg Text `json:"rg" pii:"document"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

PoliciaCivilAntecedentesCriminaisRetorno is retorno in the answer of PoliciaCivilAntecedentesCriminais.

type PoliciaFederalAntecedentesCriminaisParams 

type PoliciaFederalAntecedentesCriminaisParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Nome is sent as Nome. O parâmetro NOME deve ser enviado de forma completa.
	Nome string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.
	DataNascimento string
	// NomeMae is sent as NomeMae. O parâmetro NOMEMAE deve ser enviado de forma completa.
	NomeMae string
	// NomePai is sent as NomePai. O parâmetro NOMEPAI deve ser enviado de forma completa.
	NomePai string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

PoliciaFederalAntecedentesCriminaisParams are the parameters of PoliciaFederalAntecedentesCriminais (Polícia Federal - Antecedentes Criminais).

func (PoliciaFederalAntecedentesCriminaisParams) Request 

func (p PoliciaFederalAntecedentesCriminaisParams) Request() (Request, error)

Request builds the Request for PoliciaFederalAntecedentesCriminais.

type PoliciaFederalAntecedentesCriminaisRetorno 

type PoliciaFederalAntecedentesCriminaisRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeMae is retorno.nomeMae, documented as a string.
	NomeMae Text `json:"nomeMae" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// PossuiAntecedentesCriminais is retorno.possuiAntecedentesCriminais, documented as a boolean.
	PossuiAntecedentesCriminais Flag `json:"possuiAntecedentesCriminais"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

PoliciaFederalAntecedentesCriminaisRetorno is retorno in the answer of PoliciaFederalAntecedentesCriminais.

type PortalTransparenciaIndicadoresPessoaFisicaParams 

type PortalTransparenciaIndicadoresPessoaFisicaParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NIS is sent as NIS. O parâmetro NIS pode ser enviado com ou sem formatação.
	NIS string
}

PortalTransparenciaIndicadoresPessoaFisicaParams are the parameters of PortalTransparenciaIndicadoresPessoaFisica (Portal da Transparência - Indicadores Pessoa Física).

func (PortalTransparenciaIndicadoresPessoaFisicaParams) Request 

func (p PortalTransparenciaIndicadoresPessoaFisicaParams) Request() (Request, error)

Request builds the Request for PortalTransparenciaIndicadoresPessoaFisica.

type PortalTransparenciaIndicadoresPessoaFisicaRetorno 

type PortalTransparenciaIndicadoresPessoaFisicaRetorno struct {
	// AuxilioEmergencial is retorno.auxilioEmergencial, documented as a boolean.
	AuxilioEmergencial Flag `json:"auxilioEmergencial"`
	// BeneficiarioDiarias is retorno.beneficiarioDiarias, documented as a boolean.
	BeneficiarioDiarias Flag `json:"beneficiarioDiarias"`
	// Contratado is retorno.contratado, documented as a boolean.
	Contratado Flag `json:"contratado"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// FavorecidoAuxilioBrasil is retorno.favorecidoAuxilioBrasil, documented as a boolean.
	FavorecidoAuxilioBrasil Flag `json:"favorecidoAuxilioBrasil"`
	// FavorecidoAuxilioReconstrucao is retorno.favorecidoAuxilioReconstrucao, documented as a boolean.
	FavorecidoAuxilioReconstrucao Flag `json:"favorecidoAuxilioReconstrucao"`
	// FavorecidoBPC is retorno.favorecidoBPC, documented as a boolean.
	FavorecidoBPC Flag `json:"favorecidoBPC"`
	// FavorecidoBolsaFamilia is retorno.favorecidoBolsaFamilia, documented as a boolean.
	FavorecidoBolsaFamilia Flag `json:"favorecidoBolsaFamilia"`
	// FavorecidoCPCC is retorno.favorecidoCPCC, documented as a boolean.
	FavorecidoCPCC Flag `json:"favorecidoCPCC"`
	// FavorecidoCPDC is retorno.favorecidoCPDC, documented as a boolean.
	FavorecidoCPDC Flag `json:"favorecidoCPDC"`
	// FavorecidoCPGF is retorno.favorecidoCPGF, documented as a boolean.
	FavorecidoCPGF Flag `json:"favorecidoCPGF"`
	// FavorecidoDespesas is retorno.favorecidoDespesas, documented as a boolean.
	FavorecidoDespesas Flag `json:"favorecidoDespesas"`
	// FavorecidoNovoBolsaFamilia is retorno.favorecidoNovoBolsaFamilia, documented as a boolean.
	FavorecidoNovoBolsaFamilia Flag `json:"favorecidoNovoBolsaFamilia"`
	// FavorecidoPeti is retorno.favorecidoPeti, documented as a boolean.
	FavorecidoPeti Flag `json:"favorecidoPeti"`
	// FavorecidoSafra is retorno.favorecidoSafra, documented as a boolean.
	FavorecidoSafra Flag `json:"favorecidoSafra"`
	// FavorecidoSeguroDefeso is retorno.favorecidoSeguroDefeso, documented as a boolean.
	FavorecidoSeguroDefeso Flag `json:"favorecidoSeguroDefeso"`
	// FavorecidoTransferencias is retorno.favorecidoTransferencias, documented as a boolean.
	FavorecidoTransferencias Flag `json:"favorecidoTransferencias"`
	// InstituidorPensao is retorno.instituidorPensao, documented as a boolean.
	InstituidorPensao Flag `json:"instituidorPensao"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// ParticipanteLicitacao is retorno.participanteLicitacao, documented as a boolean.
	ParticipanteLicitacao Flag `json:"participanteLicitacao"`
	// PensionistaOuRepresentanteLegal is retorno.pensionistaOuRepresentanteLegal, documented as a boolean.
	PensionistaOuRepresentanteLegal Flag `json:"pensionistaOuRepresentanteLegal"`
	// Permissionario is retorno.permissionario, documented as a boolean.
	Permissionario Flag `json:"permissionario"`
	// PortadorCPDC is retorno.portadorCPDC, documented as a boolean.
	PortadorCPDC Flag `json:"portadorCPDC"`
	// PortadorCPGF is retorno.portadorCPGF, documented as a boolean.
	PortadorCPGF Flag `json:"portadorCPGF"`
	// SancionadoCEAF is retorno.sancionadoCEAF, documented as a boolean.
	SancionadoCEAF Flag `json:"sancionadoCEAF"`
	// SancionadoCEIS is retorno.sancionadoCEIS, documented as a boolean.
	SancionadoCEIS Flag `json:"sancionadoCEIS"`
	// SancionadoCNEP is retorno.sancionadoCNEP, documented as a boolean.
	SancionadoCNEP Flag `json:"sancionadoCNEP"`
	// Servidor is retorno.servidor, documented as a boolean.
	Servidor Flag `json:"servidor"`
	// ServidorInativo is retorno.servidorInativo, documented as a boolean.
	ServidorInativo Flag `json:"servidorInativo"`
}

PortalTransparenciaIndicadoresPessoaFisicaRetorno is retorno in the answer of PortalTransparenciaIndicadoresPessoaFisica.

type PortalTransparenciaIndicadoresPessoaJuridicaParams 

type PortalTransparenciaIndicadoresPessoaJuridicaParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

PortalTransparenciaIndicadoresPessoaJuridicaParams are the parameters of PortalTransparenciaIndicadoresPessoaJuridica (Portal da Transparência - Indicadores Pessoa Jurídica).

func (PortalTransparenciaIndicadoresPessoaJuridicaParams) Request 

func (p PortalTransparenciaIndicadoresPessoaJuridicaParams) Request() (Request, error)

Request builds the Request for PortalTransparenciaIndicadoresPessoaJuridica.

type PortalTransparenciaIndicadoresPessoaJuridicaRetorno 

type PortalTransparenciaIndicadoresPessoaJuridicaRetorno struct {
	// BeneficiadoRenunciaFiscal is retorno.beneficiadoRenunciaFiscal, documented as a boolean.
	BeneficiadoRenunciaFiscal Flag `json:"beneficiadoRenunciaFiscal"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Convenios is retorno.convenios, documented as a boolean.
	Convenios Flag `json:"convenios"`
	// EmitiuNFe is retorno.emitiuNFe, documented as a boolean.
	EmitiuNFe Flag `json:"emitiuNFe"`
	// FavorecidoDespesas is retorno.favorecidoDespesas, documented as a boolean.
	FavorecidoDespesas Flag `json:"favorecidoDespesas"`
	// FavorecidoTransferencias is retorno.favorecidoTransferencias, documented as a boolean.
	FavorecidoTransferencias Flag `json:"favorecidoTransferencias"`
	// HabilitadoRenunciaFiscal is retorno.habilitadoRenunciaFiscal, documented as a boolean.
	HabilitadoRenunciaFiscal Flag `json:"habilitadoRenunciaFiscal"`
	// IsentoImuneRenunciaFiscal is retorno.isentoImuneRenunciaFiscal, documented as a boolean.
	IsentoImuneRenunciaFiscal Flag `json:"isentoImuneRenunciaFiscal"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// ParticipanteLicitacao is retorno.participanteLicitacao, documented as a boolean.
	ParticipanteLicitacao Flag `json:"participanteLicitacao"`
	// PossuiContratacao is retorno.possuiContratacao, documented as a boolean.
	PossuiContratacao Flag `json:"possuiContratacao"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// SancionadoCEAF is retorno.sancionadoCEAF, documented as a boolean.
	SancionadoCEAF Flag `json:"sancionadoCEAF"`
	// SancionadoCEIS is retorno.sancionadoCEIS, documented as a boolean.
	SancionadoCEIS Flag `json:"sancionadoCEIS"`
	// SancionadoCEPIM is retorno.sancionadoCEPIM, documented as a boolean.
	SancionadoCEPIM Flag `json:"sancionadoCEPIM"`
	// SancionadoCNEP is retorno.sancionadoCNEP, documented as a boolean.
	SancionadoCNEP Flag `json:"sancionadoCNEP"`
}

PortalTransparenciaIndicadoresPessoaJuridicaRetorno is retorno in the answer of PortalTransparenciaIndicadoresPessoaJuridica.

type PortalTransparenciaServidoresCompletaParams 

type PortalTransparenciaServidoresCompletaParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

PortalTransparenciaServidoresCompletaParams are the parameters of PortalTransparenciaServidoresCompleta (Portal da Transparência - Servidores - Completa).

func (PortalTransparenciaServidoresCompletaParams) Request 

func (p PortalTransparenciaServidoresCompletaParams) Request() (Request, error)

Request builds the Request for PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetorno 

type PortalTransparenciaServidoresCompletaRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// HistoricoVinculos is retorno.historicoVinculos, a list.
	HistoricoVinculos []PortalTransparenciaServidoresCompletaRetornoHistoricoVinculos `json:"historicoVinculos"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiRegistros is retorno.possuiRegistros, documented as a boolean.
	PossuiRegistros Flag `json:"possuiRegistros"`
	// Remuneracoes is retorno.remuneracoes, a list.
	Remuneracoes []PortalTransparenciaServidoresCompletaRetornoRemuneracoes `json:"remuneracoes"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// VinculosVigentes is retorno.vinculosVigentes, a list.
	VinculosVigentes []PortalTransparenciaServidoresCompletaRetornoVinculosVigentes `json:"vinculosVigentes"`
}

PortalTransparenciaServidoresCompletaRetorno is retorno in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetornoHistoricoVinculos 

type PortalTransparenciaServidoresCompletaRetornoHistoricoVinculos struct {
	// Cargo is retorno.historicoVinculos[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataInicio is retorno.historicoVinculos[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// DataTermino is retorno.historicoVinculos[].dataTermino, documented as a string.
	DataTermino Text `json:"dataTermino"`
	// LocalExercicio is retorno.historicoVinculos[].localExercicio, documented as a string.
	LocalExercicio Text `json:"localExercicio"`
	// OrgaoLotacao is retorno.historicoVinculos[].orgaoLotacao, documented as a string.
	OrgaoLotacao Text `json:"orgaoLotacao"`
	// TipoVinculo is retorno.historicoVinculos[].tipoVinculo, documented as a string.
	TipoVinculo Text `json:"tipoVinculo"`
}

PortalTransparenciaServidoresCompletaRetornoHistoricoVinculos is retorno.historicoVinculos[] in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetornoRemuneracoes 

type PortalTransparenciaServidoresCompletaRetornoRemuneracoes struct {
	// AbateTetoGratificacaoNatalina is retorno.remuneracoes[].abateTetoGratificacaoNatalina, documented as a string.
	AbateTetoGratificacaoNatalina Text `json:"abateTetoGratificacaoNatalina"`
	// AbateTetoRemuneracaoBasica is retorno.remuneracoes[].abateTetoRemuneracaoBasica, documented as a string.
	AbateTetoRemuneracaoBasica Text `json:"abateTetoRemuneracaoBasica"`
	// Ferias is retorno.remuneracoes[].ferias, documented as a string.
	Ferias Text `json:"ferias"`
	// FundoSaude is retorno.remuneracoes[].fundoSaude, documented as a string.
	FundoSaude Text `json:"fundoSaude"`
	// GratificacaoNatalina is retorno.remuneracoes[].gratificacaoNatalina, documented as a string.
	GratificacaoNatalina Text `json:"gratificacaoNatalina"`
	// HonorariosAdvocaticios is retorno.remuneracoes[].honorariosAdvocaticios, a list.
	HonorariosAdvocaticios []PortalTransparenciaServidoresCompletaRetornoRemuneracoesHonorariosAdvocaticios `json:"honorariosAdvocaticios"`
	// ImpostoRetidoNaFonte is retorno.remuneracoes[].impostoRetidoNaFonte, documented as a string.
	ImpostoRetidoNaFonte Text `json:"impostoRetidoNaFonte"`
	// MesAno is retorno.remuneracoes[].mesAno, documented as a string.
	MesAno Text `json:"mesAno"`
	// Observacoes is retorno.remuneracoes[].observacoes, a list.
	Observacoes []Text `json:"observacoes"`
	// OutrasDeducoesObrigatorias is retorno.remuneracoes[].outrasDeducoesObrigatorias, documented as a string.
	OutrasDeducoesObrigatorias Text `json:"outrasDeducoesObrigatorias"`
	// OutrasRemuneracoesEventuais is retorno.remuneracoes[].outrasRemuneracoesEventuais, documented as a string.
	OutrasRemuneracoesEventuais Text `json:"outrasRemuneracoesEventuais"`
	// PensaoMilitar is retorno.remuneracoes[].pensaoMilitar, documented as a string.
	PensaoMilitar Text `json:"pensaoMilitar"`
	// PrevidenciaOficial is retorno.remuneracoes[].previdenciaOficial, documented as a string.
	PrevidenciaOficial Text `json:"previdenciaOficial"`
	// RemuneracaoBasicaBruta is retorno.remuneracoes[].remuneracaoBasicaBruta, documented as a string.
	RemuneracaoBasicaBruta Text `json:"remuneracaoBasicaBruta"`
	// TaxaOcupacaoImovelFuncional is retorno.remuneracoes[].taxaOcupacaoImovelFuncional, documented as a string.
	TaxaOcupacaoImovelFuncional Text `json:"taxaOcupacaoImovelFuncional"`
	// TipoFicha is retorno.remuneracoes[].tipoFicha, documented as a string.
	TipoFicha Text `json:"tipoFicha"`
	// TotalAposDeducoes is retorno.remuneracoes[].totalAposDeducoes, documented as a string.
	TotalAposDeducoes Text `json:"totalAposDeducoes"`
	// TotalHonorariosAdvocaticios is retorno.remuneracoes[].totalHonorariosAdvocaticios, documented as a string.
	TotalHonorariosAdvocaticios Text `json:"totalHonorariosAdvocaticios"`
	// TotalVerbasIndenizatorias is retorno.remuneracoes[].totalVerbasIndenizatorias, documented as a string.
	TotalVerbasIndenizatorias Text `json:"totalVerbasIndenizatorias"`
	// VerbasIndenizatorias is retorno.remuneracoes[].verbasIndenizatorias, a list.
	VerbasIndenizatorias []PortalTransparenciaServidoresCompletaRetornoRemuneracoesVerbasIndenizatorias `json:"verbasIndenizatorias"`
}

PortalTransparenciaServidoresCompletaRetornoRemuneracoes is retorno.remuneracoes[] in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetornoRemuneracoesHonorariosAdvocaticios 

type PortalTransparenciaServidoresCompletaRetornoRemuneracoesHonorariosAdvocaticios struct {
	// Descricao is retorno.remuneracoes[].honorariosAdvocaticios[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Valor is retorno.remuneracoes[].honorariosAdvocaticios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

PortalTransparenciaServidoresCompletaRetornoRemuneracoesHonorariosAdvocaticios is retorno.remuneracoes[].honorariosAdvocaticios[] in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetornoRemuneracoesVerbasIndenizatorias 

type PortalTransparenciaServidoresCompletaRetornoRemuneracoesVerbasIndenizatorias struct {
	// Descricao is retorno.remuneracoes[].verbasIndenizatorias[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Valor is retorno.remuneracoes[].verbasIndenizatorias[].valor, documented as a string.
	Valor Text `json:"valor"`
}

PortalTransparenciaServidoresCompletaRetornoRemuneracoesVerbasIndenizatorias is retorno.remuneracoes[].verbasIndenizatorias[] in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetornoVinculosVigentes 

type PortalTransparenciaServidoresCompletaRetornoVinculosVigentes struct {
	// Afastado is retorno.vinculosVigentes[].afastado, documented as a boolean.
	Afastado Flag `json:"afastado"`
	// AtoNomeacaoContratacao is retorno.vinculosVigentes[].atoNomeacaoContratacao, documented as a string.
	AtoNomeacaoContratacao Text `json:"atoNomeacaoContratacao"`
	// Cargo is retorno.vinculosVigentes[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// ClasseCargo is retorno.vinculosVigentes[].classeCargo, documented as a string.
	ClasseCargo Text `json:"classeCargo"`
	// CpfInstituidor is retorno.vinculosVigentes[].cpfInstituidor, documented as a string.
	CpfInstituidor Text `json:"cpfInstituidor" pii:"document"`
	// CpfRepresentanteLegal is retorno.vinculosVigentes[].cpfRepresentanteLegal, documented as a string.
	CpfRepresentanteLegal Text `json:"cpfRepresentanteLegal" pii:"document"`
	// DataIngressoCargo is retorno.vinculosVigentes[].dataIngressoCargo, documented as a string.
	DataIngressoCargo Text `json:"dataIngressoCargo"`
	// DataIngressoOrgaoLotacao is retorno.vinculosVigentes[].dataIngressoOrgaoLotacao, documented as a string.
	DataIngressoOrgaoLotacao Text `json:"dataIngressoOrgaoLotacao"`
	// DataIngressoServicoPublico is retorno.vinculosVigentes[].dataIngressoServicoPublico, documented as a string.
	DataIngressoServicoPublico Text `json:"dataIngressoServicoPublico"`
	// DataInicioPensao is retorno.vinculosVigentes[].dataInicioPensao, documented as a string.
	DataInicioPensao Text `json:"dataInicioPensao"`
	// DataPublicacaoDocumentoIngresso is retorno.vinculosVigentes[].dataPublicacaoDocumentoIngresso, documented as a string.
	DataPublicacaoDocumentoIngresso Text `json:"dataPublicacaoDocumentoIngresso"`
	// DataReformaReserva is retorno.vinculosVigentes[].dataReformaReserva, documented as a string.
	DataReformaReserva Text `json:"dataReformaReserva"`
	// Exercicio is retorno.vinculosVigentes[].exercicio.
	Exercicio PortalTransparenciaServidoresCompletaRetornoVinculosVigentesExercicio `json:"exercicio"`
	// FormaIngresso is retorno.vinculosVigentes[].formaIngresso, documented as a string.
	FormaIngresso Text `json:"formaIngresso"`
	// Funcao is retorno.vinculosVigentes[].funcao, documented as a string.
	Funcao Text `json:"funcao"`
	// JornadaTrabalho is retorno.vinculosVigentes[].jornadaTrabalho, documented as a string.
	JornadaTrabalho Text `json:"jornadaTrabalho"`
	// LocalTrabalho is retorno.vinculosVigentes[].localTrabalho, documented as a string.
	LocalTrabalho Text `json:"localTrabalho"`
	// Lotacao is retorno.vinculosVigentes[].lotacao.
	Lotacao PortalTransparenciaServidoresCompletaRetornoVinculosVigentesLotacao `json:"lotacao"`
	// Matricula is retorno.vinculosVigentes[].matricula, documented as a string.
	Matricula Text `json:"matricula"`
	// NivelCargo is retorno.vinculosVigentes[].nivelCargo, documented as a string.
	NivelCargo Text `json:"nivelCargo"`
	// NomeInstituidor is retorno.vinculosVigentes[].nomeInstituidor, documented as a string.
	NomeInstituidor Text `json:"nomeInstituidor" pii:"name"`
	// NomeRepresentanteLegal is retorno.vinculosVigentes[].nomeRepresentanteLegal, documented as a string.
	NomeRepresentanteLegal Text `json:"nomeRepresentanteLegal" pii:"name"`
	// PadraoCargo is retorno.vinculosVigentes[].padraoCargo, documented as a string.
	PadraoCargo Text `json:"padraoCargo"`
	// ProporcaoPensao is retorno.vinculosVigentes[].proporcaoPensao, documented as a string.
	ProporcaoPensao Text `json:"proporcaoPensao"`
	// RegimeJuridico is retorno.vinculosVigentes[].regimeJuridico, documented as a string.
	RegimeJuridico Text `json:"regimeJuridico"`
	// SituacaoVinculo is retorno.vinculosVigentes[].situacaoVinculo, documented as a string.
	SituacaoVinculo Text `json:"situacaoVinculo"`
	// TipoPensao is retorno.vinculosVigentes[].tipoPensao, documented as a string.
	TipoPensao Text `json:"tipoPensao"`
	// TipoReformaReserva is retorno.vinculosVigentes[].tipoReformaReserva, documented as a string.
	TipoReformaReserva Text `json:"tipoReformaReserva"`
	// TipoVinculo is retorno.vinculosVigentes[].tipoVinculo, documented as a string.
	TipoVinculo Text `json:"tipoVinculo"`
}

PortalTransparenciaServidoresCompletaRetornoVinculosVigentes is retorno.vinculosVigentes[] in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetornoVinculosVigentesExercicio 

type PortalTransparenciaServidoresCompletaRetornoVinculosVigentesExercicio struct {
	// Orgao is retorno.vinculosVigentes[].exercicio.orgao, documented as a string.
	Orgao Text `json:"orgao"`
	// OrgaoSuperior is retorno.vinculosVigentes[].exercicio.orgaoSuperior, documented as a string.
	OrgaoSuperior Text `json:"orgaoSuperior"`
	// Uf is retorno.vinculosVigentes[].exercicio.uf, documented as a string.
	Uf Text `json:"uf"`
	// Uorg is retorno.vinculosVigentes[].exercicio.uorg, documented as a string.
	Uorg Text `json:"uorg"`
}

PortalTransparenciaServidoresCompletaRetornoVinculosVigentesExercicio is retorno.vinculosVigentes[].exercicio in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresCompletaRetornoVinculosVigentesLotacao 

type PortalTransparenciaServidoresCompletaRetornoVinculosVigentesLotacao struct {
	// Orgao is retorno.vinculosVigentes[].lotacao.orgao, documented as a string.
	Orgao Text `json:"orgao"`
	// OrgaoSuperior is retorno.vinculosVigentes[].lotacao.orgaoSuperior, documented as a string.
	OrgaoSuperior Text `json:"orgaoSuperior"`
	// Uf is retorno.vinculosVigentes[].lotacao.uf, documented as a string.
	Uf Text `json:"uf"`
	// Uorg is retorno.vinculosVigentes[].lotacao.uorg, documented as a string.
	Uorg Text `json:"uorg"`
}

PortalTransparenciaServidoresCompletaRetornoVinculosVigentesLotacao is retorno.vinculosVigentes[].lotacao in the answer of PortalTransparenciaServidoresCompleta.

type PortalTransparenciaServidoresParams 

type PortalTransparenciaServidoresParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

PortalTransparenciaServidoresParams are the parameters of PortalTransparenciaServidores (Portal da Transparência - Servidores do Poder Executivo Federal).

func (PortalTransparenciaServidoresParams) Request 

func (p PortalTransparenciaServidoresParams) Request() (Request, error)

Request builds the Request for PortalTransparenciaServidores.

type PortalTransparenciaServidoresRemuneracaoParams 

type PortalTransparenciaServidoresRemuneracaoParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// MesAno is sent as MesAno. O parâmetro MESANO (mês de competência da folha) é opcional e pode ser enviado nos formatos MM/yyyy, MM-yyyy ou MMyyyy. Quando informado, a consulta retorna a remuneração da competência solicitada; se omitido, retorna a competência mais recente publicada no Portal da Transparência.
	MesAno string
}

PortalTransparenciaServidoresRemuneracaoParams are the parameters of PortalTransparenciaServidoresRemuneracao (Portal da Transparência - Servidores - Remuneração).

func (PortalTransparenciaServidoresRemuneracaoParams) Request 

func (p PortalTransparenciaServidoresRemuneracaoParams) Request() (Request, error)

Request builds the Request for PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRemuneracaoRetorno 

type PortalTransparenciaServidoresRemuneracaoRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// MesAnoReferencia is retorno.mesAnoReferencia, documented as a string.
	MesAnoReferencia Text `json:"mesAnoReferencia"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiRegistros is retorno.possuiRegistros, documented as a boolean.
	PossuiRegistros Flag `json:"possuiRegistros"`
	// Remuneracoes is retorno.remuneracoes, a list.
	Remuneracoes []PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoes `json:"remuneracoes"`
}

PortalTransparenciaServidoresRemuneracaoRetorno is retorno in the answer of PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoes 

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoes struct {
	// Observacao is retorno.remuneracoes[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Servidor is retorno.remuneracoes[].servidor.
	Servidor PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesServidor `json:"servidor"`
	// Valores is retorno.remuneracoes[].valores, a list.
	Valores []PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValores `json:"valores"`
}

PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoes is retorno.remuneracoes[] in the answer of PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesServidor 

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesServidor struct {
	// Funcao is retorno.remuneracoes[].servidor.funcao, documented as a string.
	Funcao Text `json:"funcao"`
	// Matricula is retorno.remuneracoes[].servidor.matricula, documented as a string.
	Matricula Text `json:"matricula"`
	// OrgaoExercicio is retorno.remuneracoes[].servidor.orgaoExercicio, documented as a string.
	OrgaoExercicio Text `json:"orgaoExercicio"`
	// OrgaoLotacao is retorno.remuneracoes[].servidor.orgaoLotacao, documented as a string.
	OrgaoLotacao Text `json:"orgaoLotacao"`
	// Situacao is retorno.remuneracoes[].servidor.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoServidor is retorno.remuneracoes[].servidor.tipoServidor, documented as a string.
	TipoServidor Text `json:"tipoServidor"`
}

PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesServidor is retorno.remuneracoes[].servidor in the answer of PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValores 

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValores struct {
	// AbateTetoGratificacaoNatalina is retorno.remuneracoes[].valores[].abateTetoGratificacaoNatalina, documented as a string.
	AbateTetoGratificacaoNatalina Text `json:"abateTetoGratificacaoNatalina"`
	// AbateTetoRemuneracaoBasica is retorno.remuneracoes[].valores[].abateTetoRemuneracaoBasica, documented as a string.
	AbateTetoRemuneracaoBasica Text `json:"abateTetoRemuneracaoBasica"`
	// Ferias is retorno.remuneracoes[].valores[].ferias, documented as a string.
	Ferias Text `json:"ferias"`
	// FundoSaude is retorno.remuneracoes[].valores[].fundoSaude, documented as a string.
	FundoSaude Text `json:"fundoSaude"`
	// GratificacaoNatalina is retorno.remuneracoes[].valores[].gratificacaoNatalina, documented as a string.
	GratificacaoNatalina Text `json:"gratificacaoNatalina"`
	// HonorariosAdvocaticios is retorno.remuneracoes[].valores[].honorariosAdvocaticios, a list.
	HonorariosAdvocaticios []PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresHonorariosAdvocaticios `json:"honorariosAdvocaticios"`
	// ImpostoRetidoNaFonte is retorno.remuneracoes[].valores[].impostoRetidoNaFonte, documented as a string.
	ImpostoRetidoNaFonte Text `json:"impostoRetidoNaFonte"`
	// Jetons is retorno.remuneracoes[].valores[].jetons, a list.
	Jetons []PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresJetons `json:"jetons"`
	// MesAno is retorno.remuneracoes[].valores[].mesAno, documented as a string.
	MesAno Text `json:"mesAno"`
	// ObservacoesPortal is retorno.remuneracoes[].valores[].observacoesPortal, a list.
	ObservacoesPortal []Text `json:"observacoesPortal"`
	// OutrasDeducoesObrigatorias is retorno.remuneracoes[].valores[].outrasDeducoesObrigatorias, documented as a string.
	OutrasDeducoesObrigatorias Text `json:"outrasDeducoesObrigatorias"`
	// OutrasRemuneracoesEventuais is retorno.remuneracoes[].valores[].outrasRemuneracoesEventuais, documented as a string.
	OutrasRemuneracoesEventuais Text `json:"outrasRemuneracoesEventuais"`
	// PensaoMilitar is retorno.remuneracoes[].valores[].pensaoMilitar, documented as a string.
	PensaoMilitar Text `json:"pensaoMilitar"`
	// PrevidenciaOficial is retorno.remuneracoes[].valores[].previdenciaOficial, documented as a string.
	PrevidenciaOficial Text `json:"previdenciaOficial"`
	// RemuneracaoAposDeducoesObrigatorias is retorno.remuneracoes[].valores[].remuneracaoAposDeducoesObrigatorias, documented as a string.
	RemuneracaoAposDeducoesObrigatorias Text `json:"remuneracaoAposDeducoesObrigatorias"`
	// RemuneracaoBasicaBruta is retorno.remuneracoes[].valores[].remuneracaoBasicaBruta, documented as a string.
	RemuneracaoBasicaBruta Text `json:"remuneracaoBasicaBruta"`
	// Rubricas is retorno.remuneracoes[].valores[].rubricas, a list.
	Rubricas []PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresRubricas `json:"rubricas"`
	// TaxaOcupacaoImovelFuncional is retorno.remuneracoes[].valores[].taxaOcupacaoImovelFuncional, documented as a string.
	TaxaOcupacaoImovelFuncional Text `json:"taxaOcupacaoImovelFuncional"`
	// TotalVerbasIndenizatorias is retorno.remuneracoes[].valores[].totalVerbasIndenizatorias, documented as a string.
	TotalVerbasIndenizatorias Text `json:"totalVerbasIndenizatorias"`
	// ValorTotalHonorariosAdvocaticios is retorno.remuneracoes[].valores[].valorTotalHonorariosAdvocaticios, documented as a string.
	ValorTotalHonorariosAdvocaticios Text `json:"valorTotalHonorariosAdvocaticios"`
	// ValorTotalJetons is retorno.remuneracoes[].valores[].valorTotalJetons, documented as a string.
	ValorTotalJetons Text `json:"valorTotalJetons"`
	// VerbasIndenizatoriasCivil is retorno.remuneracoes[].valores[].verbasIndenizatoriasCivil, documented as a string.
	VerbasIndenizatoriasCivil Text `json:"verbasIndenizatoriasCivil"`
	// VerbasIndenizatoriasMilitar is retorno.remuneracoes[].valores[].verbasIndenizatoriasMilitar, documented as a string.
	VerbasIndenizatoriasMilitar Text `json:"verbasIndenizatoriasMilitar"`
	// VerbasIndenizatoriasPDV is retorno.remuneracoes[].valores[].verbasIndenizatoriasPDV, documented as a string.
	VerbasIndenizatoriasPDV Text `json:"verbasIndenizatoriasPDV"`
}

PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValores is retorno.remuneracoes[].valores[] in the answer of PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresHonorariosAdvocaticios 

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresHonorariosAdvocaticios struct {
	// MesReferencia is retorno.remuneracoes[].valores[].honorariosAdvocaticios[].mesReferencia, documented as a string.
	MesReferencia Text `json:"mesReferencia"`
	// Valor is retorno.remuneracoes[].valores[].honorariosAdvocaticios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresHonorariosAdvocaticios is retorno.remuneracoes[].valores[].honorariosAdvocaticios[] in the answer of PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresJetons 

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresJetons struct {
	// Descricao is retorno.remuneracoes[].valores[].jetons[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// MesReferencia is retorno.remuneracoes[].valores[].jetons[].mesReferencia, documented as a string.
	MesReferencia Text `json:"mesReferencia"`
	// Valor is retorno.remuneracoes[].valores[].jetons[].valor, documented as a string.
	Valor Text `json:"valor"`
}

PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresJetons is retorno.remuneracoes[].valores[].jetons[] in the answer of PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresRubricas 

type PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresRubricas struct {
	// Codigo is retorno.remuneracoes[].valores[].rubricas[].codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// Descricao is retorno.remuneracoes[].valores[].rubricas[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Valor is retorno.remuneracoes[].valores[].rubricas[].valor, documented as a string.
	Valor Text `json:"valor"`
}

PortalTransparenciaServidoresRemuneracaoRetornoRemuneracoesValoresRubricas is retorno.remuneracoes[].valores[].rubricas[] in the answer of PortalTransparenciaServidoresRemuneracao.

type PortalTransparenciaServidoresRetorno 

type PortalTransparenciaServidoresRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiRegistros is retorno.possuiRegistros, documented as a boolean.
	PossuiRegistros Flag `json:"possuiRegistros"`
	// Vinculos is retorno.vinculos, a list.
	Vinculos []PortalTransparenciaServidoresRetornoVinculos `json:"vinculos"`
}

PortalTransparenciaServidoresRetorno is retorno in the answer of PortalTransparenciaServidores.

type PortalTransparenciaServidoresRetornoVinculos 

type PortalTransparenciaServidoresRetornoVinculos struct {
	// Afastado is retorno.vinculos[].afastado, documented as a boolean.
	Afastado Flag `json:"afastado"`
	// Cargo is retorno.vinculos[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// CpfInstituidorPensao is retorno.vinculos[].cpfInstituidorPensao, documented as a string.
	CpfInstituidorPensao Text `json:"cpfInstituidorPensao" pii:"document"`
	// CpfRepresentanteLegal is retorno.vinculos[].cpfRepresentanteLegal, documented as a string.
	CpfRepresentanteLegal Text `json:"cpfRepresentanteLegal" pii:"document"`
	// Fichas is retorno.vinculos[].fichas, a list.
	Fichas []PortalTransparenciaServidoresRetornoVinculosFichas `json:"fichas"`
	// Funcao is retorno.vinculos[].funcao, documented as a string.
	Funcao Text `json:"funcao"`
	// Matricula is retorno.vinculos[].matricula, documented as a string.
	Matricula Text `json:"matricula"`
	// NomeInstituidorPensao is retorno.vinculos[].nomeInstituidorPensao, documented as a string.
	NomeInstituidorPensao Text `json:"nomeInstituidorPensao" pii:"name"`
	// NomeRepresentanteLegal is retorno.vinculos[].nomeRepresentanteLegal, documented as a string.
	NomeRepresentanteLegal Text `json:"nomeRepresentanteLegal" pii:"name"`
	// OrgaoExercicio is retorno.vinculos[].orgaoExercicio.
	OrgaoExercicio PortalTransparenciaServidoresRetornoVinculosOrgaoExercicio `json:"orgaoExercicio"`
	// OrgaoLotacao is retorno.vinculos[].orgaoLotacao.
	OrgaoLotacao PortalTransparenciaServidoresRetornoVinculosOrgaoLotacao `json:"orgaoLotacao"`
	// Situacao is retorno.vinculos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoServidor is retorno.vinculos[].tipoServidor, documented as a string.
	TipoServidor Text `json:"tipoServidor"`
	// UfExercicio is retorno.vinculos[].ufExercicio, documented as a string.
	UfExercicio Text `json:"ufExercicio"`
}

PortalTransparenciaServidoresRetornoVinculos is retorno.vinculos[] in the answer of PortalTransparenciaServidores.

type PortalTransparenciaServidoresRetornoVinculosFichas 

type PortalTransparenciaServidoresRetornoVinculosFichas struct {
	// Afastamentos is retorno.vinculos[].fichas[].afastamentos, a list.
	Afastamentos []Text `json:"afastamentos"`
	// Atividade is retorno.vinculos[].fichas[].atividade, documented as a string.
	Atividade Text `json:"atividade"`
	// Cargo is retorno.vinculos[].fichas[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// ClasseCargo is retorno.vinculos[].fichas[].classeCargo, documented as a string.
	ClasseCargo Text `json:"classeCargo"`
	// CpfInstituidor is retorno.vinculos[].fichas[].cpfInstituidor, documented as a string.
	CpfInstituidor Text `json:"cpfInstituidor" pii:"document"`
	// CpfRepresentanteLegal is retorno.vinculos[].fichas[].cpfRepresentanteLegal, documented as a string.
	CpfRepresentanteLegal Text `json:"cpfRepresentanteLegal" pii:"document"`
	// DataAposentadoria is retorno.vinculos[].fichas[].dataAposentadoria, documented as a string.
	DataAposentadoria Text `json:"dataAposentadoria"`
	// DataIngressoCargo is retorno.vinculos[].fichas[].dataIngressoCargo, documented as a string.
	DataIngressoCargo Text `json:"dataIngressoCargo"`
	// DataIngressoFuncao is retorno.vinculos[].fichas[].dataIngressoFuncao, documented as a string.
	DataIngressoFuncao Text `json:"dataIngressoFuncao"`
	// DataIngressoOrgao is retorno.vinculos[].fichas[].dataIngressoOrgao, documented as a string.
	DataIngressoOrgao Text `json:"dataIngressoOrgao"`
	// DataIngressoServicoPublico is retorno.vinculos[].fichas[].dataIngressoServicoPublico, documented as a string.
	DataIngressoServicoPublico Text `json:"dataIngressoServicoPublico"`
	// DataInicioPensao is retorno.vinculos[].fichas[].dataInicioPensao, documented as a string.
	DataInicioPensao Text `json:"dataInicioPensao"`
	// DataPublicacaoDocumentoIngresso is retorno.vinculos[].fichas[].dataPublicacaoDocumentoIngresso, documented as a string.
	DataPublicacaoDocumentoIngresso Text `json:"dataPublicacaoDocumentoIngresso"`
	// DataReforma is retorno.vinculos[].fichas[].dataReforma, documented as a string.
	DataReforma Text `json:"dataReforma"`
	// DiplomaLegal is retorno.vinculos[].fichas[].diplomaLegal, documented as a string.
	DiplomaLegal Text `json:"diplomaLegal"`
	// FormaIngresso is retorno.vinculos[].fichas[].formaIngresso, documented as a string.
	FormaIngresso Text `json:"formaIngresso"`
	// Funcao is retorno.vinculos[].fichas[].funcao, documented as a string.
	Funcao Text `json:"funcao"`
	// FundamentacaoAposentadoria is retorno.vinculos[].fichas[].fundamentacaoAposentadoria, documented as a string.
	FundamentacaoAposentadoria Text `json:"fundamentacaoAposentadoria"`
	// FundamentacaoPensao is retorno.vinculos[].fichas[].fundamentacaoPensao, documented as a string.
	FundamentacaoPensao Text `json:"fundamentacaoPensao"`
	// JornadaTrabalho is retorno.vinculos[].fichas[].jornadaTrabalho, documented as a string.
	JornadaTrabalho Text `json:"jornadaTrabalho"`
	// NivelCargo is retorno.vinculos[].fichas[].nivelCargo, documented as a string.
	NivelCargo Text `json:"nivelCargo"`
	// NomeInstituidor is retorno.vinculos[].fichas[].nomeInstituidor, documented as a string.
	NomeInstituidor Text `json:"nomeInstituidor" pii:"name"`
	// OpcaoFuncao is retorno.vinculos[].fichas[].opcaoFuncao, documented as a string.
	OpcaoFuncao Text `json:"opcaoFuncao"`
	// OrgaoExercicio is retorno.vinculos[].fichas[].orgaoExercicio, documented as a string.
	OrgaoExercicio Text `json:"orgaoExercicio"`
	// OrgaoLotacao is retorno.vinculos[].fichas[].orgaoLotacao, documented as a string.
	OrgaoLotacao Text `json:"orgaoLotacao"`
	// OrgaoSuperiorExercicio is retorno.vinculos[].fichas[].orgaoSuperiorExercicio, documented as a string.
	OrgaoSuperiorExercicio Text `json:"orgaoSuperiorExercicio"`
	// OrgaoSuperiorLotacao is retorno.vinculos[].fichas[].orgaoSuperiorLotacao, documented as a string.
	OrgaoSuperiorLotacao Text `json:"orgaoSuperiorLotacao"`
	// PadraoCargo is retorno.vinculos[].fichas[].padraoCargo, documented as a string.
	PadraoCargo Text `json:"padraoCargo"`
	// ProporcaoPensao is retorno.vinculos[].fichas[].proporcaoPensao, documented as a string.
	ProporcaoPensao Text `json:"proporcaoPensao"`
	// RegimeJuridico is retorno.vinculos[].fichas[].regimeJuridico, documented as a string.
	RegimeJuridico Text `json:"regimeJuridico"`
	// RepresentanteLegal is retorno.vinculos[].fichas[].representanteLegal, documented as a string.
	RepresentanteLegal Text `json:"representanteLegal"`
	// SituacaoServidor is retorno.vinculos[].fichas[].situacaoServidor, documented as a string.
	SituacaoServidor Text `json:"situacaoServidor"`
	// TipoAposentadoria is retorno.vinculos[].fichas[].tipoAposentadoria, documented as a string.
	TipoAposentadoria Text `json:"tipoAposentadoria"`
	// TipoFicha is retorno.vinculos[].fichas[].tipoFicha, documented as a string.
	TipoFicha Text `json:"tipoFicha"`
	// TipoPensao is retorno.vinculos[].fichas[].tipoPensao, documented as a string.
	TipoPensao Text `json:"tipoPensao"`
	// UfExercicio is retorno.vinculos[].fichas[].ufExercicio, documented as a string.
	UfExercicio Text `json:"ufExercicio"`
	// UorgExercicio is retorno.vinculos[].fichas[].uorgExercicio, documented as a string.
	UorgExercicio Text `json:"uorgExercicio"`
	// UorgLotacao is retorno.vinculos[].fichas[].uorgLotacao, documented as a string.
	UorgLotacao Text `json:"uorgLotacao"`
}

PortalTransparenciaServidoresRetornoVinculosFichas is retorno.vinculos[].fichas[] in the answer of PortalTransparenciaServidores.

type PortalTransparenciaServidoresRetornoVinculosOrgaoExercicio 

type PortalTransparenciaServidoresRetornoVinculosOrgaoExercicio struct {
	// Codigo is retorno.vinculos[].orgaoExercicio.codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// Nome is retorno.vinculos[].orgaoExercicio.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// OrgaoVinculado is retorno.vinculos[].orgaoExercicio.orgaoVinculado, documented as a string.
	OrgaoVinculado Text `json:"orgaoVinculado"`
	// Sigla is retorno.vinculos[].orgaoExercicio.sigla, documented as a string.
	Sigla Text `json:"sigla"`
}

PortalTransparenciaServidoresRetornoVinculosOrgaoExercicio is retorno.vinculos[].orgaoExercicio in the answer of PortalTransparenciaServidores.

type PortalTransparenciaServidoresRetornoVinculosOrgaoLotacao 

type PortalTransparenciaServidoresRetornoVinculosOrgaoLotacao struct {
	// Codigo is retorno.vinculos[].orgaoLotacao.codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// Nome is retorno.vinculos[].orgaoLotacao.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// OrgaoVinculado is retorno.vinculos[].orgaoLotacao.orgaoVinculado, documented as a string.
	OrgaoVinculado Text `json:"orgaoVinculado"`
	// Sigla is retorno.vinculos[].orgaoLotacao.sigla, documented as a string.
	Sigla Text `json:"sigla"`
}

PortalTransparenciaServidoresRetornoVinculosOrgaoLotacao is retorno.vinculos[].orgaoLotacao in the answer of PortalTransparenciaServidores.

type PortalTransparenciaServidoresViagensParams 

type PortalTransparenciaServidoresViagensParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

PortalTransparenciaServidoresViagensParams are the parameters of PortalTransparenciaServidoresViagens (Portal da Transparência - Servidores Viagens e despesas).

func (PortalTransparenciaServidoresViagensParams) Request 

func (p PortalTransparenciaServidoresViagensParams) Request() (Request, error)

Request builds the Request for PortalTransparenciaServidoresViagens.

type PortalTransparenciaServidoresViagensRetorno 

type PortalTransparenciaServidoresViagensRetorno struct {
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// PossuiRegistros is retorno.possuiRegistros, documented as a boolean.
	PossuiRegistros Flag `json:"possuiRegistros"`
	// QuantidadeViagens is retorno.quantidadeViagens, documented as a number.
	QuantidadeViagens Number `json:"quantidadeViagens"`
	// ValorTotalViagens is retorno.valorTotalViagens, documented as a string.
	ValorTotalViagens Text `json:"valorTotalViagens"`
	// Viagens is retorno.viagens, a list.
	Viagens []PortalTransparenciaServidoresViagensRetornoViagens `json:"viagens"`
}

PortalTransparenciaServidoresViagensRetorno is retorno in the answer of PortalTransparenciaServidoresViagens.

type PortalTransparenciaServidoresViagensRetornoViagens 

type PortalTransparenciaServidoresViagensRetornoViagens struct {
	// Ano is retorno.viagens[].ano, documented as a string.
	Ano Text `json:"ano"`
	// Cargo is retorno.viagens[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataFimAfastamento is retorno.viagens[].dataFimAfastamento, documented as a string.
	DataFimAfastamento Text `json:"dataFimAfastamento"`
	// DataInicioAfastamento is retorno.viagens[].dataInicioAfastamento, documented as a string.
	DataInicioAfastamento Text `json:"dataInicioAfastamento"`
	// Funcao is retorno.viagens[].funcao, documented as a string.
	Funcao Text `json:"funcao"`
	// JustificativaUrgencia is retorno.viagens[].justificativaUrgencia, documented as a string.
	JustificativaUrgencia Text `json:"justificativaUrgencia"`
	// Motivo is retorno.viagens[].motivo, documented as a string.
	Motivo Text `json:"motivo"`
	// NumeroPCDP is retorno.viagens[].numeroPCDP, documented as a string.
	NumeroPCDP Text `json:"numeroPCDP"`
	// Orgao is retorno.viagens[].orgao.
	Orgao PortalTransparenciaServidoresViagensRetornoViagensOrgao `json:"orgao"`
	// OrgaoPagamento is retorno.viagens[].orgaoPagamento.
	OrgaoPagamento PortalTransparenciaServidoresViagensRetornoViagensOrgaoPagamento `json:"orgaoPagamento"`
	// Situacao is retorno.viagens[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoViagem is retorno.viagens[].tipoViagem, documented as a string.
	TipoViagem Text `json:"tipoViagem"`
	// UnidadeGestora is retorno.viagens[].unidadeGestora.
	UnidadeGestora PortalTransparenciaServidoresViagensRetornoViagensUnidadeGestora `json:"unidadeGestora"`
	// ValorDevolucao is retorno.viagens[].valorDevolucao, documented as a string.
	ValorDevolucao Text `json:"valorDevolucao"`
	// ValorDiarias is retorno.viagens[].valorDiarias, documented as a string.
	ValorDiarias Text `json:"valorDiarias"`
	// ValorMulta is retorno.viagens[].valorMulta, documented as a string.
	ValorMulta Text `json:"valorMulta"`
	// ValorPassagens is retorno.viagens[].valorPassagens, documented as a string.
	ValorPassagens Text `json:"valorPassagens"`
	// ValorRestituicao is retorno.viagens[].valorRestituicao, documented as a string.
	ValorRestituicao Text `json:"valorRestituicao"`
	// ValorTaxaAgenciamento is retorno.viagens[].valorTaxaAgenciamento, documented as a string.
	ValorTaxaAgenciamento Text `json:"valorTaxaAgenciamento"`
	// ValorTotalViagem is retorno.viagens[].valorTotalViagem, documented as a string.
	ValorTotalViagem Text `json:"valorTotalViagem"`
	// ViagemUrgente is retorno.viagens[].viagemUrgente, documented as a string.
	ViagemUrgente Text `json:"viagemUrgente"`
}

PortalTransparenciaServidoresViagensRetornoViagens is retorno.viagens[] in the answer of PortalTransparenciaServidoresViagens.

type PortalTransparenciaServidoresViagensRetornoViagensOrgao 

type PortalTransparenciaServidoresViagensRetornoViagensOrgao struct {
	// Cnpj is retorno.viagens[].orgao.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Nome is retorno.viagens[].orgao.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Poder is retorno.viagens[].orgao.poder, documented as a string.
	Poder Text `json:"poder"`
	// Sigla is retorno.viagens[].orgao.sigla, documented as a string.
	Sigla Text `json:"sigla"`
}

PortalTransparenciaServidoresViagensRetornoViagensOrgao is retorno.viagens[].orgao in the answer of PortalTransparenciaServidoresViagens.

type PortalTransparenciaServidoresViagensRetornoViagensOrgaoPagamento 

type PortalTransparenciaServidoresViagensRetornoViagensOrgaoPagamento struct {
	// Cnpj is retorno.viagens[].orgaoPagamento.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Nome is retorno.viagens[].orgaoPagamento.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Poder is retorno.viagens[].orgaoPagamento.poder, documented as a string.
	Poder Text `json:"poder"`
	// Sigla is retorno.viagens[].orgaoPagamento.sigla, documented as a string.
	Sigla Text `json:"sigla"`
}

PortalTransparenciaServidoresViagensRetornoViagensOrgaoPagamento is retorno.viagens[].orgaoPagamento in the answer of PortalTransparenciaServidoresViagens.

type PortalTransparenciaServidoresViagensRetornoViagensUnidadeGestora 

type PortalTransparenciaServidoresViagensRetornoViagensUnidadeGestora struct {
	// Codigo is retorno.viagens[].unidadeGestora.codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// Nome is retorno.viagens[].unidadeGestora.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// OrgaoVinculado is retorno.viagens[].unidadeGestora.orgaoVinculado, documented as a string.
	OrgaoVinculado Text `json:"orgaoVinculado"`
}

PortalTransparenciaServidoresViagensRetornoViagensUnidadeGestora is retorno.viagens[].unidadeGestora in the answer of PortalTransparenciaServidoresViagens.

type ProcessosJudiciaisAgrupadaParams 

type ProcessosJudiciaisAgrupadaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

ProcessosJudiciaisAgrupadaParams are the parameters of ProcessosJudiciaisAgrupada (Processos Judiciais - Agrupada (Base)).

func (ProcessosJudiciaisAgrupadaParams) Request 

func (p ProcessosJudiciaisAgrupadaParams) Request() (Request, error)

Request builds the Request for ProcessosJudiciaisAgrupada.

type ProcessosJudiciaisAgrupadaRetorno 

type ProcessosJudiciaisAgrupadaRetorno struct {
	// AreasDireito is retorno.areasDireito, a list.
	AreasDireito []ProcessosJudiciaisAgrupadaRetornoAreasDireito `json:"areasDireito"`
	// DistribuicaoPorAno is retorno.distribuicaoPorAno, a list.
	DistribuicaoPorAno []ProcessosJudiciaisAgrupadaRetornoDistribuicaoPorAno `json:"distribuicaoPorAno"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Segmentos is retorno.segmentos, a list.
	Segmentos []ProcessosJudiciaisAgrupadaRetornoSegmentos `json:"segmentos"`
	// TotalProcessos is retorno.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
	// Tribunais is retorno.tribunais, a list.
	Tribunais []ProcessosJudiciaisAgrupadaRetornoTribunais `json:"tribunais"`
}

ProcessosJudiciaisAgrupadaRetorno is retorno in the answer of ProcessosJudiciaisAgrupada.

type ProcessosJudiciaisAgrupadaRetornoAreasDireito 

type ProcessosJudiciaisAgrupadaRetornoAreasDireito struct {
	// AreaDireito is retorno.areasDireito[].areaDireito, documented as a string.
	AreaDireito Text `json:"areaDireito"`
	// TipoAreaDireito is retorno.areasDireito[].tipoAreaDireito, documented as a string.
	TipoAreaDireito Text `json:"tipoAreaDireito"`
	// TotalProcessosArea is retorno.areasDireito[].totalProcessosArea, documented as a number.
	TotalProcessosArea Number `json:"totalProcessosArea"`
	// TotalValorProcessosArea is retorno.areasDireito[].totalValorProcessosArea, documented as a string.
	TotalValorProcessosArea Text `json:"totalValorProcessosArea"`
}

ProcessosJudiciaisAgrupadaRetornoAreasDireito is retorno.areasDireito[] in the answer of ProcessosJudiciaisAgrupada.

type ProcessosJudiciaisAgrupadaRetornoDistribuicaoPorAno 

type ProcessosJudiciaisAgrupadaRetornoDistribuicaoPorAno struct {
	// Ano is retorno.distribuicaoPorAno[].ano, documented as a string.
	Ano Text `json:"ano"`
	// TotalPorAno is retorno.distribuicaoPorAno[].totalPorAno, documented as a number.
	TotalPorAno Number `json:"totalPorAno"`
}

ProcessosJudiciaisAgrupadaRetornoDistribuicaoPorAno is retorno.distribuicaoPorAno[] in the answer of ProcessosJudiciaisAgrupada.

type ProcessosJudiciaisAgrupadaRetornoSegmentos 

type ProcessosJudiciaisAgrupadaRetornoSegmentos struct {
	// Segmento is retorno.segmentos[].segmento, documented as a string.
	Segmento Text `json:"segmento"`
	// TotalPorSegmento is retorno.segmentos[].totalPorSegmento, documented as a number.
	TotalPorSegmento Number `json:"totalPorSegmento"`
}

ProcessosJudiciaisAgrupadaRetornoSegmentos is retorno.segmentos[] in the answer of ProcessosJudiciaisAgrupada.

type ProcessosJudiciaisAgrupadaRetornoTribunais 

type ProcessosJudiciaisAgrupadaRetornoTribunais struct {
	// TotalPorTribunal is retorno.tribunais[].totalPorTribunal, documented as a number.
	TotalPorTribunal Number `json:"totalPorTribunal"`
	// Tribunal is retorno.tribunais[].tribunal, documented as a string.
	Tribunal Text `json:"tribunal"`
}

ProcessosJudiciaisAgrupadaRetornoTribunais is retorno.tribunais[] in the answer of ProcessosJudiciaisAgrupada.

type ProcessosJudiciaisCompletaParams 

type ProcessosJudiciaisCompletaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

ProcessosJudiciaisCompletaParams are the parameters of ProcessosJudiciaisCompleta (Processos Judiciais - Completa (Base)).

func (ProcessosJudiciaisCompletaParams) Request 

func (p ProcessosJudiciaisCompletaParams) Request() (Request, error)

Request builds the Request for ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetorno 

type ProcessosJudiciaisCompletaRetorno struct {
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Processos is retorno.processos, a list.
	Processos []ProcessosJudiciaisCompletaRetornoProcessos `json:"processos"`
	// TotalProcessos is retorno.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
}

ProcessosJudiciaisCompletaRetorno is retorno in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessos 

type ProcessosJudiciaisCompletaRetornoProcessos struct {
	// AmbitoJustica is retorno.processos[].ambitoJustica, documented as a string.
	AmbitoJustica Text `json:"ambitoJustica"`
	// AreaDireito is retorno.processos[].areaDireito, documented as a string.
	AreaDireito Text `json:"areaDireito"`
	// Assuntos is retorno.processos[].assuntos, a list.
	Assuntos []ProcessosJudiciaisCompletaRetornoProcessosAssuntos `json:"assuntos"`
	// Classificacao is retorno.processos[].classificacao.
	Classificacao ProcessosJudiciaisCompletaRetornoProcessosClassificacao `json:"classificacao"`
	// DataAutuacao is retorno.processos[].dataAutuacao, documented as a string.
	DataAutuacao Text `json:"dataAutuacao"`
	// DataDistribuicao is retorno.processos[].dataDistribuicao, documented as a string.
	DataDistribuicao Text `json:"dataDistribuicao"`
	// DetalhesStatusProcesso is retorno.processos[].detalhesStatusProcesso.
	DetalhesStatusProcesso ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcesso `json:"detalhesStatusProcesso"`
	// Instancia is retorno.processos[].instancia, documented as a number.
	Instancia Number `json:"instancia"`
	// JusticaGratuita is retorno.processos[].justicaGratuita, documented as a boolean.
	JusticaGratuita Flag `json:"justicaGratuita"`
	// NumeroProcesso is retorno.processos[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// OrgaoJulgador is retorno.processos[].orgaoJulgador.
	OrgaoJulgador ProcessosJudiciaisCompletaRetornoProcessosOrgaoJulgador `json:"orgaoJulgador"`
	// Partes is retorno.processos[].partes, a list.
	Partes []ProcessosJudiciaisCompletaRetornoProcessosPartes `json:"partes"`
	// Prioritario is retorno.processos[].prioritario, documented as a boolean.
	Prioritario Flag `json:"prioritario"`
	// ProcessoDigital is retorno.processos[].processoDigital, documented as a boolean.
	ProcessoDigital Flag `json:"processoDigital"`
	// ProcessosRelacionados is retorno.processos[].processosRelacionados, a list.
	ProcessosRelacionados []Text `json:"processosRelacionados"`
	// SegredoJustica is retorno.processos[].segredoJustica, documented as a boolean.
	SegredoJustica Flag `json:"segredoJustica"`
	// Sistema is retorno.processos[].sistema, documented as a string.
	Sistema Text `json:"sistema"`
	// TutelaAntecipada is retorno.processos[].tutelaAntecipada, documented as a boolean.
	TutelaAntecipada Flag `json:"tutelaAntecipada"`
	// ValorProcesso is retorno.processos[].valorProcesso, documented as a string.
	ValorProcesso Text `json:"valorProcesso"`
}

ProcessosJudiciaisCompletaRetornoProcessos is retorno.processos[] in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosAssuntos 

type ProcessosJudiciaisCompletaRetornoProcessosAssuntos struct {
	// Assunto is retorno.processos[].assuntos[].assunto, documented as a string.
	Assunto Text `json:"assunto"`
	// AssuntoPrincipal is retorno.processos[].assuntos[].assuntoPrincipal, documented as a boolean.
	AssuntoPrincipal Flag `json:"assuntoPrincipal"`
	// CodigoAssunto is retorno.processos[].assuntos[].codigoAssunto, documented as a string.
	CodigoAssunto Text `json:"codigoAssunto"`
}

ProcessosJudiciaisCompletaRetornoProcessosAssuntos is retorno.processos[].assuntos[] in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosClassificacao 

type ProcessosJudiciaisCompletaRetornoProcessosClassificacao struct {
	// CodigoClassificacao is retorno.processos[].classificacao.codigoClassificacao, documented as a string.
	CodigoClassificacao Text `json:"codigoClassificacao"`
	// Descricao is retorno.processos[].classificacao.descricao, documented as a string.
	Descricao Text `json:"descricao"`
}

ProcessosJudiciaisCompletaRetornoProcessosClassificacao is retorno.processos[].classificacao in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcesso 

type ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcesso struct {
	// DataArquivamento is retorno.processos[].detalhesStatusProcesso.dataArquivamento, documented as a string.
	DataArquivamento Text `json:"dataArquivamento"`
	// DataTransitoJulgado is retorno.processos[].detalhesStatusProcesso.dataTransitoJulgado, documented as a string.
	DataTransitoJulgado Text `json:"dataTransitoJulgado"`
	// Julgamentos is retorno.processos[].detalhesStatusProcesso.julgamentos, a list.
	Julgamentos []ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoJulgamentos `json:"julgamentos"`
	// Penhoras is retorno.processos[].detalhesStatusProcesso.penhoras, a list.
	Penhoras []ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoPenhoras `json:"penhoras"`
	// StatusDetalhes is retorno.processos[].detalhesStatusProcesso.statusDetalhes, documented as a string.
	StatusDetalhes Text `json:"statusDetalhes"`
}

ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcesso is retorno.processos[].detalhesStatusProcesso in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoJulgamentos 

type ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoJulgamentos struct {
	// DataJulgamento is retorno.processos[].detalhesStatusProcesso.julgamentos[].dataJulgamento, documented as a string.
	DataJulgamento Text `json:"dataJulgamento"`
	// StatusJulgamento is retorno.processos[].detalhesStatusProcesso.julgamentos[].statusJulgamento, documented as a string.
	StatusJulgamento Text `json:"statusJulgamento"`
	// TipoJulgamento is retorno.processos[].detalhesStatusProcesso.julgamentos[].tipoJulgamento, documented as a string.
	TipoJulgamento Text `json:"tipoJulgamento"`
}

ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoJulgamentos is retorno.processos[].detalhesStatusProcesso.julgamentos[] in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoPenhoras 

type ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoPenhoras struct {
	// DataPenhora is retorno.processos[].detalhesStatusProcesso.penhoras[].dataPenhora, documented as a string.
	DataPenhora Text `json:"dataPenhora"`
	// TipoPenhora is retorno.processos[].detalhesStatusProcesso.penhoras[].tipoPenhora, documented as a string.
	TipoPenhora Text `json:"tipoPenhora"`
	// TrechoDecisao is retorno.processos[].detalhesStatusProcesso.penhoras[].trechoDecisao, documented as a string.
	TrechoDecisao Text `json:"trechoDecisao"`
}

ProcessosJudiciaisCompletaRetornoProcessosDetalhesStatusProcessoPenhoras is retorno.processos[].detalhesStatusProcesso.penhoras[] in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosOrgaoJulgador 

type ProcessosJudiciaisCompletaRetornoProcessosOrgaoJulgador struct {
	// Cidade is retorno.processos[].orgaoJulgador.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Comarca is retorno.processos[].orgaoJulgador.comarca, documented as a string.
	Comarca Text `json:"comarca"`
	// OrgaoResponsavel is retorno.processos[].orgaoJulgador.orgaoResponsavel, documented as a string.
	OrgaoResponsavel Text `json:"orgaoResponsavel"`
	// Tribunal is retorno.processos[].orgaoJulgador.tribunal, documented as a string.
	Tribunal Text `json:"tribunal"`
	// Uf is retorno.processos[].orgaoJulgador.uf, documented as a string.
	Uf Text `json:"uf"`
	// UnidadeOrigem is retorno.processos[].orgaoJulgador.unidadeOrigem, documented as a string.
	UnidadeOrigem Text `json:"unidadeOrigem"`
}

ProcessosJudiciaisCompletaRetornoProcessosOrgaoJulgador is retorno.processos[].orgaoJulgador in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosPartes 

type ProcessosJudiciaisCompletaRetornoProcessosPartes struct {
	// Advogados is retorno.processos[].partes[].advogados, a list.
	Advogados []ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogados `json:"advogados"`
	// Documento is retorno.processos[].partes[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeCompleto is retorno.processos[].partes[].nomeCompleto, documented as a string.
	NomeCompleto Text `json:"nomeCompleto" pii:"name"`
	// Polo is retorno.processos[].partes[].polo, documented as a string.
	Polo Text `json:"polo"`
	// PosicaoProcessual is retorno.processos[].partes[].posicaoProcessual, documented as a string.
	PosicaoProcessual Text `json:"posicaoProcessual"`
}

ProcessosJudiciaisCompletaRetornoProcessosPartes is retorno.processos[].partes[] in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogados 

type ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogados struct {
	// Documento is retorno.processos[].partes[].advogados[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeCompleto is retorno.processos[].partes[].advogados[].nomeCompleto, documented as a string.
	NomeCompleto Text `json:"nomeCompleto" pii:"name"`
	// Oab is retorno.processos[].partes[].advogados[].oab.
	Oab ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogadosOab `json:"oab"`
}

ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogados is retorno.processos[].partes[].advogados[] in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogadosOab 

type ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogadosOab struct {
	// NumeroOAB is retorno.processos[].partes[].advogados[].oab.numeroOAB, documented as a string.
	NumeroOAB Text `json:"numeroOAB"`
	// Uf is retorno.processos[].partes[].advogados[].oab.uf, documented as a string.
	Uf Text `json:"uf"`
}

ProcessosJudiciaisCompletaRetornoProcessosPartesAdvogadosOab is retorno.processos[].partes[].advogados[].oab in the answer of ProcessosJudiciaisCompleta.

type ProcessosJudiciaisSimplificadaParams 

type ProcessosJudiciaisSimplificadaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

ProcessosJudiciaisSimplificadaParams are the parameters of ProcessosJudiciaisSimplificada (Processos Judiciais - Simplificada (Base)).

func (ProcessosJudiciaisSimplificadaParams) Request 

func (p ProcessosJudiciaisSimplificadaParams) Request() (Request, error)

Request builds the Request for ProcessosJudiciaisSimplificada.

type ProcessosJudiciaisSimplificadaRetorno 

type ProcessosJudiciaisSimplificadaRetorno struct {
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Processos is retorno.processos, a list.
	Processos []ProcessosJudiciaisSimplificadaRetornoProcessos `json:"processos"`
	// TotalProcessos is retorno.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
}

ProcessosJudiciaisSimplificadaRetorno is retorno in the answer of ProcessosJudiciaisSimplificada.

type ProcessosJudiciaisSimplificadaRetornoProcessos 

type ProcessosJudiciaisSimplificadaRetornoProcessos struct {
	// AssuntoPrincipal is retorno.processos[].assuntoPrincipal, documented as a string.
	AssuntoPrincipal Text `json:"assuntoPrincipal"`
	// Classe is retorno.processos[].classe, documented as a string.
	Classe Text `json:"classe"`
	// DataAjuizamento is retorno.processos[].dataAjuizamento, documented as a string.
	DataAjuizamento Text `json:"dataAjuizamento"`
	// Grau is retorno.processos[].grau, documented as a string.
	Grau Text `json:"grau"`
	// NumeroProcesso is retorno.processos[].numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// Partes is retorno.processos[].partes, a list.
	Partes []ProcessosJudiciaisSimplificadaRetornoProcessosPartes `json:"partes"`
	// Segmento is retorno.processos[].segmento, documented as a string.
	Segmento Text `json:"segmento"`
	// Status is retorno.processos[].status, documented as a string.
	Status Text `json:"status"`
	// Tribunal is retorno.processos[].tribunal, documented as a string.
	Tribunal Text `json:"tribunal"`
	// UltimaMovimentacao is retorno.processos[].ultimaMovimentacao.
	UltimaMovimentacao ProcessosJudiciaisSimplificadaRetornoProcessosUltimaMovimentacao `json:"ultimaMovimentacao"`
	// ValorAcao is retorno.processos[].valorAcao, documented as a number.
	ValorAcao Number `json:"valorAcao"`
}

ProcessosJudiciaisSimplificadaRetornoProcessos is retorno.processos[] in the answer of ProcessosJudiciaisSimplificada.

type ProcessosJudiciaisSimplificadaRetornoProcessosPartes 

type ProcessosJudiciaisSimplificadaRetornoProcessosPartes struct {
	// Documento is retorno.processos[].partes[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeCompleto is retorno.processos[].partes[].nomeCompleto, documented as a string.
	NomeCompleto Text `json:"nomeCompleto" pii:"name"`
	// Polo is retorno.processos[].partes[].polo, documented as a string.
	Polo Text `json:"polo"`
	// Tipo is retorno.processos[].partes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// TipoPessoa is retorno.processos[].partes[].tipoPessoa, documented as a string.
	TipoPessoa Text `json:"tipoPessoa"`
}

ProcessosJudiciaisSimplificadaRetornoProcessosPartes is retorno.processos[].partes[] in the answer of ProcessosJudiciaisSimplificada.

type ProcessosJudiciaisSimplificadaRetornoProcessosUltimaMovimentacao 

type ProcessosJudiciaisSimplificadaRetornoProcessosUltimaMovimentacao struct {
	// Data is retorno.processos[].ultimaMovimentacao.data, documented as a string.
	Data Text `json:"data"`
	// Descricao is retorno.processos[].ultimaMovimentacao.descricao, documented as a string.
	Descricao Text `json:"descricao"`
}

ProcessosJudiciaisSimplificadaRetornoProcessosUltimaMovimentacao is retorno.processos[].ultimaMovimentacao in the answer of ProcessosJudiciaisSimplificada.

type Product 

type Product struct {
	// Slug is the endpoint name, such as CadastroPessoaFisicaPlus.
	Slug string
	// Name is the documentation's title.
	Name string
	// Category is the documentation's group.
	Category string
	// Target is the documentation's person type: PF, PJ or PF/PJ.
	Target string
	// Path is the endpoint path, such as /api/CadastroPessoaFisicaPlus.
	Path string
	// Params are the documented query parameters, without TOKEN and ASync,
	// which the client adds itself.
	Params []Param
	// PriceCents is the list price per query in BRL cents. A contract may
	// price differently; override it in Config.Products.
	PriceCents int64
	// Supplier is true when the documentation's origin is "Online": the
	// source is queried when the API is called (terms clause 2.3.1).
	Supplier bool
	// Status is the documentation's availability.
	Status ProductStatus
	// HasPDF is true when the documentation offers a PDF receipt.
	HasPDF bool
	// DocURL is the API's public documentation page.
	DocURL string
	// Disabled refuses the product. The application sets it for every API
	// its contract or purpose does not cover.
	Disabled bool
}

Product is one Direct Data API: where it is, what it takes and what it costs. DefaultProducts holds every API of the public catalogue; Config. Products overrides or adds entries by slug.

func (Product) TakesCNPJ 

func (p Product) TakesCNPJ() bool

TakesCNPJ reports whether the product takes a CNPJ as its document.

func (Product) TakesCPF 

func (p Product) TakesCPF() bool

TakesCPF reports whether the product takes a CPF as its document.

type ProductStatus 

type ProductStatus string

ProductStatus is a product's availability as the documentation states it. 

const (
	// StatusAvailable is a product the documentation lists as available.
	StatusAvailable ProductStatus = "available"
	// StatusMaintenance is a product the documentation lists as under
	// maintenance ("Em manutenção"). It may still be called; it may fail.
	StatusMaintenance ProductStatus = "maintenance"
	// StatusInactive is a product the documentation lists as inactive. The
	// client refuses it.
	StatusInactive ProductStatus = "inactive"
)

The product statuses.

type ProtestosNacionalBasicaParams 

type ProtestosNacionalBasicaParams struct {
	// CNPJ is sent as Cnpj. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CPF string
}

ProtestosNacionalBasicaParams are the parameters of ProtestosNacionalBasica (Protestos Nacional - IEPTB Básica).

func (ProtestosNacionalBasicaParams) Request 

func (p ProtestosNacionalBasicaParams) Request() (Request, error)

Request builds the Request for ProtestosNacionalBasica.

type ProtestosNacionalBasicaRetorno 

type ProtestosNacionalBasicaRetorno struct {
	// CnaeDevedor is retorno.cnaeDevedor, documented as a string.
	CnaeDevedor Text `json:"cnaeDevedor"`
	// ConstamProtestos is retorno.constamProtestos, documented as a boolean.
	ConstamProtestos Flag `json:"constamProtestos"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NumeroTotalProtestos is retorno.numeroTotalProtestos, documented as a number.
	NumeroTotalProtestos Number `json:"numeroTotalProtestos"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// QuantidadeCartoriosDistintos is retorno.quantidadeCartoriosDistintos, documented as a number.
	QuantidadeCartoriosDistintos Number `json:"quantidadeCartoriosDistintos"`
	// QuantidadeCidadesDistintas is retorno.quantidadeCidadesDistintas, documented as a number.
	QuantidadeCidadesDistintas Number `json:"quantidadeCidadesDistintas"`
	// Titulos is retorno.titulos, a list.
	Titulos []ProtestosNacionalBasicaRetornoTitulos `json:"titulos"`
	// ValorTotalProtestos is retorno.valorTotalProtestos, documented as a string.
	ValorTotalProtestos Text `json:"valorTotalProtestos"`
}

ProtestosNacionalBasicaRetorno is retorno in the answer of ProtestosNacionalBasica.

type ProtestosNacionalBasicaRetornoTitulos 

type ProtestosNacionalBasicaRetornoTitulos struct {
	// ValorProtestado is retorno.titulos[].valorProtestado, documented as a string.
	ValorProtestado Text `json:"valorProtestado"`
}

ProtestosNacionalBasicaRetornoTitulos is retorno.titulos[] in the answer of ProtestosNacionalBasica.

type ProtestosOnlineParams 

type ProtestosOnlineParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

ProtestosOnlineParams are the parameters of ProtestosOnline (Protestos Nacional - IEPTB Online).

func (ProtestosOnlineParams) Request 

func (p ProtestosOnlineParams) Request() (Request, error)

Request builds the Request for ProtestosOnline.

type ProtestosOnlineRetorno 

type ProtestosOnlineRetorno struct {
	// ConstamProtestos is retorno.constamProtestos, documented as a boolean.
	ConstamProtestos Flag `json:"constamProtestos"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NumeroTotalProtestos is retorno.numeroTotalProtestos, documented as a number.
	NumeroTotalProtestos Number `json:"numeroTotalProtestos"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Protestos is retorno.protestos, a list.
	Protestos []ProtestosOnlineRetornoProtestos `json:"protestos"`
	// ValorTotalProtestos is retorno.valorTotalProtestos, documented as a string.
	ValorTotalProtestos Text `json:"valorTotalProtestos"`
}

ProtestosOnlineRetorno is retorno in the answer of ProtestosOnline.

type ProtestosOnlineRetornoProtestos 

type ProtestosOnlineRetornoProtestos struct {
	// Cartorios is retorno.protestos[].cartorios, a list.
	Cartorios []ProtestosOnlineRetornoProtestosCartorios `json:"cartorios"`
	// Estado is retorno.protestos[].estado, documented as a string.
	Estado Text `json:"estado"`
	// NumeroTotalProtestosUF is retorno.protestos[].numeroTotalProtestosUF, documented as a number.
	NumeroTotalProtestosUF Number `json:"numeroTotalProtestosUF"`
	// ValorTotalProtestosEstado is retorno.protestos[].valorTotalProtestosEstado, documented as a string.
	ValorTotalProtestosEstado Text `json:"valorTotalProtestosEstado"`
}

ProtestosOnlineRetornoProtestos is retorno.protestos[] in the answer of ProtestosOnline.

type ProtestosOnlineRetornoProtestosCartorios 

type ProtestosOnlineRetornoProtestosCartorios struct {
	// Cidade is retorno.protestos[].cartorios[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoCidade is retorno.protestos[].cartorios[].codigoCidade, documented as a string.
	CodigoCidade Text `json:"codigoCidade"`
	// NumeroProtestos is retorno.protestos[].cartorios[].numeroProtestos, documented as a number.
	NumeroProtestos Number `json:"numeroProtestos"`
	// Titulos is retorno.protestos[].cartorios[].titulos, a list.
	Titulos []ProtestosOnlineRetornoProtestosCartoriosTitulos `json:"titulos"`
	// ValorTotalProtestosCartorio is retorno.protestos[].cartorios[].valorTotalProtestosCartorio, documented as a string.
	ValorTotalProtestosCartorio Text `json:"valorTotalProtestosCartorio"`
}

ProtestosOnlineRetornoProtestosCartorios is retorno.protestos[].cartorios[] in the answer of ProtestosOnline.

type ProtestosOnlineRetornoProtestosCartoriosTitulos 

type ProtestosOnlineRetornoProtestosCartoriosTitulos struct {
	// DataProtesto is retorno.protestos[].cartorios[].titulos[].dataProtesto, documented as a string.
	DataProtesto Text `json:"dataProtesto"`
	// Documento is retorno.protestos[].cartorios[].titulos[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// ValorProtestado is retorno.protestos[].cartorios[].titulos[].valorProtestado, documented as a string.
	ValorProtestado Text `json:"valorProtestado"`
}

ProtestosOnlineRetornoProtestosCartoriosTitulos is retorno.protestos[].cartorios[].titulos[] in the answer of ProtestosOnline.

type ReceitaFederalPessoaFisicaParams 

type ReceitaFederalPessoaFisicaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.
	DataNascimento string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

ReceitaFederalPessoaFisicaParams are the parameters of ReceitaFederalPessoaFisica (Receita Federal - Pessoa Física).

func (ReceitaFederalPessoaFisicaParams) Request 

func (p ReceitaFederalPessoaFisicaParams) Request() (Request, error)

Request builds the Request for ReceitaFederalPessoaFisica.

type ReceitaFederalPessoaFisicaRetorno 

type ReceitaFederalPessoaFisicaRetorno struct {
	// AnoObito is retorno.anoObito, documented as a string.
	AnoObito Text `json:"anoObito"`
	// CodigoControleComprovante is retorno.codigoControleComprovante, documented as a string.
	CodigoControleComprovante Text `json:"codigoControleComprovante"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataInscricao is retorno.dataInscricao, documented as a string.
	DataInscricao Text `json:"dataInscricao"`
	// DataInscricaoAnterior1990 is retorno.dataInscricaoAnterior1990, documented as a boolean.
	DataInscricaoAnterior1990 Flag `json:"dataInscricaoAnterior1990"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DigitoVerificador is retorno.digitoVerificador, documented as a string.
	DigitoVerificador Text `json:"digitoVerificador"`
	// NomePessoaFisica is retorno.nomePessoaFisica, documented as a string.
	NomePessoaFisica Text `json:"nomePessoaFisica" pii:"name"`
	// NomeSocial is retorno.nomeSocial, documented as a string.
	NomeSocial Text `json:"nomeSocial" pii:"name"`
	// NumeroCPF is retorno.numeroCPF, documented as a string.
	NumeroCPF Text `json:"numeroCPF" pii:"document"`
	// PossuiObito is retorno.possuiObito, documented as a boolean.
	PossuiObito Flag `json:"possuiObito"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
}

ReceitaFederalPessoaFisicaRetorno is retorno in the answer of ReceitaFederalPessoaFisica.

type ReceitaFederalPessoaJuridicaParams 

type ReceitaFederalPessoaJuridicaParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Qsa is sent as Qsa. O parâmetro QSA é utilizado para obter o Quadro de Sócios e Administradores.
	Qsa string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

ReceitaFederalPessoaJuridicaParams are the parameters of ReceitaFederalPessoaJuridica (Receita Federal - Pessoa Jurídica).

func (ReceitaFederalPessoaJuridicaParams) Request 

func (p ReceitaFederalPessoaJuridicaParams) Request() (Request, error)

Request builds the Request for ReceitaFederalPessoaJuridica.

type ReceitaFederalPessoaJuridicaRetorno 

type ReceitaFederalPessoaJuridicaRetorno struct {
	// AtividadeEconomicaPrincipal is retorno.atividadeEconomicaPrincipal, documented as a string.
	AtividadeEconomicaPrincipal Text `json:"atividadeEconomicaPrincipal"`
	// AtividadesEconomicasSecundarias is retorno.atividadesEconomicasSecundarias, a list.
	AtividadesEconomicasSecundarias []Text `json:"atividadesEconomicasSecundarias"`
	// BairroDistrito is retorno.bairroDistrito, documented as a string.
	BairroDistrito Text `json:"bairroDistrito"`
	// CapitalSocialQSA is retorno.capitalSocialQSA, documented as a string.
	CapitalSocialQSA Text `json:"capitalSocialQSA"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Complemento is retorno.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// DataAbertura is retorno.dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataSituacaoCadastral is retorno.dataSituacaoCadastral, documented as a string.
	DataSituacaoCadastral Text `json:"dataSituacaoCadastral"`
	// DataSituacaoEspecial is retorno.dataSituacaoEspecial, documented as a string.
	DataSituacaoEspecial Text `json:"dataSituacaoEspecial"`
	// Efr is retorno.efr, documented as a string.
	Efr Text `json:"efr"`
	// EmRecuperJudicial is retorno.emRecuperJudicial, documented as a boolean.
	EmRecuperJudicial Flag `json:"emRecuperJudicial"`
	// EnderecoEletronico is retorno.enderecoEletronico, documented as a string.
	EnderecoEletronico Text `json:"enderecoEletronico" pii:"address"`
	// Logradouro is retorno.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Matriz is retorno.matriz, documented as a boolean.
	Matriz Flag `json:"matriz"`
	// MotivoSituacaoCadastral is retorno.motivoSituacaoCadastral, documented as a string.
	MotivoSituacaoCadastral Text `json:"motivoSituacaoCadastral"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NaturezaJuridica is retorno.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// NomeEmpresarial is retorno.nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// Numero is retorno.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// NumeroInscricao is retorno.numeroInscricao, documented as a string.
	NumeroInscricao Text `json:"numeroInscricao"`
	// Porte is retorno.porte, documented as a string.
	Porte Text `json:"porte"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// SituacaoEspecial is retorno.situacaoEspecial, documented as a string.
	SituacaoEspecial Text `json:"situacaoEspecial"`
	// Socios is retorno.socios, a list.
	Socios []ReceitaFederalPessoaJuridicaRetornoSocios `json:"socios"`
	// Telefone is retorno.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

ReceitaFederalPessoaJuridicaRetorno is retorno in the answer of ReceitaFederalPessoaJuridica.

type ReceitaFederalPessoaJuridicaRetornoSocios 

type ReceitaFederalPessoaJuridicaRetornoSocios struct {
	// DocumentoSocio is retorno.socios[].documentoSocio, documented as a string.
	DocumentoSocio Text `json:"documentoSocio"`
	// IsRepresentanteLegal is retorno.socios[].isRepresentanteLegal, documented as a boolean.
	IsRepresentanteLegal Flag `json:"isRepresentanteLegal"`
	// NomeNomeEmpresarial is retorno.socios[].nomeNomeEmpresarial, documented as a string.
	NomeNomeEmpresarial Text `json:"nomeNomeEmpresarial" pii:"name"`
	// NomeRepresLegal is retorno.socios[].nomeRepresLegal, documented as a string.
	NomeRepresLegal Text `json:"nomeRepresLegal" pii:"name"`
	// QualifRepLegal is retorno.socios[].qualifRepLegal, documented as a string.
	QualifRepLegal Text `json:"qualifRepLegal"`
	// Qualificacao is retorno.socios[].qualificacao, documented as a string.
	Qualificacao Text `json:"qualificacao"`
}

ReceitaFederalPessoaJuridicaRetornoSocios is retorno.socios[] in the answer of ReceitaFederalPessoaJuridica.

type ReceitaPJParticipacaoSocietariaParams 

type ReceitaPJParticipacaoSocietariaParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

ReceitaPJParticipacaoSocietariaParams are the parameters of ReceitaPJParticipacaoSocietaria (Receita Federal - Pessoa Jurídica - QSA + Participação Societária).

func (ReceitaPJParticipacaoSocietariaParams) Request 

func (p ReceitaPJParticipacaoSocietariaParams) Request() (Request, error)

Request builds the Request for ReceitaPJParticipacaoSocietaria.

type ReceitaPJParticipacaoSocietariaRetorno 

type ReceitaPJParticipacaoSocietariaRetorno struct {
	// AtividadeEconomicaPrincipal is retorno.atividadeEconomicaPrincipal, documented as a string.
	AtividadeEconomicaPrincipal Text `json:"atividadeEconomicaPrincipal"`
	// AtividadesEconomicasSecundarias is retorno.atividadesEconomicasSecundarias, a list.
	AtividadesEconomicasSecundarias []Text `json:"atividadesEconomicasSecundarias"`
	// BairroDistrito is retorno.bairroDistrito, documented as a string.
	BairroDistrito Text `json:"bairroDistrito"`
	// CapitalSocialQSA is retorno.capitalSocialQSA, documented as a string.
	CapitalSocialQSA Text `json:"capitalSocialQSA"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Complemento is retorno.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// DataAbertura is retorno.dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataSituacaoCadastral is retorno.dataSituacaoCadastral, documented as a string.
	DataSituacaoCadastral Text `json:"dataSituacaoCadastral"`
	// DataSituacaoEspecial is retorno.dataSituacaoEspecial, documented as a string.
	DataSituacaoEspecial Text `json:"dataSituacaoEspecial"`
	// Efr is retorno.efr, documented as a string.
	Efr Text `json:"efr"`
	// EmRecuperacaoJudicial is retorno.emRecuperacaoJudicial, documented as a boolean.
	EmRecuperacaoJudicial Flag `json:"emRecuperacaoJudicial"`
	// EnderecoEletronico is retorno.enderecoEletronico, documented as a string.
	EnderecoEletronico Text `json:"enderecoEletronico" pii:"address"`
	// Logradouro is retorno.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Matriz is retorno.matriz, documented as a boolean.
	Matriz Flag `json:"matriz"`
	// MotivoSituacaoCadastral is retorno.motivoSituacaoCadastral, documented as a string.
	MotivoSituacaoCadastral Text `json:"motivoSituacaoCadastral"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NaturezaJuridica is retorno.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// NomeEmpresarial is retorno.nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// Numero is retorno.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// NumeroInscricao is retorno.numeroInscricao, documented as a string.
	NumeroInscricao Text `json:"numeroInscricao"`
	// Porte is retorno.porte, documented as a string.
	Porte Text `json:"porte"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// SituacaoEspecial is retorno.situacaoEspecial, documented as a string.
	SituacaoEspecial Text `json:"situacaoEspecial"`
	// Socios is retorno.socios, a list.
	Socios []ReceitaPJParticipacaoSocietariaRetornoSocios `json:"socios"`
	// Telefone is retorno.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

ReceitaPJParticipacaoSocietariaRetorno is retorno in the answer of ReceitaPJParticipacaoSocietaria.

type ReceitaPJParticipacaoSocietariaRetornoSocios 

type ReceitaPJParticipacaoSocietariaRetornoSocios struct {
	// DataEntradaSociedade is retorno.socios[].dataEntradaSociedade, documented as a string.
	DataEntradaSociedade Text `json:"dataEntradaSociedade"`
	// Documento is retorno.socios[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeEntidade is retorno.socios[].nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PercentualParticipacao is retorno.socios[].percentualParticipacao, documented as a number.
	PercentualParticipacao Number `json:"percentualParticipacao"`
	// Qualificacao is retorno.socios[].qualificacao, documented as a string.
	Qualificacao Text `json:"qualificacao"`
}

ReceitaPJParticipacaoSocietariaRetornoSocios is retorno.socios[] in the answer of ReceitaPJParticipacaoSocietaria.

type RegistrationDataArgentinaParams 

type RegistrationDataArgentinaParams struct {
	// DNI is sent as DNI. O parâmetro DNI pode ser enviado com ou sem formatação. Este parâmetro é obrigatório.
	DNI string
}

RegistrationDataArgentinaParams are the parameters of RegistrationDataArgentina (Registration Data - Argentina).

func (RegistrationDataArgentinaParams) Request 

func (p RegistrationDataArgentinaParams) Request() (Request, error)

Request builds the Request for RegistrationDataArgentina.

type RegistrationDataArgentinaRetorno 

type RegistrationDataArgentinaRetorno struct {
	// Addresses is retorno.addresses, a list.
	Addresses []RegistrationDataArgentinaRetornoAddresses `json:"addresses"`
	// Age is retorno.age, documented as a number.
	Age Number `json:"age"`
	// DateOfBirth is retorno.dateOfBirth, documented as a string.
	DateOfBirth Text `json:"dateOfBirth"`
	// Dni is retorno.dni, documented as a string.
	Dni Text `json:"dni" pii:"document"`
	// Emails is retorno.emails, a list.
	Emails []RegistrationDataArgentinaRetornoEmails `json:"emails"`
	// EstimatedSalary is retorno.estimatedSalary, documented as a string.
	EstimatedSalary Text `json:"estimatedSalary"`
	// Gender is retorno.gender, documented as a string.
	Gender Text `json:"gender"`
	// Name is retorno.name, documented as a string.
	Name Text `json:"name" pii:"name"`
	// Nationality is retorno.nationality, documented as a string.
	Nationality Text `json:"nationality"`
	// Phones is retorno.phones, a list.
	Phones []RegistrationDataArgentinaRetornoPhones `json:"phones"`
	// SalaryRange is retorno.salaryRange, documented as a string.
	SalaryRange Text `json:"salaryRange"`
}

RegistrationDataArgentinaRetorno is retorno in the answer of RegistrationDataArgentina.

type RegistrationDataArgentinaRetornoAddresses 

type RegistrationDataArgentinaRetornoAddresses struct {
	// City is retorno.addresses[].city, documented as a string.
	City Text `json:"city" pii:"address"`
	// Complement is retorno.addresses[].complement, documented as a string.
	Complement Text `json:"complement"`
	// Neighborhood is retorno.addresses[].neighborhood, documented as a string.
	Neighborhood Text `json:"neighborhood"`
	// Number is retorno.addresses[].number, documented as a string.
	Number Text `json:"number"`
	// PostalCode is retorno.addresses[].postalCode, documented as a string.
	PostalCode Text `json:"postalCode"`
	// State is retorno.addresses[].state, documented as a string.
	State Text `json:"state"`
	// Street is retorno.addresses[].street, documented as a string.
	Street Text `json:"street"`
}

RegistrationDataArgentinaRetornoAddresses is retorno.addresses[] in the answer of RegistrationDataArgentina.

type RegistrationDataArgentinaRetornoEmails 

type RegistrationDataArgentinaRetornoEmails struct {
	// EmailAddress is retorno.emails[].emailAddress, documented as a string.
	EmailAddress Text `json:"emailAddress" pii:"email"`
}

RegistrationDataArgentinaRetornoEmails is retorno.emails[] in the answer of RegistrationDataArgentina.

type RegistrationDataArgentinaRetornoPhones 

type RegistrationDataArgentinaRetornoPhones struct {
	// PhoneNumber is retorno.phones[].phoneNumber, documented as a string.
	PhoneNumber Text `json:"phoneNumber"`
	// PhoneType is retorno.phones[].phoneType, documented as a string.
	PhoneType Text `json:"phoneType"`
}

RegistrationDataArgentinaRetornoPhones is retorno.phones[] in the answer of RegistrationDataArgentina.

type RegistrationDataBrazilParams 

type RegistrationDataBrazilParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'. Checked before any request; sent bare.
	CPF string
	// Name is sent as Name. O parâmetro NAME pode ser enviado com qualquer outro.
	Name string
	// Surname is sent as Surname. O parâmetro SURNAME pode ser enviado com qualquer outro.
	Surname string
	// DOB is sent as DOB. DATA DE NASCIMENTO - Ex: yyyy/MM/dd.
	DOB string
}

RegistrationDataBrazilParams are the parameters of RegistrationDataBrazil (Registration Data - Brazil).

func (RegistrationDataBrazilParams) Request 

func (p RegistrationDataBrazilParams) Request() (Request, error)

Request builds the Request for RegistrationDataBrazil.

type RegistrationDataBrazilRetorno 

type RegistrationDataBrazilRetorno struct {
	// Addresses is retorno.addresses, a list.
	Addresses []RegistrationDataBrazilRetornoAddresses `json:"addresses"`
	// Age is retorno.age, documented as a number.
	Age Number `json:"age"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DateOfBirth is retorno.dateOfBirth, documented as a string.
	DateOfBirth Text `json:"dateOfBirth"`
	// Emails is retorno.emails, a list.
	Emails []RegistrationDataBrazilRetornoEmails `json:"emails"`
	// EstimatedSalary is retorno.estimatedSalary, documented as a string.
	EstimatedSalary Text `json:"estimatedSalary"`
	// Gender is retorno.gender, documented as a string.
	Gender Text `json:"gender"`
	// Name is retorno.name, documented as a string.
	Name Text `json:"name" pii:"name"`
	// NameMother is retorno.nameMother, documented as a string.
	NameMother Text `json:"nameMother"`
	// Phones is retorno.phones, a list.
	Phones []RegistrationDataBrazilRetornoPhones `json:"phones"`
	// SalaryRange is retorno.salaryRange, documented as a string.
	SalaryRange Text `json:"salaryRange"`
}

RegistrationDataBrazilRetorno is retorno in the answer of RegistrationDataBrazil.

type RegistrationDataBrazilRetornoAddresses 

type RegistrationDataBrazilRetornoAddresses struct {
	// City is retorno.addresses[].city, documented as a string.
	City Text `json:"city" pii:"address"`
	// Complement is retorno.addresses[].complement, documented as a string.
	Complement Text `json:"complement"`
	// Neighborhood is retorno.addresses[].neighborhood, documented as a string.
	Neighborhood Text `json:"neighborhood"`
	// Number is retorno.addresses[].number, documented as a string.
	Number Text `json:"number"`
	// PostalCode is retorno.addresses[].postalCode, documented as a string.
	PostalCode Text `json:"postalCode"`
	// State is retorno.addresses[].state, documented as a string.
	State Text `json:"state"`
	// Street is retorno.addresses[].street, documented as a string.
	Street Text `json:"street"`
}

RegistrationDataBrazilRetornoAddresses is retorno.addresses[] in the answer of RegistrationDataBrazil.

type RegistrationDataBrazilRetornoEmails 

type RegistrationDataBrazilRetornoEmails struct {
	// EmailAddress is retorno.emails[].emailAddress, documented as a string.
	EmailAddress Text `json:"emailAddress" pii:"email"`
}

RegistrationDataBrazilRetornoEmails is retorno.emails[] in the answer of RegistrationDataBrazil.

type RegistrationDataBrazilRetornoPhones 

type RegistrationDataBrazilRetornoPhones struct {
	// PhoneNumber is retorno.phones[].phoneNumber, documented as a string.
	PhoneNumber Text `json:"phoneNumber"`
	// PhoneType is retorno.phones[].phoneType, documented as a string.
	PhoneType Text `json:"phoneType"`
}

RegistrationDataBrazilRetornoPhones is retorno.phones[] in the answer of RegistrationDataBrazil.

type RegistrationDataMexicoParams 

type RegistrationDataMexicoParams struct {
	// Curp is sent as Curp. O parâmetro CURP pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.
	Curp string
}

RegistrationDataMexicoParams are the parameters of RegistrationDataMexico (Registration Data - México).

func (RegistrationDataMexicoParams) Request 

func (p RegistrationDataMexicoParams) Request() (Request, error)

Request builds the Request for RegistrationDataMexico.

type RegistrationDataMexicoRetorno 

type RegistrationDataMexicoRetorno struct {
	// Addresses is retorno.addresses, a list.
	Addresses []RegistrationDataMexicoRetornoAddresses `json:"addresses"`
	// Age is retorno.age, documented as a number.
	Age Number `json:"age"`
	// Curp is retorno.curp, documented as a string.
	Curp Text `json:"curp" pii:"document"`
	// DateOfBirth is retorno.dateOfBirth, documented as a string.
	DateOfBirth Text `json:"dateOfBirth"`
	// Emails is retorno.emails, a list.
	Emails []RegistrationDataMexicoRetornoEmails `json:"emails"`
	// EstimatedSalary is retorno.estimatedSalary, documented as a string.
	EstimatedSalary Text `json:"estimatedSalary"`
	// Gender is retorno.gender, documented as a string.
	Gender Text `json:"gender"`
	// Name is retorno.name, documented as a string.
	Name Text `json:"name" pii:"name"`
	// Phones is retorno.phones, a list.
	Phones []RegistrationDataMexicoRetornoPhones `json:"phones"`
	// Rfc is retorno.rfc, documented as a string.
	Rfc Text `json:"rfc"`
	// SalaryRange is retorno.salaryRange, documented as a string.
	SalaryRange Text `json:"salaryRange"`
}

RegistrationDataMexicoRetorno is retorno in the answer of RegistrationDataMexico.

type RegistrationDataMexicoRetornoAddresses 

type RegistrationDataMexicoRetornoAddresses struct {
	// City is retorno.addresses[].city, documented as a string.
	City Text `json:"city" pii:"address"`
	// Complement is retorno.addresses[].complement, documented as a string.
	Complement Text `json:"complement"`
	// Neighborhood is retorno.addresses[].neighborhood, documented as a string.
	Neighborhood Text `json:"neighborhood"`
	// Number is retorno.addresses[].number, documented as a string.
	Number Text `json:"number"`
	// PostalCode is retorno.addresses[].postalCode, documented as a string.
	PostalCode Text `json:"postalCode"`
	// State is retorno.addresses[].state, documented as a string.
	State Text `json:"state"`
	// Street is retorno.addresses[].street, documented as a string.
	Street Text `json:"street"`
}

RegistrationDataMexicoRetornoAddresses is retorno.addresses[] in the answer of RegistrationDataMexico.

type RegistrationDataMexicoRetornoEmails 

type RegistrationDataMexicoRetornoEmails struct {
	// EmailAddress is retorno.emails[].emailAddress, documented as a string.
	EmailAddress Text `json:"emailAddress" pii:"email"`
}

RegistrationDataMexicoRetornoEmails is retorno.emails[] in the answer of RegistrationDataMexico.

type RegistrationDataMexicoRetornoPhones 

type RegistrationDataMexicoRetornoPhones struct {
	// PhoneNumber is retorno.phones[].phoneNumber, documented as a string.
	PhoneNumber Text `json:"phoneNumber"`
	// PhoneType is retorno.phones[].phoneType, documented as a string.
	PhoneType Text `json:"phoneType"`
}

RegistrationDataMexicoRetornoPhones is retorno.phones[] in the answer of RegistrationDataMexico.

type Request 

type Request struct {
	// Product is the API's slug, such as CadastroPessoaFisicaPlus.
	Product string
	// Document is the CPF or CNPJ queried, bare or punctuated. The client
	// checks its check digits and sends it, bare, in the product's CPF, CNPJ
	// or document parameter. Leave it empty for a product queried by other
	// inputs (a plate, a name).
	Document string
	// Params are the product's other parameters, by documented name (case is
	// ignored), such as DataNascimento or Placa.
	Params map[string]string
}

Request is one query.

type RestituicaoIRPFParams 

type RestituicaoIRPFParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser fornecido, com ou sem formatação.
	DataNascimento string
	// AnoExercicio is sent as AnoExercicio. Not described by the documentation.
	AnoExercicio string
}

RestituicaoIRPFParams are the parameters of RestituicaoIRPF (Restituição Imposto de Renda - IRPF).

func (RestituicaoIRPFParams) Request 

func (p RestituicaoIRPFParams) Request() (Request, error)

Request builds the Request for RestituicaoIRPF.

type RestituicaoIRPFRetorno 

type RestituicaoIRPFRetorno struct {
	// DebitoAutomatico is retorno.debitoAutomatico, documented as a string.
	DebitoAutomatico Text `json:"debitoAutomatico"`
	// Exercicio is retorno.exercicio, documented as a number.
	Exercicio Number `json:"exercicio"`
	// Fila is retorno.fila, documented as a boolean.
	Fila Flag `json:"fila"`
	// NomeContribuinte is retorno.nomeContribuinte, documented as a string.
	NomeContribuinte Text `json:"nomeContribuinte" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// Restituicao is retorno.restituicao.
	Restituicao RestituicaoIRPFRetornoRestituicao `json:"restituicao"`
	// Resultado is retorno.resultado, documented as a string.
	Resultado Text `json:"resultado"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// TipoDeclaracao is retorno.tipoDeclaracao, documented as a string.
	TipoDeclaracao Text `json:"tipoDeclaracao"`
}

RestituicaoIRPFRetorno is retorno in the answer of RestituicaoIRPF.

type RestituicaoIRPFRetornoRestituicao 

type RestituicaoIRPFRetornoRestituicao struct {
	// DadosBancarios is retorno.restituicao.dadosBancarios.
	DadosBancarios RestituicaoIRPFRetornoRestituicaoDadosBancarios `json:"dadosBancarios"`
	// DataDisponibilidade is retorno.restituicao.dataDisponibilidade, documented as a string.
	DataDisponibilidade Text `json:"dataDisponibilidade"`
	// Lote is retorno.restituicao.lote, documented as a string.
	Lote Text `json:"lote"`
	// MensagemPeres is retorno.restituicao.mensagemPeres, documented as a string.
	MensagemPeres Text `json:"mensagemPeres"`
	// SituacaoRestituicao is retorno.restituicao.situacaoRestituicao, documented as a string.
	SituacaoRestituicao Text `json:"situacaoRestituicao"`
}

RestituicaoIRPFRetornoRestituicao is retorno.restituicao in the answer of RestituicaoIRPF.

type RestituicaoIRPFRetornoRestituicaoDadosBancarios 

type RestituicaoIRPFRetornoRestituicaoDadosBancarios struct {
	// Agencia is retorno.restituicao.dadosBancarios.agencia, documented as a string.
	Agencia Text `json:"agencia"`
	// Banco is retorno.restituicao.dadosBancarios.banco, documented as a string.
	Banco Text `json:"banco"`
	// ChavePix is retorno.restituicao.dadosBancarios.chavePix, documented as a string.
	ChavePix Text `json:"chavePix"`
	// Conta is retorno.restituicao.dadosBancarios.conta, documented as a string.
	Conta Text `json:"conta"`
}

RestituicaoIRPFRetornoRestituicaoDadosBancarios is retorno.restituicao.dadosBancarios in the answer of RestituicaoIRPF.

type Result 

type Result struct {
	// Product is the API's slug, such as CadastroPessoaFisicaPlus.
	Product string
	// Document is the queried document, masked (***.***.***-09 for a CPF,
	// 11.***.***/****-81 for a CNPJ), or "" when the query had none.
	Document string
	// RequestedAt is when the request left, in the configured location.
	RequestedAt time.Time
	// ElapsedMs is the round trip as the client measured it.
	ElapsedMs int64
	// ConsultaUID is Direct Data's identifier of the query.
	ConsultaUID string
	// PriceCents is the product's configured list price.
	PriceCents int64
	// ChargedCents is what the client settled on the Ledger for this call:
	// PriceCents when the outcome is billable, 0 when the hold was released
	// or the result came from Dedupe.
	ChargedCents int64
	// Cached is true when the result came from Dedupe and no request was
	// made.
	Cached bool
	// Async is true when the result arrived through a callback.
	Async bool
	// Outcome is what the query came to.
	Outcome Outcome
	// HTTPStatus is the HTTP status of the answer, or of the httpStatusCode
	// field when the body carries one; 0 when no answer arrived.
	HTTPStatus int
	// Status is metaDados.resultado, verbatim.
	Status string
	// StatusID is metaDados.resultadoId.
	StatusID int
	// Message is metaDados.mensagem, or the error envelope's message.
	Message string
	// Errors is the error envelope's errors list, when there is one.
	Errors []string
	// ReceiptURL is metaDados.urlComprovante.
	ReceiptURL string
	// Meta is the whole metaDados object.
	Meta MetaData
	// Retorno is the retorno object, verbatim. It is personal data: store it
	// encrypted, apart from the normalized facts.
	Retorno json.RawMessage
	// Body is the whole answer, verbatim, when it is JSON. Same care as
	// Retorno.
	Body json.RawMessage
	// Data is Retorno decoded into the product's generated type (a pointer,
	// such as *CadastroPessoaFisicaPlusRetorno), or nil when the product has
	// none, there was no retorno, or decoding failed.
	Data any
	// DataError says why Retorno did not decode into Data. Retorno is kept
	// either way.
	DataError string
	// contains filtered or unexported fields
}

Result is one query, as evidence: what was asked, when, what it cost, what Direct Data said, and the data. It holds no verdict. Whether a registry record supports a case is the application's policy.

type SCRBacenDetalhadaParams 

type SCRBacenDetalhadaParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// MESANO is sent as MESANO. O parâmetro MESANO (mês de competência) é opcional e pode ser enviado nos formatos MM/yyyy, MM-yyyy ou MMyyyy. Quando informado, a consulta retorna o SCR da competência solicitada; se omitido, retorna a competência mais recente disponível.
	MESANO string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

SCRBacenDetalhadaParams are the parameters of SCRBacenDetalhada (SCR Detalhada - Resumo BACEN).

func (SCRBacenDetalhadaParams) Request 

func (p SCRBacenDetalhadaParams) Request() (Request, error)

Request builds the Request for SCRBacenDetalhada.

type SCRBacenDetalhadaRetorno 

type SCRBacenDetalhadaRetorno struct {
	// CarteiraCredito is retorno.carteiraCredito.
	CarteiraCredito SCRBacenDetalhadaRetornoCarteiraCredito `json:"carteiraCredito"`
	// DataInicioRelacionamento is retorno.dataInicioRelacionamento, documented as a string.
	DataInicioRelacionamento Text `json:"dataInicioRelacionamento"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// FaixaRisco is retorno.faixaRisco, documented as a string.
	FaixaRisco Text `json:"faixaRisco"`
	// Modalidades is retorno.modalidades, a list.
	Modalidades []SCRBacenDetalhadaRetornoModalidades `json:"modalidades"`
	// NumeroHistorico is retorno.numeroHistorico, documented as a number.
	NumeroHistorico Number `json:"numeroHistorico"`
	// ObrigacaoAssumida is retorno.obrigacaoAssumida, documented as a string.
	ObrigacaoAssumida Text `json:"obrigacaoAssumida"`
	// ObrigacaoResumida is retorno.obrigacaoResumida, documented as a string.
	ObrigacaoResumida Text `json:"obrigacaoResumida"`
	// PercentualDocumentoProcessado is retorno.percentualDocumentoProcessado, documented as a string.
	PercentualDocumentoProcessado Text `json:"percentualDocumentoProcessado"`
	// PercentualVolumeProcessado is retorno.percentualVolumeProcessado, documented as a string.
	PercentualVolumeProcessado Text `json:"percentualVolumeProcessado"`
	// QuantidadeInstituicoes is retorno.quantidadeInstituicoes, documented as a number.
	QuantidadeInstituicoes Number `json:"quantidadeInstituicoes"`
	// QuantidadeOperacoes is retorno.quantidadeOperacoes, documented as a number.
	QuantidadeOperacoes Number `json:"quantidadeOperacoes"`
	// QuantidadeOperacoesDiscordancia is retorno.quantidadeOperacoesDiscordancia, documented as a number.
	QuantidadeOperacoesDiscordancia Number `json:"quantidadeOperacoesDiscordancia"`
	// QuantidadeOperacoesSubjudice is retorno.quantidadeOperacoesSubjudice, documented as a number.
	QuantidadeOperacoesSubjudice Number `json:"quantidadeOperacoesSubjudice"`
	// ResponsabilidadeTotal is retorno.responsabilidadeTotal, documented as a string.
	ResponsabilidadeTotal Text `json:"responsabilidadeTotal"`
	// ResponsabilidadeTotalDiscordancia is retorno.responsabilidadeTotalDiscordancia, documented as a string.
	ResponsabilidadeTotalDiscordancia Text `json:"responsabilidadeTotalDiscordancia"`
	// ResponsabilidadeTotalSubJudice is retorno.responsabilidadeTotalSubJudice, documented as a string.
	ResponsabilidadeTotalSubJudice Text `json:"responsabilidadeTotalSubJudice"`
	// RiscoIndiretoVendor is retorno.riscoIndiretoVendor, documented as a string.
	RiscoIndiretoVendor Text `json:"riscoIndiretoVendor"`
	// RiscoTotal is retorno.riscoTotal, documented as a string.
	RiscoTotal Text `json:"riscoTotal"`
	// Score is retorno.score, documented as a string.
	Score Text `json:"score"`
	// ScoreObservacao is retorno.scoreObservacao, documented as a string.
	ScoreObservacao Text `json:"scoreObservacao"`
}

SCRBacenDetalhadaRetorno is retorno in the answer of SCRBacenDetalhada.

type SCRBacenDetalhadaRetornoCarteiraCredito 

type SCRBacenDetalhadaRetornoCarteiraCredito struct {
	// Limite is retorno.carteiraCredito.limite, documented as a string.
	Limite Text `json:"limite"`
	// Prejuizo is retorno.carteiraCredito.prejuizo, documented as a string.
	Prejuizo Text `json:"prejuizo"`
	// Total is retorno.carteiraCredito.total, documented as a string.
	Total Text `json:"total"`
	// Vencer is retorno.carteiraCredito.vencer, documented as a string.
	Vencer Text `json:"vencer"`
	// Vencido is retorno.carteiraCredito.vencido, documented as a string.
	Vencido Text `json:"vencido"`
}

SCRBacenDetalhadaRetornoCarteiraCredito is retorno.carteiraCredito in the answer of SCRBacenDetalhada.

type SCRBacenDetalhadaRetornoModalidades 

type SCRBacenDetalhadaRetornoModalidades struct {
	// AVencer is retorno.modalidades[].aVencer.
	AVencer SCRBacenDetalhadaRetornoModalidadesAVencer `json:"aVencer"`
	// CodigoModalidade is retorno.modalidades[].codigoModalidade, documented as a string.
	CodigoModalidade Text `json:"codigoModalidade"`
	// DescricaoModalidade is retorno.modalidades[].descricaoModalidade, documented as a string.
	DescricaoModalidade Text `json:"descricaoModalidade"`
	// LimiteCredito is retorno.modalidades[].limiteCredito, documented as a string.
	LimiteCredito Text `json:"limiteCredito"`
	// Prejuizo is retorno.modalidades[].prejuizo.
	Prejuizo SCRBacenDetalhadaRetornoModalidadesPrejuizo `json:"prejuizo"`
	// VariacaoCambial is retorno.modalidades[].variacaoCambial, documented as a string.
	VariacaoCambial Text `json:"variacaoCambial"`
	// Vencido is retorno.modalidades[].vencido.
	Vencido SCRBacenDetalhadaRetornoModalidadesVencido `json:"vencido"`
}

SCRBacenDetalhadaRetornoModalidades is retorno.modalidades[] in the answer of SCRBacenDetalhada.

type SCRBacenDetalhadaRetornoModalidadesAVencer 

type SCRBacenDetalhadaRetornoModalidadesAVencer struct {
	// AcimaDe361Dias is retorno.modalidades[].aVencer.acimaDe361Dias, documented as a string.
	AcimaDe361Dias Text `json:"acimaDe361Dias"`
	// De181a360Dias is retorno.modalidades[].aVencer.de181a360Dias, documented as a string.
	De181a360Dias Text `json:"de181a360Dias"`
	// De1a30Dias is retorno.modalidades[].aVencer.de1a30Dias, documented as a string.
	De1a30Dias Text `json:"de1a30Dias"`
	// De31a60Dias is retorno.modalidades[].aVencer.de31a60Dias, documented as a string.
	De31a60Dias Text `json:"de31a60Dias"`
	// De61a90Dias is retorno.modalidades[].aVencer.de61a90Dias, documented as a string.
	De61a90Dias Text `json:"de61a90Dias"`
	// De91a180Dias is retorno.modalidades[].aVencer.de91a180Dias, documented as a string.
	De91a180Dias Text `json:"de91a180Dias"`
	// Total is retorno.modalidades[].aVencer.total, documented as a string.
	Total Text `json:"total"`
}

SCRBacenDetalhadaRetornoModalidadesAVencer is retorno.modalidades[].aVencer in the answer of SCRBacenDetalhada.

type SCRBacenDetalhadaRetornoModalidadesPrejuizo 

type SCRBacenDetalhadaRetornoModalidadesPrejuizo struct {
	// AcimaDe48Meses is retorno.modalidades[].prejuizo.acimaDe48Meses, documented as a string.
	AcimaDe48Meses Text `json:"acimaDe48Meses"`
	// Prejuizo12Meses is retorno.modalidades[].prejuizo.prejuizo12Meses, documented as a string.
	Prejuizo12Meses Text `json:"prejuizo12Meses"`
	// Prejuizo24Meses is retorno.modalidades[].prejuizo.prejuizo24Meses, documented as a string.
	Prejuizo24Meses Text `json:"prejuizo24Meses"`
	// Prejuizo36Meses is retorno.modalidades[].prejuizo.prejuizo36Meses, documented as a string.
	Prejuizo36Meses Text `json:"prejuizo36Meses"`
	// Prejuizo48Meses is retorno.modalidades[].prejuizo.prejuizo48Meses, documented as a string.
	Prejuizo48Meses Text `json:"prejuizo48Meses"`
	// Total is retorno.modalidades[].prejuizo.total, documented as a string.
	Total Text `json:"total"`
}

SCRBacenDetalhadaRetornoModalidadesPrejuizo is retorno.modalidades[].prejuizo in the answer of SCRBacenDetalhada.

type SCRBacenDetalhadaRetornoModalidadesVencido 

type SCRBacenDetalhadaRetornoModalidadesVencido struct {
	// AcimaDe361Dias is retorno.modalidades[].vencido.acimaDe361Dias, documented as a string.
	AcimaDe361Dias Text `json:"acimaDe361Dias"`
	// De181a360Dias is retorno.modalidades[].vencido.de181a360Dias, documented as a string.
	De181a360Dias Text `json:"de181a360Dias"`
	// De1a30Dias is retorno.modalidades[].vencido.de1a30Dias, documented as a string.
	De1a30Dias Text `json:"de1a30Dias"`
	// De31a60Dias is retorno.modalidades[].vencido.de31a60Dias, documented as a string.
	De31a60Dias Text `json:"de31a60Dias"`
	// De61a90Dias is retorno.modalidades[].vencido.de61a90Dias, documented as a string.
	De61a90Dias Text `json:"de61a90Dias"`
	// De91a180Dias is retorno.modalidades[].vencido.de91a180Dias, documented as a string.
	De91a180Dias Text `json:"de91a180Dias"`
	// Total is retorno.modalidades[].vencido.total, documented as a string.
	Total Text `json:"total"`
}

SCRBacenDetalhadaRetornoModalidadesVencido is retorno.modalidades[].vencido in the answer of SCRBacenDetalhada.

type SCRBacenParams 

type SCRBacenParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

SCRBacenParams are the parameters of SCRBacen (SCR Analítico - Resumo BACEN).

func (SCRBacenParams) Request 

func (p SCRBacenParams) Request() (Request, error)

Request builds the Request for SCRBacen.

type SCRBacenRetorno 

type SCRBacenRetorno struct {
	// CarteiraCredito is retorno.carteiraCredito.
	CarteiraCredito SCRBacenRetornoCarteiraCredito `json:"carteiraCredito"`
	// ClasseRisco is retorno.classeRisco, documented as a string.
	ClasseRisco Text `json:"classeRisco"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Indice is retorno.indice.
	Indice SCRBacenRetornoIndice `json:"indice"`
	// PercentualCategoria is retorno.percentualCategoria.
	PercentualCategoria SCRBacenRetornoPercentualCategoria `json:"percentualCategoria"`
	// PercentualEvolucaoCompromisso is retorno.percentualEvolucaoCompromisso.
	PercentualEvolucaoCompromisso SCRBacenRetornoPercentualEvolucaoCompromisso `json:"percentualEvolucaoCompromisso"`
	// PercentualPrazo is retorno.percentualPrazo.
	PercentualPrazo SCRBacenRetornoPercentualPrazo `json:"percentualPrazo"`
	// PercentualVencido is retorno.percentualVencido.
	PercentualVencido SCRBacenRetornoPercentualVencido `json:"percentualVencido"`
	// Perfil is retorno.perfil, documented as a string.
	Perfil Text `json:"perfil"`
	// QuantidadeInstituicoes is retorno.quantidadeInstituicoes, documented as a number.
	QuantidadeInstituicoes Number `json:"quantidadeInstituicoes"`
	// QuantidadeOperacoes is retorno.quantidadeOperacoes, documented as a number.
	QuantidadeOperacoes Number `json:"quantidadeOperacoes"`
	// Relacionamentos is retorno.relacionamentos, documented as a string.
	Relacionamentos Text `json:"relacionamentos"`
	// Score is retorno.score, documented as a string.
	Score Text `json:"score"`
	// Situacao is retorno.situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Volume is retorno.volume, documented as a string.
	Volume Text `json:"volume"`
}

SCRBacenRetorno is retorno in the answer of SCRBacen.

type SCRBacenRetornoCarteiraCredito 

type SCRBacenRetornoCarteiraCredito struct {
	// ValorVencer is retorno.carteiraCredito.valorVencer, documented as a string.
	ValorVencer Text `json:"valorVencer"`
	// ValorVencida is retorno.carteiraCredito.valorVencida, documented as a string.
	ValorVencida Text `json:"valorVencida"`
}

SCRBacenRetornoCarteiraCredito is retorno.carteiraCredito in the answer of SCRBacen.

type SCRBacenRetornoIndice 

type SCRBacenRetornoIndice struct {
	// Cartao is retorno.indice.cartao, documented as a string.
	Cartao Text `json:"cartao"`
	// ChequeEspecial is retorno.indice.chequeEspecial, documented as a string.
	ChequeEspecial Text `json:"chequeEspecial"`
	// CreditoPessoal is retorno.indice.creditoPessoal, documented as a string.
	CreditoPessoal Text `json:"creditoPessoal"`
	// Total is retorno.indice.total, documented as a string.
	Total Text `json:"total"`
}

SCRBacenRetornoIndice is retorno.indice in the answer of SCRBacen.

type SCRBacenRetornoPercentualCategoria 

type SCRBacenRetornoPercentualCategoria struct {
	// AdiantamentosDepositantes is retorno.percentualCategoria.adiantamentosDepositantes, documented as a string.
	AdiantamentosDepositantes Text `json:"adiantamentosDepositantes"`
	// Cartao is retorno.percentualCategoria.cartao, documented as a string.
	Cartao Text `json:"cartao"`
	// Coobrigacoes is retorno.percentualCategoria.coobrigacoes, documented as a string.
	Coobrigacoes Text `json:"coobrigacoes"`
	// Emprestimos is retorno.percentualCategoria.emprestimos, documented as a string.
	Emprestimos Text `json:"emprestimos"`
	// Financiamentos is retorno.percentualCategoria.financiamentos, documented as a string.
	Financiamentos Text `json:"financiamentos"`
	// FinanciamentosExportacao is retorno.percentualCategoria.financiamentosExportacao, documented as a string.
	FinanciamentosExportacao Text `json:"financiamentosExportacao"`
	// FinanciamentosImobiliarios is retorno.percentualCategoria.financiamentosImobiliarios, documented as a string.
	FinanciamentosImobiliarios Text `json:"financiamentosImobiliarios"`
	// FinanciamentosVeiculos is retorno.percentualCategoria.financiamentosVeiculos, documented as a string.
	FinanciamentosVeiculos Text `json:"financiamentosVeiculos"`
	// LinhaRiscoMaior is retorno.percentualCategoria.linhaRiscoMaior, documented as a string.
	LinhaRiscoMaior Text `json:"linhaRiscoMaior"`
	// OperacoesArrendamento is retorno.percentualCategoria.operacoesArrendamento, documented as a string.
	OperacoesArrendamento Text `json:"operacoesArrendamento"`
	// Outros is retorno.percentualCategoria.outros, documented as a string.
	Outros Text `json:"outros"`
	// OutrosCreditos is retorno.percentualCategoria.outrosCreditos, documented as a string.
	OutrosCreditos Text `json:"outrosCreditos"`
}

SCRBacenRetornoPercentualCategoria is retorno.percentualCategoria in the answer of SCRBacen.

type SCRBacenRetornoPercentualEvolucaoCompromisso 

type SCRBacenRetornoPercentualEvolucaoCompromisso struct {
	// Cartao is retorno.percentualEvolucaoCompromisso.cartao, documented as a string.
	Cartao Text `json:"cartao"`
	// Financiamentos is retorno.percentualEvolucaoCompromisso.financiamentos, documented as a string.
	Financiamentos Text `json:"financiamentos"`
	// MaiorRisco is retorno.percentualEvolucaoCompromisso.maiorRisco, documented as a string.
	MaiorRisco Text `json:"maiorRisco"`
	// Total is retorno.percentualEvolucaoCompromisso.total, documented as a string.
	Total Text `json:"total"`
}

SCRBacenRetornoPercentualEvolucaoCompromisso is retorno.percentualEvolucaoCompromisso in the answer of SCRBacen.

type SCRBacenRetornoPercentualPrazo 

type SCRBacenRetornoPercentualPrazo struct {
	// Curto is retorno.percentualPrazo.curto, documented as a string.
	Curto Text `json:"curto"`
	// Longo is retorno.percentualPrazo.longo, documented as a string.
	Longo Text `json:"longo"`
	// Medio is retorno.percentualPrazo.medio, documented as a string.
	Medio Text `json:"medio"`
}

SCRBacenRetornoPercentualPrazo is retorno.percentualPrazo in the answer of SCRBacen.

type SCRBacenRetornoPercentualVencido 

type SCRBacenRetornoPercentualVencido struct {
	// AdiantamentoDepositos is retorno.percentualVencido.adiantamentoDepositos, documented as a string.
	AdiantamentoDepositos Text `json:"adiantamentoDepositos"`
	// Cartao is retorno.percentualVencido.cartao, documented as a string.
	Cartao Text `json:"cartao"`
	// Emprestimos is retorno.percentualVencido.emprestimos, documented as a string.
	Emprestimos Text `json:"emprestimos"`
	// Financiamentos is retorno.percentualVencido.financiamentos, documented as a string.
	Financiamentos Text `json:"financiamentos"`
	// FinanciamentosImobiliarios is retorno.percentualVencido.financiamentosImobiliarios, documented as a string.
	FinanciamentosImobiliarios Text `json:"financiamentosImobiliarios"`
	// FinanciamentosVeiculos is retorno.percentualVencido.financiamentosVeiculos, documented as a string.
	FinanciamentosVeiculos Text `json:"financiamentosVeiculos"`
}

SCRBacenRetornoPercentualVencido is retorno.percentualVencido in the answer of SCRBacen.

type STMCertidaoNegativauniaoParams 

type STMCertidaoNegativauniaoParams struct {
	// Nome is sent as Nome. Named by the endpoint template only; the parameter table does not list it.
	Nome string
	// CPF is sent as CPF. Named by the endpoint template only; the parameter table does not list it. Checked before any request; sent bare.
	CPF string
	// DataNascimento is sent as DataNascimento. Named by the endpoint template only; the parameter table does not list it.
	DataNascimento string
	// NomeMae is sent as NomeMae. Named by the endpoint template only; the parameter table does not list it.
	NomeMae string
}

STMCertidaoNegativauniaoParams are the parameters of STMCertidaoNegativauniao (STM - Certidão Negativa da União).

func (STMCertidaoNegativauniaoParams) Request 

func (p STMCertidaoNegativauniaoParams) Request() (Request, error)

Request builds the Request for STMCertidaoNegativauniao.

type STMCertidaoNegativauniaoRetorno 

type STMCertidaoNegativauniaoRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PossuiPenalidade is retorno.possuiPenalidade, documented as a boolean.
	PossuiPenalidade Flag `json:"possuiPenalidade"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

STMCertidaoNegativauniaoRetorno is retorno in the answer of STMCertidaoNegativauniao.

type ScoreParams 

type ScoreParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

ScoreParams are the parameters of Score (Score de Crédito - QUOD).

func (ScoreParams) Request 

func (p ScoreParams) Request() (Request, error)

Request builds the Request for Score.

type ScoreRetorno 

type ScoreRetorno struct {
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// PessoaFisica is retorno.pessoaFisica.
	PessoaFisica ScoreRetornoPessoaFisica `json:"pessoaFisica"`
	// PessoaJuridica is retorno.pessoaJuridica.
	PessoaJuridica ScoreRetornoPessoaJuridica `json:"pessoaJuridica"`
}

ScoreRetorno is retorno in the answer of Score.

type ScoreRetornoPessoaFisica 

type ScoreRetornoPessoaFisica struct {
	// CapacidadePagamento is retorno.pessoaFisica.capacidadePagamento, documented as a string.
	CapacidadePagamento Text `json:"capacidadePagamento"`
	// FaixaScore is retorno.pessoaFisica.faixaScore, documented as a string.
	FaixaScore Text `json:"faixaScore"`
	// Perfil is retorno.pessoaFisica.perfil, documented as a string.
	Perfil Text `json:"perfil"`
	// Score is retorno.pessoaFisica.score, documented as a number.
	Score Number `json:"score"`
}

ScoreRetornoPessoaFisica is retorno.pessoaFisica in the answer of Score.

type ScoreRetornoPessoaJuridica 

type ScoreRetornoPessoaJuridica struct {
	// FaixaScore is retorno.pessoaJuridica.faixaScore, documented as a string.
	FaixaScore Text `json:"faixaScore"`
	// IndicadoresNegocio is retorno.pessoaJuridica.indicadoresNegocio, a list.
	IndicadoresNegocio []ScoreRetornoPessoaJuridicaIndicadoresNegocio `json:"indicadoresNegocio"`
	// Motivos is retorno.pessoaJuridica.motivos, a list.
	Motivos []Text `json:"motivos"`
	// Score is retorno.pessoaJuridica.score, documented as a number.
	Score Number `json:"score"`
}

ScoreRetornoPessoaJuridica is retorno.pessoaJuridica in the answer of Score.

type ScoreRetornoPessoaJuridicaIndicadoresNegocio 

type ScoreRetornoPessoaJuridicaIndicadoresNegocio struct {
	// Indicador is retorno.pessoaJuridica.indicadoresNegocio[].indicador, documented as a string.
	Indicador Text `json:"indicador"`
	// Observacao is retorno.pessoaJuridica.indicadoresNegocio[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Risco is retorno.pessoaJuridica.indicadoresNegocio[].risco, documented as a string.
	Risco Text `json:"risco"`
	// Status is retorno.pessoaJuridica.indicadoresNegocio[].status, documented as a string.
	Status Text `json:"status"`
}

ScoreRetornoPessoaJuridicaIndicadoresNegocio is retorno.pessoaJuridica.indicadoresNegocio[] in the answer of Score.

type SecretHeaderVerifier 

type SecretHeaderVerifier struct {
	// Header is the header holding the secret.
	Header string
	// Secret is the expected value.
	Secret Token
}

SecretHeaderVerifier accepts a callback whose header Header holds Secret, compared in constant time, for when the portal lets the callback carry a header.

func (SecretHeaderVerifier) VerifyCallback 

func (v SecretHeaderVerifier) VerifyCallback(r CallbackRequest) error

VerifyCallback compares the header with the secret.

type SecretQueryVerifier 

type SecretQueryVerifier struct {
	// Param is the query parameter holding the secret.
	Param string
	// Secret is the expected value.
	Secret Token
}

SecretQueryVerifier accepts a callback whose query parameter Param holds Secret, compared in constant time. It fits a callback URL registered in the portal with a secret of the application's own in it, such as https://app.example/directd/callback?k=<secret>. The secret travels in the URL, so it is only as private as the logs of every hop that sees the URL.

func (SecretQueryVerifier) VerifyCallback 

func (v SecretQueryVerifier) VerifyCallback(r CallbackRequest) error

VerifyCallback compares the parameter with the secret.

type SeguroDefesoParams 

type SeguroDefesoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Nis is sent as Nis. O parâmetro NIS pode ser enviado com ou sem formatação.
	Nis string
}

SeguroDefesoParams are the parameters of SeguroDefeso (Seguro Defeso).

func (SeguroDefesoParams) Request 

func (p SeguroDefesoParams) Request() (Request, error)

Request builds the Request for SeguroDefeso.

type SeguroDefesoRetorno 

type SeguroDefesoRetorno struct {
	// Beneficios is retorno.beneficios, a list.
	Beneficios []SeguroDefesoRetornoBeneficios `json:"beneficios"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Nis is retorno.nis, documented as a string.
	Nis Text `json:"nis" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Rgp is retorno.rgp, documented as a string.
	Rgp Text `json:"rgp"`
}

SeguroDefesoRetorno is retorno in the answer of SeguroDefeso.

type SeguroDefesoRetornoBeneficios 

type SeguroDefesoRetornoBeneficios struct {
	// Data is retorno.beneficios[].data, documented as a string.
	Data Text `json:"data"`
	// Municipio is retorno.beneficios[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NumeroParcela is retorno.beneficios[].numeroParcela, documented as a number.
	NumeroParcela Number `json:"numeroParcela"`
	// Portaria is retorno.beneficios[].portaria, documented as a string.
	Portaria Text `json:"portaria"`
	// Situacao is retorno.beneficios[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Uf is retorno.beneficios[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Valor is retorno.beneficios[].valor, documented as a string.
	Valor Text `json:"valor"`
}

SeguroDefesoRetornoBeneficios is retorno.beneficios[] in the answer of SeguroDefeso.

type SimilarityArgentinaParams 

type SimilarityArgentinaParams struct {
	// DNI is sent as DNI. O parâmetro DNI pode ser enviado com ou sem formatação. Este parâmetro é obrigatório.
	DNI string
	// Name is sent as Name. O parâmetro NAME pode ser enviado com qualquer outro.
	Name string
	// Surname is sent as Surname. O parâmetro SURNAME pode ser enviado com qualquer outro.
	Surname string
	// DOB is sent as DOB. O parâmetro DOB deve ser fornecido, com ou sem formatação.
	DOB string
	// Address is sent as Address. ENDEREÇO - Ex: Av. Santa Fe, 3250.
	Address string
	// City is sent as City. NOME DA CIDADE.
	City string
	// State is sent as State. ESTADO - Ex: BUE.
	State string
	// PostCode is sent as PostCode. CEP - Ex: 1425.
	PostCode string
	// Phone is sent as Phone. Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 11987654321 | 11912345678.
	Phone string
}

SimilarityArgentinaParams are the parameters of SimilarityArgentina (Similarity - Argentina).

func (SimilarityArgentinaParams) Request 

func (p SimilarityArgentinaParams) Request() (Request, error)

Request builds the Request for SimilarityArgentina.

type SimilarityArgentinaRetorno 

type SimilarityArgentinaRetorno struct {
	// Address is retorno.address.
	Address SimilarityArgentinaRetornoAddress `json:"address"`
	// City is retorno.city.
	City SimilarityArgentinaRetornoCity `json:"city"`
	// Dni is retorno.dni.
	Dni SimilarityArgentinaRetornoDni `json:"dni"`
	// Dob is retorno.dob.
	Dob SimilarityArgentinaRetornoDob `json:"dob"`
	// Name is retorno.name.
	Name SimilarityArgentinaRetornoName `json:"name"`
	// Phone is retorno.phone, a list.
	Phone []SimilarityArgentinaRetornoPhone `json:"phone"`
	// PostCode is retorno.postCode.
	PostCode SimilarityArgentinaRetornoPostCode `json:"postCode"`
	// State is retorno.state.
	State SimilarityArgentinaRetornoState `json:"state"`
}

SimilarityArgentinaRetorno is retorno in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoAddress 

type SimilarityArgentinaRetornoAddress struct {
	// Address is retorno.address.address, documented as a string.
	Address Text `json:"address" pii:"address"`
	// Description is retorno.address.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.address.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityArgentinaRetornoAddress is retorno.address in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoCity 

type SimilarityArgentinaRetornoCity struct {
	// City is retorno.city.city, documented as a string.
	City Text `json:"city" pii:"address"`
	// Description is retorno.city.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.city.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityArgentinaRetornoCity is retorno.city in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoDni 

type SimilarityArgentinaRetornoDni struct {
	// Description is retorno.dni.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.dni.distance, documented as a number.
	Distance Number `json:"distance"`
	// Dni is retorno.dni.dni, documented as a string.
	Dni Text `json:"dni" pii:"document"`
}

SimilarityArgentinaRetornoDni is retorno.dni in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoDob 

type SimilarityArgentinaRetornoDob struct {
	// Description is retorno.dob.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.dob.distance, documented as a number.
	Distance Number `json:"distance"`
	// Dob is retorno.dob.dob, documented as a string.
	Dob Text `json:"dob" pii:"birthdate"`
}

SimilarityArgentinaRetornoDob is retorno.dob in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoName 

type SimilarityArgentinaRetornoName struct {
	// Description is retorno.name.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.name.distance, documented as a number.
	Distance Number `json:"distance"`
	// Name is retorno.name.name, documented as a string.
	Name Text `json:"name" pii:"name"`
}

SimilarityArgentinaRetornoName is retorno.name in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoPhone 

type SimilarityArgentinaRetornoPhone struct {
	// Description is retorno.phone[].description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.phone[].distance, documented as a number.
	Distance Number `json:"distance"`
	// Phone is retorno.phone[].phone, documented as a string.
	Phone Text `json:"phone" pii:"phone"`
}

SimilarityArgentinaRetornoPhone is retorno.phone[] in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoPostCode 

type SimilarityArgentinaRetornoPostCode struct {
	// Description is retorno.postCode.description, documented as a string.
	Description Text `json:"description"`
	// DescriptionOnFirstFiveDigits is retorno.postCode.descriptionOnFirstFiveDigits, documented as a string.
	DescriptionOnFirstFiveDigits Text `json:"descriptionOnFirstFiveDigits"`
	// Distance is retorno.postCode.distance, documented as a number.
	Distance Number `json:"distance"`
	// DistanceOnFirstFiveDigits is retorno.postCode.distanceOnFirstFiveDigits, documented as a number.
	DistanceOnFirstFiveDigits Number `json:"distanceOnFirstFiveDigits"`
	// PostCode is retorno.postCode.postCode, documented as a string.
	PostCode Text `json:"postCode" pii:"address"`
}

SimilarityArgentinaRetornoPostCode is retorno.postCode in the answer of SimilarityArgentina.

type SimilarityArgentinaRetornoState 

type SimilarityArgentinaRetornoState struct {
	// Description is retorno.state.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.state.distance, documented as a number.
	Distance Number `json:"distance"`
	// State is retorno.state.state, documented as a string.
	State Text `json:"state"`
}

SimilarityArgentinaRetornoState is retorno.state in the answer of SimilarityArgentina.

type SimilarityMexicoParams 

type SimilarityMexicoParams struct {
	// CURP is sent as CURP. O parâmetro CURP pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'.
	CURP string
	// Name is sent as Name. O parâmetro NAME pode ser enviado com qualquer outro.
	Name string
	// Surname is sent as Surname. O parâmetro SURNAME pode ser enviado com qualquer outro.
	Surname string
	// DOB is sent as DOB. O parâmetro DOB deve ser fornecido, com ou sem formatação.
	DOB string
	// Address is sent as Address. ENDEREÇO - Ex: Calle Colinas Del Valle, 3150.
	Address string
	// City is sent as City. NOME DA CIDADE.
	City string
	// State is sent as State. ESTADO - Ex: CHI.
	State string
	// PostCode is sent as PostCode. CEP - Ex: 22206.
	PostCode string
	// Phone is sent as Phone. Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 6641769451 | 4659554184.
	Phone string
}

SimilarityMexicoParams are the parameters of SimilarityMexico (Similarity - México).

func (SimilarityMexicoParams) Request 

func (p SimilarityMexicoParams) Request() (Request, error)

Request builds the Request for SimilarityMexico.

type SimilarityMexicoRetorno 

type SimilarityMexicoRetorno struct {
	// Address is retorno.address.
	Address SimilarityMexicoRetornoAddress `json:"address"`
	// City is retorno.city.
	City SimilarityMexicoRetornoCity `json:"city"`
	// Curp is retorno.curp.
	Curp SimilarityMexicoRetornoCurp `json:"curp"`
	// Dob is retorno.dob.
	Dob SimilarityMexicoRetornoDob `json:"dob"`
	// Name is retorno.name.
	Name SimilarityMexicoRetornoName `json:"name"`
	// Phone is retorno.phone, a list.
	Phone []SimilarityMexicoRetornoPhone `json:"phone"`
	// PostCode is retorno.postCode.
	PostCode SimilarityMexicoRetornoPostCode `json:"postCode"`
	// State is retorno.state.
	State SimilarityMexicoRetornoState `json:"state"`
}

SimilarityMexicoRetorno is retorno in the answer of SimilarityMexico.

type SimilarityMexicoRetornoAddress 

type SimilarityMexicoRetornoAddress struct {
	// Address is retorno.address.address, documented as a string.
	Address Text `json:"address" pii:"address"`
	// Description is retorno.address.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.address.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityMexicoRetornoAddress is retorno.address in the answer of SimilarityMexico.

type SimilarityMexicoRetornoCity 

type SimilarityMexicoRetornoCity struct {
	// City is retorno.city.city, documented as a string.
	City Text `json:"city" pii:"address"`
	// Description is retorno.city.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.city.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityMexicoRetornoCity is retorno.city in the answer of SimilarityMexico.

type SimilarityMexicoRetornoCurp 

type SimilarityMexicoRetornoCurp struct {
	// Curp is retorno.curp.curp, documented as a string.
	Curp Text `json:"curp" pii:"document"`
	// Description is retorno.curp.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.curp.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityMexicoRetornoCurp is retorno.curp in the answer of SimilarityMexico.

type SimilarityMexicoRetornoDob 

type SimilarityMexicoRetornoDob struct {
	// Description is retorno.dob.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.dob.distance, documented as a number.
	Distance Number `json:"distance"`
	// Dob is retorno.dob.dob, documented as a string.
	Dob Text `json:"dob" pii:"birthdate"`
}

SimilarityMexicoRetornoDob is retorno.dob in the answer of SimilarityMexico.

type SimilarityMexicoRetornoName 

type SimilarityMexicoRetornoName struct {
	// Description is retorno.name.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.name.distance, documented as a number.
	Distance Number `json:"distance"`
	// Name is retorno.name.name, documented as a string.
	Name Text `json:"name" pii:"name"`
}

SimilarityMexicoRetornoName is retorno.name in the answer of SimilarityMexico.

type SimilarityMexicoRetornoPhone 

type SimilarityMexicoRetornoPhone struct {
	// Description is retorno.phone[].description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.phone[].distance, documented as a number.
	Distance Number `json:"distance"`
	// Phone is retorno.phone[].phone, documented as a string.
	Phone Text `json:"phone" pii:"phone"`
}

SimilarityMexicoRetornoPhone is retorno.phone[] in the answer of SimilarityMexico.

type SimilarityMexicoRetornoPostCode 

type SimilarityMexicoRetornoPostCode struct {
	// Description is retorno.postCode.description, documented as a string.
	Description Text `json:"description"`
	// DescriptionOnFirstFiveDigits is retorno.postCode.descriptionOnFirstFiveDigits, documented as a string.
	DescriptionOnFirstFiveDigits Text `json:"descriptionOnFirstFiveDigits"`
	// Distance is retorno.postCode.distance, documented as a number.
	Distance Number `json:"distance"`
	// DistanceOnFirstFiveDigits is retorno.postCode.distanceOnFirstFiveDigits, documented as a number.
	DistanceOnFirstFiveDigits Number `json:"distanceOnFirstFiveDigits"`
	// PostCode is retorno.postCode.postCode, documented as a string.
	PostCode Text `json:"postCode" pii:"address"`
}

SimilarityMexicoRetornoPostCode is retorno.postCode in the answer of SimilarityMexico.

type SimilarityMexicoRetornoState 

type SimilarityMexicoRetornoState struct {
	// Description is retorno.state.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.state.distance, documented as a number.
	Distance Number `json:"distance"`
	// State is retorno.state.state, documented as a string.
	State Text `json:"state"`
}

SimilarityMexicoRetornoState is retorno.state in the answer of SimilarityMexico.

type SimilarityParams 

type SimilarityParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Este parâmetro não é obrigatório, mas caso não utilizado, enviar os parâmetros 'NAME', 'SURNAME' e 'DOB'. Checked before any request; sent bare.
	CPF string
	// Name is sent as Name. O parâmetro NAME pode ser enviado com qualquer outro.
	Name string
	// Surname is sent as Surname. O parâmetro SURNAME pode ser enviado com qualquer outro.
	Surname string
	// DOB is sent as DOB. DATA DE NASCIMENTO - Ex: yyyy/MM/dd.
	DOB string
	// Address is sent as Address. ENDEREÇO - Ex: Rua Óbidos, 674.
	Address string
	// City is sent as City. NOME DA CIDADE.
	City string
	// State is sent as State. ESTADO - Ex: SP.
	State string
	// PostCode is sent as PostCode. CEP - Ex: 12345-123.
	PostCode string
	// Phone is sent as Phone. Caso haja mais de um telefone, use “|” (sem aspas) para separá-los. Ex: 11912345678 | 11987654321.
	Phone string
}

SimilarityParams are the parameters of Similarity (Similarity - Brazil).

func (SimilarityParams) Request 

func (p SimilarityParams) Request() (Request, error)

Request builds the Request for Similarity.

type SimilarityRetorno 

type SimilarityRetorno struct {
	// Address is retorno.address.
	Address SimilarityRetornoAddress `json:"address"`
	// City is retorno.city.
	City SimilarityRetornoCity `json:"city"`
	// Cpf is retorno.cpf.
	Cpf SimilarityRetornoCpf `json:"cpf"`
	// Dob is retorno.dob.
	Dob SimilarityRetornoDob `json:"dob"`
	// Name is retorno.name.
	Name SimilarityRetornoName `json:"name"`
	// Phone is retorno.phone, a list.
	Phone []SimilarityRetornoPhone `json:"phone"`
	// PostCode is retorno.postCode.
	PostCode SimilarityRetornoPostCode `json:"postCode"`
	// State is retorno.state.
	State SimilarityRetornoState `json:"state"`
}

SimilarityRetorno is retorno in the answer of Similarity.

type SimilarityRetornoAddress 

type SimilarityRetornoAddress struct {
	// Address is retorno.address.address, documented as a string.
	Address Text `json:"address" pii:"address"`
	// Description is retorno.address.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.address.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityRetornoAddress is retorno.address in the answer of Similarity.

type SimilarityRetornoCity 

type SimilarityRetornoCity struct {
	// City is retorno.city.city, documented as a string.
	City Text `json:"city" pii:"address"`
	// Description is retorno.city.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.city.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityRetornoCity is retorno.city in the answer of Similarity.

type SimilarityRetornoCpf 

type SimilarityRetornoCpf struct {
	// Cpf is retorno.cpf.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// Description is retorno.cpf.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.cpf.distance, documented as a number.
	Distance Number `json:"distance"`
}

SimilarityRetornoCpf is retorno.cpf in the answer of Similarity.

type SimilarityRetornoDob 

type SimilarityRetornoDob struct {
	// Description is retorno.dob.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.dob.distance, documented as a number.
	Distance Number `json:"distance"`
	// Dob is retorno.dob.dob, documented as a string.
	Dob Text `json:"dob" pii:"birthdate"`
}

SimilarityRetornoDob is retorno.dob in the answer of Similarity.

type SimilarityRetornoName 

type SimilarityRetornoName struct {
	// Description is retorno.name.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.name.distance, documented as a number.
	Distance Number `json:"distance"`
	// Name is retorno.name.name, documented as a string.
	Name Text `json:"name" pii:"name"`
}

SimilarityRetornoName is retorno.name in the answer of Similarity.

type SimilarityRetornoPhone 

type SimilarityRetornoPhone struct {
	// Description is retorno.phone[].description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.phone[].distance, documented as a number.
	Distance Number `json:"distance"`
	// Phone is retorno.phone[].phone, documented as a string.
	Phone Text `json:"phone" pii:"phone"`
}

SimilarityRetornoPhone is retorno.phone[] in the answer of Similarity.

type SimilarityRetornoPostCode 

type SimilarityRetornoPostCode struct {
	// Description is retorno.postCode.description, documented as a string.
	Description Text `json:"description"`
	// DescriptionOnFirstFiveDigits is retorno.postCode.descriptionOnFirstFiveDigits, documented as a string.
	DescriptionOnFirstFiveDigits Text `json:"descriptionOnFirstFiveDigits"`
	// Distance is retorno.postCode.distance, documented as a number.
	Distance Number `json:"distance"`
	// DistanceOnFirstFiveDigits is retorno.postCode.distanceOnFirstFiveDigits, documented as a number.
	DistanceOnFirstFiveDigits Number `json:"distanceOnFirstFiveDigits"`
	// PostCode is retorno.postCode.postCode, documented as a string.
	PostCode Text `json:"postCode" pii:"address"`
}

SimilarityRetornoPostCode is retorno.postCode in the answer of Similarity.

type SimilarityRetornoState 

type SimilarityRetornoState struct {
	// Description is retorno.state.description, documented as a string.
	Description Text `json:"description"`
	// Distance is retorno.state.distance, documented as a number.
	Distance Number `json:"distance"`
	// State is retorno.state.state, documented as a string.
	State Text `json:"state"`
}

SimilarityRetornoState is retorno.state in the answer of Similarity.

type SimplesNacionalParams 

type SimplesNacionalParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

SimplesNacionalParams are the parameters of SimplesNacional (Simples Nacional).

func (SimplesNacionalParams) Request 

func (p SimplesNacionalParams) Request() (Request, error)

Request builds the Request for SimplesNacional.

type SimplesNacionalRetorno 

type SimplesNacionalRetorno struct {
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// EnquadradoSIMEI is retorno.enquadradoSIMEI, documented as a boolean.
	EnquadradoSIMEI Flag `json:"enquadradoSIMEI"`
	// EventosFuturosSIMEI is retorno.eventosFuturosSIMEI, a list.
	EventosFuturosSIMEI []SimplesNacionalRetornoEventosFuturosSIMEI `json:"eventosFuturosSIMEI"`
	// EventosFuturosSimplesNacional is retorno.eventosFuturosSimplesNacional, a list.
	EventosFuturosSimplesNacional []SimplesNacionalRetornoEventosFuturosSimplesNacional `json:"eventosFuturosSimplesNacional"`
	// MeiTransportadorAutonomo is retorno.meiTransportadorAutonomo, a list.
	MeiTransportadorAutonomo []SimplesNacionalRetornoMeiTransportadorAutonomo `json:"meiTransportadorAutonomo"`
	// NomeEmpresarial is retorno.nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// OptanteSimplesNacional is retorno.optanteSimplesNacional, documented as a boolean.
	OptanteSimplesNacional Flag `json:"optanteSimplesNacional"`
	// SimeiPeriodosAnteriores is retorno.simeiPeriodosAnteriores, a list.
	SimeiPeriodosAnteriores []SimplesNacionalRetornoSimeiPeriodosAnteriores `json:"simeiPeriodosAnteriores"`
	// SimplesNacionalPeriodosAnteriores is retorno.simplesNacionalPeriodosAnteriores, a list.
	SimplesNacionalPeriodosAnteriores []SimplesNacionalRetornoSimplesNacionalPeriodosAnteriores `json:"simplesNacionalPeriodosAnteriores"`
	// SituacaoSIMEI is retorno.situacaoSIMEI, documented as a string.
	SituacaoSIMEI Text `json:"situacaoSIMEI"`
	// SituacaoSimplesNacional is retorno.situacaoSimplesNacional, documented as a string.
	SituacaoSimplesNacional Text `json:"situacaoSimplesNacional"`
}

SimplesNacionalRetorno is retorno in the answer of SimplesNacional.

type SimplesNacionalRetornoEventosFuturosSIMEI 

type SimplesNacionalRetornoEventosFuturosSIMEI struct {
	// DataFim is retorno.eventosFuturosSIMEI[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.eventosFuturosSIMEI[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Detalhamento is retorno.eventosFuturosSIMEI[].detalhamento, documented as a string.
	Detalhamento Text `json:"detalhamento"`
}

SimplesNacionalRetornoEventosFuturosSIMEI is retorno.eventosFuturosSIMEI[] in the answer of SimplesNacional.

type SimplesNacionalRetornoEventosFuturosSimplesNacional 

type SimplesNacionalRetornoEventosFuturosSimplesNacional struct {
	// DataFim is retorno.eventosFuturosSimplesNacional[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.eventosFuturosSimplesNacional[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Detalhamento is retorno.eventosFuturosSimplesNacional[].detalhamento, documented as a string.
	Detalhamento Text `json:"detalhamento"`
}

SimplesNacionalRetornoEventosFuturosSimplesNacional is retorno.eventosFuturosSimplesNacional[] in the answer of SimplesNacional.

type SimplesNacionalRetornoMeiTransportadorAutonomo 

type SimplesNacionalRetornoMeiTransportadorAutonomo struct {
	// DataFim is retorno.meiTransportadorAutonomo[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.meiTransportadorAutonomo[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Detalhamento is retorno.meiTransportadorAutonomo[].detalhamento, documented as a string.
	Detalhamento Text `json:"detalhamento"`
}

SimplesNacionalRetornoMeiTransportadorAutonomo is retorno.meiTransportadorAutonomo[] in the answer of SimplesNacional.

type SimplesNacionalRetornoSimeiPeriodosAnteriores 

type SimplesNacionalRetornoSimeiPeriodosAnteriores struct {
	// DataFim is retorno.simeiPeriodosAnteriores[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.simeiPeriodosAnteriores[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Detalhamento is retorno.simeiPeriodosAnteriores[].detalhamento, documented as a string.
	Detalhamento Text `json:"detalhamento"`
}

SimplesNacionalRetornoSimeiPeriodosAnteriores is retorno.simeiPeriodosAnteriores[] in the answer of SimplesNacional.

type SimplesNacionalRetornoSimplesNacionalPeriodosAnteriores 

type SimplesNacionalRetornoSimplesNacionalPeriodosAnteriores struct {
	// DataFim is retorno.simplesNacionalPeriodosAnteriores[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.simplesNacionalPeriodosAnteriores[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Detalhamento is retorno.simplesNacionalPeriodosAnteriores[].detalhamento, documented as a string.
	Detalhamento Text `json:"detalhamento"`
}

SimplesNacionalRetornoSimplesNacionalPeriodosAnteriores is retorno.simplesNacionalPeriodosAnteriores[] in the answer of SimplesNacional.

type SintegraCCCCompletaParams 

type SintegraCCCCompletaParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Ie is sent as ie. O parâmetro IE pode ser enviado com ou sem formatação.
	Ie string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Uf is sent as Uf. Not described by the documentation.
	Uf string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

SintegraCCCCompletaParams are the parameters of SintegraCCC-Completa (Sintegra - CCC - Completa).

func (SintegraCCCCompletaParams) Request 

func (p SintegraCCCCompletaParams) Request() (Request, error)

Request builds the Request for SintegraCCC-Completa.

type SintegraCCCCompletaRetorno 

type SintegraCCCCompletaRetorno struct {
	// AtividadeEconomicaPrincipal is retorno.atividadeEconomicaPrincipal, documented as a string.
	AtividadeEconomicaPrincipal Text `json:"atividadeEconomicaPrincipal"`
	// AtividadesEconomicasSecundarias is retorno.atividadesEconomicasSecundarias, a list.
	AtividadesEconomicasSecundarias []Text `json:"atividadesEconomicasSecundarias"`
	// Bairro is retorno.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// CodigoControle is retorno.codigoControle, documented as a string.
	CodigoControle Text `json:"codigoControle"`
	// Complemento is retorno.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataAbertura is retorno.dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataCredenciamentoEmissorNFe is retorno.dataCredenciamentoEmissorNFe, documented as a string.
	DataCredenciamentoEmissorNFe Text `json:"dataCredenciamentoEmissorNFe"`
	// DataFimAtividade is retorno.dataFimAtividade, documented as a string.
	DataFimAtividade Text `json:"dataFimAtividade"`
	// DataInicioAtividade is retorno.dataInicioAtividade, documented as a string.
	DataInicioAtividade Text `json:"dataInicioAtividade"`
	// DataInicioObrigatoriedadeNFe is retorno.dataInicioObrigatoriedadeNFe, documented as a string.
	DataInicioObrigatoriedadeNFe Text `json:"dataInicioObrigatoriedadeNFe"`
	// DataSituacaoCadastral is retorno.dataSituacaoCadastral, documented as a string.
	DataSituacaoCadastral Text `json:"dataSituacaoCadastral"`
	// Email is retorno.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Ie is retorno.ie, documented as a string.
	Ie Text `json:"ie" pii:"document"`
	// IndicadorObrigatoriedadeNFe is retorno.indicadorObrigatoriedadeNFe, documented as a string.
	IndicadorObrigatoriedadeNFe Text `json:"indicadorObrigatoriedadeNFe"`
	// InformacaoIBGE is retorno.informacaoIBGE.
	InformacaoIBGE SintegraCCCCompletaRetornoInformacaoIBGE `json:"informacaoIBGE"`
	// InscricoesEstaduaisSintegra is retorno.inscricoesEstaduaisSintegra, a list.
	InscricoesEstaduaisSintegra []SintegraCCCCompletaRetornoInscricoesEstaduaisSintegra `json:"inscricoesEstaduaisSintegra"`
	// Logradouro is retorno.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// MotivoSituacaoCadastral is retorno.motivoSituacaoCadastral, documented as a string.
	MotivoSituacaoCadastral Text `json:"motivoSituacaoCadastral"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NaturezaJuridica is retorno.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// NomeEmpresarial is retorno.nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// Numero is retorno.numero, documented as a number.
	Numero Number `json:"numero" pii:"address"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// OcorrenciaFiscal is retorno.ocorrenciaFiscal, documented as a string.
	OcorrenciaFiscal Text `json:"ocorrenciaFiscal"`
	// RegimeApuracao is retorno.regimeApuracao, documented as a string.
	RegimeApuracao Text `json:"regimeApuracao"`
	// SituacaoCNPJ is retorno.situacaoCNPJ, documented as a string.
	SituacaoCNPJ Text `json:"situacaoCNPJ" pii:"document"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// SituacaoContribuinteNaData is retorno.situacaoContribuinteNaData, documented as a string.
	SituacaoContribuinteNaData Text `json:"situacaoContribuinteNaData"`
	// Telefone is retorno.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TipoIE is retorno.tipoIE, documented as a string.
	TipoIE Text `json:"tipoIE"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Ufie is retorno.ufie, documented as a string.
	Ufie Text `json:"ufie"`
}

SintegraCCCCompletaRetorno is retorno in the answer of SintegraCCC-Completa.

type SintegraCCCCompletaRetornoInformacaoIBGE 

type SintegraCCCCompletaRetornoInformacaoIBGE struct {
	// Cidade is retorno.informacaoIBGE.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Codigo is retorno.informacaoIBGE.codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// DataConsulta is retorno.informacaoIBGE.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Tipo is retorno.informacaoIBGE.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Uf is retorno.informacaoIBGE.uf, documented as a string.
	Uf Text `json:"uf"`
}

SintegraCCCCompletaRetornoInformacaoIBGE is retorno.informacaoIBGE in the answer of SintegraCCC-Completa.

type SintegraCCCCompletaRetornoInscricoesEstaduaisSintegra 

type SintegraCCCCompletaRetornoInscricoesEstaduaisSintegra struct {
	// AtividadeEconomicaPrincipal is retorno.inscricoesEstaduaisSintegra[].atividadeEconomicaPrincipal, documented as a string.
	AtividadeEconomicaPrincipal Text `json:"atividadeEconomicaPrincipal"`
	// AtividadesEconomicasSecundarias is retorno.inscricoesEstaduaisSintegra[].atividadesEconomicasSecundarias, a list.
	AtividadesEconomicasSecundarias []Text `json:"atividadesEconomicasSecundarias"`
	// Bairro is retorno.inscricoesEstaduaisSintegra[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.inscricoesEstaduaisSintegra[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cnpj is retorno.inscricoesEstaduaisSintegra[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// CodigoControle is retorno.inscricoesEstaduaisSintegra[].codigoControle, documented as a string.
	CodigoControle Text `json:"codigoControle"`
	// Complemento is retorno.inscricoesEstaduaisSintegra[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Cpf is retorno.inscricoesEstaduaisSintegra[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataAbertura is retorno.inscricoesEstaduaisSintegra[].dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataConsulta is retorno.inscricoesEstaduaisSintegra[].dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataCredenciamentoEmissorNFe is retorno.inscricoesEstaduaisSintegra[].dataCredenciamentoEmissorNFe, documented as a string.
	DataCredenciamentoEmissorNFe Text `json:"dataCredenciamentoEmissorNFe"`
	// DataFimAtividade is retorno.inscricoesEstaduaisSintegra[].dataFimAtividade, documented as a string.
	DataFimAtividade Text `json:"dataFimAtividade"`
	// DataInicioAtividade is retorno.inscricoesEstaduaisSintegra[].dataInicioAtividade, documented as a string.
	DataInicioAtividade Text `json:"dataInicioAtividade"`
	// DataInicioObrigatoriedadeNFe is retorno.inscricoesEstaduaisSintegra[].dataInicioObrigatoriedadeNFe, documented as a string.
	DataInicioObrigatoriedadeNFe Text `json:"dataInicioObrigatoriedadeNFe"`
	// DataSituacaoCadastral is retorno.inscricoesEstaduaisSintegra[].dataSituacaoCadastral, documented as a string.
	DataSituacaoCadastral Text `json:"dataSituacaoCadastral"`
	// Email is retorno.inscricoesEstaduaisSintegra[].email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Ie is retorno.inscricoesEstaduaisSintegra[].ie, documented as a string.
	Ie Text `json:"ie" pii:"document"`
	// IndicadorObrigatoriedadeNFe is retorno.inscricoesEstaduaisSintegra[].indicadorObrigatoriedadeNFe, documented as a string.
	IndicadorObrigatoriedadeNFe Text `json:"indicadorObrigatoriedadeNFe"`
	// InformacaoIBGE is retorno.inscricoesEstaduaisSintegra[].informacaoIBGE.
	InformacaoIBGE SintegraCCCCompletaRetornoInscricoesEstaduaisSintegraInformacaoIBGE `json:"informacaoIBGE"`
	// Logradouro is retorno.inscricoesEstaduaisSintegra[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// MotivoSituacaoCadastral is retorno.inscricoesEstaduaisSintegra[].motivoSituacaoCadastral, documented as a string.
	MotivoSituacaoCadastral Text `json:"motivoSituacaoCadastral"`
	// Municipio is retorno.inscricoesEstaduaisSintegra[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NaturezaJuridica is retorno.inscricoesEstaduaisSintegra[].naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// NomeEmpresarial is retorno.inscricoesEstaduaisSintegra[].nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// NomeFantasia is retorno.inscricoesEstaduaisSintegra[].nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// Numero is retorno.inscricoesEstaduaisSintegra[].numero, documented as a number.
	Numero Number `json:"numero" pii:"address"`
	// Observacao is retorno.inscricoesEstaduaisSintegra[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// OcorrenciaFiscal is retorno.inscricoesEstaduaisSintegra[].ocorrenciaFiscal, documented as a string.
	OcorrenciaFiscal Text `json:"ocorrenciaFiscal"`
	// RegimeApuracao is retorno.inscricoesEstaduaisSintegra[].regimeApuracao, documented as a string.
	RegimeApuracao Text `json:"regimeApuracao"`
	// SituacaoCNPJ is retorno.inscricoesEstaduaisSintegra[].situacaoCNPJ, documented as a string.
	SituacaoCNPJ Text `json:"situacaoCNPJ" pii:"document"`
	// SituacaoCadastral is retorno.inscricoesEstaduaisSintegra[].situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// SituacaoContribuinteNaData is retorno.inscricoesEstaduaisSintegra[].situacaoContribuinteNaData, documented as a string.
	SituacaoContribuinteNaData Text `json:"situacaoContribuinteNaData"`
	// Telefone is retorno.inscricoesEstaduaisSintegra[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TipoIE is retorno.inscricoesEstaduaisSintegra[].tipoIE, documented as a string.
	TipoIE Text `json:"tipoIE"`
	// Uf is retorno.inscricoesEstaduaisSintegra[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Ufie is retorno.inscricoesEstaduaisSintegra[].ufie, documented as a string.
	Ufie Text `json:"ufie"`
}

SintegraCCCCompletaRetornoInscricoesEstaduaisSintegra is retorno.inscricoesEstaduaisSintegra[] in the answer of SintegraCCC-Completa.

type SintegraCCCCompletaRetornoInscricoesEstaduaisSintegraInformacaoIBGE 

type SintegraCCCCompletaRetornoInscricoesEstaduaisSintegraInformacaoIBGE struct {
	// Cidade is retorno.inscricoesEstaduaisSintegra[].informacaoIBGE.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Codigo is retorno.inscricoesEstaduaisSintegra[].informacaoIBGE.codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// DataConsulta is retorno.inscricoesEstaduaisSintegra[].informacaoIBGE.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Tipo is retorno.inscricoesEstaduaisSintegra[].informacaoIBGE.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Uf is retorno.inscricoesEstaduaisSintegra[].informacaoIBGE.uf, documented as a string.
	Uf Text `json:"uf"`
}

SintegraCCCCompletaRetornoInscricoesEstaduaisSintegraInformacaoIBGE is retorno.inscricoesEstaduaisSintegra[].informacaoIBGE in the answer of SintegraCCC-Completa.

type SintegraCCCParams 

type SintegraCCCParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Ie is sent as ie. O parâmetro IE pode ser enviado com ou sem formatação.
	Ie string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Uf is sent as Uf. Not described by the documentation.
	Uf string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

SintegraCCCParams are the parameters of SintegraCCC (Sintegra - Cadastro Centralizado de Contribuinte - CCC).

func (SintegraCCCParams) Request 

func (p SintegraCCCParams) Request() (Request, error)

Request builds the Request for SintegraCCC.

type SintegraCCCRetorno 

type SintegraCCCRetorno struct {
	// AtividadeEconomicaPrincipal is retorno.atividadeEconomicaPrincipal, documented as a string.
	AtividadeEconomicaPrincipal Text `json:"atividadeEconomicaPrincipal"`
	// AtividadesEconomicasSecundarias is retorno.atividadesEconomicasSecundarias, a list.
	AtividadesEconomicasSecundarias []Text `json:"atividadesEconomicasSecundarias"`
	// Bairro is retorno.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// CodigoControle is retorno.codigoControle, documented as a string.
	CodigoControle Text `json:"codigoControle"`
	// Complemento is retorno.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataAbertura is retorno.dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataCredenciamentoEmissorNFe is retorno.dataCredenciamentoEmissorNFe, documented as a string.
	DataCredenciamentoEmissorNFe Text `json:"dataCredenciamentoEmissorNFe"`
	// DataFimAtividade is retorno.dataFimAtividade, documented as a string.
	DataFimAtividade Text `json:"dataFimAtividade"`
	// DataInicioAtividade is retorno.dataInicioAtividade, documented as a string.
	DataInicioAtividade Text `json:"dataInicioAtividade"`
	// DataInicioObrigatoriedadeNFe is retorno.dataInicioObrigatoriedadeNFe, documented as a string.
	DataInicioObrigatoriedadeNFe Text `json:"dataInicioObrigatoriedadeNFe"`
	// DataSituacaoCadastral is retorno.dataSituacaoCadastral, documented as a string.
	DataSituacaoCadastral Text `json:"dataSituacaoCadastral"`
	// Email is retorno.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Ie is retorno.ie, documented as a string.
	Ie Text `json:"ie" pii:"document"`
	// IndicadorObrigatoriedadeNFe is retorno.indicadorObrigatoriedadeNFe, documented as a string.
	IndicadorObrigatoriedadeNFe Text `json:"indicadorObrigatoriedadeNFe"`
	// InformacaoIBGE is retorno.informacaoIBGE.
	InformacaoIBGE SintegraCCCRetornoInformacaoIBGE `json:"informacaoIBGE"`
	// InscricoesEstaduais is retorno.inscricoesEstaduais, a list.
	InscricoesEstaduais []SintegraCCCRetornoInscricoesEstaduais `json:"inscricoesEstaduais"`
	// Logradouro is retorno.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// MotivoSituacaoCadastral is retorno.motivoSituacaoCadastral, documented as a string.
	MotivoSituacaoCadastral Text `json:"motivoSituacaoCadastral"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NaturezaJuridica is retorno.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// NomeEmpresarial is retorno.nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// Numero is retorno.numero, documented as a number.
	Numero Number `json:"numero" pii:"address"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// OcorrenciaFiscal is retorno.ocorrenciaFiscal, documented as a string.
	OcorrenciaFiscal Text `json:"ocorrenciaFiscal"`
	// RegimeApuracao is retorno.regimeApuracao, documented as a string.
	RegimeApuracao Text `json:"regimeApuracao"`
	// SituacaoCNPJ is retorno.situacaoCNPJ, documented as a string.
	SituacaoCNPJ Text `json:"situacaoCNPJ" pii:"document"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// SituacaoContribuinteNaData is retorno.situacaoContribuinteNaData, documented as a string.
	SituacaoContribuinteNaData Text `json:"situacaoContribuinteNaData"`
	// Telefone is retorno.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TipoIE is retorno.tipoIE, documented as a string.
	TipoIE Text `json:"tipoIE"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Ufie is retorno.ufie, documented as a string.
	Ufie Text `json:"ufie"`
}

SintegraCCCRetorno is retorno in the answer of SintegraCCC.

type SintegraCCCRetornoInformacaoIBGE 

type SintegraCCCRetornoInformacaoIBGE struct {
	// Cidade is retorno.informacaoIBGE.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Codigo is retorno.informacaoIBGE.codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// DataConsulta is retorno.informacaoIBGE.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Tipo is retorno.informacaoIBGE.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Uf is retorno.informacaoIBGE.uf, documented as a string.
	Uf Text `json:"uf"`
}

SintegraCCCRetornoInformacaoIBGE is retorno.informacaoIBGE in the answer of SintegraCCC.

type SintegraCCCRetornoInscricoesEstaduais 

type SintegraCCCRetornoInscricoesEstaduais struct {
	// AtivoHabilitada is retorno.inscricoesEstaduais[].ativoHabilitada, documented as a string.
	AtivoHabilitada Text `json:"ativoHabilitada"`
	// Inscricao is retorno.inscricoesEstaduais[].inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
	// Situacao is retorno.inscricoesEstaduais[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Uf is retorno.inscricoesEstaduais[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Vinculo is retorno.inscricoesEstaduais[].vinculo, documented as a string.
	Vinculo Text `json:"vinculo"`
}

SintegraCCCRetornoInscricoesEstaduais is retorno.inscricoesEstaduais[] in the answer of SintegraCCC.

type SintegraParams 

type SintegraParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Ie is sent as ie. O parâmetro IE pode ser enviado com ou sem formatação.
	Ie string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Uf is sent as Uf. Not described by the documentation.
	Uf string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

SintegraParams are the parameters of Sintegra (Sintegra - Cadastros Estaduais).

func (SintegraParams) Request 

func (p SintegraParams) Request() (Request, error)

Request builds the Request for Sintegra.

type SintegraRetorno 

type SintegraRetorno struct {
	// AtividadeEconomicaPrincipal is retorno.atividadeEconomicaPrincipal, documented as a string.
	AtividadeEconomicaPrincipal Text `json:"atividadeEconomicaPrincipal"`
	// AtividadesEconomicasSecundarias is retorno.atividadesEconomicasSecundarias, a list.
	AtividadesEconomicasSecundarias []Text `json:"atividadesEconomicasSecundarias"`
	// Bairro is retorno.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// CodigoControle is retorno.codigoControle, documented as a string.
	CodigoControle Text `json:"codigoControle"`
	// Complemento is retorno.complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// Cpf is retorno.cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataAbertura is retorno.dataAbertura, documented as a string.
	DataAbertura Text `json:"dataAbertura"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataCredenciamentoEmissorNFe is retorno.dataCredenciamentoEmissorNFe, documented as a string.
	DataCredenciamentoEmissorNFe Text `json:"dataCredenciamentoEmissorNFe"`
	// DataFimAtividade is retorno.dataFimAtividade, documented as a string.
	DataFimAtividade Text `json:"dataFimAtividade"`
	// DataInicioAtividade is retorno.dataInicioAtividade, documented as a string.
	DataInicioAtividade Text `json:"dataInicioAtividade"`
	// DataInicioObrigatoriedadeNFe is retorno.dataInicioObrigatoriedadeNFe, documented as a string.
	DataInicioObrigatoriedadeNFe Text `json:"dataInicioObrigatoriedadeNFe"`
	// DataSituacaoCadastral is retorno.dataSituacaoCadastral, documented as a string.
	DataSituacaoCadastral Text `json:"dataSituacaoCadastral"`
	// Email is retorno.email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// Ie is retorno.ie, documented as a string.
	Ie Text `json:"ie" pii:"document"`
	// IndicadorObrigatoriedadeNFe is retorno.indicadorObrigatoriedadeNFe, documented as a string.
	IndicadorObrigatoriedadeNFe Text `json:"indicadorObrigatoriedadeNFe"`
	// InformacaoIBGE is retorno.informacaoIBGE.
	InformacaoIBGE SintegraRetornoInformacaoIBGE `json:"informacaoIBGE"`
	// InscricoesEstaduais is retorno.inscricoesEstaduais, a list.
	InscricoesEstaduais []SintegraRetornoInscricoesEstaduais `json:"inscricoesEstaduais"`
	// Logradouro is retorno.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// MotivoSituacaoCadastral is retorno.motivoSituacaoCadastral, documented as a string.
	MotivoSituacaoCadastral Text `json:"motivoSituacaoCadastral"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// NaturezaJuridica is retorno.naturezaJuridica, documented as a string.
	NaturezaJuridica Text `json:"naturezaJuridica"`
	// NomeEmpresarial is retorno.nomeEmpresarial, documented as a string.
	NomeEmpresarial Text `json:"nomeEmpresarial" pii:"name"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// Numero is retorno.numero, documented as a number.
	Numero Number `json:"numero" pii:"address"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// OcorrenciaFiscal is retorno.ocorrenciaFiscal, documented as a string.
	OcorrenciaFiscal Text `json:"ocorrenciaFiscal"`
	// RegimeApuracao is retorno.regimeApuracao, documented as a string.
	RegimeApuracao Text `json:"regimeApuracao"`
	// SituacaoCNPJ is retorno.situacaoCNPJ, documented as a string.
	SituacaoCNPJ Text `json:"situacaoCNPJ" pii:"document"`
	// SituacaoCadastral is retorno.situacaoCadastral, documented as a string.
	SituacaoCadastral Text `json:"situacaoCadastral"`
	// SituacaoContribuinteNaData is retorno.situacaoContribuinteNaData, documented as a string.
	SituacaoContribuinteNaData Text `json:"situacaoContribuinteNaData"`
	// Telefone is retorno.telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// TipoIE is retorno.tipoIE, documented as a string.
	TipoIE Text `json:"tipoIE"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Ufie is retorno.ufie, documented as a string.
	Ufie Text `json:"ufie"`
}

SintegraRetorno is retorno in the answer of Sintegra.

type SintegraRetornoInformacaoIBGE 

type SintegraRetornoInformacaoIBGE struct {
	// Cidade is retorno.informacaoIBGE.cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// Codigo is retorno.informacaoIBGE.codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// DataConsulta is retorno.informacaoIBGE.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Tipo is retorno.informacaoIBGE.tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Uf is retorno.informacaoIBGE.uf, documented as a string.
	Uf Text `json:"uf"`
}

SintegraRetornoInformacaoIBGE is retorno.informacaoIBGE in the answer of Sintegra.

type SintegraRetornoInscricoesEstaduais 

type SintegraRetornoInscricoesEstaduais struct {
	// AtivoHabilitada is retorno.inscricoesEstaduais[].ativoHabilitada, documented as a string.
	AtivoHabilitada Text `json:"ativoHabilitada"`
	// Inscricao is retorno.inscricoesEstaduais[].inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
	// Situacao is retorno.inscricoesEstaduais[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
	// Uf is retorno.inscricoesEstaduais[].uf, documented as a string.
	Uf Text `json:"uf"`
	// Vinculo is retorno.inscricoesEstaduais[].vinculo, documented as a string.
	Vinculo Text `json:"vinculo"`
}

SintegraRetornoInscricoesEstaduais is retorno.inscricoesEstaduais[] in the answer of Sintegra.

type SituacaoEleitoralParams 

type SituacaoEleitoralParams struct {
	// Nome is sent as Nome. O parâmetro NOME deve ser enviado de forma completa. Caso informado, enviar também DATANASCIMENTO nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.
	Nome string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NumeroTituloEleitoral is sent as NumeroTituloEleitoral. O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.
	NumeroTituloEleitoral string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa. Caso informado, enviar também NOME de forma completa.
	DataNascimento string
}

SituacaoEleitoralParams are the parameters of SituacaoEleitoral (TSE - Situação Eleitoral).

func (SituacaoEleitoralParams) Request 

func (p SituacaoEleitoralParams) Request() (Request, error)

Request builds the Request for SituacaoEleitoral.

type SituacaoEleitoralRetorno 

type SituacaoEleitoralRetorno struct {
	// BiometriaColetada is retorno.biometriaColetada, documented as a boolean.
	BiometriaColetada Flag `json:"biometriaColetada"`
	// Identificacao is retorno.identificacao, documented as a string.
	Identificacao Text `json:"identificacao"`
	// IsRegular is retorno.isRegular, documented as a boolean.
	IsRegular Flag `json:"isRegular"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

SituacaoEleitoralRetorno is retorno in the answer of SituacaoEleitoral.

type SuframaCNPJParams 

type SuframaCNPJParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

SuframaCNPJParams are the parameters of SuframaCNPJ (Suframa - CNPJ).

func (SuframaCNPJParams) Request 

func (p SuframaCNPJParams) Request() (Request, error)

Request builds the Request for SuframaCNPJ.

type SuframaCNPJRetorno 

type SuframaCNPJRetorno struct {
	// Inscricoes is retorno.inscricoes, a list.
	Inscricoes []SuframaCNPJRetornoInscricoes `json:"inscricoes"`
	// QuantidadeInscricoes is retorno.quantidadeInscricoes, documented as a number.
	QuantidadeInscricoes Number `json:"quantidadeInscricoes"`
}

SuframaCNPJRetorno is retorno in the answer of SuframaCNPJ.

type SuframaCNPJRetornoInscricoes 

type SuframaCNPJRetornoInscricoes struct {
	// AtividadeEconomicaEstadual is retorno.inscricoes[].atividadeEconomicaEstadual, documented as a string.
	AtividadeEconomicaEstadual Text `json:"atividadeEconomicaEstadual"`
	// AtividadeEconomicaPrincipal is retorno.inscricoes[].atividadeEconomicaPrincipal, documented as a string.
	AtividadeEconomicaPrincipal Text `json:"atividadeEconomicaPrincipal"`
	// AtividadesEconomicasSecundarias is retorno.inscricoes[].atividadesEconomicasSecundarias, a list.
	AtividadesEconomicasSecundarias []Text `json:"atividadesEconomicasSecundarias"`
	// Bairro is retorno.inscricoes[].bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Cep is retorno.inscricoes[].cep, documented as a string.
	Cep Text `json:"cep" pii:"address"`
	// Cnpj is retorno.inscricoes[].cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// Complemento is retorno.inscricoes[].complemento, documented as a string.
	Complemento Text `json:"complemento" pii:"address"`
	// DataConsulta is retorno.inscricoes[].dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataConsultaSuframa is retorno.inscricoes[].dataConsultaSuframa, documented as a string.
	DataConsultaSuframa Text `json:"dataConsultaSuframa"`
	// DataValidadeCadastral is retorno.inscricoes[].dataValidadeCadastral, documented as a string.
	DataValidadeCadastral Text `json:"dataValidadeCadastral"`
	// Email is retorno.inscricoes[].email, documented as a string.
	Email Text `json:"email" pii:"email"`
	// InscricaoSuframa is retorno.inscricoes[].inscricaoSuframa, documented as a number.
	InscricaoSuframa Number `json:"inscricaoSuframa"`
	// Logradouro is retorno.inscricoes[].logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Municipio is retorno.inscricoes[].municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// RazaoSocial is retorno.inscricoes[].razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// SituacaoCadastralAtual is retorno.inscricoes[].situacaoCadastralAtual, documented as a string.
	SituacaoCadastralAtual Text `json:"situacaoCadastralAtual"`
	// Telefone is retorno.inscricoes[].telefone, documented as a string.
	Telefone Text `json:"telefone" pii:"phone"`
	// Uf is retorno.inscricoes[].uf, documented as a string.
	Uf Text `json:"uf"`
}

SuframaCNPJRetornoInscricoes is retorno.inscricoes[] in the answer of SuframaCNPJ.

type SuicaSECOParams 

type SuicaSECOParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
}

SuicaSECOParams are the parameters of SuicaSECO (Suíça SECO - Sanções Internacionais).

func (SuicaSECOParams) Request 

func (p SuicaSECOParams) Request() (Request, error)

Request builds the Request for SuicaSECO.

type SuicaSECORetorno 

type SuicaSECORetorno struct {
	// DataLista is retorno.dataLista, documented as a string.
	DataLista Text `json:"dataLista"`
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []SuicaSECORetornoSancoes `json:"sancoes"`
}

SuicaSECORetorno is retorno in the answer of SuicaSECO.

type SuicaSECORetornoSancoes 

type SuicaSECORetornoSancoes struct {
	// Apelidos is retorno.sancoes[].apelidos, a list.
	Apelidos []SuicaSECORetornoSancoesApelidos `json:"apelidos"`
	// Atributos is retorno.sancoes[].atributos, a list.
	Atributos []SuicaSECORetornoSancoesAtributos `json:"atributos"`
	// DataInclusaoLista is retorno.sancoes[].dataInclusaoLista, documented as a string.
	DataInclusaoLista Text `json:"dataInclusaoLista"`
	// DataNascimento is retorno.sancoes[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// Enderecos is retorno.sancoes[].enderecos, a list.
	Enderecos []SuicaSECORetornoSancoesEnderecos `json:"enderecos"`
	// Genero is retorno.sancoes[].genero, documented as a string.
	Genero Text `json:"genero"`
	// Identificacoes is retorno.sancoes[].identificacoes, a list.
	Identificacoes []SuicaSECORetornoSancoesIdentificacoes `json:"identificacoes"`
	// LocalNascimento is retorno.sancoes[].localNascimento, documented as a string.
	LocalNascimento Text `json:"localNascimento"`
	// Nacionalidade is retorno.sancoes[].nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Nome is retorno.sancoes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Programas is retorno.sancoes[].programas, documented as a string.
	Programas Text `json:"programas"`
	// Status is retorno.sancoes[].status, documented as a string.
	Status Text `json:"status"`
	// TipoRegistro is retorno.sancoes[].tipoRegistro, documented as a string.
	TipoRegistro Text `json:"tipoRegistro"`
}

SuicaSECORetornoSancoes is retorno.sancoes[] in the answer of SuicaSECO.

type SuicaSECORetornoSancoesApelidos 

type SuicaSECORetornoSancoesApelidos struct {
	// Idioma is retorno.sancoes[].apelidos[].idioma, documented as a string.
	Idioma Text `json:"idioma"`
	// Nome is retorno.sancoes[].apelidos[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Qualidade is retorno.sancoes[].apelidos[].qualidade, documented as a string.
	Qualidade Text `json:"qualidade"`
	// Tipo is retorno.sancoes[].apelidos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

SuicaSECORetornoSancoesApelidos is retorno.sancoes[].apelidos[] in the answer of SuicaSECO.

type SuicaSECORetornoSancoesAtributos 

type SuicaSECORetornoSancoesAtributos struct {
	// Chave is retorno.sancoes[].atributos[].chave, documented as a string.
	Chave Text `json:"chave" pii:"document"`
	// Valor is retorno.sancoes[].atributos[].valor, documented as a string.
	Valor Text `json:"valor"`
}

SuicaSECORetornoSancoesAtributos is retorno.sancoes[].atributos[] in the answer of SuicaSECO.

type SuicaSECORetornoSancoesEnderecos 

type SuicaSECORetornoSancoesEnderecos struct {
	// Cidade is retorno.sancoes[].enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoPostal is retorno.sancoes[].enderecos[].codigoPostal, documented as a string.
	CodigoPostal Text `json:"codigoPostal"`
	// Endereco is retorno.sancoes[].enderecos[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Estado is retorno.sancoes[].enderecos[].estado, documented as a string.
	Estado Text `json:"estado"`
	// Pais is retorno.sancoes[].enderecos[].pais, documented as a string.
	Pais Text `json:"pais"`
}

SuicaSECORetornoSancoesEnderecos is retorno.sancoes[].enderecos[] in the answer of SuicaSECO.

type SuicaSECORetornoSancoesIdentificacoes 

type SuicaSECORetornoSancoesIdentificacoes struct {
	// DataEmissao is retorno.sancoes[].identificacoes[].dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataExpiracao is retorno.sancoes[].identificacoes[].dataExpiracao, documented as a string.
	DataExpiracao Text `json:"dataExpiracao"`
	// Documento is retorno.sancoes[].identificacoes[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Pais is retorno.sancoes[].identificacoes[].pais, documented as a string.
	Pais Text `json:"pais"`
	// Tipo is retorno.sancoes[].identificacoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

SuicaSECORetornoSancoesIdentificacoes is retorno.sancoes[].identificacoes[] in the answer of SuicaSECO.

type TCUCertidaoNegativaLicitanteInidoneoParams 

type TCUCertidaoNegativaLicitanteInidoneoParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TCUCertidaoNegativaLicitanteInidoneoParams are the parameters of TCUCertidaoNegativaLicitanteInidoneo (TCU - Certidão Negativa de Licitante Inidôneo).

func (TCUCertidaoNegativaLicitanteInidoneoParams) Request 

func (p TCUCertidaoNegativaLicitanteInidoneoParams) Request() (Request, error)

Request builds the Request for TCUCertidaoNegativaLicitanteInidoneo.

type TCUCertidaoNegativaLicitanteInidoneoRetorno 

type TCUCertidaoNegativaLicitanteInidoneoRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PossuiSancao is retorno.possuiSancao, documented as a boolean.
	PossuiSancao Flag `json:"possuiSancao"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
}

TCUCertidaoNegativaLicitanteInidoneoRetorno is retorno in the answer of TCUCertidaoNegativaLicitanteInidoneo.

type TCUConsultaConsolidadaPessoaJuridicaParams 

type TCUConsultaConsolidadaPessoaJuridicaParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TCUConsultaConsolidadaPessoaJuridicaParams are the parameters of TCUConsultaConsolidadaPessoaJuridica (TCU - Consulta Consolidada de Pessoa Jurídica - APF).

func (TCUConsultaConsolidadaPessoaJuridicaParams) Request 

func (p TCUConsultaConsolidadaPessoaJuridicaParams) Request() (Request, error)

Request builds the Request for TCUConsultaConsolidadaPessoaJuridica.

type TCUConsultaConsolidadaPessoaJuridicaRetorno 

type TCUConsultaConsolidadaPessoaJuridicaRetorno struct {
	// Certidoes is retorno.certidoes, a list.
	Certidoes []TCUConsultaConsolidadaPessoaJuridicaRetornoCertidoes `json:"certidoes"`
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// ConstamSancoes is retorno.constamSancoes, documented as a boolean.
	ConstamSancoes Flag `json:"constamSancoes"`
	// NomeFantasia is retorno.nomeFantasia, documented as a string.
	NomeFantasia Text `json:"nomeFantasia" pii:"name"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

TCUConsultaConsolidadaPessoaJuridicaRetorno is retorno in the answer of TCUConsultaConsolidadaPessoaJuridica.

type TCUConsultaConsolidadaPessoaJuridicaRetornoCertidoes 

type TCUConsultaConsolidadaPessoaJuridicaRetornoCertidoes struct {
	// DataEmissao is retorno.certidoes[].dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// Descricao is retorno.certidoes[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Emissor is retorno.certidoes[].emissor, documented as a string.
	Emissor Text `json:"emissor"`
	// PossuiSancao is retorno.certidoes[].possuiSancao, documented as a boolean.
	PossuiSancao Flag `json:"possuiSancao"`
	// Status is retorno.certidoes[].status, documented as a string.
	Status Text `json:"status"`
	// Tipo is retorno.certidoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

TCUConsultaConsolidadaPessoaJuridicaRetornoCertidoes is retorno.certidoes[] in the answer of TCUConsultaConsolidadaPessoaJuridica.

type TJCertidaoCivelCriminalFiscalParams 

type TJCertidaoCivelCriminalFiscalParams struct {
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// Nome is sent as Nome. O parâmetro NOME deve ser enviado de forma completa.
	Nome string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.
	DataNascimento string
	// NomeMae is sent as NomeMae. O parâmetro NOMEMAE deve ser enviado de forma completa.
	NomeMae string
	// NomePai is sent as NomePai. O parâmetro NOMEPAI deve ser enviado de forma completa.
	NomePai string
	// RG is sent as RG. O parâmetro RG pode ser enviado com ou sem formatação.
	RG string
	// Genero is sent as Genero. Not described by the documentation.
	Genero string
	// UF is sent as UF. Not described by the documentation.
	UF string
	// Tipo is sent as Tipo. O parâmetro TIPO deve ser enviado.
	Tipo string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TJCertidaoCivelCriminalFiscalParams are the parameters of TJCertidaoCivelCriminalFiscal (TJ - Certidão Cível, Criminal e Fiscal - Tribunal de Justiça).

func (TJCertidaoCivelCriminalFiscalParams) Request 

func (p TJCertidaoCivelCriminalFiscalParams) Request() (Request, error)

Request builds the Request for TJCertidaoCivelCriminalFiscal.

type TJCertidaoCivelCriminalFiscalRetorno 

type TJCertidaoCivelCriminalFiscalRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// PossuiOcorrencia is retorno.possuiOcorrencia, documented as a string.
	PossuiOcorrencia Text `json:"possuiOcorrencia"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TipoCertidao is retorno.tipoCertidao, documented as a string.
	TipoCertidao Text `json:"tipoCertidao"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

TJCertidaoCivelCriminalFiscalRetorno is retorno in the answer of TJCertidaoCivelCriminalFiscal.

type TSECertidaoCrimesEleitoraisParams 

type TSECertidaoCrimesEleitoraisParams struct {
	// Nome is sent as Nome. O parâmetro NOME deve ser enviado de forma completa.
	Nome string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NomeMae is sent as NomeMae. O parâmetro NOMEMAE deve ser enviado de forma completa.
	NomeMae string
	// NOMEPAI is sent as NOMEPAI. O parâmetro NOMEPAI deve ser enviado de forma completa.
	NOMEPAI string
	// NumeroTituloEleitoral is sent as NumeroTituloEleitoral. O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.
	NumeroTituloEleitoral string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.
	DataNascimento string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TSECertidaoCrimesEleitoraisParams are the parameters of TSECertidaoCrimesEleitorais (TSE - Certidão de Crimes Eleitorais).

func (TSECertidaoCrimesEleitoraisParams) Request 

func (p TSECertidaoCrimesEleitoraisParams) Request() (Request, error)

Request builds the Request for TSECertidaoCrimesEleitorais.

type TSECertidaoCrimesEleitoraisRetorno 

type TSECertidaoCrimesEleitoraisRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// DomicilioDesde is retorno.domicilioDesde, documented as a string.
	DomicilioDesde Text `json:"domicilioDesde"`
	// Filiacao is retorno.filiacao, documented as a string.
	Filiacao Text `json:"filiacao"`
	// Inscricao is retorno.inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
	// IsRegular is retorno.isRegular, documented as a boolean.
	IsRegular Flag `json:"isRegular"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Secao is retorno.secao, documented as a string.
	Secao Text `json:"secao"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Zona is retorno.zona, documented as a string.
	Zona Text `json:"zona"`
}

TSECertidaoCrimesEleitoraisRetorno is retorno in the answer of TSECertidaoCrimesEleitorais.

type TSECertidaodeQuitacaoEleitoralParams 

type TSECertidaodeQuitacaoEleitoralParams struct {
	// Nome is sent as Nome. O parâmetro NOME deve ser enviado de forma completa.
	Nome string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NOMEMAE is sent as NOMEMAE. O parâmetro NOMEMAE deve ser enviado de forma completa.
	NOMEMAE string
	// NOMEPAI is sent as NOMEPAI. O parâmetro NOMEPAI deve ser enviado de forma completa.
	NOMEPAI string
	// NUMEROTITULOELEITORAL is sent as NUMEROTITULOELEITORAL. O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.
	NUMEROTITULOELEITORAL string
	// DATANASCIMENTO is sent as DATANASCIMENTO. O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.
	DATANASCIMENTO string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TSECertidaodeQuitacaoEleitoralParams are the parameters of TSECertidaodeQuitacaoEleitoral (TSE - Certidão de Quitação Eleitoral).

func (TSECertidaodeQuitacaoEleitoralParams) Request 

func (p TSECertidaodeQuitacaoEleitoralParams) Request() (Request, error)

Request builds the Request for TSECertidaodeQuitacaoEleitoral.

type TSECertidaodeQuitacaoEleitoralRetorno 

type TSECertidaodeQuitacaoEleitoralRetorno struct {
	// DataNascimento is retorno.dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// DomicilioDesde is retorno.domicilioDesde, documented as a string.
	DomicilioDesde Text `json:"domicilioDesde"`
	// Filiacao is retorno.filiacao, documented as a string.
	Filiacao Text `json:"filiacao"`
	// Inscricao is retorno.inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
	// IsRegular is retorno.isRegular, documented as a boolean.
	IsRegular Flag `json:"isRegular"`
	// Municipio is retorno.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// OcupacaoDeclarada is retorno.ocupacaoDeclarada, documented as a string.
	OcupacaoDeclarada Text `json:"ocupacaoDeclarada"`
	// Secao is retorno.secao, documented as a string.
	Secao Text `json:"secao"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
	// Zona is retorno.zona, documented as a string.
	Zona Text `json:"zona"`
}

TSECertidaodeQuitacaoEleitoralRetorno is retorno in the answer of TSECertidaodeQuitacaoEleitoral.

type TSTCertidaoNegativaDebitosTrabalhistasParams 

type TSTCertidaoNegativaDebitosTrabalhistasParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TSTCertidaoNegativaDebitosTrabalhistasParams are the parameters of TSTCertidaoNegativaDebitosTrabalhistas (TST - Certidão Negativa de Débitos Trabalhistas).

func (TSTCertidaoNegativaDebitosTrabalhistasParams) Request 

func (p TSTCertidaoNegativaDebitosTrabalhistasParams) Request() (Request, error)

Request builds the Request for TSTCertidaoNegativaDebitosTrabalhistas.

type TSTCertidaoNegativaDebitosTrabalhistasRetorno 

type TSTCertidaoNegativaDebitosTrabalhistasRetorno struct {
	// DataExpedicao is retorno.dataExpedicao, documented as a string.
	DataExpedicao Text `json:"dataExpedicao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// PossuiProcesso is retorno.possuiProcesso, documented as a boolean.
	PossuiProcesso Flag `json:"possuiProcesso"`
	// Processos is retorno.processos, a list.
	Processos []TSTCertidaoNegativaDebitosTrabalhistasRetornoProcessos `json:"processos"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TotalProcessos is retorno.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
}

TSTCertidaoNegativaDebitosTrabalhistasRetorno is retorno in the answer of TSTCertidaoNegativaDebitosTrabalhistas.

type TSTCertidaoNegativaDebitosTrabalhistasRetornoProcessos 

type TSTCertidaoNegativaDebitosTrabalhistasRetornoProcessos struct {
	// Codigo is retorno.processos[].codigo, documented as a string.
	Codigo Text `json:"codigo"`
	// Local is retorno.processos[].local, documented as a string.
	Local Text `json:"local"`
}

TSTCertidaoNegativaDebitosTrabalhistasRetornoProcessos is retorno.processos[] in the answer of TSTCertidaoNegativaDebitosTrabalhistas.

type Text 

type Text string

Text is a string field of a response. Direct Data documents its fields with example values only, so a field documented as a string is read whether it arrives as a string, a number or a boolean; null reads as "".

func (Text) String 

func (t Text) String() string

String returns the text.

func (*Text) UnmarshalJSON 

func (t *Text) UnmarshalJSON(b []byte) error

UnmarshalJSON reads a string, a number, a boolean or null.

type Ticket 

type Ticket struct {
	// Product is the API's slug.
	Product string
	// Document is the queried document, masked.
	Document string
	// ConsultaUID is Direct Data's identifier of the query; the callback
	// carries the same one.
	ConsultaUID string
	// HoldID is the Ledger hold kept open until CompleteAsync, or "" when
	// none is open.
	HoldID string
	// PriceCents is the product's configured list price.
	PriceCents int64
	// RequestedAt is when the request left.
	RequestedAt time.Time
	// HTTPStatus is the HTTP status of the submission.
	HTTPStatus int
	// Status is the submission's metaDados.resultado.
	Status string
	// Message is the submission's metaDados.mensagem.
	Message string
	// Result is set when the submission was not left pending: Direct Data
	// answered at once, or refused it. Its hold is then already settled or
	// released, and HoldID is "".
	Result *Result
}

Ticket is an asynchronous query that Direct Data accepted, or the result it answered with instead. The application stores the ticket, finds it again by ConsultaUID when the callback arrives, and passes both to CompleteAsync.

type TituloLocalVotacaoParams 

type TituloLocalVotacaoParams struct {
	// Nome is sent as Nome. O parâmetro NOME deve ser enviado de forma completa.
	Nome string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// NumeroTituloEleitoral is sent as NumeroTituloEleitoral. O parâmetro NUMEROTITULOELEITORAL pode ser enviado com ou sem formatação.
	NumeroTituloEleitoral string
	// DataNascimento is sent as DataNascimento. O parâmetro DATANASCIMENTO deve ser enviado nestes formatos: dd/mm/aaaa ou dd-mm-aaaa.
	DataNascimento string
	// NomeMae is sent as NomeMae. O parâmetro NOMEMAE deve ser enviado de forma completa.
	NomeMae string
}

TituloLocalVotacaoParams are the parameters of TituloLocalVotacao (TSE - Título e Local de Votação).

func (TituloLocalVotacaoParams) Request 

func (p TituloLocalVotacaoParams) Request() (Request, error)

Request builds the Request for TituloLocalVotacao.

type TituloLocalVotacaoRetorno 

type TituloLocalVotacaoRetorno struct {
	// BiometriaColetada is retorno.biometriaColetada, documented as a boolean.
	BiometriaColetada Flag `json:"biometriaColetada"`
	// DomicilioEleitoral is retorno.domicilioEleitoral.
	DomicilioEleitoral TituloLocalVotacaoRetornoDomicilioEleitoral `json:"domicilioEleitoral"`
	// Identificacao is retorno.identificacao.
	Identificacao TituloLocalVotacaoRetornoIdentificacao `json:"identificacao"`
}

TituloLocalVotacaoRetorno is retorno in the answer of TituloLocalVotacao.

type TituloLocalVotacaoRetornoDomicilioEleitoral 

type TituloLocalVotacaoRetornoDomicilioEleitoral struct {
	// Bairro is retorno.domicilioEleitoral.bairro, documented as a string.
	Bairro Text `json:"bairro" pii:"address"`
	// Local is retorno.domicilioEleitoral.local, documented as a string.
	Local Text `json:"local"`
	// Logradouro is retorno.domicilioEleitoral.logradouro, documented as a string.
	Logradouro Text `json:"logradouro" pii:"address"`
	// Municipio is retorno.domicilioEleitoral.municipio, documented as a string.
	Municipio Text `json:"municipio" pii:"address"`
	// Numero is retorno.domicilioEleitoral.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// ProximaEleicao is retorno.domicilioEleitoral.proximaEleicao, documented as a string.
	ProximaEleicao Text `json:"proximaEleicao"`
	// Secao is retorno.domicilioEleitoral.secao, documented as a number.
	Secao Number `json:"secao"`
	// Uf is retorno.domicilioEleitoral.uf, documented as a string.
	Uf Text `json:"uf"`
	// Zona is retorno.domicilioEleitoral.zona, documented as a number.
	Zona Number `json:"zona"`
}

TituloLocalVotacaoRetornoDomicilioEleitoral is retorno.domicilioEleitoral in the answer of TituloLocalVotacao.

type TituloLocalVotacaoRetornoIdentificacao 

type TituloLocalVotacaoRetornoIdentificacao struct {
	// Eleitor is retorno.identificacao.eleitor, documented as a string.
	Eleitor Text `json:"eleitor"`
	// Inscricao is retorno.identificacao.inscricao, documented as a string.
	Inscricao Text `json:"inscricao"`
}

TituloLocalVotacaoRetornoIdentificacao is retorno.identificacao in the answer of TituloLocalVotacao.

type Token 

type Token string

Token is the Direct Data API token. Direct Data authenticates every request with it as the TOKEN query parameter, and every query it authorizes is billed to its owner, so it is a credential.

It never prints: String, GoString, LogValue, MarshalJSON and MarshalText all write "[redacted]". The client puts it into the request URL and nowhere else, and strips the URL from transport errors so it cannot leak through one.

func (Token) Empty 

func (t Token) Empty() bool

Empty reports whether no token was given.

func (Token) GoString 

func (Token) GoString() string

GoString writes "[redacted]", for %#v.

func (Token) LogValue 

func (Token) LogValue() slog.Value

LogValue writes "[redacted]" in structured logs.

func (Token) MarshalJSON 

func (Token) MarshalJSON() ([]byte, error)

MarshalJSON writes "[redacted]".

func (Token) MarshalText 

func (Token) MarshalText() ([]byte, error)

MarshalText writes "[redacted]".

func (Token) String 

func (Token) String() string

String writes "[redacted]".

type TribunalJusticaParams 

type TribunalJusticaParams struct {
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// NomeParte is sent as NomeParte. O parâmetro NOMEPARTE deve ser enviado de forma completa.
	NomeParte string
	// NumeroProcesso is sent as NumeroProcesso. O parâmetro NUMEROPROCESSO pode ser enviado com ou sem formatação.
	NumeroProcesso string
	// Uf is sent as Uf. Not described by the documentation.
	Uf string
	// Grau is sent as Grau. Not described by the documentation.
	Grau string
}

TribunalJusticaParams are the parameters of TribunalJustica (TJ - Tribunal de Justiça - Processos).

func (TribunalJusticaParams) Request 

func (p TribunalJusticaParams) Request() (Request, error)

Request builds the Request for TribunalJustica.

type TribunalJusticaRetorno 

type TribunalJusticaRetorno struct {
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Grau is retorno.grau, documented as a number.
	Grau Number `json:"grau"`
	// NomeParte is retorno.nomeParte, documented as a string.
	NomeParte Text `json:"nomeParte" pii:"name"`
	// NumeroProcesso is retorno.numeroProcesso, documented as a string.
	NumeroProcesso Text `json:"numeroProcesso"`
	// PrimeiroGrau is retorno.primeiroGrau.
	PrimeiroGrau TribunalJusticaRetornoPrimeiroGrau `json:"primeiroGrau"`
	// SegundoGrau is retorno.segundoGrau.
	SegundoGrau TribunalJusticaRetornoSegundoGrau `json:"segundoGrau"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.uf, documented as a string.
	Uf Text `json:"uf"`
}

TribunalJusticaRetorno is retorno in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrau 

type TribunalJusticaRetornoPrimeiroGrau struct {
	// Foros is retorno.primeiroGrau.foros, a list.
	Foros []TribunalJusticaRetornoPrimeiroGrauForos `json:"foros"`
	// TotalProcessos is retorno.primeiroGrau.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
}

TribunalJusticaRetornoPrimeiroGrau is retorno.primeiroGrau in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForos 

type TribunalJusticaRetornoPrimeiroGrauForos struct {
	// DadosProcesso is retorno.primeiroGrau.foros[].dadosProcesso.
	DadosProcesso TribunalJusticaRetornoPrimeiroGrauForosDadosProcesso `json:"dadosProcesso"`
	// Foro is retorno.primeiroGrau.foros[].foro, documented as a string.
	Foro Text `json:"foro"`
	// ResumoProcessos is retorno.primeiroGrau.foros[].resumoProcessos, a list.
	ResumoProcessos []TribunalJusticaRetornoPrimeiroGrauForosResumoProcessos `json:"resumoProcessos"`
}

TribunalJusticaRetornoPrimeiroGrauForos is retorno.primeiroGrau.foros[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcesso 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcesso struct {
	// Apensos is retorno.primeiroGrau.foros[].dadosProcesso.apensos, a list.
	Apensos []TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoApensos `json:"apensos"`
	// Area is retorno.primeiroGrau.foros[].dadosProcesso.area, documented as a string.
	Area Text `json:"area"`
	// Assunto is retorno.primeiroGrau.foros[].dadosProcesso.assunto, documented as a string.
	Assunto Text `json:"assunto"`
	// Audiencias is retorno.primeiroGrau.foros[].dadosProcesso.audiencias, a list.
	Audiencias []TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoAudiencias `json:"audiencias"`
	// Classe is retorno.primeiroGrau.foros[].dadosProcesso.classe, documented as a string.
	Classe Text `json:"classe"`
	// Controle is retorno.primeiroGrau.foros[].dadosProcesso.controle, documented as a string.
	Controle Text `json:"controle"`
	// Distribuicao is retorno.primeiroGrau.foros[].dadosProcesso.distribuicao.
	Distribuicao TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoDistribuicao `json:"distribuicao"`
	// Incidentes is retorno.primeiroGrau.foros[].dadosProcesso.incidentes, a list.
	Incidentes []TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoIncidentes `json:"incidentes"`
	// Juiz is retorno.primeiroGrau.foros[].dadosProcesso.juiz, documented as a string.
	Juiz Text `json:"juiz"`
	// Movimentacoes is retorno.primeiroGrau.foros[].dadosProcesso.movimentacoes, a list.
	Movimentacoes []TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoMovimentacoes `json:"movimentacoes"`
	// NumeroProcesso is retorno.primeiroGrau.foros[].dadosProcesso.numeroProcesso.
	NumeroProcesso TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoNumeroProcesso `json:"numeroProcesso"`
	// OutrosAssuntos is retorno.primeiroGrau.foros[].dadosProcesso.outrosAssuntos, documented as a string.
	OutrosAssuntos Text `json:"outrosAssuntos"`
	// PartesProcesso is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso, a list.
	PartesProcesso []TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcesso `json:"partesProcesso"`
	// PeticoesDiversas is retorno.primeiroGrau.foros[].dadosProcesso.peticoesDiversas, a list.
	PeticoesDiversas []TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPeticoesDiversas `json:"peticoesDiversas"`
	// ValorAcao is retorno.primeiroGrau.foros[].dadosProcesso.valorAcao, documented as a number.
	ValorAcao Number `json:"valorAcao"`
	// Vara is retorno.primeiroGrau.foros[].dadosProcesso.vara, documented as a string.
	Vara Text `json:"vara"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcesso is retorno.primeiroGrau.foros[].dadosProcesso in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoApensos 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoApensos struct {
	// Classe is retorno.primeiroGrau.foros[].dadosProcesso.apensos[].classe, documented as a string.
	Classe Text `json:"classe"`
	// DataApensamento is retorno.primeiroGrau.foros[].dadosProcesso.apensos[].dataApensamento, documented as a string.
	DataApensamento Text `json:"dataApensamento"`
	// Motivo is retorno.primeiroGrau.foros[].dadosProcesso.apensos[].motivo, documented as a string.
	Motivo Text `json:"motivo"`
	// Numero is retorno.primeiroGrau.foros[].dadosProcesso.apensos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoApensos is retorno.primeiroGrau.foros[].dadosProcesso.apensos[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoAudiencias 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoAudiencias struct {
	// Audiencia is retorno.primeiroGrau.foros[].dadosProcesso.audiencias[].audiencia, documented as a string.
	Audiencia Text `json:"audiencia"`
	// Data is retorno.primeiroGrau.foros[].dadosProcesso.audiencias[].data, documented as a string.
	Data Text `json:"data"`
	// QuantidadePessoas is retorno.primeiroGrau.foros[].dadosProcesso.audiencias[].quantidadePessoas, documented as a number.
	QuantidadePessoas Number `json:"quantidadePessoas"`
	// Situacao is retorno.primeiroGrau.foros[].dadosProcesso.audiencias[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoAudiencias is retorno.primeiroGrau.foros[].dadosProcesso.audiencias[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoDistribuicao 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoDistribuicao struct {
	// Data is retorno.primeiroGrau.foros[].dadosProcesso.distribuicao.data, documented as a string.
	Data Text `json:"data"`
	// Distribuicao is retorno.primeiroGrau.foros[].dadosProcesso.distribuicao.distribuicao, documented as a string.
	Distribuicao Text `json:"distribuicao"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoDistribuicao is retorno.primeiroGrau.foros[].dadosProcesso.distribuicao in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoIncidentes 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoIncidentes struct {
	// Classe is retorno.primeiroGrau.foros[].dadosProcesso.incidentes[].classe, documented as a string.
	Classe Text `json:"classe"`
	// DataRecebimento is retorno.primeiroGrau.foros[].dadosProcesso.incidentes[].dataRecebimento, documented as a string.
	DataRecebimento Text `json:"dataRecebimento"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoIncidentes is retorno.primeiroGrau.foros[].dadosProcesso.incidentes[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoMovimentacoes 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoMovimentacoes struct {
	// Data is retorno.primeiroGrau.foros[].dadosProcesso.movimentacoes[].data, documented as a string.
	Data Text `json:"data"`
	// Descricao is retorno.primeiroGrau.foros[].dadosProcesso.movimentacoes[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Movimento is retorno.primeiroGrau.foros[].dadosProcesso.movimentacoes[].movimento, documented as a string.
	Movimento Text `json:"movimento"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoMovimentacoes is retorno.primeiroGrau.foros[].dadosProcesso.movimentacoes[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoNumeroProcesso 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoNumeroProcesso struct {
	// Incidente is retorno.primeiroGrau.foros[].dadosProcesso.numeroProcesso.incidente, documented as a string.
	Incidente Text `json:"incidente"`
	// Numero is retorno.primeiroGrau.foros[].dadosProcesso.numeroProcesso.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoNumeroProcesso is retorno.primeiroGrau.foros[].dadosProcesso.numeroProcesso in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcesso 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcesso struct {
	// Nome is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Representantes is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso[].representantes, a list.
	Representantes []TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcessoRepresentantes `json:"representantes"`
	// Tipo is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcesso is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcessoRepresentantes 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcessoRepresentantes struct {
	// Nome is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso[].representantes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Tipo is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso[].representantes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPartesProcessoRepresentantes is retorno.primeiroGrau.foros[].dadosProcesso.partesProcesso[].representantes[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPeticoesDiversas 

type TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPeticoesDiversas struct {
	// Data is retorno.primeiroGrau.foros[].dadosProcesso.peticoesDiversas[].data, documented as a string.
	Data Text `json:"data"`
	// Tipo is retorno.primeiroGrau.foros[].dadosProcesso.peticoesDiversas[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

TribunalJusticaRetornoPrimeiroGrauForosDadosProcessoPeticoesDiversas is retorno.primeiroGrau.foros[].dadosProcesso.peticoesDiversas[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosResumoProcessos 

type TribunalJusticaRetornoPrimeiroGrauForosResumoProcessos struct {
	// Assunto is retorno.primeiroGrau.foros[].resumoProcessos[].assunto, documented as a string.
	Assunto Text `json:"assunto"`
	// Classe is retorno.primeiroGrau.foros[].resumoProcessos[].classe, documented as a string.
	Classe Text `json:"classe"`
	// Distribuicao is retorno.primeiroGrau.foros[].resumoProcessos[].distribuicao.
	Distribuicao TribunalJusticaRetornoPrimeiroGrauForosResumoProcessosDistribuicao `json:"distribuicao"`
	// Numero is retorno.primeiroGrau.foros[].resumoProcessos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Parte is retorno.primeiroGrau.foros[].resumoProcessos[].parte, documented as a string.
	Parte Text `json:"parte"`
}

TribunalJusticaRetornoPrimeiroGrauForosResumoProcessos is retorno.primeiroGrau.foros[].resumoProcessos[] in the answer of TribunalJustica.

type TribunalJusticaRetornoPrimeiroGrauForosResumoProcessosDistribuicao 

type TribunalJusticaRetornoPrimeiroGrauForosResumoProcessosDistribuicao struct {
	// Data is retorno.primeiroGrau.foros[].resumoProcessos[].distribuicao.data, documented as a string.
	Data Text `json:"data"`
	// Distribuicao is retorno.primeiroGrau.foros[].resumoProcessos[].distribuicao.distribuicao, documented as a string.
	Distribuicao Text `json:"distribuicao"`
}

TribunalJusticaRetornoPrimeiroGrauForosResumoProcessosDistribuicao is retorno.primeiroGrau.foros[].resumoProcessos[].distribuicao in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrau 

type TribunalJusticaRetornoSegundoGrau struct {
	// Sessoes is retorno.segundoGrau.sessoes, a list.
	Sessoes []TribunalJusticaRetornoSegundoGrauSessoes `json:"sessoes"`
	// TotalProcessos is retorno.segundoGrau.totalProcessos, documented as a number.
	TotalProcessos Number `json:"totalProcessos"`
}

TribunalJusticaRetornoSegundoGrau is retorno.segundoGrau in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoes 

type TribunalJusticaRetornoSegundoGrauSessoes struct {
	// DadosProcesso is retorno.segundoGrau.sessoes[].dadosProcesso.
	DadosProcesso TribunalJusticaRetornoSegundoGrauSessoesDadosProcesso `json:"dadosProcesso"`
	// ResumoProcessos is retorno.segundoGrau.sessoes[].resumoProcessos, a list.
	ResumoProcessos []TribunalJusticaRetornoSegundoGrauSessoesResumoProcessos `json:"resumoProcessos"`
	// Sessao is retorno.segundoGrau.sessoes[].sessao, documented as a string.
	Sessao Text `json:"sessao"`
}

TribunalJusticaRetornoSegundoGrauSessoes is retorno.segundoGrau.sessoes[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcesso 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcesso struct {
	// Area is retorno.segundoGrau.sessoes[].dadosProcesso.area, documented as a string.
	Area Text `json:"area"`
	// Assunto is retorno.segundoGrau.sessoes[].dadosProcesso.assunto, documented as a string.
	Assunto Text `json:"assunto"`
	// Classe is retorno.segundoGrau.sessoes[].dadosProcesso.classe, documented as a string.
	Classe Text `json:"classe"`
	// ComposicaoJulgamentos is retorno.segundoGrau.sessoes[].dadosProcesso.composicaoJulgamentos, a list.
	ComposicaoJulgamentos []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoComposicaoJulgamentos `json:"composicaoJulgamentos"`
	// Julgamentos is retorno.segundoGrau.sessoes[].dadosProcesso.julgamentos, a list.
	Julgamentos []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoJulgamentos `json:"julgamentos"`
	// Movimentacoes is retorno.segundoGrau.sessoes[].dadosProcesso.movimentacoes, a list.
	Movimentacoes []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoMovimentacoes `json:"movimentacoes"`
	// NumeroProcesso is retorno.segundoGrau.sessoes[].dadosProcesso.numeroProcesso.
	NumeroProcesso TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumeroProcesso `json:"numeroProcesso"`
	// NumerosPrimeiraInstancia is retorno.segundoGrau.sessoes[].dadosProcesso.numerosPrimeiraInstancia, a list.
	NumerosPrimeiraInstancia []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumerosPrimeiraInstancia `json:"numerosPrimeiraInstancia"`
	// OrgaoJulgador is retorno.segundoGrau.sessoes[].dadosProcesso.orgaoJulgador, documented as a string.
	OrgaoJulgador Text `json:"orgaoJulgador"`
	// Origem is retorno.segundoGrau.sessoes[].dadosProcesso.origem, documented as a string.
	Origem Text `json:"origem"`
	// PartesProcesso is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso, a list.
	PartesProcesso []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcesso `json:"partesProcesso"`
	// PeticoesDiversas is retorno.segundoGrau.sessoes[].dadosProcesso.peticoesDiversas, a list.
	PeticoesDiversas []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPeticoesDiversas `json:"peticoesDiversas"`
	// Relator is retorno.segundoGrau.sessoes[].dadosProcesso.relator, documented as a string.
	Relator Text `json:"relator"`
	// Secao is retorno.segundoGrau.sessoes[].dadosProcesso.secao, documented as a string.
	Secao Text `json:"secao"`
	// SubprocessosRecursos is retorno.segundoGrau.sessoes[].dadosProcesso.subprocessosRecursos, a list.
	SubprocessosRecursos []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoSubprocessosRecursos `json:"subprocessosRecursos"`
	// ValorAcao is retorno.segundoGrau.sessoes[].dadosProcesso.valorAcao, documented as a number.
	ValorAcao Number `json:"valorAcao"`
	// VolumeApenso is retorno.segundoGrau.sessoes[].dadosProcesso.volumeApenso, documented as a string.
	VolumeApenso Text `json:"volumeApenso"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcesso is retorno.segundoGrau.sessoes[].dadosProcesso in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoComposicaoJulgamentos 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoComposicaoJulgamentos struct {
	// Magistrado is retorno.segundoGrau.sessoes[].dadosProcesso.composicaoJulgamentos[].magistrado, documented as a string.
	Magistrado Text `json:"magistrado"`
	// Participacao is retorno.segundoGrau.sessoes[].dadosProcesso.composicaoJulgamentos[].participacao, documented as a string.
	Participacao Text `json:"participacao"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoComposicaoJulgamentos is retorno.segundoGrau.sessoes[].dadosProcesso.composicaoJulgamentos[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoJulgamentos 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoJulgamentos struct {
	// Data is retorno.segundoGrau.sessoes[].dadosProcesso.julgamentos[].data, documented as a string.
	Data Text `json:"data"`
	// Decisao is retorno.segundoGrau.sessoes[].dadosProcesso.julgamentos[].decisao, documented as a string.
	Decisao Text `json:"decisao"`
	// Situacao is retorno.segundoGrau.sessoes[].dadosProcesso.julgamentos[].situacao, documented as a string.
	Situacao Text `json:"situacao"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoJulgamentos is retorno.segundoGrau.sessoes[].dadosProcesso.julgamentos[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoMovimentacoes 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoMovimentacoes struct {
	// Data is retorno.segundoGrau.sessoes[].dadosProcesso.movimentacoes[].data, documented as a string.
	Data Text `json:"data"`
	// Descricao is retorno.segundoGrau.sessoes[].dadosProcesso.movimentacoes[].descricao, documented as a string.
	Descricao Text `json:"descricao"`
	// Movimento is retorno.segundoGrau.sessoes[].dadosProcesso.movimentacoes[].movimento, documented as a string.
	Movimento Text `json:"movimento"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoMovimentacoes is retorno.segundoGrau.sessoes[].dadosProcesso.movimentacoes[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumeroProcesso 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumeroProcesso struct {
	// Incidente is retorno.segundoGrau.sessoes[].dadosProcesso.numeroProcesso.incidente, documented as a string.
	Incidente Text `json:"incidente"`
	// Numero is retorno.segundoGrau.sessoes[].dadosProcesso.numeroProcesso.numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumeroProcesso is retorno.segundoGrau.sessoes[].dadosProcesso.numeroProcesso in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumerosPrimeiraInstancia 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumerosPrimeiraInstancia struct {
	// Foro is retorno.segundoGrau.sessoes[].dadosProcesso.numerosPrimeiraInstancia[].foro, documented as a string.
	Foro Text `json:"foro"`
	// Juiz is retorno.segundoGrau.sessoes[].dadosProcesso.numerosPrimeiraInstancia[].juiz, documented as a string.
	Juiz Text `json:"juiz"`
	// Numero is retorno.segundoGrau.sessoes[].dadosProcesso.numerosPrimeiraInstancia[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Observacao is retorno.segundoGrau.sessoes[].dadosProcesso.numerosPrimeiraInstancia[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Vara is retorno.segundoGrau.sessoes[].dadosProcesso.numerosPrimeiraInstancia[].vara, documented as a string.
	Vara Text `json:"vara"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoNumerosPrimeiraInstancia is retorno.segundoGrau.sessoes[].dadosProcesso.numerosPrimeiraInstancia[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcesso 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcesso struct {
	// Nome is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Representantes is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso[].representantes, a list.
	Representantes []TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcessoRepresentantes `json:"representantes"`
	// Tipo is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcesso is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcessoRepresentantes 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcessoRepresentantes struct {
	// Nome is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso[].representantes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// Tipo is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso[].representantes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPartesProcessoRepresentantes is retorno.segundoGrau.sessoes[].dadosProcesso.partesProcesso[].representantes[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPeticoesDiversas 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPeticoesDiversas struct {
	// Data is retorno.segundoGrau.sessoes[].dadosProcesso.peticoesDiversas[].data, documented as a string.
	Data Text `json:"data"`
	// Tipo is retorno.segundoGrau.sessoes[].dadosProcesso.peticoesDiversas[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoPeticoesDiversas is retorno.segundoGrau.sessoes[].dadosProcesso.peticoesDiversas[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoSubprocessosRecursos 

type TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoSubprocessosRecursos struct {
	// Classe is retorno.segundoGrau.sessoes[].dadosProcesso.subprocessosRecursos[].classe, documented as a string.
	Classe Text `json:"classe"`
	// DataRecebimento is retorno.segundoGrau.sessoes[].dadosProcesso.subprocessosRecursos[].dataRecebimento, documented as a string.
	DataRecebimento Text `json:"dataRecebimento"`
}

TribunalJusticaRetornoSegundoGrauSessoesDadosProcessoSubprocessosRecursos is retorno.segundoGrau.sessoes[].dadosProcesso.subprocessosRecursos[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesResumoProcessos 

type TribunalJusticaRetornoSegundoGrauSessoesResumoProcessos struct {
	// Assunto is retorno.segundoGrau.sessoes[].resumoProcessos[].assunto, documented as a string.
	Assunto Text `json:"assunto"`
	// Classe is retorno.segundoGrau.sessoes[].resumoProcessos[].classe, documented as a string.
	Classe Text `json:"classe"`
	// Distribuicao is retorno.segundoGrau.sessoes[].resumoProcessos[].distribuicao.
	Distribuicao TribunalJusticaRetornoSegundoGrauSessoesResumoProcessosDistribuicao `json:"distribuicao"`
	// Numero is retorno.segundoGrau.sessoes[].resumoProcessos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
	// Parte is retorno.segundoGrau.sessoes[].resumoProcessos[].parte, documented as a string.
	Parte Text `json:"parte"`
}

TribunalJusticaRetornoSegundoGrauSessoesResumoProcessos is retorno.segundoGrau.sessoes[].resumoProcessos[] in the answer of TribunalJustica.

type TribunalJusticaRetornoSegundoGrauSessoesResumoProcessosDistribuicao 

type TribunalJusticaRetornoSegundoGrauSessoesResumoProcessosDistribuicao struct {
	// Data is retorno.segundoGrau.sessoes[].resumoProcessos[].distribuicao.data, documented as a string.
	Data Text `json:"data"`
	// Distribuicao is retorno.segundoGrau.sessoes[].resumoProcessos[].distribuicao.distribuicao, documented as a string.
	Distribuicao Text `json:"distribuicao"`
}

TribunalJusticaRetornoSegundoGrauSessoesResumoProcessosDistribuicao is retorno.segundoGrau.sessoes[].resumoProcessos[].distribuicao in the answer of TribunalJustica.

type TribunalRegionalFederalParams 

type TribunalRegionalFederalParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Regiao is sent as Regiao. O parâmetro REGIAO deve ser enviado.
	Regiao string
	// Tipo is sent as Tipo. O parâmetro TIPO deve ser enviado.
	Tipo string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TribunalRegionalFederalParams are the parameters of TribunalRegionalFederal (TRF - Tribunal Regional Federal (Certidão Cível, Eleitoral ou Criminal)).

func (TribunalRegionalFederalParams) Request 

func (p TribunalRegionalFederalParams) Request() (Request, error)

Request builds the Request for TribunalRegionalFederal.

type TribunalRegionalFederalRetorno 

type TribunalRegionalFederalRetorno struct {
	// CodigoValidacao is retorno.codigoValidacao, documented as a string.
	CodigoValidacao Text `json:"codigoValidacao"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// PossuiProcesso is retorno.possuiProcesso, documented as a boolean.
	PossuiProcesso Flag `json:"possuiProcesso"`
	// Processos is retorno.processos, a list.
	Processos []TribunalRegionalFederalRetornoProcessos `json:"processos"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TipoCertidao is retorno.tipoCertidao, documented as a string.
	TipoCertidao Text `json:"tipoCertidao"`
}

TribunalRegionalFederalRetorno is retorno in the answer of TribunalRegionalFederal.

type TribunalRegionalFederalRetornoProcessos 

type TribunalRegionalFederalRetornoProcessos struct {
	// ClasseProcessual is retorno.processos[].classeProcessual, documented as a string.
	ClasseProcessual Text `json:"classeProcessual"`
	// Juizo is retorno.processos[].juizo, documented as a string.
	Juizo Text `json:"juizo"`
	// Local is retorno.processos[].local, documented as a string.
	Local Text `json:"local"`
	// Numero is retorno.processos[].numero, documented as a string.
	Numero Text `json:"numero" pii:"address"`
}

TribunalRegionalFederalRetornoProcessos is retorno.processos[] in the answer of TribunalRegionalFederal.

type TribunalRegionalTrabalhoParams 

type TribunalRegionalTrabalhoParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
	// Regiao is sent as Regiao. O parâmetro REGIAO deve ser enviado.
	Regiao string
	// TIPO is sent as TIPO. O parâmetro TIPO deve ser enviado.
	TIPO string
	// GerarComprovante is sent as GERARCOMPROVANTE. Este parâmetro possibilita gerar o comprovante em PDF desta consulta.
	GerarComprovante string
}

TribunalRegionalTrabalhoParams are the parameters of TribunalRegionalTrabalho (TRT - Tribunal Regional do Trabalho).

func (TribunalRegionalTrabalhoParams) Request 

func (p TribunalRegionalTrabalhoParams) Request() (Request, error)

Request builds the Request for TribunalRegionalTrabalho.

type TribunalRegionalTrabalhoRetorno 

type TribunalRegionalTrabalhoRetorno struct {
	// CodigoAutenticidade is retorno.codigoAutenticidade, documented as a string.
	CodigoAutenticidade Text `json:"codigoAutenticidade"`
	// ConstaProcessoTST is retorno.constaProcessoTST, documented as a boolean.
	ConstaProcessoTST Flag `json:"constaProcessoTST"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DataEmissao is retorno.dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// DataValidade is retorno.dataValidade, documented as a string.
	DataValidade Text `json:"dataValidade"`
	// Documento is retorno.documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Nome is retorno.nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NumeroCertidao is retorno.numeroCertidao, documented as a string.
	NumeroCertidao Text `json:"numeroCertidao"`
	// Observacao is retorno.observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// PossuiProcesso is retorno.possuiProcesso, documented as a boolean.
	PossuiProcesso Flag `json:"possuiProcesso"`
	// Processos is retorno.processos, a list.
	Processos []TribunalRegionalTrabalhoRetornoProcessos `json:"processos"`
	// Regiao is retorno.regiao, documented as a string.
	Regiao Text `json:"regiao"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TipoConsultado is retorno.tipoConsultado, documented as a string.
	TipoConsultado Text `json:"tipoConsultado"`
}

TribunalRegionalTrabalhoRetorno is retorno in the answer of TribunalRegionalTrabalho.

type TribunalRegionalTrabalhoRetornoProcessos 

type TribunalRegionalTrabalhoRetornoProcessos struct {
	// Local is retorno.processos[].local, documented as a string.
	Local Text `json:"local"`
	// Processo is retorno.processos[].processo, a list.
	Processo []Text `json:"processo"`
}

TribunalRegionalTrabalhoRetornoProcessos is retorno.processos[] in the answer of TribunalRegionalTrabalho.

type UKHmTreasuryParams 

type UKHmTreasuryParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado com qualquer outro.
	Nome string
}

UKHmTreasuryParams are the parameters of UKHmTreasury (UK Hm Treasury - Financial Sanctions).

func (UKHmTreasuryParams) Request 

func (p UKHmTreasuryParams) Request() (Request, error)

Request builds the Request for UKHmTreasury.

type UKHmTreasuryRetorno 

type UKHmTreasuryRetorno struct {
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []UKHmTreasuryRetornoSancoes `json:"sancoes"`
}

UKHmTreasuryRetorno is retorno in the answer of UKHmTreasury.

type UKHmTreasuryRetornoSancoes 

type UKHmTreasuryRetornoSancoes struct {
	// CidadeNascimento is retorno.sancoes[].cidadeNascimento, documented as a string.
	CidadeNascimento Text `json:"cidadeNascimento"`
	// DataInclusaoLista is retorno.sancoes[].dataInclusaoLista, documented as a string.
	DataInclusaoLista Text `json:"dataInclusaoLista"`
	// DataNascimento is retorno.sancoes[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DataUltimaAtualizacao is retorno.sancoes[].dataUltimaAtualizacao, documented as a string.
	DataUltimaAtualizacao Text `json:"dataUltimaAtualizacao"`
	// Documentos is retorno.sancoes[].documentos, a list.
	Documentos []UKHmTreasuryRetornoSancoesDocumentos `json:"documentos"`
	// Endereco is retorno.sancoes[].endereco.
	Endereco UKHmTreasuryRetornoSancoesEndereco `json:"endereco"`
	// GroupID is retorno.sancoes[].groupID, documented as a string.
	GroupID Text `json:"groupID"`
	// Nacionalidade is retorno.sancoes[].nacionalidade, documented as a string.
	Nacionalidade Text `json:"nacionalidade"`
	// Nome is retorno.sancoes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// OutrasInformacoes is retorno.sancoes[].outrasInformacoes, documented as a string.
	OutrasInformacoes Text `json:"outrasInformacoes"`
	// PaisNascimento is retorno.sancoes[].paisNascimento, documented as a string.
	PaisNascimento Text `json:"paisNascimento"`
	// Posicao is retorno.sancoes[].posicao, documented as a string.
	Posicao Text `json:"posicao"`
	// Regime is retorno.sancoes[].regime, documented as a string.
	Regime Text `json:"regime"`
	// Status is retorno.sancoes[].status, documented as a string.
	Status Text `json:"status"`
	// Tipo is retorno.sancoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

UKHmTreasuryRetornoSancoes is retorno.sancoes[] in the answer of UKHmTreasury.

type UKHmTreasuryRetornoSancoesDocumentos 

type UKHmTreasuryRetornoSancoesDocumentos struct {
	// Detalhes is retorno.sancoes[].documentos[].detalhes, documented as a string.
	Detalhes Text `json:"detalhes"`
	// Documento is retorno.sancoes[].documentos[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
}

UKHmTreasuryRetornoSancoesDocumentos is retorno.sancoes[].documentos[] in the answer of UKHmTreasury.

type UKHmTreasuryRetornoSancoesEndereco 

type UKHmTreasuryRetornoSancoesEndereco struct {
	// CodigoPostal is retorno.sancoes[].endereco.codigoPostal, documented as a string.
	CodigoPostal Text `json:"codigoPostal"`
	// EnderecoCompleto is retorno.sancoes[].endereco.enderecoCompleto, documented as a string.
	EnderecoCompleto Text `json:"enderecoCompleto" pii:"address"`
	// Pais is retorno.sancoes[].endereco.pais, documented as a string.
	Pais Text `json:"pais"`
}

UKHmTreasuryRetornoSancoesEndereco is retorno.sancoes[].endereco in the answer of UKHmTreasury.

type UnitedNationsSecurityListParams 

type UnitedNationsSecurityListParams struct {
	// Nome is sent as Nome. O parâmetro NOME pode ser enviado em maiúsculo ou minúsculo.
	Nome string
	// Sobrenome is sent as Sobrenome. Named by the endpoint template only; the parameter table does not list it.
	Sobrenome string
}

UnitedNationsSecurityListParams are the parameters of UnitedNationsSecurityList (UNSCCL - United Nations Security Council Consolidated List).

func (UnitedNationsSecurityListParams) Request 

func (p UnitedNationsSecurityListParams) Request() (Request, error)

Request builds the Request for UnitedNationsSecurityList.

type UnitedNationsSecurityListRetorno 

type UnitedNationsSecurityListRetorno struct {
	// NomeConsultado is retorno.nomeConsultado, documented as a string.
	NomeConsultado Text `json:"nomeConsultado" pii:"name"`
	// Observacoes is retorno.observacoes, documented as a string.
	Observacoes Text `json:"observacoes"`
	// ResultadosEncontrados is retorno.resultadosEncontrados, documented as a number.
	ResultadosEncontrados Number `json:"resultadosEncontrados"`
	// Sancoes is retorno.sancoes, a list.
	Sancoes []UnitedNationsSecurityListRetornoSancoes `json:"sancoes"`
}

UnitedNationsSecurityListRetorno is retorno in the answer of UnitedNationsSecurityList.

type UnitedNationsSecurityListRetornoSancoes 

type UnitedNationsSecurityListRetornoSancoes struct {
	// Alcunhas is retorno.sancoes[].alcunhas, a list.
	Alcunhas []Text `json:"alcunhas"`
	// DataInclusao is retorno.sancoes[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// DataNascimento is retorno.sancoes[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DatasAtualizacoes is retorno.sancoes[].datasAtualizacoes, a list.
	DatasAtualizacoes []Text `json:"datasAtualizacoes"`
	// Designacoes is retorno.sancoes[].designacoes, a list.
	Designacoes []Text `json:"designacoes"`
	// Documentos is retorno.sancoes[].documentos, a list.
	Documentos []UnitedNationsSecurityListRetornoSancoesDocumentos `json:"documentos"`
	// Enderecos is retorno.sancoes[].enderecos, a list.
	Enderecos []UnitedNationsSecurityListRetornoSancoesEnderecos `json:"enderecos"`
	// LocalNascimento is retorno.sancoes[].localNascimento, documented as a string.
	LocalNascimento Text `json:"localNascimento"`
	// Nacionalidades is retorno.sancoes[].nacionalidades, a list.
	Nacionalidades []Text `json:"nacionalidades"`
	// Nome is retorno.sancoes[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
	// NomeEscritaOriginal is retorno.sancoes[].nomeEscritaOriginal, documented as a string.
	NomeEscritaOriginal Text `json:"nomeEscritaOriginal" pii:"name"`
	// NumeroRegistro is retorno.sancoes[].numeroRegistro, documented as a string.
	NumeroRegistro Text `json:"numeroRegistro"`
	// Observacao is retorno.sancoes[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Referencia is retorno.sancoes[].referencia, documented as a string.
	Referencia Text `json:"referencia"`
	// Sexo is retorno.sancoes[].sexo, documented as a string.
	Sexo Text `json:"sexo"`
	// Sobrenome is retorno.sancoes[].sobrenome, documented as a string.
	Sobrenome Text `json:"sobrenome" pii:"name"`
	// Tipo is retorno.sancoes[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
	// Titulos is retorno.sancoes[].titulos, a list.
	Titulos []Text `json:"titulos"`
	// UnLista is retorno.sancoes[].unLista, documented as a string.
	UnLista Text `json:"unLista"`
	// Versao is retorno.sancoes[].versao, documented as a string.
	Versao Text `json:"versao"`
}

UnitedNationsSecurityListRetornoSancoes is retorno.sancoes[] in the answer of UnitedNationsSecurityList.

type UnitedNationsSecurityListRetornoSancoesDocumentos 

type UnitedNationsSecurityListRetornoSancoesDocumentos struct {
	// DataEmissao is retorno.sancoes[].documentos[].dataEmissao, documented as a string.
	DataEmissao Text `json:"dataEmissao"`
	// Documento is retorno.sancoes[].documentos[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Observacao is retorno.sancoes[].documentos[].observacao, documented as a string.
	Observacao Text `json:"observacao"`
	// Tipo is retorno.sancoes[].documentos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

UnitedNationsSecurityListRetornoSancoesDocumentos is retorno.sancoes[].documentos[] in the answer of UnitedNationsSecurityList.

type UnitedNationsSecurityListRetornoSancoesEnderecos 

type UnitedNationsSecurityListRetornoSancoesEnderecos struct {
	// Cidade is retorno.sancoes[].enderecos[].cidade, documented as a string.
	Cidade Text `json:"cidade" pii:"address"`
	// CodigoPostal is retorno.sancoes[].enderecos[].codigoPostal, documented as a string.
	CodigoPostal Text `json:"codigoPostal"`
	// Endereco is retorno.sancoes[].enderecos[].endereco, documented as a string.
	Endereco Text `json:"endereco" pii:"address"`
	// Estado is retorno.sancoes[].enderecos[].estado, documented as a string.
	Estado Text `json:"estado"`
	// Pais is retorno.sancoes[].enderecos[].pais, documented as a string.
	Pais Text `json:"pais"`
}

UnitedNationsSecurityListRetornoSancoesEnderecos is retorno.sancoes[].enderecos[] in the answer of UnitedNationsSecurityList.

type VerificacaoEmpregadorTrabalhoForcadoParams 

type VerificacaoEmpregadorTrabalhoForcadoParams struct {
	// CNPJ is sent as Cnpj. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as Cpf. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

VerificacaoEmpregadorTrabalhoForcadoParams are the parameters of VerificacaoEmpregadorTrabalhoForcado (Verificação de Empregador - Trabalho Forçado).

func (VerificacaoEmpregadorTrabalhoForcadoParams) Request 

func (p VerificacaoEmpregadorTrabalhoForcadoParams) Request() (Request, error)

Request builds the Request for VerificacaoEmpregadorTrabalhoForcado.

type VerificacaoEmpregadorTrabalhoForcadoRetorno 

type VerificacaoEmpregadorTrabalhoForcadoRetorno struct {
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// Empregador is retorno.empregador, documented as a string.
	Empregador Text `json:"empregador"`
	// Locais is retorno.locais, a list.
	Locais []VerificacaoEmpregadorTrabalhoForcadoRetornoLocais `json:"locais"`
	// PossuiTrabalhoForcado is retorno.possuiTrabalhoForcado, documented as a boolean.
	PossuiTrabalhoForcado Flag `json:"possuiTrabalhoForcado"`
	// Status is retorno.status, documented as a string.
	Status Text `json:"status"`
	// TotalTrabalhadores is retorno.totalTrabalhadores, documented as a number.
	TotalTrabalhadores Number `json:"totalTrabalhadores"`
}

VerificacaoEmpregadorTrabalhoForcadoRetorno is retorno in the answer of VerificacaoEmpregadorTrabalhoForcado.

type VerificacaoEmpregadorTrabalhoForcadoRetornoLocais 

type VerificacaoEmpregadorTrabalhoForcadoRetornoLocais struct {
	// AnoAcaoFiscal is retorno.locais[].anoAcaoFiscal, documented as a string.
	AnoAcaoFiscal Text `json:"anoAcaoFiscal"`
	// Cnae is retorno.locais[].cnae, documented as a string.
	Cnae Text `json:"cnae"`
	// DataAdministrativa is retorno.locais[].dataAdministrativa, documented as a string.
	DataAdministrativa Text `json:"dataAdministrativa"`
	// DataInclusao is retorno.locais[].dataInclusao, documented as a string.
	DataInclusao Text `json:"dataInclusao"`
	// Estabelecimento is retorno.locais[].estabelecimento, documented as a string.
	Estabelecimento Text `json:"estabelecimento"`
	// QuantidadeTrabalhadores is retorno.locais[].quantidadeTrabalhadores, documented as a number.
	QuantidadeTrabalhadores Number `json:"quantidadeTrabalhadores"`
	// Status is retorno.locais[].status, documented as a string.
	Status Text `json:"status"`
	// Uf is retorno.locais[].uf, documented as a string.
	Uf Text `json:"uf"`
}

VerificacaoEmpregadorTrabalhoForcadoRetornoLocais is retorno.locais[] in the answer of VerificacaoEmpregadorTrabalhoForcado.

type VinculoEmpregaticioParams 

type VinculoEmpregaticioParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
}

VinculoEmpregaticioParams are the parameters of VinculoEmpregaticio (Vínculo Empregatício).

func (VinculoEmpregaticioParams) Request 

func (p VinculoEmpregaticioParams) Request() (Request, error)

Request builds the Request for VinculoEmpregaticio.

type VinculoEmpregaticioRetorno 

type VinculoEmpregaticioRetorno struct {
	// Cnpj is retorno.cnpj, documented as a string.
	Cnpj Text `json:"cnpj" pii:"document"`
	// DataConsulta is retorno.dataConsulta, documented as a string.
	DataConsulta Text `json:"dataConsulta"`
	// Funcionarios is retorno.funcionarios, a list.
	Funcionarios []VinculoEmpregaticioRetornoFuncionarios `json:"funcionarios"`
	// QuantidadeFuncionarios is retorno.quantidadeFuncionarios, documented as a number.
	QuantidadeFuncionarios Number `json:"quantidadeFuncionarios"`
	// RazaoSocial is retorno.razaoSocial, documented as a string.
	RazaoSocial Text `json:"razaoSocial" pii:"name"`
}

VinculoEmpregaticioRetorno is retorno in the answer of VinculoEmpregaticio.

type VinculoEmpregaticioRetornoFuncionarios 

type VinculoEmpregaticioRetornoFuncionarios struct {
	// CodigoCBO is retorno.funcionarios[].codigoCBO, documented as a string.
	CodigoCBO Text `json:"codigoCBO"`
	// Cpf is retorno.funcionarios[].cpf, documented as a string.
	Cpf Text `json:"cpf" pii:"document"`
	// DataAdmissao is retorno.funcionarios[].dataAdmissao, documented as a string.
	DataAdmissao Text `json:"dataAdmissao"`
	// DataNascimento is retorno.funcionarios[].dataNascimento, documented as a string.
	DataNascimento Text `json:"dataNascimento" pii:"birthdate"`
	// DescricaoCBO is retorno.funcionarios[].descricaoCBO, documented as a string.
	DescricaoCBO Text `json:"descricaoCBO"`
	// Nome is retorno.funcionarios[].nome, documented as a string.
	Nome Text `json:"nome" pii:"name"`
}

VinculoEmpregaticioRetornoFuncionarios is retorno.funcionarios[] in the answer of VinculoEmpregaticio.

type VinculosSocietariosParams 

type VinculosSocietariosParams struct {
	// CNPJ is sent as CNPJ. O parâmetro CNPJ pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CNPJ string
	// CPF is sent as CPF. O parâmetro CPF pode ser enviado com ou sem formatação. Checked before any request; sent bare.
	CPF string
}

VinculosSocietariosParams are the parameters of VinculosSocietarios (Vínculos Societários).

func (VinculosSocietariosParams) Request 

func (p VinculosSocietariosParams) Request() (Request, error)

Request builds the Request for VinculosSocietarios.

type VinculosSocietariosRetorno 

type VinculosSocietariosRetorno struct {
	// DocumentoConsultado is retorno.documentoConsultado, documented as a string.
	DocumentoConsultado Text `json:"documentoConsultado" pii:"document"`
	// NomeEntidade is retorno.nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PepMatriz is retorno.pepMatriz, documented as a boolean.
	PepMatriz Flag `json:"pepMatriz"`
	// Relacionamentos is retorno.relacionamentos, a list.
	Relacionamentos []VinculosSocietariosRetornoRelacionamentos `json:"relacionamentos"`
}

VinculosSocietariosRetorno is retorno in the answer of VinculosSocietarios.

type VinculosSocietariosRetornoRelacionamentos 

type VinculosSocietariosRetornoRelacionamentos struct {
	// Documento is retorno.relacionamentos[].documento, documented as a string.
	Documento Text `json:"documento" pii:"document"`
	// Grau is retorno.relacionamentos[].grau, documented as a string.
	Grau Text `json:"grau"`
	// Historicos is retorno.relacionamentos[].historicos, a list.
	Historicos []VinculosSocietariosRetornoRelacionamentosHistoricos `json:"historicos"`
	// Nivel is retorno.relacionamentos[].nivel, documented as a number.
	Nivel Number `json:"nivel"`
	// NomeEntidade is retorno.relacionamentos[].nomeEntidade, documented as a string.
	NomeEntidade Text `json:"nomeEntidade" pii:"name"`
	// PepMatriz is retorno.relacionamentos[].pepMatriz, documented as a boolean.
	PepMatriz Flag `json:"pepMatriz"`
	// Relacionamentos is retorno.relacionamentos[].relacionamentos, a list.
	Relacionamentos []Text `json:"relacionamentos"`
	// Status is retorno.relacionamentos[].status, documented as a boolean.
	Status Flag `json:"status"`
	// Tipo is retorno.relacionamentos[].tipo, documented as a string.
	Tipo Text `json:"tipo"`
}

VinculosSocietariosRetornoRelacionamentos is retorno.relacionamentos[] in the answer of VinculosSocietarios.

type VinculosSocietariosRetornoRelacionamentosHistoricos 

type VinculosSocietariosRetornoRelacionamentosHistoricos struct {
	// Cargo is retorno.relacionamentos[].historicos[].cargo, documented as a string.
	Cargo Text `json:"cargo"`
	// DataFim is retorno.relacionamentos[].historicos[].dataFim, documented as a string.
	DataFim Text `json:"dataFim"`
	// DataInicio is retorno.relacionamentos[].historicos[].dataInicio, documented as a string.
	DataInicio Text `json:"dataInicio"`
	// Status is retorno.relacionamentos[].historicos[].status, documented as a boolean.
	Status Flag `json:"status"`
}

VinculosSocietariosRetornoRelacionamentosHistoricos is retorno.relacionamentos[].historicos[] in the answer of VinculosSocietarios.

Source Files

View all Source files

Directories

Path Synopsis
cmd
directd-catalog command
Command directd-catalog reads Direct Data's public API documentation and writes catalog/catalog.json, the catalogue the package's products, request builders and response types are generated from.
 Command directd-catalog reads Direct Data's public API documentation and writes catalog/catalog.json, the catalogue the package's products, request builders and response types are generated from.
directd-smoke command
Command directd-smoke makes a capped run of real Direct Data queries, to check the client against the live API.
 Command directd-smoke makes a capped run of real Direct Data queries, to check the client against the live API.
internal
catalog
Package catalog reads Direct Data's public API documentation and holds the catalogue built from it.
 Package catalog reads Direct Data's public API documentation and holds the catalogue built from it.
gen
Package gen generates the package's products, response types, request builders and README table from catalog/catalog.json.
 Package gen generates the package's products, response types, request builders and README table from catalog/catalog.json.
gen/run command
Command run writes the generated files from catalog/catalog.json.
 Command run writes the generated files from catalog/catalog.json.
pii
Package pii classifies the fields of Direct Data responses by the kind of personal data they hold, from the field's JSON key alone.
 Package pii classifies the fields of Direct Data responses by the kind of personal data they hold, from the field's JSON key alone.
smoke
Package smoke is the body of cmd/directd-smoke: a capped run of real Direct Data queries, to check the client against the live API.
 Package smoke is the body of cmd/directd-smoke: a capped run of real Direct Data queries, to check the client against the live API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.