Módulos e escopos

Uma operação depende de três permissões: acesso da oferta de API, módulo do contrato e escopo da chave. read_only autoriza consultas; full também permite as escritas documentadas. O administrador pode disponibilizar API por plano ou configurar uma exceção para um contrato.

Consulte GET /v1/team para data.api.access, modules, scopes e limites. GET /v1/me descreve apenas a chave.

Recursos e áreas

Área	Recursos e escopos	Módulo	Operações
Cadastros	customers	clientes	Leitura e escrita, incluindo subcadastros
Cadastros	suppliers	fornecedores	Leitura e escrita, incluindo subcadastros
Catálogo	products, services	catalogo	Leitura
Catálogo	catalog	catalogo	Leitura, cadastro, composição, imagens e arquivamento
Catálogo	inventory	estoque	Leitura
Financeiro	sales	vendas	Leitura e escrita
Financeiro	expenses	despesas	Leitura e escrita
Financeiro	bank-accounts, wallets, credit-cards, card-machines	contas_bancarias	Leitura e escrita
Financeiro	transfers	contas_bancarias	Transferências internas e estornos
Agenda	calendars, appointments	agendamentos	Leitura e escrita
Conta e equipe	me, team, contract, users	Nenhum módulo específico	Leitura

Acrescente :read ou :write ao recurso, por exemplo calendars:write. *:read permite consultar os recursos disponíveis; *:write também concede leitura, sempre respeitando oferta, módulo e operações existentes. Bancos globais usam bank-accounts:read e permanecem somente leitura. Chaves PIX usam bank-accounts:read ou bank-accounts:write; feriados usam calendars:read. Subcadastros de clientes e fornecedores herdam o escopo do recurso principal.

A navegação reúne produtos e serviços em Catálogo e recursos de contas em Financeiro. O endpoint services ainda representa o cadastro legado de serviços, conforme seu schema; ele não equivale a toda a estrutura interna de catálogo.

Fora do escopo

Produção, Repasses, Documentos e Vitrines não fazem parte desta expansão. Transferências internas usam transfers; não correspondem aos repasses profissionais. Pagamentos e recebimentos registram fatos no LIGGA, sem executar PIX, transferências bancárias ou transações em adquirentes. Recursos de documentos de clientes e fornecedores já existentes mantêm seus contratos.

Pets, Projetos, Oportunidades e Formulários estão adiados e não têm endpoints públicos nesta versão. Frota, Acessos, Instagram, WhatsApp, Automações, Horas de máquinas, Máquinas alugadas e Certidões estão fora do desenvolvimento da API. Habilitar esses módulos no aplicativo não os torna disponíveis na API.

Erros de acesso

Erro	Verificação
api_disabled	Habilitação e elegibilidade do contrato
module_not_enabled	Módulo exigido pelo recurso
insufficient_scope	Escopo da chave e acesso somente leitura da oferta

Veja Autenticação e os contratos completos na Referência.