• Primeiros Passos
  • Emissão Avançada
  • Gestão de Notas
  • Autenticação
  • API Reference
Information
Empresas
    Percentual de completude do cadastro da empresagetListar empresasgetCriar empresapostConsultar dados de empresa por CNPJ (Minha Receita)getConsultar validade do certificado digitalgetObter empresa por IDgetAtualizar empresaputDesativar empresadeleteUpload de certificado digital A1post
Tomadores
    Listar tomadoresgetCriar tomadorpostObter tomador por IDgetAtualizar tomadorputExcluir tomadordeleteListar países disponíveis (ISO 3166-1 alpha-2)get
Serviços
    Listar serviços da LC 116/03getObter serviço por códigoget
Séries
    Listar séries da empresagetCriar nova sériepostObtém a série ativa para um ambientegetObtém o próximo número da série ativagetObtém uma série por IDgetAtualizar sérieputDefine o número inicial de uma série (para migração)post
NFS-e
    Listar NFS-egetEmitir NFS-epostDownload de XMLs em ZIP por períodogetObter NFS-e por IDgetExcluir NFS-e pendentedeleteCancelar NFS-epostRetransmitir NFS-e rejeitadapostDownload do XML da NFS-egetDownload do DANFSE em PDFget
Endereços
    Buscar endereço por CEPget
NBS
    Lista códigos NBSgetBusca código NBS específicoget
Schemas
powered by Zudoku
Nottou API
Nottou API

Tomadores

Gestão de tomadores de serviço

Listar tomadores

GET
https://nfse.labds.com.br/api/v1
/tomadores

Listar tomadores › query Parameters

page
​integer
Default: 1
limit
​integer
Default: 20
search
​string

Busca por nome, CPF/CNPJ ou NIF

Listar tomadores › Responses

200

Lista de tomadores

success
​boolean
​object[]
​object
GET/tomadores
curl --request GET \ --url https://nfse.labds.com.br/api/v1/tomadores
shell
Example Responses
{ "success": true, "data": [ { "id": "00000000-0000-0000-0000-000000000000", "cpfCnpj": "cpfCnpj", "nome": "nome", "nomeFantasia": "nomeFantasia", "cep": "cep", "logradouro": "logradouro", "numero": "numero", "bairro": "bairro", "nomeMunicipio": "nomeMunicipio", "uf": "uf", "telefone": "telefone", "email": "test@example.com" } ], "pagination": { "page": 0, "limit": 0, "total": 0 } }
json
application/json

Criar tomador

POST
https://nfse.labds.com.br/api/v1
/tomadores

Criar tomador › Request Body

nome
​string · required

Nome completo ou razão social

cpfCnpj
​string

CPF/CNPJ para tomadores brasileiros (opcional para exterior)

Example: 123.456.789-00
nomeFantasia
​string

Nome fantasia (apenas para PJ)

inscricaoMunicipal
​string

Inscrição municipal

cep
​string

CEP (apenas para tomadores brasileiros)

logradouro
​string

Logradouro ou rua

numero
​string

Número do endereço

complemento
​string

Complemento do endereço

bairro
​string

Bairro

codigoMunicipioIbge
​string

Código IBGE do município (apenas para brasileiros)

nomeMunicipio
​string

Nome do município

uf
​string

UF (apenas para brasileiros)

pais
​string

Código ISO 3166-1 alpha-2 do país

Example: BR
Default: BR
telefone
​string

Telefone com DDD

email
​string

E-mail

nif
​string · maxLength: 40

Número de Identificação Fiscal (obrigatório para exterior)

codigoNaoNif
​string · enum

Motivo para não informação do NIF: 0 - Não informado na nota de origem; 1 - Dispensado do NIF; 2 - Não exigência do NIF;

Enum values:
0
1
2
cidadeExterior
​string · maxLength: 60

Nome da cidade no exterior

estadoProvRegiao
​string · maxLength: 60

Estado/Província/Região no exterior

codigoEndPostal
​string · maxLength: 11

Código de endereçamento postal exterior

Criar tomador › Responses

Cliente criado

No data returned
POST/tomadores
curl --request POST \ --url https://nfse.labds.com.br/api/v1/tomadores \ --header 'Content-Type: application/json' \ --data ' { "cpfCnpj": "123.456.789-00", "nome": "nome", "nomeFantasia": "nomeFantasia", "inscricaoMunicipal": "inscricaoMunicipal", "cep": "cep", "logradouro": "logradouro", "numero": "numero", "complemento": "complemento", "bairro": "bairro", "codigoMunicipioIbge": "codigoMunicipioIbge", "nomeMunicipio": "nomeMunicipio", "uf": "uf", "pais": "BR", "telefone": "telefone", "email": "email", "nif": "nif", "codigoNaoNif": "0", "cidadeExterior": "cidadeExterior", "estadoProvRegiao": "estadoProvRegiao", "codigoEndPostal": "codigoEndPostal" } '
shell
Example Request Body
{ "cpfCnpj": "123.456.789-00", "nome": "nome", "nomeFantasia": "nomeFantasia", "inscricaoMunicipal": "inscricaoMunicipal", "cep": "cep", "logradouro": "logradouro", "numero": "numero", "complemento": "complemento", "bairro": "bairro", "codigoMunicipioIbge": "codigoMunicipioIbge", "nomeMunicipio": "nomeMunicipio", "uf": "uf", "pais": "BR", "telefone": "telefone", "email": "email", "nif": "nif", "codigoNaoNif": "0", "cidadeExterior": "cidadeExterior", "estadoProvRegiao": "estadoProvRegiao", "codigoEndPostal": "codigoEndPostal" }
json
Example Responses
No example specified for this content type

Obter tomador por ID

GET
https://nfse.labds.com.br/api/v1
/tomadores/{id}

Obter tomador por ID › path Parameters

id
​string · uuid · required

Obter tomador por ID › Responses

Dados do tomador

No data returned
GET/tomadores/{id}
curl --request GET \ --url https://nfse.labds.com.br/api/v1/tomadores/:id
shell
Example Responses
No example specified for this content type

Atualizar tomador

PUT
https://nfse.labds.com.br/api/v1
/tomadores/{id}

Atualizar tomador › path Parameters

id
​string · uuid · required

Atualizar tomador › Request Body

id
​string · uuid
cpfCnpj
​string
nome
​string
nomeFantasia
​string
cep
​string
logradouro
​string
numero
​string
bairro
​string
nomeMunicipio
​string
uf
​string
telefone
​string
email
​string · email

Atualizar tomador › Responses

Cliente atualizado

No data returned
PUT/tomadores/{id}
curl --request PUT \ --url https://nfse.labds.com.br/api/v1/tomadores/:id \ --header 'Content-Type: application/json' \ --data ' { "id": "00000000-0000-0000-0000-000000000000", "cpfCnpj": "cpfCnpj", "nome": "nome", "nomeFantasia": "nomeFantasia", "cep": "cep", "logradouro": "logradouro", "numero": "numero", "bairro": "bairro", "nomeMunicipio": "nomeMunicipio", "uf": "uf", "telefone": "telefone", "email": "test@example.com" } '
shell
Example Request Body
{ "id": "00000000-0000-0000-0000-000000000000", "cpfCnpj": "cpfCnpj", "nome": "nome", "nomeFantasia": "nomeFantasia", "cep": "cep", "logradouro": "logradouro", "numero": "numero", "bairro": "bairro", "nomeMunicipio": "nomeMunicipio", "uf": "uf", "telefone": "telefone", "email": "test@example.com" }
json
Example Responses
No example specified for this content type

Excluir tomador

DELETE
https://nfse.labds.com.br/api/v1
/tomadores/{id}

Excluir tomador › path Parameters

id
​string · uuid · required

Excluir tomador › Responses

Cliente excluído

No data returned
DELETE/tomadores/{id}
curl --request DELETE \ --url https://nfse.labds.com.br/api/v1/tomadores/:id
shell
Example Responses
No example specified for this content type

Listar países disponíveis (ISO 3166-1 alpha-2)

GET
https://nfse.labds.com.br/api/v1
/tomadores/paises

Listar países disponíveis (ISO 3166-1 alpha-2) › Responses

200

Lista de países ordenada por nome

​object[]
codigo
​string
nome
​string
GET/tomadores/paises
curl --request GET \ --url https://nfse.labds.com.br/api/v1/tomadores/paises
shell
Example Responses
[ { "codigo": "BR", "nome": "Brasil" } ]
json
application/json
EmpresasServiços