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

Plano de contas

Cadastra as contas contábeis usadas como de-para na exportação contábil.

Listar contas

O plano de contas é a lista de contas contábeis do seller. Aqui ele serve de-para para a exportação contábil: ao exportar, cada tipo de lançamento usa a primeira conta ativa daquele tipo. A lista vem com as ativas primeiro e por código, sem paginação.

GET/api/v1/vendor/erp/contabil/accountsSeller

Lista o plano de contas

Exemplo de requisição: Listar contas

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

Resposta: Listar contas

200Contas
json
{
  "accounts": [
    {
      "id": "2c3d4e5f-6071-4829-a3b4-c5d6e7f80921",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "code": "3.1.1",
      "name": "Receita de vendas",
      "type": "revenue",
      "description": "Vendas de balcão e online",
      "is_active": true,
      "created_at": "2026-10-11T14:30:00Z",
      "updated_at": "2026-10-11T14:30:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

accountsarray

Contas.

iduuid
Id da conta.
vendor_iduuid
Seller dono.
codestring
Código contábil, único por seller.
namestring
Nome da conta.
typestring
assetliabilityequityrevenueexpense
Natureza da conta.
descriptionstring
Descrição. Vazio se não informada.
is_activeboolean
Se a conta pode ser usada na exportação.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.
totalinteger
Quantidade devolvida.

Erros: Listar contas

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"}

Criar conta

POST/api/v1/vendor/erp/contabil/accountsSeller

Cria uma conta contábil

Corpo da requisição

codestringobrigatório
Código contábil. Obrigatório e único entre as contas não apagadas do seller.
namestringobrigatório
Nome. Obrigatório.
typestringobrigatório
assetliabilityequityrevenueexpense
Natureza da conta. Aceita maiúsculas.
descriptionstring
Descrição.
is_activebooleanpadrão: true
Se está ativa.

Exemplo de requisição: Criar conta

bash
curl -X POST "$BASE_URL/api/v1/vendor/erp/contabil/accounts" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "3.1.1",
  "name": "Receita de vendas",
  "type": "revenue",
  "description": "Vendas de balcão e online"
}'

Resposta: Criar conta

201Conta criada
json
{
  "id": "2c3d4e5f-6071-4829-a3b4-c5d6e7f80921",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "code": "3.1.1",
  "name": "Receita de vendas",
  "type": "revenue",
  "description": "Vendas de balcão e online",
  "is_active": true,
  "created_at": "2026-10-11T14:30:00Z",
  "updated_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id da conta.
vendor_iduuid
Seller dono.
codestring
Código contábil, único por seller.
namestring
Nome da conta.
typestring
assetliabilityequityrevenueexpense
Natureza da conta.
descriptionstring
Descrição. Vazio se não informada.
is_activeboolean
Se a conta pode ser usada na exportação.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.

Erros: Criar conta

StatusQuandoCorpo
400Corpo não é um JSON válido.{"error":"invalid request body","detail":"invalid character 'b' looking for beginning of object key string"}
400code em branco.{"error":"vendorerp: code required"}
400name em branco.{"error":"vendorerp: name required"}
400type inválido.{"error":"vendorerp: type must be asset|liability|equity|revenue|expense"}
400Já existe uma conta com este code.{"error":"vendorerp: an account with this code already exists"}
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"}

Alterar conta

PUT/api/v1/vendor/erp/contabil/accounts/{id}Seller

Altera uma conta contábil

Parâmetros de caminho

iduuidobrigatório
Id (UUID) da conta.

Corpo da requisição

codestringobrigatório
Código contábil. Obrigatório e único entre as contas não apagadas do seller.
namestringobrigatório
Nome. Obrigatório.
typestringobrigatório
assetliabilityequityrevenueexpense
Natureza da conta. Aceita maiúsculas.
descriptionstring
Descrição.
is_activebooleanpadrão: true
Se está ativa.

Exemplo de requisição: Alterar conta

bash
curl -X PUT "$BASE_URL/api/v1/vendor/erp/contabil/accounts/3f6c1c1e-8d0b-4a55-9a52-1d6f6a4a7b10" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "3.1.1",
  "name": "Receita de vendas",
  "type": "revenue",
  "is_active": true
}'

Resposta: Alterar conta

200Conta alterada
json
{
  "id": "2c3d4e5f-6071-4829-a3b4-c5d6e7f80921",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "code": "3.1.1",
  "name": "Receita de vendas",
  "type": "revenue",
  "description": "Vendas de balcão e online",
  "is_active": true,
  "created_at": "2026-10-11T14:30:00Z",
  "updated_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id da conta.
vendor_iduuid
Seller dono.
codestring
Código contábil, único por seller.
namestring
Nome da conta.
typestring
assetliabilityequityrevenueexpense
Natureza da conta.
descriptionstring
Descrição. Vazio se não informada.
is_activeboolean
Se a conta pode ser usada na exportação.
created_atdatetime
Criação.
updated_atdatetime
Última alteração.

Erros: Alterar conta

StatusQuandoCorpo
400Corpo não é um JSON válido.{"error":"invalid request body","detail":"invalid character 'b' looking for beginning of object key string"}
400code em branco.{"error":"vendorerp: code required"}
400name em branco.{"error":"vendorerp: name required"}
400type inválido.{"error":"vendorerp: type must be asset|liability|equity|revenue|expense"}
400Já existe uma conta com este code.{"error":"vendorerp: an account with this code already exists"}
404A conta não existe ou é de outro seller.{"error":"account 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"}
Omitir is_active reativa a conta

is_active vale true quando não vem no corpo, e a descrição omitida é apagada.

Apagar conta

DELETE/api/v1/vendor/erp/contabil/accounts/{id}Seller

Apaga uma conta contábil

Parâmetros de caminho

iduuidobrigatório
Id (UUID) da conta.

Exemplo de requisição: Apagar conta

bash
curl -X DELETE "$BASE_URL/api/v1/vendor/erp/contabil/accounts/3f6c1c1e-8d0b-4a55-9a52-1d6f6a4a7b10" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Apagar conta

200Conta apagada
json
{
  "message": "account deleted"
}

Campos da resposta

messagestring
Sempre account deleted.

Erros: Apagar conta

StatusQuandoCorpo
404A conta não existe ou é de outro seller.{"error":"account 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

  • Exportação contábil
Anterior
Notas fiscais emitidas
Próxima
Exportação contábil
Nesta página
  • Listar contas
  • Exemplo de requisição: Listar contas
  • Resposta: Listar contas
  • Erros: Listar contas
  • Criar conta
  • Exemplo de requisição: Criar conta
  • Resposta: Criar conta
  • Erros: Criar conta
  • Alterar conta
  • Exemplo de requisição: Alterar conta
  • Resposta: Alterar conta
  • Erros: Alterar conta
  • Apagar conta
  • Exemplo de requisição: Apagar conta
  • Resposta: Apagar conta
  • Erros: Apagar conta
  • Veja também