CTC Contratos - GrupoBRA/SocialAPI-v2-Doc GitHub Wiki
Obtendo os contratos de uma CTC
GET
Endpoint: /v1/pessoa-fisica/ctc/contratos/{pf_id}/{pf_ctc_id}/
Retorno:
{
"success":true,
"data":{
"SocialAPI":{
"current":[
{
"pf_ctc_contr_id":"{id}",
"pf_ctc_contr_nulo": "S",
"pf_ctc_contr_nulo_motivo": "S",
"pf_ctc_contr_empregador": "ACME S/A",
"pf_ctc_contr_inicio":"2001-01-01",
"pf_ctc_contr_term":"2001-12-31",
"pf_ctc_contr_dias_desc":19,
"pf_ctc_contr_dias_liq":346,
"pf_ctc_contr_iniciativa":"P|V",
"pf_ctc_contr_cargo_esp":1,
"pf_ctc_contr_cargo":"Nome do cargo",
"pf_ctc_contr_regime":"RGPS|RPPS",
"pf_ctc_contr_cnpj":"10582517000190",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
},
{
"pf_ctc_contr_id":"{id}",
"pf_ctc_contr_nulo": "S",
"pf_ctc_contr_nulo_motivo": "LS",
"pf_ctc_contr_inicio":"2001-01-01",
"pf_ctc_contr_term":"2001-12-31",
"pf_ctc_contr_dias_desc":19,
"pf_ctc_contr_dias_liq":346,
"pf_ctc_contr_iniciativa":"P|V",
"pf_ctc_contr_cargo_esp":0,
"pf_ctc_contr_cargo":"Nome do cargo",
"pf_ctc_contr_regime":"RGPS|RPPS",
"pf_ctc_contr_cnpj":"10582517000190",
"author":{
"oid":"{oid}",
"uupfid":"{uupfid}",
"nome":"Nome do autor",
"timestamp":123123
}
}
],
"revisions":[
]
}
}
}
Forçando o flush do cache
GET
Endpoint: /v1/pessoa-fisica/ctc/contratos/flush/{pf_id}/{pf_ctc_id}/
Retorno conforme este endpoint.
Inserindo um contrato para uma CTC
POST
Endpoint: /v1/pessoa-fisica/ctc/contratos/
Payload:
{
"pf_id":"{pf_id}",
"pf_ctc_id": "{pf_ctc_id}",
"pf_ctc_contr_nulo": "S",
"pf_ctc_contr_nulo_motivo": "S", // F = Faltas, L = Licenças, LS = Licença sem vencimentos, S = Suspensões, D = Disponibilidade, O = Outros
"pf_ctc_contr_empregador": "ACME S/A",
"pf_ctc_contr_inicio":"2001-01-01",
"pf_ctc_contr_term":"2001-12-31",
"pf_ctc_contr_dias_desc":19,
"pf_ctc_contr_dias_liq":346,
"pf_ctc_contr_iniciativa":"P|V",
"pf_ctc_contr_cargo_esp":1,
"pf_ctc_contr_cargo":"Nome do cargo",
"pf_ctc_contr_regime":"RGPS|RPPS",
"pf_ctc_contr_cnpj":"10582517000190",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 201
Alterando um contrato de uma CTC
PUT
Endpoint: /v1/pessoa-fisica/ctc/contratos/{pf_id}/{pf_ctc_contr_id}/
Payload:
{
"pf_ctc_contr_nulo": "S",
"pf_ctc_contr_empregador": "ACME S/A",
"pf_ctc_contr_inicio":"2001-01-01",
"pf_ctc_contr_term":"2001-12-31",
"pf_ctc_contr_dias_desc":19,
"pf_ctc_contr_dias_liq":346,
"pf_ctc_contr_iniciativa":"P|V",
"pf_ctc_contr_cargo_esp":1,
"pf_ctc_contr_cargo":"Nome do cargo",
"pf_ctc_contr_regime":"RGPS|RPPS",
"pf_ctc_contr_cnpj":"10582517000190",
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 200
Removendo um contrato de uma CTC
DELETE
Endpoint: /v1/pessoa-fisica/ctc/contratos/{pf_id}/{pf_ctc_contr_id}/
Payload:
{
"device":{
"id":"7df0723b4c86ab59711ea26c66642c47",
"log":{
"lat":"-7.9839111",
"lon":"-34.8387671"
}
}
}
Retorno:
Status code: 204