VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/ERP Fiscal, contábil e custos

Perfil fiscal

Lê, grava e apaga o perfil fiscal do seller (regime e códigos padrão).

Ler perfil fiscal

O perfil fiscal guarda os dados tributários do seller: o regime (Simples Nacional, MEI, Lucro Presumido ou Lucro Real) e os códigos padrão de operação (CFOP) e de produto (NCM). Cada seller tem no máximo um. Sem perfil cadastrado a resposta é {"profile": null} com status 200.

GET/api/v1/vendor/erp/fiscal/profileSeller

Lê o perfil fiscal do seller

Exemplo de requisição: Ler perfil fiscal

bash
curl "$BASE_URL/api/v1/vendor/erp/fiscal/profile" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Ler perfil fiscal

200Perfil
json
{
  "profile": {
    "id": "e8ad966a-d73b-464d-9f3d-c5d7f52fd55a",
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "regime": "simples",
    "cnae": "4781-4/00",
    "default_cfop": "5102",
    "default_ncm": "61091000",
    "active": true,
    "created_at": "2026-10-11T14:30:00Z",
    "updated_at": "2026-10-11T14:30:00Z"
  }
}
200Sem perfil
json
{
  "profile": null
}

Campos da resposta

profileobject

O perfil, ou null se não há.

iduuid
Id do perfil.
vendor_iduuid
Seller dono.
regimestring
simplesmeipresumidoreal
Regime tributário.
cnaestring
CNAE principal. Vazio se não informado.
default_cfopstring
CFOP padrão das operações. Vazio se não informado.
default_ncmstring
NCM padrão dos produtos. Vazio se não informado.
activeboolean
Se o perfil está ativo.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.

Erros: Ler perfil fiscal

StatusQuandoCorpo
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Gravar perfil fiscal

Grava o perfil (cria na primeira vez, substitui nas seguintes). Sempre responde 200.

PUT/api/v1/vendor/erp/fiscal/profileSeller

Cria ou substitui o perfil fiscal

Corpo da requisição

regimestringpadrão: simples
simplesmeipresumidoreal
Regime tributário. Vazio vira simples.
cnaestring
CNAE principal.
default_cfopstring
CFOP padrão.
default_ncmstring
NCM padrão.
activebooleanpadrão: true
Se está ativo.

Exemplo de requisição: Gravar perfil fiscal

bash
curl -X PUT "$BASE_URL/api/v1/vendor/erp/fiscal/profile" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "regime": "simples",
  "cnae": "4781-4/00",
  "default_cfop": "5102",
  "default_ncm": "61091000"
}'

Resposta: Gravar perfil fiscal

200Perfil gravado
json
{
  "id": "e8ad966a-d73b-464d-9f3d-c5d7f52fd55a",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "regime": "simples",
  "cnae": "4781-4/00",
  "default_cfop": "5102",
  "default_ncm": "61091000",
  "active": true,
  "created_at": "2026-10-11T14:30:00Z",
  "updated_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id do perfil.
vendor_iduuid
Seller dono.
regimestring
simplesmeipresumidoreal
Regime tributário.
cnaestring
CNAE principal. Vazio se não informado.
default_cfopstring
CFOP padrão das operações. Vazio se não informado.
default_ncmstring
NCM padrão dos produtos. Vazio se não informado.
activeboolean
Se o perfil está ativo.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.

Erros: Gravar perfil fiscal

StatusQuandoCorpo
400Corpo não é um JSON válido.{"error":"invalid request body","detail":"invalid character 'b' looking for beginning of object key string"}
400Regime fora dos quatro valores.{"error":"vendorerp: regime must be simples|mei|presumido|real"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}
Substituição completa

Campos de texto omitidos são apagados e active volta a true. Nenhum código valida CNAE, CFOP ou NCM: o texto é guardado como veio.

Apagar perfil fiscal

DELETE/api/v1/vendor/erp/fiscal/profileSeller

Apaga o perfil fiscal

Exemplo de requisição: Apagar perfil fiscal

bash
curl -X DELETE "$BASE_URL/api/v1/vendor/erp/fiscal/profile" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Apagar perfil fiscal

200Perfil apagado
json
{
  "message": "fiscal profile deleted"
}

Campos da resposta

messagestring
Sempre fiscal profile deleted.

Erros: Apagar perfil fiscal

StatusQuandoCorpo
404O seller não tem perfil.{"error":"fiscal profile not found"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}

Veja também

  • Notas fiscais emitidas
  • Plano de contas
Anterior
ERP fiscal, contábil e custos
Próxima
Notas fiscais emitidas
Nesta página
  • Ler perfil fiscal
  • Exemplo de requisição: Ler perfil fiscal
  • Resposta: Ler perfil fiscal
  • Erros: Ler perfil fiscal
  • Gravar perfil fiscal
  • Exemplo de requisição: Gravar perfil fiscal
  • Resposta: Gravar perfil fiscal
  • Erros: Gravar perfil fiscal
  • Apagar perfil fiscal
  • Exemplo de requisição: Apagar perfil fiscal
  • Resposta: Apagar perfil fiscal
  • Erros: Apagar perfil fiscal
  • Veja também