Docs/Produtos
Produtos e serviços
Catálogo reutilizável — o mesmo da Dashboard. Cadastre uma vez e referencie pelo id (ULID Emitfy) em commercial.items ou atalhos de emissão.
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 do body
name
stringobrigatórioNome do item (3–64 caracteres).
type
stringobrigatórioservice, product ou split.
category
stringopcionalCategoria do catálogo (obrigatória quando type não é split).
price
numberopcionalPreço padrão em reais.
ncm
stringopcionalNCM (produtos físicos).
serviceItemCode
stringopcionalCódigo do serviço (LC 116) para NFS-e.
curl -X POST "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/products" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
"name": "Assinatura mensal",
"type": "service",
"category": "saas",
"price": 99.9
}'{
"ok": true,
"data": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "Assinatura mensal",
"type": "service",
"category": "saas",
"price": 99.9
}
}{
"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 ou id.
type
stringopcionalFiltra por type (service, product, split).
curl -X GET "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/products?page=1&search=PLAN" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
{
"ok": true,
"data": [
{
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "Assinatura mensal",
"type": "service",
"price": 99.9
}
],
"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 produto.
curl -X GET "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/products/01ARZ3NDEKTSV4RRFFQ69G5FAV" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
{
"ok": true,
"data": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "Assinatura mensal",
"type": "service",
"category": "saas",
"price": 99.9
}
}{
"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 produto.
Parâmetros do body
name
stringobrigatórioNome do item (3–64 caracteres).
type
stringobrigatórioservice, product ou split.
category
stringopcionalCategoria do catálogo (obrigatória quando type não é split).
price
numberopcionalPreço padrão em reais.
ncm
stringopcionalNCM (produtos físicos).
serviceItemCode
stringopcionalCódigo do serviço (LC 116) para NFS-e.
curl -X PUT "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/products/01ARZ3NDEKTSV4RRFFQ69G5FAV" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
-H "Content-Type: application/json" \
-d '{
"name": "Assinatura mensal",
"type": "service",
"category": "saas",
"price": 119.9
}'{
"ok": true,
"data": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"name": "Assinatura mensal",
"type": "service",
"category": "saas",
"price": 99.9
}
}{
"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 produto.
curl -X DELETE "https://api.emitfy.com/v1/companies/ID_DA_EMPRESA/products/01ARZ3NDEKTSV4RRFFQ69G5FAV" \
-H "X-Api-Key: SUA_API_KEY" \
-H "X-Api-Secret: SUA_API_SECRET" \
{
"ok": true,
"data": {
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"deleted": true
}
}{
"ok": false,
"code": "VALIDATION_ERROR",
"message": "Um ou mais campos falharam na validação de entrada.",
"statusCode": 422
}