Company
IMPORTANTE
Para mais detalhes sobre os dados de entrada e saída consulte a documentação da API.
Get Company Details#
Este método retorna os detalhes de uma empresa específica.
- Recebe o argumento - paramsque é um dicionário com os campos:- companyId: (obrigatório) id da Empresa -- string.
 
- Retorna um objeto com os métodos: - content: conteúdo da resposta.- id: string.
- document: string.
- name: string.
- logo: string.
- url: string.
- segment: string.
 
- id: 
- status_code: status da requisição.
 
Get Company List#
Este método retorna todas as empresas da sua conta.
- Recebe o argumento - paramsque é um dicionário com os campos:- page: (opcional) número de uma página especifica -- number.
- pageSize: (opcional) quantidade de items por página (por padrão tem o valor 20) -- number.
 
- Retorna um objeto com os métodos: - content: conteúdo da resposta.- results: array.
- pageNumber: number.
- nextPage: string.
 
- results: 
- status_code: status da requisição.
 
Get Company Store#
Este método retorna todas as empresas da sua conta.
- Recebe o argumento - paramsque é um dicionário com os campos:- companyId: (obrigatório) id da empresa -- string.
- page: (opcional) número de uma página especifica -- number.
- pageSize: (opcional) quantidade de items por página (por padrão tem o valor 20) -- number.
 
- Retorna um objeto com os métodos: - content: conteúdo da resposta.- results: array.
- pageNumber: number.
- nextPage: string.
 
- results: 
- status_code: status da requisição.
 
Update Company#
Este método atualiza dados de uma empresa.
- Recebe o argumento - paramsque é um dicionário com os campos:- companyId: (obrigatório) id da empresa -- string.
 
- Recebe o argumento - bodyque é um dicionário com os campos:- document: (obrigatório) documento de identificaçao (CNPJ/CPF) -- string.
- name:(obrigatório) nome da empresa -- string.
- logo: (opcional) url da logo da empresa -- string.
- url: (opcional) url da página de impacto da empresa -- string.
- segment: (opcional) segmento da empresa -- string.
 
- Retorna um objeto com os métodos: - content: conteúdo da resposta.- id: string.
- document: string.
- name: string.
- logo: string.
- url: string.
- segment: string.
 
- id: 
- status_code: status da requisição.
 
Create Company#
Este método cria uma empresa.
- Recebe o argumento - bodyque é um dicionário com os campos:- document: (obrigatório) documento de identificaçao (CNPJ/CPF) -- string.
- name: nome da empresa -- string.
- logo: url da logo da empresa -- string.
- url: url da página de impacto da empresa -- string.
- segment: segmento da empresa -- string.
 
- Retorna um objeto com os métodos: - content: conteúdo da resposta.- id: string.
- document: string.
- name: string.
- logo: string.
- url: string.
- segment: string.
 
- id: 
- status_code: status da requisição.