Dados cadastrais device-based: POST /dados/{action}.
Além das funções nomeadas, request/4 aceita qualquer action do catálogo e
queue/4 executa a mesma action por fila.
{:ok, envelope} = ApiBrasil.Data.Dados.cnpj(client, %{"cnpj" => "00000000000000"})
ApiBrasil.Core.DeviceResponse.response(envelope)Para as mesmas consultas debitando créditos, veja ApiBrasil.Data.Consulta.
Summary
Functions
Consulta por filtros livres: POST /dados/byquery.
Como by_query/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta o capital social: POST /dados/capital-social.
Como capital_social/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta um CEP: POST /dados/cep.
Como cep/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta um CNPJ: POST /dados/cnpj — body %{"cnpj" => "..."}.
Como cnpj/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Consulta um CPF: POST /dados/cpf — body %{"cpf" => "..."}.
Como cpf/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista os CNAEs: POST /dados/lista-cnaes.
Como lista_cnaes/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Lista os sócios de uma empresa: POST /dados/lista-socios.
Como lista_socios/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
Executa a action de forma assíncrona, por fila: POST /dados/{action}/queue.
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Executa qualquer action do serviço: POST /dados/{action}.
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
Serviço do gateway coberto por este módulo: dados.
Types
@type result() :: {:ok, map()} | {:error, ApiBrasil.Core.Error.t()}
Functions
@spec by_query(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta por filtros livres: POST /dados/byquery.
@spec by_query!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como by_query/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec capital_social(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta o capital social: POST /dados/capital-social.
@spec capital_social!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como capital_social/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec cep(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta um CEP: POST /dados/cep.
@spec cep!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como cep/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec cnpj(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta um CNPJ: POST /dados/cnpj — body %{"cnpj" => "..."}.
@spec cnpj!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como cnpj/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec cpf(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Consulta um CPF: POST /dados/cpf — body %{"cpf" => "..."}.
@spec cpf!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como cpf/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec lista_cnaes(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista os CNAEs: POST /dados/lista-cnaes.
@spec lista_cnaes!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como lista_cnaes/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec lista_socios(ApiBrasil.Client.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Lista os sócios de uma empresa: POST /dados/lista-socios.
@spec lista_socios!(ApiBrasil.Client.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como lista_socios/3, mas devolve o resultado direto e levanta ApiBrasil.Core.Error em caso de falha.
@spec queue(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Executa a action de forma assíncrona, por fila: POST /dados/{action}/queue.
@spec queue!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como queue/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec request(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: {:ok, ApiBrasil.Core.DeviceResponse.t()} | {:error, ApiBrasil.Core.Error.t()}
Executa qualquer action do serviço: POST /dados/{action}.
As actions conhecidas estão em
ApiBrasil.Generated.Catalog.service_actions("dados"); a
documentação completa fica em https://doc.apibrasil.io.
@spec request!(ApiBrasil.Client.t(), String.t(), term(), keyword()) :: ApiBrasil.Core.DeviceResponse.t()
Como request/4, mas levanta ApiBrasil.Core.Error em caso de falha.
@spec service() :: String.t()
Serviço do gateway coberto por este módulo: dados.