TOTVS RH Linha Ahgora Integrador

Árvore de páginas

Subsidiaries (Filiais)


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


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

Subsidiaries (Filiais)

campotipoObrig.DescriçãoRegras
numeroCadastroStringSimnúmero do CNPJSem separadores
razaoSocialStringSimNome da empresa
telefoneDDDStringNãoCódigo de areaFormato: "DDD"
telefoneStringNãoNúmero de telefoneSem separadores
cepStringNãoCEPFormato: XXXXXXXX
Sem separadores
enderecoStringNãoEndereço
complementoStringNãoComplemento
bairroStringNãoBairro
cidadeStringNãoCidade
estadoStringNãoEstadoSigla válida de dois dígitos em minúsculas
paisStringNãoCódigo do paisPadrão: 1058
Para Brasil, use o código: 1058
ativacaoStringNãoAtivação do relógio de ponto na filialUse 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:

[
  {
    "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:

[
  {
    "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:

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

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


ERRO de Validação - Code 400:

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


ERRO de Autenticação - Code 401:

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


ERRO de Permissão - Code 403:

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

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