Pular para o conteúdo
notemnotemDocumentação

Referência da API › Tomadores

Listar tomadores

Lista os clientes (tomadores) cadastrados em uma empresa.

GET/api/v1/empresas/{id}/tomadores

Use para encontrar um tomador antes de emitir, pelo documento, pelo código no seu sistema (id_externo) ou pelo nome. A lista é paginada.

Cada tomador pertence a uma única empresa: os clientes de uma empresa não aparecem para outra.

Parâmetros

idtextono caminhoobrigatório
Empresa da organização da chave (de outra organização → 404). UUID (RFC 9562); fora do padrão → 400 REQUISICAO_INVALIDA com campo id. · UUID
limiteinteirona consulta
de 1 a 100 · Padrão: 50
cursortextona consulta
documentotextona consulta
id_externotextona consulta
buscatextona consulta

Respostas

200 Lista paginada

Campos da resposta
dadoslista de objeto
dados[].idtexto
UUID
dados[].id_externotexto ou null
Único por empresa · até 100 caracteres
dados[].tipotexto
Valores: pj, pf, estrangeiro
dados[].nometexto
1 a 150 caracteres
dados[].documentotexto ou null
CPF (11 números) ou CNPJ (14 posições, numérico ou alfanumérico) com dígitos verificadores válidos; máscara e minúsculas são normalizadas · até 18 caracteres
dados[].niftexto ou null
até 40 caracteres
dados[].motivo_sem_niftexto ou null
Valores: dispensado, nao_exigido
dados[].emailtexto ou null
dados[].telefonetexto ou null
dados[].inscricao_municipaltexto ou null
até 15 caracteres
dados[].enderecoobjeto ou null
Nacional exige CEP/logradouro/número/bairro/IBGE. Exterior exige país/cidade/código postal/província/logradouro ou endereço livre/número/bairro. Complemento opcional.
dados[].endereco.ceptexto
Formato: ^[0-9]{8}$
dados[].endereco.codigo_municipiotexto
Formato: ^[0-9]{7}$
dados[].endereco.paistexto
Formato: ^[A-Z]{2}$
dados[].endereco.cidadetexto
dados[].endereco.codigo_postaltexto
dados[].endereco.estado_provincia_regiaotexto
dados[].endereco.logradourotexto
dados[].endereco.endereco_livretexto
dados[].endereco.numerotexto
dados[].endereco.bairrotexto
dados[].endereco.complementotexto ou null
dados[].criada_emtexto
data e hora ISO 8601
dados[].atualizada_emtexto
data e hora ISO 8601
proximo_cursortexto ou null

404 Erro no formato padrão

Limites

Esta operação: 60 por minuto. Valem também os limites gerais da chave. Veja Limites de uso.