TOTVS RH Linha Ahgora Integrador

Árvore de páginas

Subsidiaries (Branch offices)


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


warning

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


Subsidiaries (Branch offices)

Item

Description

Flow:Client → PontoWeb
Routehttps://api.ahgora.com.br/subsidiaries
Method:POST

Subsidiaries (Branch offices)

FieldTypeRequiredDescriptionRules
numeroCadastroStringYesCNPJ numberNo separators
razaoSocialStringYesCompany nameNo separators
telefoneDDDStringNoArea CodeExpected format: "DDD"
telefoneStringNoTelephone NumberNo separators
cepStringNoZIP CODEExpected format: XXXXXXXX
No separators
enderecoStringNoAddress
complementoStringNoComplement
bairroStringNoNeighborhood
cidadeStringNoCity
estadoStringNoStateValid two-digit acronym in lower case
paisStringNoCountry acronymDefault: 1058
For Brazil, use: 1058
ativacaoStringNoTime clock activation at the branch officeUse true for yes and false for no
Use CNPJ or CPF to activate Time Clocks.


Request examples:


Request Body - Inclusion, Modification and Activation:

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

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

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

tip

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


Validation ERROR - Code 400:

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


Authentication ERROR - Code 401:

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


Permission ERROR - Code 403:

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

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