Índice

outline	true

Portuguese (Brasil)

Subsidiaries (Filiais)

Serviço utilizado para cadastro, alteração e desativação de filiais no Ahgora PontoWeb.

Aviso

title	warning

Permite envio em lote, máximo de 1000 registros por solicitação, ou 1mb (mega).

Subsidiaries (filiais)

Item	Descrição
Fluxo:	Cliente → PontoWeb
Rota:	https://api.ahgora.com.br/subsidiaries
Método:	POST

Sem separadores

Subsidiaries (Filiais)
campo	tipo	Obrig.	Descrição	Regras
numeroCadastro	String	Sim	número do CNPJ	Sem separadores
razaoSocial	String	Sim	Nome da empresa
telefoneDDD	String	Não	Código de area	Formato: "DDD"
telefone	String	Não	Número de telefone	Sem separadores
cep	String	Não	CEP	Formato: XXXXXXXX Sem separadores
endereco	String	Não	Endereço
complemento	String	Não	Complemento
bairro	String	Não	Bairro
cidade	String	Não	Cidade
estado	String	Não	Estado	Sigla válida de dois dígitos em minúsculas
pais	String	Não	Código do pais	Padrão: 1058 Para Brasil, use o código: 1058
ativacao	String	Não	Ativação do relógio de ponto na filial	Use true para sim e false para não Use o CNPJ ou CPF para ativar os relógios de ponto.

Exemplos de requisição (Request):

Corpo da Requisição - Inclusão, Alteração e Ativação:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "numeroCadastro": "XXXXXXXX0001XX",
    "razaoSocial": "Example Text",
    "telefoneDDD": "XX",
    "telefone": "XXXXXXXX",
    "cep": "XXXXXXX",
    "endereco": "Avenida XYZ",
    "complemento": "número 0123, Setor A",
    "bairro": "Example",
    "cidade": "São Paulo",
    "estado": "sp",
    "pais": "1058",
    "ativacao": true
  }
]

Corpo da Requisição - Desativação:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "numeroCadastro": "XXXXXXXX0001XX",
    "razaoSocial": "Example Text",
    "telefoneDDD": "XX",
    "telefone": "XXXXXXXX",
    "cep": "XXXXXXX",
    "endereco": "Avenida XYZ",
    "complemento": "número 0123, Setor A",
    "bairro": "Example",
    "cidade": "São Paulo",
    "estado": "sp",
    "pais": "1058",
    "ativacao": false
  }
]

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "company": "a000101",
  "unique": "bd751350",
  "message": "Subsidiaries Integration on progress"
}

Dica
Para obter mais detalhe, utilize o serviço Process. Para saber mais entre no link.

ERRO de Validação - Code 400:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "message": "Request format must be an Array",
  "code": 400
}

ERRO de Autenticação - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "message": "Unauthorized",
  "code": 401
}

ERRO de Permissão - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Observação: Verificar as permissões do usuário para acessar a rota/serviço.

English (US)

Subsidiaries (Branch offices)

Service used to register, change and deactivate branches on Ahgora PontoWeb.

Aviso

title	warning

Batch sending allowed, maximum 1000 records per request, or 1mb (mega)

Subsidiaries (Branch offices)

Item	Description
Flow:	Client → PontoWeb
Route	https://api.ahgora.com.br/subsidiaries
Method:	POST

Subsidiaries (Branch offices)
Field	Type	Required	Description	Rules
numeroCadastro	String	Yes	CNPJ number	No separators
razaoSocial	String	Yes	Company name	No separators
telefoneDDD	String	No	Area Code	Expected format: "DDD"
telefone	String	No	Telephone Number	No separators
cep	String	No	ZIP CODE	Expected format: XXXXXXXX No separators
endereco	String	No	Address
complemento	String	No	Complement
bairro	String	No	Neighborhood
cidade	String	No	City
estado	String	No	State	Valid two-digit acronym in lower case
pais	String	No	Country acronym	Default: 1058 For Brazil, use: 1058
ativacao	String	No	Time clock activation at the branch office	Use true for yes and false for no Use CNPJ or CPF to activate Time Clocks.

Request examples:

Request Body - Inclusion, Modification and Activation:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "numeroCadastro": "XXXXXXXX0001XX",
    "razaoSocial": "Example Text",
    "telefoneDDD": "XX",
    "telefone": "XXXXXXXX",
    "cep": "XXXXXXX",
    "endereco": "Avenida XYZ",
    "complemento": "número 0123, Setor A",
    "bairro": "Example",
    "cidade": "São Paulo",
    "estado": "sp",
    "pais": "1058",
    "ativacao": true
  }
]

Request Body - Deactivation:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "numeroCadastro": "XXXXXXXX0001XX",
    "razaoSocial": "Example Text",
    "telefoneDDD": "XX",
    "telefone": "XXXXXXXX",
    "cep": "XXXXXXX",
    "endereco": "Avenida XYZ",
    "complemento": "número 0123, Setor A",
    "bairro": "Example",
    "cidade": "São Paulo",
    "estado": "sp",
    "pais": "1058",
    "ativacao": false
  }
]

Response examples:

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "company": "a000101",
  "unique": "bd751350",
  "message": "Subsidiaries Integration on progress"
}

Dica

title	tip

For more details, use the Process service. To find out more, click here.

Validation ERROR - Code 400:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "message": "Request format must be an Array",
  "code": 400
}

Authentication ERROR - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "message": "Unauthorized",
  "code": 401
}

Permission ERROR - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Note: Check the user's permissions to access the route/service.

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Subsidiaries (Filiais)

Exemplos de requisição (Request):

Corpo da Requisição - Inclusão, Alteração e Ativação:

Corpo da Requisição - Desativação:

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

ERRO de Validação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

Subsidiaries (Branch offices)

Request examples:

Request Body - Inclusion, Modification and Activation:

Request Body - Deactivation:

Response examples:

Response when SUCCESS - Code 200:

Validation ERROR - Code 400:

Authentication ERROR - Code 401:

Permission ERROR - Code 403:

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 6

Nova versão Atual

Chave

Subsidiaries (Filiais)

Exemplos de requisição (Request):

Corpo da Requisição - Inclusão, Alteração e Ativação:

Corpo da Requisição - Desativação:

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

ERRO de Validação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

Subsidiaries (Branch offices)

Request examples:

Request Body - Inclusion, Modification and Activation:

Request Body - Deactivation:

Response examples:

Response when SUCCESS - Code 200:

Validation ERROR - Code 400:

Authentication ERROR - Code 401:

Permission ERROR - Code 403: