Índice

outline	true

Portuguese (Brasil)

Afastamentos (Absences)

Serviço utilizado para cadastrar. alterar e remover afastamentos do Ahgora PontoWeb.

Aviso
Permitido envio em lote, máximo 1000 registros por requisição, ou 1mb (mega)

Afastamentos (absences)

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

Afastamentos - Absences
Campo	Tipo	Obrig.	Descrição	Regra
matricula	String	Sim	Matrícula do Funcionário
motivo	String	Sim	Motivo do Afastamento	*String do motivo de afastamento cadastrado no PontoWeb Enviar o Código ou o Motivo, é obrigatória uma das informações
inicio	String	Sim	Data e/ou hora Inicial do Afastamento	YYYY-MM-DDTHH:MM
fim	String	Sim	Data e/ou hora Final do Afastamento	YYYY-MM-DDTHH:MM (Enviando hora final

2400

24:00 corresponde ao dia total)
cod_interno	String	*Sim	Código interno do Afastamento	*Obrigatório para manutenções via integração. Este campo é chave para acessar o registro. A manutenção da ausência depende

do

deste campo

'internalCode'

, caso o mesmo não seja informado não será possível alterar ou remover a ausência pela integração

Este código é armazenado para servir de chave para alterações no afastamento

. Ele deve ser único para todos os afastamentos cadastrados pela integração.
operation	String	Sim	Ação a ser realizada	INS operação para inserção ALT para alterar DEL para remoção da ausência
ignora_bloqueio	String	Não	Ignora bloqueios de períodos	Ignora o bloqueio de apurações para inserir ou alterar registro de afastamento em período de bloqueio. Caso utilize o recurso "bloqueio de competências" no PontoWeb. Para alterar afastamentos ou incluir quando a competência estiver bloqueada deverá utilizar este campo para alterar ou incluir. 0 = false (default quando o campo não é enviado) 1 = true A alteração ou inclusão só será aplicada na apuração da competência bloqueada se o período for desbloqueado. Exemplo: No caso de um afastamento inserido no sistema com data início 10/10/2000 e data fim 10/10/2050 e utilizado o recurso de "bloqueio de competência", se necessário alterar ou a data inicio ou a data fim desse afastamento, deve-se utilizar o "ignora_bloqueio = 1" para que o afastamento seja alterado com sucesso.

Exemplos de Requisições (Requests)

Exemplo de corpo

Corpo da

requisição

Requisição - Inclusão:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "matricula": "00000001",
    "motivo": "Atestado médico",
    "inicio": "2024-01-11T10:00",
    "fim": "2024-01-15T23:00",
    "cod_interno": "w289fdf2",
    "operation": "INS"
  }
]

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

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "matricula": "00000001",
    "motivo": "Atestado médico",
    "inicio": "2024-01-11T10:00",
    "fim": "2024-01-15T23:00",
    "cod_interno": "w289fdf2",
    "operation": "ALT",
    "ignora_bloqueio"= "1"
  }
]

Exemplo de corpo

Corpo da

requisição

Requisição - Exclusão:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "matricula": "00000001",
    "motivo": "Atestado médico",
    "inicio": "2024-01-11T10:00",
    "fim": "2024-01-15T23:00",
    "cod_interno": "w289fdf2",
    "operation": "DEL"
  }
]

Exemplos de Retornos (Responses)

Exemplo de resposta

Resposta quando SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "company": "a000101",
  "

unique

message": "

bd751350

Absences's Integration on progress",
  "

message

unique": "bd751350"

Absences

Integration

on progress

"subunique": "dc8ab430"
}

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

Exemplo de

ERRO de

validação

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
}

Exemplo de ERRO

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)

Absences

Service used to register, change and remove leave from Ahgora PontoWeb.

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

Afastamentos (absences)

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

Absences
Field	Type	Required	Description	Rule
matricula	String	Yes	Employee's registration
motivo	String	Yes	Reason for absence	*String of the leave reason registered in PontoWeb Send the Code or Reason, one of the following is mandatory
inicio	String	Yes	Start date and/or time of absence	Expected format: "YYYY-MM-DDTHH:MM"
fim	String	Yes	End date and/or time of absence	Expected formta: "YYYY-MM-DDTHH:MM" (Sending end time 24:00 corresponds to the total day)
cod_interno	String	Yes*	Internal code for absence	*Mandatory for maintenance via integration. This field is key to accessing the record. Maintenance of the absence depends on this field; if it is not entered, it will not be possible to change or remove the absence via the integration. It must be unique for all absences registered via the integration.
operation	String	Yes	Action to be taken	INS (insertion operation) ALT (to alter) DEL (to remove the absence)
ignora_bloqueio	String	No	Bypasses period blocks	Bypasses the calculation lock to insert or change a leave record in a lock period. If you use the "competency lock" feature in PontoWeb. To change leave or add it when the competence is blocked, you must use this field to change or add it. 0 = false (default when the field is not sent) 1 = true The change or inclusion will only be applied to the calculation of the locked period if the period is unlocked. Example: In the case of a leave of absence entered in the system with a start date of 10/10/2000 and an end date of 10/10/2050 and the "blocking of competence" feature is used, if it is necessary to change either the start date or the end date of this leave of absence, "ignora_bloqueio = 1" must be used so that the leave of absence is successfully changed.

Requests examples:

Body Request - Inclusion:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "matricula": "00000001",
    "motivo": "Medical certificate",
    "inicio": "2024-01-11T10:00",
    "fim": "2024-01-15T23:00",
    "cod_interno": "w289fdf2",
    "operation": "INS"
  }
]

Body Request - Changes:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "matricula": "00000001",
    "motivo": "Medical certificate",
    "inicio": "2024-01-11T10:00",
    "fim": "2024-01-15T23:00",
    "cod_interno": "w289fdf2",
    "operation": "ALT",
    "ignora_bloqueio"= "1"
  }
]

Body Resquest - Exclusion:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

[
  {
    "matricula": "00000001",
    "motivo": "Medical certificate",
    "inicio": "2024-01-11T10:00",
    "fim": "2024-01-15T23:00",
    "cod_interno": "w289fdf2",
    "operation": "DEL"
  }
]

Responses examples:

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
  "company": "a000101",
  "message": "Absences's Integration on progress",
  "unique": "bd751350",
  "subunique": "dc8ab430"
}

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

de autenticação

- 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 4

Nova versão Atual

Chave

Afastamentos (Absences)

Exemplos de Requisições (Requests)

Corpo da

Requisição - Inclusão:

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

Exemplos de Retornos (Responses)

Resposta quando SUCESSO - Code 200:

ERRO de

Validação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

Absences

Requests examples:

Body Request - Inclusion:

Body Request - Changes:

Body Resquest - Exclusion:

Responses 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 4

Nova versão Atual

Chave

Afastamentos (Absences)

Exemplos de Requisições (Requests)

Corpo da

Requisição - Inclusão:

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

Exemplos de Retornos (Responses)

Resposta quando SUCESSO - Code 200:

ERRO de

Validação - Code 400:

ERRO de Autenticação - Code 401:

ERRO de Permissão - Code 403:

Absences

Requests examples:

Body Request - Inclusion:

Body Request - Changes:

Body Resquest - Exclusion:

Responses examples:

Response when SUCCESS - Code 200:

Validation ERROR - Code 400:

Authentication ERROR

- Code 401:

Permission ERROR - Code 403: