Benefícios

Listagem de grupos e respectivos benefícios

List Benefits Groups

Lista grupos de benefícios separados por categoria e ordenado por título.

GET Url Produção: https://api.acessorh.com.br Url Homologação: https://api.rh.homolog.acesso.io Endpoint: /v1/benefit/groups

Headers

Key	Type	Description
Authorization*	string	Token de acesso adquirido pela plataforma Identity (bearer)

Query Parameters

Key	Type	Description
account*	string	UID da empresa (obrigatório)
order	string	Ordena o resultado dos grupos de benefícios de forma crescente e decrescente ("desc" e "asc").
sort	string	Ordena o resultado dos grupos de benefícios.
skip	integer	Indica a quantidade de grupos de benefícios que serão pulados (paginação).
limit	integer	Limite de grupos de benefícios que serão listados(paginação).
category	string	UID da categoria que deseja filtrar.

Lista de categorias

• "b26803a7-3a7c-48d1-8a66-70a5e59f68fe" - Alimentação

• "3f4e1ee3-c225-49df-9b17-3a4444dd59e0" - Assistência Odontológica

• "47dcc73a-1985-40f5-98bd-07e00b9bf08a" - Assistência Médica

• "b62f3492-3dcd-41e7-b644-40f4f72c753f" - Seguro de vida

• "e3a19b9a-333d-4db9-b203-24baf0f3d984" - Transporte

Tipos de sort

• name

• title

• created

• updated

Caso não seja inserido os parâmetros limit e skip , os valores padrões serão, respectivamente, 1000 e 0.

O parâmetro limit tem o seu valor máximo como 1000.

Exemplo de requisição, apenas obrigatorio.

curl --location --request DELETE 'https://api.acessorh.com.br/v1/department?uid=uid%20do%20departamento&acc=uid%20da%20empresa' \
--header 'Authorization: Bearer token de auth'

Exemplo de requisição completa

curl --location 'https://api.acessorh.com.br/v1/benefit/groups?account=uid%20da%20empresa&order=asc&sort=name&limit=1000&skip=0&category=b26803a7-3a7c-48d1-8a66-70a5e59f68fe' \
--header 'Authorization: Bearer token de auth'

Exemplo de response

200 OK: Em caso de sucesso

[
    {
        "uid": "28640fba-9757-411b-bfca-04d1bb2c0286",
        "account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
        "title": "Teste alimentação",
        "description": "Teste de alimentação",
        "canOpt": true,
        "context": "brazil",
        "category": {
            "type": "b26803a7-3a7c-48d1-8a66-70a5e59f68fe",
            "slug": "alimentacao",
            "title": {
                "pt_BR": "Alimentação"
            },
            "data": {
                "flexivel": null
            }
        },
        "benefits": [
            {
                "uid": "52b554d1-37ca-493a-b583-4830fd4c28ef",
                "type": "08662463-4bd9-4224-8e27-09fcac91a1c8",
                "slug": "combo-vrva",
                "title": {
                    "pt_BR": "Combo VR/VA"
                },
                "data": {
                    "flexivel": true,
                    "frequencia": "mensal",
                    "slug": "combo-vrva",
                    "title": {
                        "pt_BR": "Combo VR/VA"
                    },
                    "va": {
                        "provedor": "Provedor do plano",
                        "frequencia": "",
                        "valor": 0,
                        "desconto": "Formato de desconto."
                    },
                    "valorTotal": 800,
                    "vr": {
                        "provedor": "Provedor do plano",
                        "frequencia": "",
                        "valor": 0,
                        "valorMinimo": 200,
                        "desconto": "Formato de desconto."
                    }
                }
            }
        ],
        "totalOfBenefits": 1
    },
    {
        "uid": "1a69f7df-1f48-449b-93fb-0e43a910284f",
        "account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
        "title": "Teste assistência Odontológica",
        "description": "Teste ass odonto",
        "canOpt": false,
        "context": "brazil",
        "category": {
            "type": "3f4e1ee3-c225-49df-9b17-3a4444dd59e0",
            "slug": "assistencia-odontologica",
            "title": {
                "pt_BR": "Assistência Odontológica"
            },
            "data": {}
        },
        "benefits": [
            {
                "uid": "19bf72e0-20c8-4099-aa31-16a9f7c49cb9",
                "type": "64b879be-f2cf-430b-a47d-7ad674b62459",
                "slug": "plano-odontologico",
                "title": {
                    "pt_BR": "Assistência Odontológica"
                },
                "data": {
                    "aceitaIncapaz": true,
                    "anexo": null,
                    "dependentes": true,
                    "desconto": "Formato de desconto.",
                    "planos": [
                        {
                            "uid": "469d5762-f5ac-4023-bcfd-778d90ab0357",
                            "nome": "Nome do plano",
                            "desconto": "Formato de desconto."
                        }
                    ],
                    "preferencias": [
                        {
                            "parentesco": "conjuge",
                            "idadeMinima": 10,
                            "idadeMaxima": 100
                        },
                        {
                            "parentesco": "filho",
                            "idadeMinima": 0,
                            "idadeMaxima": 120
                        },
                        {
                            "parentesco": "enteado",
                            "idadeMinima": 10,
                            "idadeMaxima": 60
                        },
                        {
                            "parentesco": "irmao",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        },
                        {
                            "parentesco": "neto",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        },
                        {
                            "parentesco": "bisneto",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        },
                        {
                            "parentesco": "menor-pobre",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        },
                        {
                            "parentesco": "pai-mae",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        },
                        {
                            "parentesco": "avo",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        },
                        {
                            "parentesco": "bisavo",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        }
                    ],
                    "provedor": "Provedor do plano",
                    "slug": "plano-odontologico",
                    "title": {
                        "pt_BR": "Assistência Odontológica"
                    }
                }
            }
        ],
        "totalOfBenefits": 1
    },
    {
        "uid": "438cb683-a5eb-4c36-ba5b-1074a0360ba9",
        "account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
        "title": "Teste assistência médica",
        "description": "Teste ass médica",
        "canOpt": true,
        "context": "brazil",
        "category": {
            "type": "47dcc73a-1985-40f5-98bd-07e00b9bf08a",
            "slug": "assistencia-medica",
            "title": {
                "pt_BR": "Assistência Médica"
            },
            "data": {}
        },
        "benefits": [
            {
                "uid": "90f1c983-e318-4095-a0a4-a9913adc56ce",
                "type": "165544c0-bf16-4880-8db9-b9815733acd3",
                "slug": "plano-saude",
                "title": {
                    "pt_BR": "Plano de Saúde"
                },
                "data": {
                    "aceitaIncapaz": true,
                    "anexo": {
                        "path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/account/2d9174c4-06b7-4956-a5dc-8824d8a2f49e/benefit/attachment/7b01a6b7-5a2c-4032-be33-40f48ae08fd7/7b01a6b7-5a2c-4032-be33-40f48ae08fd7.pdf",
                        "mime": "application/pdf",
                        "size": 3028,
                        "name": "sample.pdf"
                    },
                    "dependentes": true,
                    "desconto": "Formato de desconto.",
                    "planos": [
                        {
                            "uid": "0a3d2fee-aa8f-4180-95ca-f7447e0a70c4",
                            "nome": "Nome do plano",
                            "desconto": "Formato de desconto."
                        }
                    ],
                    "preferencias": [
                        {
                            "parentesco": "conjuge",
                            "idadeMinima": 15,
                            "idadeMaxima": 120
                        },
                        {
                            "parentesco": "filho",
                            "idadeMinima": 0,
                            "idadeMaxima": 25
                        },
                        {
                            "parentesco": "irmao",
                            "idadeMinima": 0,
                            "idadeMaxima": 40
                        },
                        {
                            "parentesco": "menor-pobre",
                            "idadeMinima": 0,
                            "idadeMaxima": 100
                        }
                    ],
                    "provedor": "Provedor do plano",
                    "slug": "plano-saude",
                    "title": {
                        "pt_BR": "Plano de Saúde"
                    }
                }
            }
        ],
        "totalOfBenefits": 1
    },
    {
        "uid": "6246de95-3e02-4f7a-8de7-d54453f74cd0",
        "account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
        "title": "Teste seguro Vida",
        "description": "Teste seguro de vida",
        "canOpt": false,
        "context": "brazil",
        "category": {
            "type": "b62f3492-3dcd-41e7-b644-40f4f72c753f",
            "slug": "seguro-vida",
            "title": {
                "pt_BR": "Seguro de vida"
            },
            "data": {}
        },
        "benefits": [
            {
                "uid": "678ad091-077e-474a-be3e-434a467e24e9",
                "type": "77951cff-6986-4fef-be7e-8aa598191ff5",
                "slug": "seguro-vida",
                "title": {
                    "pt_BR": "Seguro de Vida"
                },
                "data": {
                    "aceitaIncapaz": null,
                    "anexo": {
                        "path": "organization/896ffd1d-a3a9-43df-a2e8-eed057fe40e6/account/2d9174c4-06b7-4956-a5dc-8824d8a2f49e/benefit/attachment/d664ae34-6377-4aeb-92f3-5d18fc15d959/d664ae34-6377-4aeb-92f3-5d18fc15d959.pdf",
                        "mime": "application/pdf",
                        "size": 3028,
                        "name": "sample.pdf"
                    },
                    "descontoFolha": null,
                    "flexivel": true,
                    "incluirBeneficiarios": true,
                    "planos": [
                        {
                            "uid": "550fbdfa-d2af-4d0b-8d95-d689fe4320be",
                            "nome": "Nome do plano",
                            "desconto": "Formato de desconto."
                        }
                    ],
                    "provedor": "Provedor do plano",
                    "slug": "seguro-vida",
                    "title": {
                        "pt_BR": "Seguro de Vida"
                    }
                }
            }
        ],
        "totalOfBenefits": 1
    },
    {
        "uid": "88518ae2-9c68-4fd4-bc31-a07612acca5b",
        "account": "2d9174c4-06b7-4956-a5dc-8824d8a2f49e",
        "title": "Teste transporte",
        "description": "Teste do benefício de transporte",
        "canOpt": true,
        "context": "brazil",
        "category": {
            "type": "e3a19b9a-333d-4db9-b203-24baf0f3d984",
            "slug": "transporte",
            "title": {
                "pt_BR": "Transporte"
            },
            "data": {}
        },
        "benefits": [
            {
                "uid": "1a2f30df-e5d0-497a-bab6-796dfffc9269",
                "type": "3c2e4354-768f-4dc0-a783-ad94e0e48c64",
                "slug": "aluguel-veicular",
                "title": {
                    "pt_BR": "Aluguel de Veículo"
                },
                "data": {
                    "desconto": "Formato de desconto.",
                    "frequencia": "diario",
                    "provedor": "Provedor",
                    "slug": "aluguel-veicular",
                    "title": {
                        "pt_BR": "Aluguel de Veículo"
                    },
                    "valor": 100
                }
            },
            {
                "uid": "ddd54853-9387-40b8-ae2a-eb3247ea552b",
                "type": "0d672cdd-4719-421e-8ae6-31f9ef5e34c1",
                "slug": "estacionamento",
                "title": {
                    "pt_BR": "Estacionamento"
                },
                "data": {
                    "desconto": "Formato de desconto.",
                    "frequencia": "diario",
                    "provedor": "Provedor",
                    "slug": "estacionamento",
                    "title": {
                        "pt_BR": "Estacionamento"
                    },
                    "valor": 2
                }
            },
            {
                "uid": "d30f925f-2f44-4c31-891e-7c06c64b92eb",
                "type": "1fefbd30-2056-4ad6-903e-9235e7bc6afb",
                "slug": "fretado",
                "title": {
                    "pt_BR": "Fretado"
                },
                "data": {
                    "desconto": "Formato de desconto.",
                    "frequencia": "mensal",
                    "provedor": "Provedor",
                    "slug": "fretado",
                    "title": {
                        "pt_BR": "Fretado"
                    },
                    "valor": 25
                }
            },
            {
                "uid": "c042c502-c270-43ce-994f-5cfecf3c558c",
                "type": "59da7250-9740-4792-99ea-b73e22f915f3",
                "slug": "gasolina",
                "title": {
                    "pt_BR": "Gasolina"
                },
                "data": {
                    "desconto": "Formato de desconto.",
                    "frequencia": "diario",
                    "provedor": "Provedor",
                    "slug": "gasolina",
                    "title": {
                        "pt_BR": "Gasolina"
                    },
                    "valor": 1000
                }
            },
            {
                "uid": "d9fb3e3b-3f64-401a-9640-786cfad6c534",
                "type": "f5887287-442e-4237-a738-31130ecf350a",
                "slug": "vt",
                "title": {
                    "pt_BR": "Vale Transporte"
                },
                "data": {
                    "desconto": "Formato de desconto.",
                    "slug": "vt",
                    "title": {
                        "pt_BR": "Vale Transporte"
                    },
                    "trajeto": "melhor"
                }
            }
        ],
        "totalOfBenefits": 5
    }
]

400: Em caso de falha