{"openapi":"3.1.0","info":{"title":"Olhary API","version":"1.0.0","description":"Consultas públicas e agregações da Olhary, compartilhadas pelo produto e por integrações via API key. Operações que exigem login gov.br, automação de portal ou emissão de certidões não fazem parte desta API."},"servers":[{"url":"/","description":"Servidor atual"}],"externalDocs":{"description":"Guia da API e conexão com apps de IA","url":"https://olhary.ai/docs"},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Chave criada pelo usuário em Configurações → Chaves de API."}},"schemas":{"BancoPrecosSearchResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BancoPrecosPrice"}}},"required":["data"]},"BancoPrecosPrice":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"unit":{"type":"string"},"unit_price":{"type":"string","pattern":"^(?:\\d{1,3}(?:\\.\\d{3})*|\\d+),\\d{2,4}$"},"source":{"type":"string"},"uf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"reference_url":{"type":"string","nullable":true,"format":"uri"},"reference_date":{"type":"string","nullable":true,"format":"date"},"price_kind":{"type":"string","enum":["homologated","estimated"]}},"required":["code","description","unit","unit_price","source","uf","reference_url","reference_date","price_kind"]},"BancoPrecosError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Stable public API code, including INVALID_REQUEST, RATE_LIMIT_EXCEEDED, and BANCO_PRECOS_SEARCH.","example":"RATE_LIMIT_EXCEEDED"},"message":{"type":"string"},"details":{"nullable":true}},"required":["code","message"]}},"required":["error"]},"CompanyRegistryResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyRegistry"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyRegistry":{"type":"object","properties":{"documento":{"type":"string"},"tipo_documento":{"type":"string"},"cnpj_basico":{"type":"string"},"razao_social":{"type":"string"},"nome_fantasia":{"type":"string","nullable":true},"situacao":{"type":"string"},"data_situacao":{"type":"string"},"motivo_situacao":{"type":"string","nullable":true},"data_abertura":{"type":"string"},"capital_social":{"type":"number"},"porte":{"type":"string","nullable":true},"matriz_filial":{"type":"string","nullable":true},"natureza_juridica":{"type":"object","properties":{"codigo":{"type":"string"},"descricao":{"type":"string"}},"required":["codigo","descricao"]},"atividade_principal":{"type":"object","nullable":true,"properties":{"codigo":{"type":"string"},"descricao":{"type":"string"}},"required":["codigo","descricao"]},"atividades_secundarias":{"type":"array","items":{"type":"object","properties":{"codigo":{"type":"string"},"descricao":{"type":"string"}},"required":["codigo","descricao"]}},"endereco":{"type":"object","properties":{"logradouro":{"type":"string"},"numero":{"type":"string"},"complemento":{"type":"string","nullable":true},"bairro":{"type":"string"},"cidade":{"type":"string"},"uf":{"type":"string"},"cep":{"type":"string"}},"required":["logradouro","numero","complemento","bairro","cidade","uf","cep"]},"telefones":{"type":"array","items":{"type":"object","properties":{"ddi":{"type":"string"},"ddd":{"type":"string"},"numero":{"type":"string"},"numero_completo":{"type":"string"},"estado":{"type":"string"},"operadora":{"type":"string"}},"required":["ddi","ddd","numero","numero_completo","estado","operadora"]}},"emails":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"dominio":{"type":"string"},"corporativo":{"type":"boolean"}},"required":["email","dominio","corporativo"]}},"socios":{"type":"array","items":{"type":"object","properties":{"nome":{"type":"string"},"documento":{"type":"string"},"tipo_documento":{"type":"string"},"tipo":{"type":"string"},"qualificacao":{"type":"string"},"data_entrada":{"type":"string"},"data_nascimento":{"type":"string","nullable":true},"sexo":{"type":"string","nullable":true},"idade":{"type":"number","nullable":true},"faixa_etaria":{"type":"string","nullable":true},"pais":{"type":"string"}},"required":["nome","documento","tipo_documento","tipo","qualificacao","data_entrada","data_nascimento","sexo","idade","faixa_etaria","pais"]}},"situacao_especial":{"type":"string","nullable":true},"data_situacao_especial":{"type":"string","nullable":true},"inscricoes_estaduais":{"type":"array","items":{"type":"object","properties":{"numero":{"type":"string"},"uf":{"type":"string"},"ativa":{"type":"boolean"}},"required":["numero","uf","ativa"]}}},"required":["documento","tipo_documento","cnpj_basico","razao_social","nome_fantasia","situacao","data_situacao","motivo_situacao","data_abertura","capital_social","porte","matriz_filial","natureza_juridica","atividade_principal","atividades_secundarias","endereco","telefones","emails","socios","situacao_especial","data_situacao_especial"]},"ApiMetadata":{"type":"object","properties":{"source":{"type":"string"},"cached":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time"}},"required":["source","cached","updatedAt"]},"ApiError":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"nullable":true}},"required":["code","message"]}},"required":["error"]},"CompanySanctionsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanySanctions"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanySanctions":{"type":"object","properties":{"verificado":{"type":"boolean","description":"true só quando CEIS, CNEP, CEPIM e leniência têm cópia verificada e recente. Com false, uma lista vazia não prova que a empresa está livre de sanções: confira `fontes`."},"consultadoEm":{"type":"string","description":"Quando esta resposta foi montada."},"fontes":{"type":"array","items":{"type":"object","properties":{"cadastro":{"type":"string","enum":["CEIS","CNEP","CEPIM","LENIENCIA"]},"verified":{"type":"boolean"},"atualizadoEm":{"type":"string","nullable":true}},"required":["cadastro","verified","atualizadoEm"]},"description":"Estado e data da cópia de cada cadastro consultado."},"documento":{"type":"string"},"sancionado":{"type":"boolean"},"totalAtivas":{"type":"integer"},"totalHistorico":{"type":"integer"},"sancoes":{"type":"array","items":{"type":"object","properties":{"cadastro":{"type":"string","enum":["CEIS","CNEP","CEPIM","LENIENCIA"]},"categoria":{"type":"string","nullable":true},"orgaoSancionador":{"type":"string","nullable":true},"ufOrgao":{"type":"string","nullable":true},"esfera":{"type":"string","nullable":true},"dataInicio":{"type":"string","nullable":true},"dataFim":{"type":"string","nullable":true},"fundamentacao":{"type":"string","nullable":true},"numeroProcesso":{"type":"string","nullable":true},"abrangencia":{"type":"string","nullable":true},"valorMulta":{"type":"number","nullable":true},"ativa":{"type":"boolean"}},"required":["cadastro","categoria","orgaoSancionador","ufOrgao","esfera","dataInicio","dataFim","fundamentacao","numeroProcesso","abrangencia","valorMulta","ativa"]}},"fonte":{"type":"string"},"atualizadoEm":{"type":"string","nullable":true}},"required":["verificado","consultadoEm","fontes","documento","sancionado","totalAtivas","totalHistorico","sancoes","fonte","atualizadoEm"]},"CompanyFederalPresenceResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyFederalPresence"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyFederalPresence":{"type":"object","properties":{"found":{"type":"boolean"},"razaoSocial":{"type":"string","nullable":true},"nomeFantasia":{"type":"string","nullable":true},"favorecidoDespesas":{"type":"boolean"},"possuiContratacao":{"type":"boolean"},"convenios":{"type":"boolean"},"favorecidoTransferencias":{"type":"boolean"},"participanteLicitacao":{"type":"boolean"},"emitiuNFe":{"type":"boolean"},"sancionadoCEIS":{"type":"boolean"},"sancionadoCNEP":{"type":"boolean"},"sancionadoCEPIM":{"type":"boolean"},"sancionadoCEAF":{"type":"boolean"},"beneficiadoRenunciaFiscal":{"type":"boolean"},"isentoImuneRenunciaFiscal":{"type":"boolean"},"habilitadoRenunciaFiscal":{"type":"boolean"}},"required":["found","razaoSocial","nomeFantasia","favorecidoDespesas","possuiContratacao","convenios","favorecidoTransferencias","participanteLicitacao","emitiuNFe","sancionadoCEIS","sancionadoCNEP","sancionadoCEPIM","sancionadoCEAF","beneficiadoRenunciaFiscal","isentoImuneRenunciaFiscal","habilitadoRenunciaFiscal"]},"CompanyFederalSpendingResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyFederalSpending"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyFederalSpending":{"type":"object","properties":{"contractsCount":{"type":"integer"},"contractsCountIsLowerBound":{"type":"boolean"},"contractsTotalValue":{"type":"number"},"contractsMedianValue":{"type":"number"},"contractsByOrgao":{"type":"array","items":{"type":"object","properties":{"orgao":{"type":"string"},"count":{"type":"integer"},"valor":{"type":"number"}},"required":["orgao","count","valor"]}},"topContracts":{"type":"array","items":{"type":"object","properties":{"objeto":{"type":"string"},"orgao":{"type":"string"},"valor":{"type":"number","nullable":true},"situacao":{"type":"string","nullable":true},"vigenciaInicio":{"type":"string","nullable":true},"vigenciaFim":{"type":"string","nullable":true}},"required":["objeto","orgao","valor","situacao","vigenciaInicio","vigenciaFim"]}},"receiptsWindowMonths":{"type":"integer"},"receiptsNet":{"type":"number"},"receiptsByOrgao":{"type":"array","items":{"type":"object","properties":{"orgao":{"type":"string"},"valor":{"type":"number"}},"required":["orgao","valor"]}},"receiptsIsLowerBound":{"type":"boolean"}},"required":["contractsCount","contractsCountIsLowerBound","contractsTotalValue","topContracts","receiptsWindowMonths","receiptsNet","receiptsByOrgao","receiptsIsLowerBound"]},"CompanyCmedResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyCmed"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyCmed":{"type":"object","properties":{"cnpj":{"type":"string"},"totalMedicamentos":{"type":"integer","minimum":0},"displayedMedicamentosTruncated":{"type":"boolean"},"produtosDistintosExibidos":{"type":"integer","minimum":0},"pfSemImpostosMinimoExibido":{"type":"number","nullable":true},"pfSemImpostosMaximoExibido":{"type":"number","nullable":true},"pmvgSemImpostosMinimoExibido":{"type":"number","nullable":true},"pmvgSemImpostosMaximoExibido":{"type":"number","nullable":true},"topClassesTerapeuticas":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"count":{"type":"integer","minimum":0}},"required":["label","count"]}},"medicamentos":{"type":"array","items":{"type":"object","properties":{"substancia":{"type":"string","nullable":true},"laboratorio":{"type":"string","nullable":true},"produto":{"type":"string","nullable":true},"apresentacao":{"type":"string","nullable":true},"classeTerapeutica":{"type":"string","nullable":true},"tarja":{"type":"string","nullable":true},"ggrem":{"type":"string","nullable":true},"registro":{"type":"string","nullable":true},"ean1":{"type":"string","nullable":true},"pfSemImpostos":{"type":"number","nullable":true},"pmvgSemImpostos":{"type":"number","nullable":true},"refreshedAt":{"type":"string","format":"date-time"}},"required":["substancia","laboratorio","produto","apresentacao","classeTerapeutica","tarja","ggrem","registro","ean1","pfSemImpostos","pmvgSemImpostos","refreshedAt"]}},"latestRefreshAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["cnpj","totalMedicamentos","displayedMedicamentosTruncated","produtosDistintosExibidos","pfSemImpostosMinimoExibido","pfSemImpostosMaximoExibido","pmvgSemImpostosMinimoExibido","pmvgSemImpostosMaximoExibido","topClassesTerapeuticas","medicamentos","latestRefreshAt"]},"CompanyCauResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyCau"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyCau":{"type":"object","properties":{"sourceUrl":{"type":"string","format":"uri"},"checkedAt":{"type":"string","format":"date-time"},"coverageYear":{"type":"integer"},"registrations":{"type":"array","items":{"type":"object","properties":{"cnpj":{"type":"string"},"name":{"type":"string","nullable":true},"registration":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true}},"required":["cnpj","name","registration","status","city","uf"]}},"contractedRrts":{"type":"array","items":{"type":"object","properties":{"number":{"type":"integer"},"status":{"type":"string","nullable":true},"activity":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"contractValue":{"type":"number","nullable":true},"startDate":{"type":"string","nullable":true}},"required":["number","status","activity","city","uf","contractValue","startDate"]}},"registrationsTruncated":{"type":"boolean"},"rrtsTruncated":{"type":"boolean"}},"required":["sourceUrl","checkedAt","coverageYear","registrations","contractedRrts","registrationsTruncated","rrtsTruncated"]},"CompanyTransferegovResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyTransferegov"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyTransferegov":{"type":"object","properties":{"totalConvenios":{"type":"integer"},"displayedConveniosTruncated":{"type":"boolean"},"valorConveniosExibidos":{"type":"number"},"valorLiberadoExibido":{"type":"number"},"convenios":{"type":"array","items":{"type":"object","properties":{"numeroConvenio":{"type":"string"},"situacao":{"type":"string","nullable":true},"objeto":{"type":"string","nullable":true},"orgaoConcedente":{"type":"string","nullable":true},"orgaoSuperior":{"type":"string","nullable":true},"municipio":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"tipoInstrumento":{"type":"string","nullable":true},"valorConvenio":{"type":"number","nullable":true},"valorLiberado":{"type":"number","nullable":true},"valorContrapartida":{"type":"number","nullable":true},"dataPublicacao":{"type":"string","nullable":true},"dataInicioVigencia":{"type":"string","nullable":true},"dataFinalVigencia":{"type":"string","nullable":true},"dataUltimaLiberacao":{"type":"string","nullable":true},"snapshotDate":{"type":"string"}},"required":["numeroConvenio","situacao","objeto","orgaoConcedente","orgaoSuperior","municipio","uf","tipoInstrumento","valorConvenio","valorLiberado","valorContrapartida","dataPublicacao","dataInicioVigencia","dataFinalVigencia","dataUltimaLiberacao","snapshotDate"]}},"latestSnapshotDate":{"type":"string","nullable":true}},"required":["totalConvenios","displayedConveniosTruncated","valorConveniosExibidos","valorLiberadoExibido","convenios","latestSnapshotDate"]},"CompanyTcuResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyTcu"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyTcu":{"type":"object","properties":{"razaoSocial":{"type":"string"},"cnpj":{"type":"string"},"certidoes":{"type":"array","items":{"type":"object","properties":{"emissor":{"type":"string"},"tipo":{"type":"string"},"dataHoraEmissao":{"type":"string"},"descricao":{"type":"string"},"situacao":{"type":"string"},"observacao":{"type":"string","nullable":true}},"required":["emissor","tipo","dataHoraEmissao","descricao","situacao","observacao"]}},"totalCertidoes":{"type":"integer","minimum":0},"regularCount":{"type":"integer","minimum":0},"irregularCount":{"type":"integer","minimum":0},"cnpjFoundInTcu":{"type":"boolean"}},"required":["razaoSocial","cnpj","certidoes","totalCertidoes","regularCount","irregularCount","cnpjFoundInTcu"]},"CompanySupplierPerformanceResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanySupplierPerformance"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanySupplierPerformance":{"type":"object","properties":{"totalWins":{"type":"integer","minimum":0},"totalHomologatedValue":{"type":"number"},"winsByPeriod":{"type":"array","items":{"type":"object","properties":{"period":{"type":"string"},"count":{"type":"integer","minimum":0},"value":{"type":"number"}},"required":["period","count","value"]}},"lowData":{"type":"boolean"}},"required":["totalWins","totalHomologatedValue","winsByPeriod","lowData"]},"CompanyTopBuyersResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyTopBuyers"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyTopBuyers":{"type":"object","properties":{"buyers":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"object","properties":{"kind":{"type":"string","enum":["company","person","unknown"]},"document":{"type":"string","nullable":true},"name":{"type":"string"},"masked":{"type":"boolean"}},"required":["kind","document","name","masked"]},"wins":{"type":"integer","minimum":0},"value":{"type":"number"}},"required":["ref","wins","value"]}},"lowData":{"type":"boolean"}},"required":["buyers","lowData"]},"CompanyCompetitorsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyCompetitors"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyCompetitors":{"type":"object","properties":{"competitors":{"type":"array","items":{"type":"object","properties":{"ref":{"type":"object","properties":{"kind":{"type":"string","enum":["company","person","unknown"]},"document":{"type":"string","nullable":true},"name":{"type":"string"},"masked":{"type":"boolean"}},"required":["kind","document","name","masked"]},"coOccurrences":{"type":"integer","minimum":0}},"required":["ref","coOccurrences"]}},"lowData":{"type":"boolean"}},"required":["competitors","lowData"]},"CompanyContractsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyContracts"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyContracts":{"type":"object","properties":{"contracts":{"type":"array","items":{"type":"object","properties":{"contratoId":{"type":"string"},"numeroControlePncp":{"type":"string","nullable":true},"objetoContrato":{"type":"string"},"fornecedor":{"type":"object","properties":{"kind":{"type":"string","enum":["company","person","unknown"]},"document":{"type":"string","nullable":true},"name":{"type":"string"},"masked":{"type":"boolean"}},"required":["kind","document","name","masked"]},"valorInicial":{"type":"number","nullable":true},"valorFinal":{"type":"number","nullable":true},"vigenciaInicio":{"type":"string","nullable":true},"vigenciaFim":{"type":"string","nullable":true},"termos":{"type":"array","items":{"type":"object","properties":{"tipo":{"type":"string"},"objeto":{"type":"string","nullable":true},"valorAcrescimo":{"type":"number","nullable":true},"valorReducao":{"type":"number","nullable":true},"dataAssinatura":{"type":"string","nullable":true},"dataPublicacao":{"type":"string","nullable":true}},"required":["tipo","objeto","valorAcrescimo","valorReducao","dataAssinatura","dataPublicacao"]}},"documentos":{"type":"array","items":{"type":"object","properties":{"sequencial":{"type":"integer"},"titulo":{"type":"string"},"tipoDocumento":{"type":"string"},"dataPublicacao":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["sequencial","titulo","tipoDocumento","dataPublicacao","url"]}}},"required":["contratoId","numeroControlePncp","objetoContrato","fornecedor","valorInicial","valorFinal","vigenciaInicio","vigenciaFim","termos","documentos"]}},"totalValue":{"type":"number"},"lowData":{"type":"boolean"}},"required":["contracts","totalValue","lowData"]},"CompanyAttentionResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CompanyAttention"},"metadata":{"$ref":"#/components/schemas/ApiMetadata"}},"required":["data","metadata"]},"CompanyAttention":{"type":"object","properties":{"level":{"type":"string","enum":["baixo","medio","elevado"]},"signals":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"severity":{"type":"string","enum":["info","atencao","alerta"]},"source":{"type":"string"},"params":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"}]}}},"required":["key","severity","source"]}}},"required":["level","signals"]},"FederalDocumentsResponse":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentCode":{"type":"string","nullable":true},"documentSummary":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"phase":{"type":"string","nullable":true},"documentKind":{"type":"string","nullable":true},"beneficiaryDocument":{"type":"string","nullable":true},"beneficiaryName":{"type":"string","nullable":true},"beneficiaryUf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"hasIntermediateBeneficiary":{"type":"boolean","nullable":true},"amount":{"type":"number","nullable":true},"function":{"type":"string","nullable":true},"subfunction":{"type":"string","nullable":true},"program":{"type":"string","nullable":true},"action":{"type":"string","nullable":true},"managingUnitCode":{"type":"string","nullable":true},"managingUnitName":{"type":"string","nullable":true},"agencyCode":{"type":"string","nullable":true},"agencyName":{"type":"string","nullable":true},"superiorAgencyCode":{"type":"string","nullable":true},"superiorAgencyName":{"type":"string","nullable":true},"processNumber":{"type":"string","nullable":true}},"required":["documentCode","documentSummary","date","phase","documentKind","beneficiaryDocument","beneficiaryName","beneficiaryUf","hasIntermediateBeneficiary","amount","function","subfunction","program","action","managingUnitCode","managingUnitName","agencyCode","agencyName","superiorAgencyCode","superiorAgencyName","processNumber"]}},"count":{"type":"integer","minimum":0},"pagesFetched":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"source":{"type":"string"},"retrievedAt":{"type":"string","format":"date-time"}},"required":["documents","count","pagesFetched","truncated","source","retrievedAt"]},"FederalCommitmentsResponse":{"type":"object","properties":{"commitments":{"type":"array","items":{"type":"object","properties":{"documentCode":{"type":"string","nullable":true},"documentSummary":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"phase":{"type":"string","nullable":true},"documentKind":{"type":"string","nullable":true},"beneficiaryDocument":{"type":"string","nullable":true},"beneficiaryName":{"type":"string","nullable":true},"beneficiaryUf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"hasIntermediateBeneficiary":{"type":"boolean","nullable":true},"amount":{"type":"number","nullable":true},"function":{"type":"string","nullable":true},"subfunction":{"type":"string","nullable":true},"program":{"type":"string","nullable":true},"action":{"type":"string","nullable":true},"managingUnitCode":{"type":"string","nullable":true},"managingUnitName":{"type":"string","nullable":true},"agencyCode":{"type":"string","nullable":true},"agencyName":{"type":"string","nullable":true},"superiorAgencyCode":{"type":"string","nullable":true},"superiorAgencyName":{"type":"string","nullable":true},"processNumber":{"type":"string","nullable":true}},"required":["documentCode","documentSummary","date","phase","documentKind","beneficiaryDocument","beneficiaryName","beneficiaryUf","hasIntermediateBeneficiary","amount","function","subfunction","program","action","managingUnitCode","managingUnitName","agencyCode","agencyName","superiorAgencyCode","superiorAgencyName","processNumber"]}},"count":{"type":"integer","minimum":0},"pagesFetched":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"source":{"type":"string"},"retrievedAt":{"type":"string","format":"date-time"}},"required":["commitments","count","pagesFetched","truncated","source","retrievedAt"]},"FederalInvoicesResponse":{"type":"object","properties":{"invoices":{"type":"array","items":{"type":"object","properties":{"invoiceId":{"type":"string","nullable":true},"accessKey":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"series":{"type":"string","nullable":true},"issuerDocument":{"type":"string","nullable":true},"issuerName":{"type":"string","nullable":true},"issuerMunicipality":{"type":"string","nullable":true},"recipientAgencyCode":{"type":"string","nullable":true},"recipientAgencyName":{"type":"string","nullable":true},"superiorAgencyCode":{"type":"string","nullable":true},"superiorAgencyName":{"type":"string","nullable":true},"amount":{"type":"number","nullable":true},"issueDate":{"type":"string","nullable":true},"latestEventType":{"type":"string","nullable":true},"latestEventDate":{"type":"string","nullable":true}},"required":["invoiceId","accessKey","number","series","issuerDocument","issuerName","issuerMunicipality","recipientAgencyCode","recipientAgencyName","superiorAgencyCode","superiorAgencyName","amount","issueDate","latestEventType","latestEventDate"]}},"count":{"type":"integer","minimum":0},"pagesFetched":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"source":{"type":"string"},"retrievedAt":{"type":"string","format":"date-time"}},"required":["invoices","count","pagesFetched","truncated","source","retrievedAt"]},"FederalCovidTransfersResponse":{"type":"object","properties":{"transfers":{"type":"array","items":{"type":"object","properties":{"month":{"type":"string","nullable":true},"transferType":{"type":"string","nullable":true},"agencyCode":{"type":"string","nullable":true},"beneficiaryType":{"type":"string","nullable":true},"beneficiaryDocument":{"type":"string","nullable":true},"beneficiaryName":{"type":"string","nullable":true},"function":{"type":"string","nullable":true},"program":{"type":"string","nullable":true},"action":{"type":"string","nullable":true},"expenseNatureCode":{"type":"string","nullable":true},"expenseNature":{"type":"string","nullable":true},"expenseCategoryCode":{"type":"string","nullable":true},"expenseCategory":{"type":"string","nullable":true},"amount":{"type":"number","nullable":true}},"required":["month","transferType","agencyCode","beneficiaryType","beneficiaryDocument","beneficiaryName","function","program","action","expenseNatureCode","expenseNature","expenseCategoryCode","expenseCategory","amount"]}},"count":{"type":"integer","minimum":0},"pagesFetched":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"source":{"type":"string"},"retrievedAt":{"type":"string","format":"date-time"}},"required":["transfers","count","pagesFetched","truncated","source","retrievedAt"]},"FederalAgreementsResponse":{"type":"object","properties":{"agreements":{"type":"array","items":{"type":"object","properties":{"agreementId":{"type":"string","nullable":true},"agreementNumber":{"type":"string","nullable":true},"startDate":{"type":"string","nullable":true},"endDate":{"type":"string","nullable":true},"publicationDate":{"type":"string","nullable":true},"status":{"type":"string","nullable":true},"convenantee":{"type":"string","nullable":true},"municipalityIbge":{"type":"string","nullable":true,"pattern":"^\\d{7}$"},"uf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"agencyCode":{"type":"string","nullable":true},"agencyName":{"type":"string","nullable":true},"managingUnitCode":{"type":"string","nullable":true},"managingUnitName":{"type":"string","nullable":true},"instrumentType":{"type":"string","nullable":true},"agreementValue":{"type":"number","nullable":true},"releasedValue":{"type":"number","nullable":true},"counterpartValue":{"type":"number","nullable":true},"processNumber":{"type":"string","nullable":true}},"required":["agreementId","agreementNumber","startDate","endDate","publicationDate","status","convenantee","municipalityIbge","uf","agencyCode","agencyName","managingUnitCode","managingUnitName","instrumentType","agreementValue","releasedValue","counterpartValue","processNumber"]}},"count":{"type":"integer","minimum":0},"pagesFetched":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"source":{"type":"string"},"retrievedAt":{"type":"string","format":"date-time"}},"required":["agreements","count","pagesFetched","truncated","source","retrievedAt"]},"FederalAmendmentsResponse":{"type":"object","properties":{"amendments":{"type":"array","items":{"type":"object","properties":{"amendmentCode":{"type":"string","nullable":true},"year":{"type":"integer","nullable":true},"type":{"type":"string","nullable":true},"authorLabel":{"type":"string","nullable":true},"authorName":{"type":"string","nullable":true},"amendmentNumber":{"type":"string","nullable":true},"spendingLocalityText":{"type":"string","nullable":true},"function":{"type":"string","nullable":true},"subfunction":{"type":"string","nullable":true},"committedAmount":{"type":"number","nullable":true},"liquidatedAmount":{"type":"number","nullable":true},"paidAmount":{"type":"number","nullable":true},"registeredOutstandingAmount":{"type":"number","nullable":true},"cancelledOutstandingAmount":{"type":"number","nullable":true},"paidOutstandingAmount":{"type":"number","nullable":true}},"required":["amendmentCode","year","type","authorLabel","authorName","amendmentNumber","spendingLocalityText","function","subfunction","committedAmount","liquidatedAmount","paidAmount","registeredOutstandingAmount","cancelledOutstandingAmount","paidOutstandingAmount"]}},"count":{"type":"integer","minimum":0},"pagesFetched":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"source":{"type":"string"},"retrievedAt":{"type":"string","format":"date-time"}},"required":["amendments","count","pagesFetched","truncated","source","retrievedAt"]},"FederalAmendmentDocumentsResponse":{"type":"object","properties":{"documents":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"string","nullable":true},"date":{"type":"string","nullable":true},"phase":{"type":"string","nullable":true},"documentCode":{"type":"string","nullable":true},"documentSummary":{"type":"string","nullable":true},"documentKind":{"type":"string","nullable":true},"amendmentType":{"type":"string","nullable":true}},"required":["documentId","date","phase","documentCode","documentSummary","documentKind","amendmentType"]}},"count":{"type":"integer","minimum":0},"pagesFetched":{"type":"integer","minimum":0},"truncated":{"type":"boolean"},"source":{"type":"string"},"retrievedAt":{"type":"string","format":"date-time"}},"required":["documents","count","pagesFetched","truncated","source","retrievedAt"]},"CompanyChamberExpensesResponse":{"type":"object","properties":{"cnpj":{"type":"string"},"year":{"type":"integer"},"expenses":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer","nullable":true,"minimum":1,"maximum":12},"deputyId":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true},"deputyName":{"type":"string"},"party":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"legislatureId":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true},"category":{"type":"string","nullable":true},"subcategory":{"type":"string","nullable":true},"supplierDocument":{"type":"string","nullable":true},"supplierName":{"type":"string","nullable":true},"documentGroupingId":{"type":"string","nullable":true},"documentNumber":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"documentDate":{"type":"string","nullable":true},"documentUrl":{"type":"string","nullable":true,"format":"uri"},"grossAmount":{"type":"number","nullable":true},"glosaAmount":{"type":"number","nullable":true},"netAmount":{"type":"number","nullable":true},"installment":{"type":"string","nullable":true},"lot":{"type":"string","nullable":true},"reimbursement":{"type":"string","nullable":true},"restitutionDate":{"type":"string","nullable":true},"restitutionAmount":{"type":"number","nullable":true}},"required":["year","month","deputyId","deputyName","party","uf","legislatureId","category","subcategory","supplierDocument","supplierName","documentGroupingId","documentNumber","documentType","documentDate","documentUrl","grossAmount","glosaAmount","netAmount","installment","lot","reimbursement","restitutionDate","restitutionAmount"]}},"sourceYear":{"type":"integer"},"count":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"limit":{"type":"integer","minimum":0,"exclusiveMinimum":true},"offset":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["cnpj","year","expenses","sourceYear","count","total","limit","offset","hasMore","source","warehouseUpdatedAt"]},"DeputyExpensesResponse":{"type":"object","properties":{"deputyId":{"type":"integer","minimum":0,"exclusiveMinimum":true},"year":{"type":"integer"},"expenses":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer"},"month":{"type":"integer","nullable":true,"minimum":1,"maximum":12},"deputyId":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true},"deputyName":{"type":"string"},"party":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"legislatureId":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true},"category":{"type":"string","nullable":true},"subcategory":{"type":"string","nullable":true},"supplierDocument":{"type":"string","nullable":true},"supplierName":{"type":"string","nullable":true},"documentGroupingId":{"type":"string","nullable":true},"documentNumber":{"type":"string","nullable":true},"documentType":{"type":"string","nullable":true},"documentDate":{"type":"string","nullable":true},"documentUrl":{"type":"string","nullable":true,"format":"uri"},"grossAmount":{"type":"number","nullable":true},"glosaAmount":{"type":"number","nullable":true},"netAmount":{"type":"number","nullable":true},"installment":{"type":"string","nullable":true},"lot":{"type":"string","nullable":true},"reimbursement":{"type":"string","nullable":true},"restitutionDate":{"type":"string","nullable":true},"restitutionAmount":{"type":"number","nullable":true}},"required":["year","month","deputyId","deputyName","party","uf","legislatureId","category","subcategory","supplierDocument","supplierName","documentGroupingId","documentNumber","documentType","documentDate","documentUrl","grossAmount","glosaAmount","netAmount","installment","lot","reimbursement","restitutionDate","restitutionAmount"]}},"sourceYear":{"type":"integer"},"count":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"limit":{"type":"integer","minimum":0,"exclusiveMinimum":true},"offset":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["deputyId","year","expenses","sourceYear","count","total","limit","offset","hasMore","source","warehouseUpdatedAt"]},"DeputySearchResponse":{"type":"object","properties":{"deputies":{"type":"array","items":{"type":"object","properties":{"deputyId":{"type":"integer","minimum":0,"exclusiveMinimum":true},"name":{"type":"string"},"party":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"legislatureId":{"type":"integer","nullable":true,"minimum":0,"exclusiveMinimum":true},"photoUrl":{"type":"string","nullable":true,"format":"uri"},"email":{"type":"string","nullable":true}},"required":["deputyId","name","party","uf","legislatureId","photoUrl","email"]}},"count":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"limit":{"type":"integer","minimum":0,"exclusiveMinimum":true},"offset":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["deputies","count","total","limit","offset","hasMore","source","warehouseUpdatedAt"]},"TransferegovBankOrdersResponse":{"type":"object","properties":{"agreementNumber":{"type":"string"},"orders":{"type":"array","items":{"type":"object","properties":{"orderNumber":{"type":"string"},"originalNumber":{"type":"string","nullable":true},"issuedAt":{"type":"string","nullable":true},"releasedAmount":{"type":"number","nullable":true},"snapshotDate":{"type":"string"}},"required":["orderNumber","originalNumber","issuedAt","releasedAmount","snapshotDate"]}},"count":{"type":"integer"},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"},"hasMore":{"type":"boolean"},"snapshotDate":{"type":"string","nullable":true},"source":{"type":"string"}},"required":["agreementNumber","orders","count","total","limit","offset","hasMore","snapshotDate","source"]},"CatalogSearchResponse":{"type":"object","properties":{"query":{"type":"string"},"type":{"type":"string","nullable":true,"enum":["material","service",null]},"items":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["material","service"]},"code":{"type":"string"},"description":{"type":"string","nullable":true},"classCode":{"type":"string","nullable":true},"className":{"type":"string","nullable":true}},"required":["type","code","description","classCode","className"]}},"count":{"type":"integer","minimum":0},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["query","type","items","count","source","warehouseUpdatedAt"]},"ReferencePriceResponse":{"type":"object","properties":{"type":{"type":"string","enum":["material","service"]},"code":{"type":"string"},"description":{"type":"string","nullable":true},"state":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"stats":{"type":"object","properties":{"count":{"type":"integer","minimum":0},"minimum":{"type":"number","nullable":true},"median":{"type":"number","nullable":true},"mean":{"type":"number","nullable":true},"maximum":{"type":"number","nullable":true}},"required":["count","minimum","median","mean","maximum"]},"sample":{"type":"array","items":{"type":"object","properties":{"itemDescription":{"type":"string","nullable":true},"unitPrice":{"type":"number","nullable":true},"quantity":{"type":"number","nullable":true},"supplyUnit":{"type":"string","nullable":true},"supplierDocument":{"type":"string","nullable":true},"supplierName":{"type":"string","nullable":true},"brand":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"municipality":{"type":"string","nullable":true},"purchasingUnitCode":{"type":"string","nullable":true},"agencyName":{"type":"string","nullable":true},"purchasedAt":{"type":"string","nullable":true}},"required":["itemDescription","unitPrice","quantity","supplyUnit","supplierDocument","supplierName","brand","state","municipality","purchasingUnitCode","agencyName","purchasedAt"]}},"methodologyUrl":{"type":"string","format":"uri"},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["type","code","description","state","stats","sample","methodologyUrl","source","warehouseUpdatedAt"]},"ProcurementSearchResponse":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string","enum":["compra","ata","contrato"]},"scope":{"type":"string","enum":["objeto","item"]},"controlNumber":{"type":"string"},"titulo":{"type":"string"},"matchedItems":{"type":"array","items":{"type":"object","properties":{"descricao":{"type":"string"},"quantidadeEValor":{"type":"string"}},"required":["descricao"]}},"matchedItemCount":{"type":"integer"},"compraControlNumber":{"type":"string"},"ataCount":{"type":"integer"},"orgaoNome":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"municipioNome":{"type":"string","nullable":true},"valor":{"type":"number","nullable":true},"lifecycleStatus":{"type":"string","nullable":true},"vigenciaStatus":{"type":"string","nullable":true},"dataPublicacaoPncp":{"type":"string","nullable":true},"dataEncerramentoProposta":{"type":"string"},"lastChangedAt":{"type":"string","nullable":true},"similarityScore":{"type":"number","nullable":true},"winnerSanctioned":{"type":"boolean"},"bidderSanctioned":{"type":"boolean"},"sistemaOrigem":{"type":"string"}},"required":["entityType","controlNumber","titulo","orgaoNome","uf","municipioNome","valor","lifecycleStatus","vigenciaStatus","dataPublicacaoPncp","lastChangedAt","similarityScore"]}},"hasMore":{"type":"boolean"},"truncated":{"type":"boolean"},"appliedFacets":{"type":"object","properties":{"entityType":{"type":"string","enum":["compra","ata","contrato"]},"scope":{"type":"string","enum":["objeto","item"]},"lifecycleStatus":{"type":"string","enum":["recebendo_proposta","em_julgamento","encerrada","suspensa","pre"]},"vigenciaStatus":{"type":"string","enum":["vigente","nao_vigente"]},"uf":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"]},"municipioIbge":{"type":"string","pattern":"^\\d{7}$"},"raioKm":{"type":"number","minimum":0,"maximum":300},"orgaoCnpj":{"type":"string"},"modalidadeId":{"type":"integer","minimum":0,"exclusiveMinimum":true},"valorMin":{"type":"number","minimum":0},"valorMax":{"type":"number","minimum":0},"dataPublicacaoAfter":{"type":"string","format":"date"},"dataPublicacaoBefore":{"type":"string","format":"date"},"permiteAdesao":{"type":"boolean"},"srp":{"type":"boolean","description":"Sistema de Registro de Preços tenders only. A compra attribute: atas and contratos never match true."},"beneficioMeEpp":{"type":"boolean","description":"TRUE keeps only tenders with at least one item reserved for micro/small enterprises (participação exclusiva or cota reservada ME/EPP). Compra-only; FALSE reads as unset."},"esferaId":{"type":"string","enum":["F","E","M","D","N"],"description":"Buyer government sphere: F(ederal), E(stadual), M(unicipal), D(istrital), N(ão se aplica; e.g. state-owned enterprises)."},"excludeTerms":{"type":"array","items":{"type":"string","minLength":1,"maxLength":60},"maxItems":10,"description":"Negative keywords: results whose text contains any of these terms are dropped (accent-insensitive, plural-tolerant). A term matching the tender's objeto excludes the whole tender."},"excludeOrgaos":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Órgão CNPJs (14 characters) whose tenders are excluded from results."},"excludeModalidades":{"type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":true},"maxItems":13,"description":"Modality ids excluded from results."}}},"effectiveQuery":{"type":"string"},"curatedTitle":{"type":"string"}},"required":["results","hasMore"]},"ProcurementSearchRequest":{"type":"object","properties":{"query":{"type":"string","maxLength":500},"facets":{"type":"object","properties":{"entityType":{"type":"string","enum":["compra","ata","contrato"]},"scope":{"type":"string","enum":["objeto","item"]},"lifecycleStatus":{"type":"string","enum":["recebendo_proposta","em_julgamento","encerrada","suspensa","pre"]},"vigenciaStatus":{"type":"string","enum":["vigente","nao_vigente"]},"uf":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"]},"municipioIbge":{"type":"string","pattern":"^\\d{7}$"},"raioKm":{"type":"number","minimum":0,"maximum":300},"orgaoCnpj":{"type":"string"},"modalidadeId":{"type":"integer","minimum":0,"exclusiveMinimum":true},"valorMin":{"type":"number","minimum":0},"valorMax":{"type":"number","minimum":0},"dataPublicacaoAfter":{"type":"string","format":"date"},"dataPublicacaoBefore":{"type":"string","format":"date"},"permiteAdesao":{"type":"boolean"},"srp":{"type":"boolean","description":"Sistema de Registro de Preços tenders only. A compra attribute: atas and contratos never match true."},"beneficioMeEpp":{"type":"boolean","description":"TRUE keeps only tenders with at least one item reserved for micro/small enterprises (participação exclusiva or cota reservada ME/EPP). Compra-only; FALSE reads as unset."},"esferaId":{"type":"string","enum":["F","E","M","D","N"],"description":"Buyer government sphere: F(ederal), E(stadual), M(unicipal), D(istrital), N(ão se aplica; e.g. state-owned enterprises)."},"excludeTerms":{"type":"array","items":{"type":"string","minLength":1,"maxLength":60},"maxItems":10,"description":"Negative keywords: results whose text contains any of these terms are dropped (accent-insensitive, plural-tolerant). A term matching the tender's objeto excludes the whole tender."},"excludeOrgaos":{"type":"array","items":{"type":"string"},"maxItems":20,"description":"Órgão CNPJs (14 characters) whose tenders are excluded from results."},"excludeModalidades":{"type":"array","items":{"type":"integer","minimum":0,"exclusiveMinimum":true},"maxItems":13,"description":"Modality ids excluded from results."}},"default":{}},"sort":{"type":"string","enum":["relevance","recent","value"],"description":"Ordering for keyword searches: 'recent' reorders the relevant matches by publication date (newest first); omitted or 'relevance' keeps semantic relevance ranking. Filter-only searches are always publication-date ordered."},"limit":{"type":"integer","minimum":1,"maximum":100,"default":20},"offset":{"type":"integer","minimum":0,"default":0}}},"CompanySenateExpensesResponse":{"type":"object","properties":{"cnpj":{"type":"string"},"year":{"type":"integer","nullable":true},"expenses":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer","nullable":true},"month":{"type":"integer","nullable":true},"senator":{"type":"string"},"expenseType":{"type":"string"},"supplierDocument":{"type":"string"},"supplierName":{"type":"string"},"document":{"type":"string"},"date":{"type":"string","nullable":true},"details":{"type":"string"},"reimbursedAmount":{"type":"number","nullable":true},"documentCode":{"type":"string"},"sourceUrl":{"type":"string","format":"uri"}},"required":["year","month","senator","expenseType","supplierDocument","supplierName","document","date","details","reimbursedAmount","documentCode","sourceUrl"]}},"count":{"type":"integer","minimum":0},"total":{"type":"integer","minimum":0},"limit":{"type":"integer","minimum":0,"exclusiveMinimum":true},"offset":{"type":"integer","minimum":0},"hasMore":{"type":"boolean"},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["cnpj","year","expenses","count","total","limit","offset","hasMore","source","warehouseUpdatedAt"]},"CapagResponse":{"type":"object","properties":{"status":{"type":"string","enum":["available","not_found"]},"scope":{"type":"string","enum":["municipality","state"]},"entityName":{"type":"string","nullable":true},"municipalityIbge":{"type":"string","nullable":true},"uf":{"type":"string","nullable":true},"grade":{"type":"string","nullable":true,"enum":["A+","A","B+","B","C","D",null]},"riskLevel":{"type":"string","enum":["low","moderate","elevated","critical","unknown"]},"eligibleForUnionGuarantee":{"type":"boolean","nullable":true},"indicators":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["debt","currentSavings","relativeLiquidity"]},"valuePercent":{"type":"number","nullable":true},"grade":{"type":"string","enum":["A","B","C","not_available"]}},"required":["key","valuePercent","grade"]}},"observation":{"type":"string","nullable":true},"source":{"type":"object","nullable":true,"properties":{"dataset":{"type":"string","enum":["capag-municipios","capag-estados"]},"datasetTitle":{"type":"string","nullable":true},"resourceName":{"type":"string","nullable":true},"resourceUrl":{"type":"string","nullable":true,"format":"uri"},"referenceYear":{"type":"integer","nullable":true},"referenceDate":{"type":"string","nullable":true},"lastModified":{"type":"string","nullable":true},"methodology":{"type":"string"},"methodologyUrl":{"type":"string","format":"uri"}},"required":["dataset","datasetTitle","resourceName","resourceUrl","referenceYear","referenceDate","lastModified","methodology","methodologyUrl"]},"referenceYear":{"type":"integer","nullable":true},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["status","scope","entityName","municipalityIbge","uf","grade","riskLevel","eligibleForUnionGuarantee","indicators","observation","source","referenceYear","warehouseUpdatedAt"]},"CnaeResponse":{"type":"object","properties":{"status":{"type":"string","enum":["available","not_found"]},"code":{"type":"string"},"description":{"type":"string","nullable":true},"activities":{"type":"array","items":{"type":"string"}},"class":{"type":"object","nullable":true,"properties":{"code":{"type":"string"},"description":{"type":"string"}},"required":["code","description"]},"group":{"type":"object","nullable":true,"properties":{"code":{"type":"string"},"description":{"type":"string"}},"required":["code","description"]},"division":{"type":"object","nullable":true,"properties":{"code":{"type":"string"},"description":{"type":"string"}},"required":["code","description"]},"section":{"type":"object","nullable":true,"properties":{"code":{"type":"string"},"description":{"type":"string"}},"required":["code","description"]},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["status","code","description","activities","class","group","division","section","source","warehouseUpdatedAt"]},"MunicipalitySearchResponse":{"type":"object","properties":{"query":{"type":"string"},"uf":{"type":"string","nullable":true,"enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO",null]},"municipalities":{"type":"array","items":{"type":"object","properties":{"municipalityIbge":{"type":"string"},"name":{"type":"string"},"state":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["code","name"]},"mesoregion":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"region":{"type":"string"}},"required":["municipalityIbge","name","state","mesoregion","region"]}},"count":{"type":"integer","minimum":0},"source":{"type":"string"},"warehouseUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["query","uf","municipalities","count","source","warehouseUpdatedAt"]},"MunicipalityDetailResponse":{"type":"object","properties":{"status":{"type":"string","enum":["available","not_found"]},"municipality":{"type":"object","nullable":true,"properties":{"municipalityIbge":{"type":"string"},"name":{"type":"string"},"state":{"type":"object","properties":{"code":{"type":"string"},"name":{"type":"string"}},"required":["code","name"]},"mesoregion":{"type":"object","nullable":true,"properties":{"id":{"type":"integer"},"name":{"type":"string"}},"required":["id","name"]},"region":{"type":"string"}},"required":["municipalityIbge","name","state","mesoregion","region"]},"economy":{"type":"object","nullable":true,"properties":{"population":{"type":"integer","nullable":true,"minimum":0},"gdpThousandBrl":{"type":"number","nullable":true},"referenceYear":{"type":"integer"}},"required":["population","gdpThousandBrl","referenceYear"]},"source":{"type":"string"},"catalogUpdatedAt":{"type":"string","nullable":true,"format":"date-time"},"economyUpdatedAt":{"type":"string","nullable":true,"format":"date-time"}},"required":["status","municipality","economy","source","catalogUpdatedAt","economyUpdatedAt"]},"LegislationSearchResponse":{"type":"object","properties":{"query":{"type":"string"},"normaId":{"type":"string","nullable":true},"results":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"normaId":{"type":"string"},"normaTitle":{"type":"string"},"kind":{"type":"string","enum":["norma","titulo","capitulo","secao","subsecao","artigo","paragrafo","inciso","alinea"]},"label":{"type":"string"},"heading":{"type":"string"},"text":{"type":"string"},"parentPath":{"type":"string","nullable":true},"score":{"type":"number"}},"required":["path","normaId","normaTitle","kind","label","heading","text","parentPath","score"]}},"count":{"type":"integer","minimum":0},"source":{"type":"string"}},"required":["query","normaId","results","count","source"]}},"parameters":{}},"paths":{"/fontes/compras-gov/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosComprasGov","description":"Compras.gov.br: Painel de Preços: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://dadosabertos.compras.gov.br/swagger-ui/index.html. Refresh: daily, with a rotating CATMAT/CATSER code window. Description example: GET /fontes/compras-gov/api/v1/banco-precos/search?q=material%20hospitalar&uf=SP. Code example: GET /fontes/compras-gov/api/v1/banco-precos/search?q=275035&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"material hospitalar"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"material hospitalar"},"code":{"summary":"Code lookup","value":"275035"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"275035","description":"Material hospitalar","unit":"UN","unit_price":"34,00","source":"Compras.gov.br: Painel de Preços · material · 2026-07-15 · SP","uf":"SP","reference_url":"https://dadosabertos.compras.gov.br/modulo-pesquisa-preco/1_consultarMaterial?pagina=1&tamanhoPagina=500&tipo=codigoItemCatalogo&codigo=275035","reference_date":"2026-07-15","price_kind":"homologated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/bps/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosBps","description":"Banco de Preços em Saúde (BPS): public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://apidadosabertos.saude.gov.br/v1/. Refresh: daily, with a rotating CATMAT code window; the upstream dataset is published semiannually. Description example: GET /fontes/bps/api/v1/banco-precos/search?q=medicamento&uf=RO. Code example: GET /fontes/bps/api/v1/banco-precos/search?q=342134&uf=RO. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"medicamento"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"medicamento"},"code":{"summary":"Code lookup","value":"342134"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"342134","description":"Medicamento","unit":"COMPRIMIDO","unit_price":"2,50","source":"Banco de Preços em Saúde (BPS) · Pregão · 2026-06-10 · RO","uf":"RO","reference_url":"https://apidadosabertos.saude.gov.br/economia-da-saude/bps?codigoCatmat=342134","reference_date":"2026-06-10","price_kind":"homologated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/sinapi/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosSinapi","description":"SINAPI: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://www.caixa.gov.br/poder-publico/modernizacao-gestao/sinapi/Paginas/default.aspx. Refresh: checked daily until the latest expected CAIXA competence is published. Description example: GET /fontes/sinapi/api/v1/banco-precos/search?q=composicao%20sinapi&uf=SP. Code example: GET /fontes/sinapi/api/v1/banco-precos/search?q=103689&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"composicao sinapi"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"composicao sinapi"},"code":{"summary":"Code lookup","value":"103689"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"103689","description":"Composição SINAPI","unit":"M2","unit_price":"1.234,50","source":"SINAPI / CAIXA · COMPOSICAO_SEM_DESONERACAO · 2026-07-01 · SP","uf":"SP","reference_url":"https://www.caixa.gov.br/Downloads/sinapi-relatorios-mensais/SINAPI-2026-07-formato-xlsx.zip","reference_date":"2026-07-01","price_kind":"estimated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/sicro/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosSicro","description":"SICRO: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://www.gov.br/dnit/pt-br/assuntos/planejamento-e-pesquisa/custos-referenciais/sistemas-de-custos/sicro/relatorios. Refresh: checked weekly against the latest complete DNIT reports. Description example: GET /fontes/sicro/api/v1/banco-precos/search?q=composicao%20sicro&uf=SP. Code example: GET /fontes/sicro/api/v1/banco-precos/search?q=5501700&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"composicao sicro"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"composicao sicro"},"code":{"summary":"Code lookup","value":"5501700"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"5501700","description":"Composição SICRO","unit":"M3","unit_price":"456,78","source":"DNIT SICRO · composicoes · 2026-04-01 · SP","uf":"SP","reference_url":"https://www.gov.br/dnit/pt-br/assuntos/planejamento-e-pesquisa/custos-referenciais/sistemas-de-custos/sicro/relatorios","reference_date":"2026-04-01","price_kind":"estimated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/cdhu-sp/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosCdhuSp","description":"CDHU/SP: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://www.cdhu.sp.gov.br/cdhu/Transpar%C3%AAncia/Licitacoes%20e%20Contratos/Tabela%20de%20Composicao%20de%20Servicos. Refresh: monthly, from the latest published synthetic tables. Description example: GET /fontes/cdhu-sp/api/v1/banco-precos/search?q=servico%20padrao&uf=SP. Code example: GET /fontes/cdhu-sp/api/v1/banco-precos/search?q=003247&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"servico padrao"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"servico padrao"},"code":{"summary":"Code lookup","value":"003247"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"003247","description":"Serviço padrão CDHU","unit":"UN","unit_price":"9.577,84","source":"CDHU/SP · standard · 2026-05-01 · SP","uf":"SP","reference_url":"https://stor.cdhu.sp.gov.br/sites-portais/publico/DOCUMENTOS/transparencia/licitacoes/tabelas-composicao/tabela-de-composicao-sintetica-de-servicos-padrao/tabela-de-composicao-sintetica-de-servicos-padrao-05-26.xls","reference_date":"2026-05-01","price_kind":"estimated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/tce-sp-audesp/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosTceSpAudesp","description":"TCE-SP/AUDESP: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://transparencia.tce.sp.gov.br/conjunto-de-dados. Refresh: monthly, from the latest official Licitações archive. Description example: GET /fontes/tce-sp-audesp/api/v1/banco-precos/search?q=computador&uf=SP. Code example: GET /fontes/tce-sp-audesp/api/v1/banco-precos/search?q=202500000001&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"computador"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"computador"},"code":{"summary":"Code lookup","value":"202500000001"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"202500000001","description":"Caderno universitário","unit":"UN","unit_price":"12,00","source":"TCE-SP/AUDESP · PREF MUN DE CAMPINAS · Pregão Eletrônico · estimado · 2025-07-17 · SP","uf":"SP","reference_url":"https://transparencia.tce.sp.gov.br/conjunto-de-dados","reference_date":"2025-07-17","price_kind":"estimated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/anp/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosAnp","description":"ANP: Série Histórica de Preços: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://www.gov.br/anp/pt-br/centrais-de-conteudo/dados-abertos/serie-historica-de-precos-de-combustiveis. Refresh: weekly, from the latest four-week official CSV snapshots. Description example: GET /fontes/anp/api/v1/banco-precos/search?q=gasolina%20comum&uf=SP. Code example: GET /fontes/anp/api/v1/banco-precos/search?q=Gasolina%20C&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"gasolina comum"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"gasolina comum"},"code":{"summary":"Code lookup","value":"Gasolina C"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"Gasolina C","description":"Gasolina C: Posto Oficial, São Paulo/SP","unit":"litro","unit_price":"5,89","source":"ANP: Série Histórica de Preços de Combustíveis · preço praticado · metodologia ANP · 2026-08-16 · SP","uf":"SP","reference_url":"https://www.gov.br/anp/pt-br/centrais-de-conteudo/dados-abertos/serie-historica-de-precos-de-combustiveis","reference_date":"2026-08-16","price_kind":"homologated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/cmed-anvisa/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosCmedAnvisa","description":"CMED/Anvisa: Preços Máximos de Medicamentos: public warehouse-backed search by official item code or description, optionally filtered by UF. These national prices are stored without a UF; omit the uf filter. Official source: https://www.gov.br/anvisa/pt-br/assuntos/medicamentos/cmed/precos. Refresh: monthly, after the successful CMED catalog refresh. Description example: GET /fontes/cmed-anvisa/api/v1/banco-precos/search?q=amoxicilina. Code example: GET /fontes/cmed-anvisa/api/v1/banco-precos/search?q=5112121. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"amoxicilina"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"amoxicilina"},"code":{"summary":"Code lookup","value":"5112121"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"5112121","description":"Dipirona: 500 MG COM CT BL AL PLAS","unit":"apresentação","unit_price":"2,50","source":"CMED/Anvisa · PF sem impostos · lista de preços · 2026-08-01","uf":null,"reference_url":"https://www.gov.br/anvisa/pt-br/assuntos/medicamentos/cmed/precos","reference_date":"2026-08-01","price_kind":"estimated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/fnde-sigarp/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosFndeSigarp","description":"FNDE/SIGARP: Atas de Registro de Preços: public warehouse-backed search by official item code or description, optionally filtered by UF. Registrations can be nationwide or coverage-scoped; a valid uf filters structured rows and includes truly national rows. Official source: https://www.gov.br/fnde/pt-br/acesso-a-informacao/acoes-e-programas/acoes/compras-governamentais/atas-de-registro-de-precos. Refresh: checked daily for active official registrations. Description example: GET /fontes/fnde-sigarp/api/v1/banco-precos/search?q=%C3%B4nibus%20escolar&uf=SP. Code example: GET /fontes/fnde-sigarp/api/v1/banco-precos/search?q=115&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"ônibus escolar"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"ônibus escolar"},"code":{"summary":"Code lookup","value":"115"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"115","description":"Caderno Material Papel Off-Set 56g/M2","unit":"Unidade","unit_price":"7,44","source":"FNDE/SIGARP · ARP 11/2024 · fornecedor Fornecedor Escolar LTDA · vigência 2024-08-29–2026-08-29 · abrangência Centro-Oeste, Sudeste e Sul","uf":null,"reference_url":"https://www.gov.br/fnde/pt-br/acesso-a-informacao/acoes-e-programas/acoes/compras-governamentais/atas-de-registro-de-precos","reference_date":"2024-08-29","price_kind":"homologated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/siurb-sp/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosSiurbSp","description":"SIURB/SP: Tabelas de Custos: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://prefeitura.sp.gov.br/web/obras/w/tabelas_de_custos/355179. Refresh: checked weekly for the latest complete category/regime tables. Description example: GET /fontes/siurb-sp/api/v1/banco-precos/search?q=alvenaria&uf=SP. Code example: GET /fontes/siurb-sp/api/v1/banco-precos/search?q=1009000&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"alvenaria"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"alvenaria"},"code":{"summary":"Code lookup","value":"1009000"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"1009000","description":"LEVANTAMENTO PLANIMÉTRICO CADASTRAL","unit":"M2","unit_price":"0,72","source":"SIURB/SP · INFRA · SIURB 2025-07 · item de composição · 2025-07-01 · SP","uf":"SP","reference_url":"https://prefeitura.sp.gov.br/web/obras/w/tabelas_de_custos/355179","reference_date":"2025-07-01","price_kind":"estimated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/der-sp/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosDerSp","description":"DER/SP: Tabela de Preços Unitários: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://www.der.sp.gov.br/der/biblioteca/manuais_e_normas/tabelas. Refresh: checked weekly; complete standard and exempt payroll-tax regimes published together. Description example: GET /fontes/der-sp/api/v1/banco-precos/search?q=sondagem&uf=SP. Code example: GET /fontes/der-sp/api/v1/banco-precos/search?q=21.01.01&uf=SP. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"sondagem"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"sondagem"},"code":{"summary":"Code lookup","value":"21.01.01"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"21.01.01","description":"SONDAGEM A PERCUSSAO ATE 15M","unit":"m","unit_price":"223,44","source":"DER/SP: TPU · onerada · 2026-04-30 · SP","uf":"SP","reference_url":"http://200.144.30.103/tpu-internet/arquivos/TPU_04_2026.zip","reference_date":"2026-04-30","price_kind":"estimated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/fontes/tce-rs-licitacon/api/v1/banco-precos/search":{"get":{"operationId":"searchBancoPrecosTceRsLicitacon","description":"TCE-RS/LicitaCon: public warehouse-backed search by official item code or description, optionally filtered by UF. Official source: https://dados.tce.rs.gov.br/api/3/action/package_show?id=licitacoes-consolidado-2026. Refresh: checked weekly for the latest official annual dataset. Description example: GET /fontes/tce-rs-licitacon/api/v1/banco-precos/search?q=computador&uf=RS. Code example: GET /fontes/tce-rs-licitacon/api/v1/banco-precos/search?q=0002&uf=RS. No authentication is required. Requests are limited to 60 per minute per network IP; 429 responses include Retry-After.","security":[],"parameters":[{"schema":{"type":"string","minLength":3,"maxLength":255,"example":"computador"},"required":true,"name":"q","in":"query","examples":{"description":{"summary":"Description lookup","value":"computador"},"code":{"summary":"Code lookup","value":"0002"}}},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"SP"},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Matching price observations; no matches return { data: [] }.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosSearchResponse"},"examples":{"populated":{"summary":"Matching observations","value":{"data":[{"code":"2","description":"Cimento, saco de 50 kg","unit":"SC","unit_price":"38,50","source":"TCE-RS/LicitaCon · PM DE SÉRIO · PCE · lote-1/item-2 · homologated · 2026-03-01 · RS","uf":"RS","reference_url":"https://dados.tce.rs.gov.br/api/3/action/package_show?id=licitacoes-consolidado-2026","reference_date":"2026-03-01","price_kind":"homologated"}]}},"empty":{"summary":"No matching observations","value":{"data":[]}}}}}},"400":{"description":"Invalid q or UF query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}},"429":{"description":"The public per-IP request limit was exceeded.","headers":{"Retry-After":{"description":"Seconds until the fixed request window resets.","schema":{"type":"string","pattern":"^\\d+$"},"example":"17"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"},"examples":{"rateLimited":{"summary":"Public network request limit exceeded","value":{"error":{"code":"RATE_LIMIT_EXCEEDED","message":"Too many price searches from this network. Please try again later."}}}}}}},"500":{"description":"The local price warehouse is temporarily unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BancoPrecosError"}}}}}}},"/v1/companies/{cnpj}/registry":{"get":{"tags":["Empresas"],"summary":"Consulta cadastral de CNPJ","description":"Consulta dados públicos da Receita Federal por uma cadeia de provedores gratuitos. Não autentica em portais e não emite certidões.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Dados cadastrais públicos da empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyRegistryResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"CNPJ não encontrado na fonte consultada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/sanctions":{"get":{"tags":["Empresas"],"summary":"Consulta sanções e impedimentos","description":"Consulta o espelho Olhary dos cadastros públicos CEIS, CNEP, CEPIM e acordos de leniência.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Sanções ativas e histórico conhecido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySanctionsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/federal-presence":{"get":{"tags":["Empresas"],"summary":"Consulta presença em bases federais","description":"Indica em quais bases consolidadas do Portal da Transparência o CNPJ aparece.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Indicadores de presença em bases federais.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyFederalPresenceResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/federal-spending":{"get":{"tags":["Empresas"],"summary":"Consulta contratos e recursos federais","description":"Agrega contratos federais do CNPJ e recursos recebidos de órgãos federais no período coberto pela Olhary.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Contratos, recebimentos e concentração por órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyFederalSpendingResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/medicines":{"get":{"tags":["Empresas"],"summary":"Consulta catálogo regulado de medicamentos","description":"Consulta os medicamentos associados ao CNPJ do laboratório no espelho mensal da tabela CMED/ANVISA, incluindo preços fábrica (PF) e máximo de venda ao governo (PMVG) sem impostos.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Medicamentos, faixas de preço e classes terapêuticas do laboratório.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCmedResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/cau":{"get":{"tags":["Empresas"],"summary":"Consulta cadastro e serviços contratados no CAU","description":"Consulta pública SICCAU por CNPJ, com cache de 24 horas. Cadastro de empresa e até 12 RRTs em que o CNPJ é contratante, no ano mais recente disponível. Não é certidão, validação de autenticidade nem comprovação da habilitação profissional. Falhas da fonte não são tratadas como ausência de registros.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Observações públicas, ano de cobertura, fonte e data da consulta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCauResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/transferegov-agreements":{"get":{"tags":["Empresas"],"summary":"Consulta convênios Transferegov","description":"Consulta convênios em que o CNPJ é convenente no espelho diário do Transferegov mantido pela Olhary.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Convênios, valores pactuados e valores liberados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyTransferegovResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/tcu-certificates":{"get":{"tags":["Empresas"],"summary":"Consulta certidões APF do TCU","description":"Consulta o status público consolidado pelo TCU. A API não emite documento nem automatiza portal.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Status das certidões públicas encontradas para o CNPJ.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyTcuResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/procurement/performance":{"get":{"tags":["Empresas"],"summary":"Consulta desempenho do fornecedor no PNCP","description":"Resume vitórias e valores homologados do CNPJ no espelho PNCP da Olhary.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Desempenho histórico do fornecedor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySupplierPerformanceResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/procurement/top-buyers":{"get":{"tags":["Empresas"],"summary":"Consulta principais compradores públicos","description":"Lista os órgãos nos quais o CNPJ mais venceu contratações no PNCP.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Principais compradores públicos do fornecedor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyTopBuyersResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/procurement/competitors":{"get":{"tags":["Empresas"],"summary":"Consulta concorrentes recorrentes","description":"Lista participantes que aparecem com o CNPJ nas mesmas compras ou itens do PNCP.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Concorrentes recorrentes identificados no PNCP.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCompetitorsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/procurement/contracts":{"get":{"tags":["Empresas"],"summary":"Consulta contratos do fornecedor","description":"Lista contratos, termos e documentos do PNCP associados ao CNPJ fornecedor.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Contratos públicos associados ao fornecedor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyContractsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/attention":{"get":{"tags":["Empresas"],"summary":"Consulta pontos de atenção","description":"Sintetiza sinais factuais e citados de diligência. Não representa acusação ou juízo de irregularidade.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"}],"responses":{"200":{"description":"Pontos de atenção derivados de registros públicos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyAttentionResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/federal-documents":{"get":{"operationId":"getCompanyFederalDocuments","tags":["Portal da Transparência"],"summary":"Consulta documentos de despesa federal","description":"Consulta documentos de despesa em que o CNPJ aparece como favorecido no Portal da Transparência. A resposta é uma amostra limitada pela paginação da fonte, sem total de completude.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"},{"schema":{"type":"integer","minimum":2008,"maximum":2100},"required":true,"name":"year","in":"query"},{"schema":{"type":"string","enum":["commitment","liquidation","payment"]},"required":true,"name":"phase","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"managingUnitCode","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"managementCode","in":"query"},{"schema":{"type":"string","enum":["date_asc","date_desc","amount_asc","amount_desc"]},"required":false,"name":"sort","in":"query"}],"responses":{"200":{"description":"Amostra normalizada de documentos de despesa federal.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederalDocumentsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/federal-commitments":{"get":{"operationId":"getCompanyFederalCommitments","tags":["Portal da Transparência"],"summary":"Consulta empenhos federais","description":"Consulta documentos na fase de empenho em que o CNPJ aparece como favorecido no Portal da Transparência. Não representa uma lista exclusiva de contratações.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"},{"schema":{"type":"integer","minimum":2008,"maximum":2100},"required":true,"name":"year","in":"query"}],"responses":{"200":{"description":"Amostra normalizada de documentos na fase de empenho.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederalCommitmentsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/federal-invoices":{"get":{"operationId":"getCompanyFederalInvoices","tags":["Portal da Transparência"],"summary":"Consulta notas fiscais federais","description":"Consulta notas fiscais emitidas pelo CNPJ no Portal da Transparência. A resposta é uma amostra limitada pela paginação da fonte e não aceita filtros de ano ou data.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"agencyCode","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200},"required":false,"name":"productName","in":"query"}],"responses":{"200":{"description":"Amostra normalizada de notas fiscais emitidas pela empresa.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederalInvoicesResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/federal/covid-transfers":{"get":{"operationId":"listFederalCovidTransfers","tags":["Portal da Transparência"],"summary":"Consulta transferências federais da Covid-19","description":"Consulta transferências federais relacionadas à Covid-19 por competência mensal e ao menos um filtro de escopo suportado pelo Portal da Transparência.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","pattern":"^(?:20\\d{2}|21\\d{2})(?:0[1-9]|1[0-2])$"},"required":true,"name":"month","in":"query"},{"schema":{"type":"string","pattern":"^\\d{7}$"},"required":false,"name":"municipalityIbge","in":"query"},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"]},"required":false,"name":"uf","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"agencyCode","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":-2147483648,"maximum":2147483647},"required":false,"name":"transferType","in":"query"}],"responses":{"200":{"description":"Amostra normalizada de transferências Covid-19.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederalCovidTransfersResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/federal/agreements":{"get":{"operationId":"listFederalAgreements","tags":["Portal da Transparência"],"summary":"Consulta convênios federais","description":"Consulta convênios federais pela data de referência informada pelo Portal da Transparência, usando apenas os filtros documentados. Não substitui a consulta de convênios por empresa do Transferegov.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","format":"date","description":"Data de referência usada pelo provedor para a consulta."},"required":true,"description":"Data de referência usada pelo provedor para a consulta.","name":"date","in":"query"},{"schema":{"type":"string","pattern":"^\\d{7}$"},"required":false,"name":"municipalityIbge","in":"query"},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"]},"required":false,"name":"uf","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"agencyCode","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"statusCode","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100},"required":false,"name":"instrumentType","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":50},"required":false,"name":"agreementNumber","in":"query"}],"responses":{"200":{"description":"Amostra normalizada de convênios federais.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederalAgreementsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/federal/amendments":{"get":{"operationId":"listFederalAmendments","tags":["Portal da Transparência"],"summary":"Consulta emendas parlamentares federais","description":"Consulta emendas federais por filtros seletivos documentados. Localidade é preservada como texto da fonte e não é convertida em município IBGE ou beneficiário.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"integer","minimum":2008,"maximum":2100},"required":false,"name":"year","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":50},"required":false,"name":"amendmentCode","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":50},"required":false,"name":"amendmentNumber","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200},"required":false,"name":"authorName","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100},"required":false,"name":"type","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"functionCode","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"subfunctionCode","in":"query"}],"responses":{"200":{"description":"Amostra normalizada de emendas parlamentares.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederalAmendmentsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/federal/amendments/{amendmentCode}/documents":{"get":{"operationId":"listFederalAmendmentDocuments","tags":["Portal da Transparência"],"summary":"Consulta documentos vinculados a uma emenda","description":"Consulta documentos relacionados à emenda no Portal da Transparência. O vínculo documental não prova beneficiário empresarial ou município.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":100,"example":"202412345678"},"required":true,"name":"amendmentCode","in":"path"}],"responses":{"200":{"description":"Amostra normalizada de documentos da emenda.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FederalAmendmentDocumentsResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/chamber-expenses":{"get":{"operationId":"listCompanyChamberExpenses","tags":["Câmara dos Deputados"],"summary":"Consulta despesas da Câmara por fornecedor","description":"Consulta despesas CEAP da Câmara dos Deputados em um snapshot anual ingerido pela Olhary, filtradas por CNPJ exato do fornecedor. Anos sem snapshot ativo retornam indisponibilidade.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"},{"schema":{"type":"integer","minimum":2008,"maximum":2100},"required":true,"name":"year","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Despesas CEAP normalizadas e paginação exata do snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyChamberExpensesResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/deputies/{id}/expenses":{"get":{"operationId":"listDeputyExpenses","tags":["Câmara dos Deputados"],"summary":"Consulta despesas de deputado","description":"Consulta despesas CEAP de um deputado em um snapshot anual ingerido pela Olhary. A rota não consulta a API da Câmara em tempo de requisição.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","pattern":"^[1-9][0-9]*$","example":"204379"},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","minimum":2008,"maximum":2100},"required":true,"name":"year","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Despesas CEAP normalizadas e paginação exata do snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeputyExpensesResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/deputies/search":{"get":{"operationId":"searchDeputies","tags":["Câmara dos Deputados"],"summary":"Pesquisa deputados","description":"Pesquisa o snapshot do cadastro oficial de deputados ingerido pela Olhary por nome e filtros de campos preservados da fonte.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":200},"required":true,"name":"query","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":30},"required":false,"name":"party","in":"query"},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"]},"required":false,"name":"uf","in":"query"},{"schema":{"type":"integer","minimum":0,"exclusiveMinimum":true},"required":false,"name":"legislatureId","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":50,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Deputados encontrados e paginação exata do snapshot.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeputySearchResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/transferegov/agreements/{agreementNumber}/bank-orders":{"get":{"tags":["Transferegov"],"summary":"Consulta ordens bancárias de convênio","description":"Lista as ordens bancárias liberadas para um convênio no espelho diário do Transferegov mantido pela Olhary.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","pattern":"^\\d{1,30}$","example":"101231"},"required":true,"name":"agreementNumber","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Ordens bancárias ordenadas pela data de emissão mais recente.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferegovBankOrdersResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/catalog/items":{"get":{"tags":["Catálogo"],"summary":"Pesquisa itens CATMAT e CATSER","description":"Pesquisa materiais e serviços ativos nos catálogos federais CATMAT/CATSER espelhados pela Olhary. Aceita uma descrição ou um código CATMAT/CATSER. O código resolve direto para o item, que aparece à frente das correspondências por descrição.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":2,"maxLength":200},"required":true,"name":"query","in":"query"},{"schema":{"type":"string","enum":["material","service"]},"required":false,"name":"type","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Itens de catálogo correspondentes à consulta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogSearchResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/prices/{type}/{code}":{"get":{"tags":["Preços"],"summary":"Consulta preços praticados pelo governo","description":"Calcula a distribuição de preços unitários praticados em compras federais para um código CATMAT ou CATSER, com filtro opcional por UF e uma amostra das compras mais recentes.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["material","service"],"example":"material"},"required":true,"name":"type","in":"path"},{"schema":{"type":"string","pattern":"^\\d{1,30}$","example":"150246"},"required":true,"name":"code","in":"path"},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"]},"required":false,"name":"uf","in":"query"}],"responses":{"200":{"description":"Distribuição de preços e amostra recente de compras públicas.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferencePriceResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/procurements/search":{"post":{"tags":["Licitações"],"summary":"Pesquisa licitações, atas e contratos","description":"Pesquisa o índice PNCP da Olhary por texto e filtros estruturados. O resultado pode incluir alertas de participantes sancionados.","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcurementSearchRequest"}}}},"responses":{"200":{"description":"Resultados ordenados por relevância ou recência.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcurementSearchResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Serviço de pesquisa temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/companies/{cnpj}/senate-expenses":{"get":{"tags":["Empresas"],"summary":"Consulta despesas CEAPS por fornecedor","description":"Lista reembolsos declarados no CEAPS do Senado em que o CNPJ consta como fornecedor. Não representa contratos.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","example":"18320832000100"},"required":true,"name":"cnpj","in":"path"},{"schema":{"type":"integer","minimum":2008,"maximum":2100},"required":false,"name":"year","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"default":0},"required":false,"name":"offset","in":"query"}],"responses":{"200":{"description":"Despesas CEAPS registradas para o fornecedor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySenateExpensesResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/fiscal/capag/municipalities/{municipalityIbge}":{"get":{"tags":["Fiscal"],"summary":"Consulta CAPAG municipal","description":"Consulta a capacidade de pagamento do município no espelho do Tesouro Nacional.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","pattern":"^\\d{7}$","example":"3170107"},"required":true,"name":"municipalityIbge","in":"path"}],"responses":{"200":{"description":"CAPAG municipal ou status not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapagResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/fiscal/capag/states/{uf}":{"get":{"tags":["Fiscal"],"summary":"Consulta CAPAG estadual","description":"Consulta a capacidade de pagamento do estado ou DF no espelho do Tesouro Nacional.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"],"example":"MG"},"required":true,"name":"uf","in":"path"}],"responses":{"200":{"description":"CAPAG estadual ou status not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapagResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/cnae/{code}":{"get":{"tags":["Cadastros"],"summary":"Consulta subclasse CNAE","description":"Consulta a classificação oficial CNAE 2.0 mantida pelo IBGE.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-?\\d\\/?\\d{2}$","example":"6201-5/01"},"required":true,"name":"code","in":"path"}],"responses":{"200":{"description":"Subclasse CNAE ou status not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CnaeResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/municipalities":{"get":{"tags":["Municípios"],"summary":"Pesquisa municípios","description":"Pesquisa o catálogo oficial de municípios do IBGE por nome e UF.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":2,"maxLength":100},"required":true,"name":"query","in":"query"},{"schema":{"type":"string","enum":["AC","AL","AP","AM","BA","CE","DF","ES","GO","MA","MT","MS","MG","PA","PB","PR","PE","PI","RJ","RN","RS","RO","RR","SC","SP","SE","TO"]},"required":false,"name":"uf","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Municípios encontrados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MunicipalitySearchResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/municipalities/{municipalityIbge}":{"get":{"tags":["Municípios"],"summary":"Consulta município e economia","description":"Combina o cadastro municipal com a população e o PIB mais recentes disponíveis no IBGE.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","pattern":"^\\d{7}$","example":"3170107"},"required":true,"name":"municipalityIbge","in":"path"}],"responses":{"200":{"description":"Município com economia opcional ou status not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MunicipalityDetailResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/legislation/search":{"get":{"tags":["Legislação"],"summary":"Pesquisa legislação federal","description":"Executa busca lexical no corpus estruturado de legislação federal da Olhary.","security":[{"ApiKeyAuth":[]}],"parameters":[{"schema":{"type":"string","minLength":2,"maxLength":500},"required":true,"name":"query","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100},"required":false,"name":"normaId","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":50,"default":12},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Trechos de legislação encontrados.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegislationSearchResponse"}}}},"400":{"description":"Parâmetros inválidos.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Autenticação ausente ou inválida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"413":{"description":"Corpo da requisição excede o limite.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Limite de requisições excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"Fonte pública temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}}}