Empresas

📄️ Listar empresas

Lista as empresas vinculadas ao cliente autenticado. Use os filtros para encontrar empresas por data de criação, atualização ou situação da agenda, e use a paginação por cursor quando houver muitos resultados. O token precisa incluir `companies:read`.

📄️ Cadastrar uma ou mais empresas

Cadastra uma ou mais empresas para o cliente autenticado. Para uma única empresa, a resposta de sucesso é direta; para lotes, a API pode retornar `207 Multi-Status` para indicar o resultado individual de cada item. Use um token com `companies:write`.

📄️ Consultar dados de uma empresa

Consulta os dados cadastrais de uma empresa específica. Use esta chamada depois de descobrir o `companyId` na listagem ou após criar a empresa. O token precisa incluir `companies:read`.

📄️ Inativar uma empresa

Inativa uma empresa quando ela não possui dependências ativas que impeçam a exclusão lógica. Use esta operação para encerrar o uso da empresa sem remover o histórico associado. O token precisa incluir `companies:write`.

📄️ Criar grupo econômico

Cria um grupo econômico para organizar empresas relacionadas dentro do mesmo cliente. Use grupos para facilitar manutenção, consulta e vínculo de empresas que devem ser tratadas em conjunto. O token precisa incluir `write:companies:groups`.

📄️ Consultar grupo econômico

Consulta os dados de um grupo econômico e as empresas associadas a ele. Use esta chamada para conferir a composição do grupo antes ou depois de adicionar e remover membros. O token precisa incluir `read:companies:groups`.

📄️ Adicionar empresas ao grupo

Adiciona empresas a um grupo econômico existente. Envie apenas as empresas que devem ser incluídas no grupo; o vínculo passa a valer para consultas futuras. O token precisa incluir `write:companies:groups`.

📄️ Remover empresas do grupo

Remove empresas de um grupo econômico sem excluir as empresas em si. Use para corrigir vínculos ou desfazer uma associação que deixou de fazer sentido. O token precisa incluir `write:companies:groups`.

📄️ Consultar adquirentes adicionais

Mostra os adquirentes adicionais configurados para a empresa. Os adquirentes do pacote padrão continuam ativos por regra de produto e, por isso, não aparecem nesta resposta: `58160789000128`, `01027058000191`, `10440482000154`, `01027058000191`, `18727053000174`, `16501555000157`, `08561701014323`, `08561701000101`, `14380200000121`, `10573521000515`, `10573521000191`, `18189547000142` e `22177858000169`. O token precisa incluir `read:companies:acquirers`.

📄️ Substituir adquirentes adicionais

Substitui a lista completa de adquirentes adicionais da empresa. O corpo da requisição representa o estado final desejado: adquirentes omitidos são removidos e adquirentes enviados passam a ficar configurados, desde que estejam homologados, não sejam duplicados e não façam parte do pacote padrão. O pacote padrão permanece sempre ativo. O token precisa incluir `write:companies:acquirers`.

📄️ Consultar arranjos de pagamento

Lista os arranjos de pagamento habilitados para a empresa. Use esta consulta para entender quais bandeiras/arranjos podem participar dos fluxos de agenda, antecipação, cobrança e recebíveis. O token precisa incluir `read:companies:schemes`.

📄️ Substituir arranjos de pagamento

Substitui o conjunto de arranjos de pagamento da empresa. Envie a lista completa que deve permanecer ativa; valores omitidos deixam de fazer parte da configuração. O token precisa incluir `manage:companies:schemes`.

📄️ Consultar conta de devolução

Consulta a conta bancária usada em devoluções automáticas da empresa. Essa conta é usada quando uma operação precisa devolver valores ao cliente. O token precisa incluir `read:companies:accounts`.

📄️ Cadastrar conta de devolução

Cadastra a conta bancária que será usada para devoluções automáticas da empresa. Use quando ainda não houver conta configurada para esse fim. O token precisa incluir `manage:companies:accounts`.

📄️ Atualizar conta de devolução

Atualiza a conta bancária usada nas devoluções automáticas da empresa. Use para corrigir dados bancários ou trocar a conta operacional. O token precisa incluir `manage:companies:accounts`.