Docs/Clientes
Clientes
Cadastro fiscal reutilizável — o mesmo recurso da Dashboard. Use para SaaS recorrente, correção de endereço e referência por ID nas vendas.
Ver requisitos de autenticaçãoHeaders
X-Api-Key
stringobrigatórioChave de API da conta (id do usuário).
X-Api-Secret
stringobrigatórioSegredo da chave de API.
Content-Type
stringobrigatórioapplication/json
Parâmetros do body
name
stringobrigatórioNome do cliente (3–64 caracteres).
E-mail válido.
document
stringopcionalCPF ou CNPJ.
phone
stringopcionalTelefone celular.
foreign
booleanopcionaltrue se o cliente for exterior.
address
objectopcionalEndereço fiscal.
zipcode
stringopcionalCEP (8 dígitos).
street
stringopcionalLogradouro.
number
stringopcionalNúmero.
district
stringopcionalBairro.
city
stringopcionalCidade.
state
stringopcionalUF (ex.: SP).
complement
stringopcionalComplemento.
municipalRegistration
stringopcionalInscrição municipal.
stateRegistration
stringopcionalInscrição estadual.
curl -X POST "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/customers" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
"name": "João da Silva",
"email": "[email protected]",
"document": "12345678901",
"phone": "(11) 98888-7777",
"address": {
"zipcode": "01310100",
"street": "Av. Paulista",
"number": "1000",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
}'{
"ok": true,
"data": {
"id": "018f6e3b-0000-0000-0000-000000000001",
"name": "João da Silva",
"email": "[email protected]",
"document": "123.456.789-01",
"phone": "(11) 98888-7777",
"address": {
"zipcode": "01310-100",
"street": "Av. Paulista",
"number": "1000",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
}
}{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"statusCode": 422
}Headers
X-Api-Key
stringobrigatórioChave de API da conta (id do usuário).
X-Api-Secret
stringobrigatórioSegredo da chave de API.
Query params
page
numberopcionalPágina atual. Padrão: 1.
pageSize
numberopcionalItens por página.
search
stringopcionalBusca por nome, e-mail ou documento.
curl -X GET "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/customers?page=1&search=joao" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
{
"ok": true,
"data": [
{
"id": "018f6e3b-0000-0000-0000-000000000001",
"name": "João da Silva",
"email": "[email protected]",
"document": "123.456.789-01"
}
],
"pageInfo": {
"page": 1,
"pageSize": 20,
"total": 1
}
}{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"statusCode": 422
}Headers
X-Api-Key
stringobrigatórioChave de API da conta (id do usuário).
X-Api-Secret
stringobrigatórioSegredo da chave de API.
Parâmetros de rota
id
string (UUID)obrigatórioIdentificador do cliente.
curl -X GET "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/customers/018f6e3b-0000-0000-0000-000000000001" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
{
"ok": true,
"data": {
"id": "018f6e3b-0000-0000-0000-000000000001",
"name": "João da Silva",
"email": "[email protected]",
"document": "123.456.789-01",
"phone": "(11) 98888-7777",
"address": {
"zipcode": "01310-100",
"street": "Av. Paulista",
"number": "1000",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
}
}{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"statusCode": 422
}Headers
X-Api-Key
stringobrigatórioChave de API da conta (id do usuário).
X-Api-Secret
stringobrigatórioSegredo da chave de API.
Content-Type
stringobrigatórioapplication/json
Parâmetros de rota
id
string (UUID)obrigatórioIdentificador do cliente.
Parâmetros do body
name
stringobrigatórioNome do cliente (3–64 caracteres).
E-mail válido.
document
stringopcionalCPF ou CNPJ.
phone
stringopcionalTelefone celular.
foreign
booleanopcionaltrue se o cliente for exterior.
address
objectopcionalEndereço fiscal.
zipcode
stringopcionalCEP (8 dígitos).
street
stringopcionalLogradouro.
number
stringopcionalNúmero.
district
stringopcionalBairro.
city
stringopcionalCidade.
state
stringopcionalUF (ex.: SP).
complement
stringopcionalComplemento.
municipalRegistration
stringopcionalInscrição municipal.
stateRegistration
stringopcionalInscrição estadual.
curl -X PUT "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/customers/018f6e3b-0000-0000-0000-000000000001" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
"name": "João da Silva",
"email": "[email protected]",
"document": "12345678901",
"address": {
"zipcode": "01310100",
"street": "Av. Paulista",
"number": "1000",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
}'{
"ok": true,
"data": {
"id": "018f6e3b-0000-0000-0000-000000000001",
"name": "João da Silva",
"email": "[email protected]",
"document": "123.456.789-01",
"phone": "(11) 98888-7777",
"address": {
"zipcode": "01310-100",
"street": "Av. Paulista",
"number": "1000",
"district": "Bela Vista",
"city": "São Paulo",
"state": "SP"
}
}
}{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"statusCode": 422
}Headers
X-Api-Key
stringobrigatórioChave de API da conta (id do usuário).
X-Api-Secret
stringobrigatórioSegredo da chave de API.
Parâmetros de rota
id
string (UUID)obrigatórioIdentificador do cliente.
curl -X DELETE "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/customers/018f6e3b-0000-0000-0000-000000000001" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
{
"ok": true,
"data": {
"id": "018f6e3b-0000-0000-0000-000000000001",
"deleted": true
}
}{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"statusCode": 422
}