Beneficiários
Buscar CPT
Buscar dados de CPT de um beneficiário.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sgu20/beneficiario/cpts
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| carteira | Sim | string | 9999-9999-999999-99 | Carteira do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| cid | Não | string | min:1 | max:7 | CID |
| data_limite | Não | date | Y-m-d H:i:s | Data limite |
| descricao | Não | string | livre | Descrição |
Buscar beneficiários
Buscar dados de um ou mais beneficiários.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sgu20/beneficiario/search
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| carteira | Não | string | 9999-9999-999999-99 | Carteira do beneficiário |
| cpf | Não | string | 999.999.999-99 | CPF do beneficiário |
| unimed_responsavel | Não | int | 1 a 4 dígitos | Código da Unimed responsável (carteira) |
| contrato | Não | int | 1 a 4 dígitos | Código do contrato (carteira) |
| codigo | Não | int | 1 a 6 dígitos | Código do beneficiário (carteira) |
| dependente | Não | int | 1 a 2 dígitos | Código do dependente (carteira) |
| nome | Não | string | livre | Nome do beneficiário |
| data_nascimento_de | Não | date | d/m/Y | Data de nascimento inicial |
| data_nascimento_ate | Não | date | d/m/Y | Data de nascimento final |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| unimed_responsavel | Sim | int | 1 a 4 dígitos | Código da Unimed responsável (carteira) |
| contrato | Sim | int | 1 a 4 dígitos | Código do contrato (carteira) |
| codigo | Sim | int | 1 a 6 dígitos | Código do beneficiário (carteira) |
| dependente | Sim | int | 1 a 2 dígitos | Código do dependente (carteira) |
| plano_id | Sim | string | alfanumérico | min:1 | max: 15 | Código do plano |
| cpf | Não | int | 11 dígitos | CPF do beneficiário |
| data_exclusao | Não | date | Y-m-d H:i:s | Data de exclusão |
| data_inicio_vigencia | Não | date | Y-m-d H:i:s | Nome de início de vigência |
| data_nascimento | Não | date | Y-m-d H:i:s | Data de nascimento |
| grau_dependencia | Não | string | livre | Grau de dependência |
| nome | Não | string | livre | Nome completo |
| codigo_origem | Sim | int | 1 a 10 dígitos | Código da pessoa no sistema |
| sexo | Sim | string | 1 caractere (F ou M) | Sexo da pessoa |
Buscar carências
Buscar dados de carência de um beneficiário.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sgu20/beneficiario/carencias
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| carteira | Sim | string | 9999-9999-999999-99 | Carteira do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| descricao | Não | string | livre | Descrição |
| dias | Não | int | livre | Dias |
| mensagem | Não | string | livre | Mensagem |
Buscar contatos
Buscar dados de contatos de um beneficiário.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sgu20/beneficiario/contatos
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| carteira | Sim | string | 9999-9999-999999-99 | Carteira do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| endereco | Não | string | livre | Endereço |
| telefone | Não | int | 8 a 11 dígitos | Telefone |
| tipo_endereco | Não | string | livre | Tipo do endereço |
Buscar família
Buscar dados dos beneficiários de uma família.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sgu20/beneficiario/familia
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| carteira | Sim | string | 9999-9999-999999-99 | Carteira do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| unimed_responsavel | Sim | int | 1 a 4 dígitos | Código da Unimed responsável (carteira) |
| contrato | Sim | int | 1 a 4 dígitos | Código do contrato (carteira) |
| codigo | Sim | int | 1 a 6 dígitos | Código do beneficiário (carteira) |
| dependente | Sim | int | 1 a 2 dígitos | Código do dependente (carteira) |
| plano_id | Sim | string | alfanumérico | min:1 | max: 15 | Código do plano |
| cpf | Não | int | 11 dígitos | CPF do beneficiário |
| data_exclusao | Não | date | Y-m-d H:i:s | Data de exclusão |
| data_inicio_vigencia | Não | date | Y-m-d H:i:s | Nome de início de vigência |
| data_nascimento | Não | date | Y-m-d H:i:s | Data de nascimento |
| grau_dependencia | Não | string | livre | Grau de dependência |
| nome | Não | string | livre | Nome completo |
Buscar mensalidades
Buscar dados de mensalidade de um beneficiário.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sgu20/beneficiario/mensalidades
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| carteira | Sim | string | 9999-9999-999999-99 | Carteira do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| acrescimo | Não | number | livre | Acréscimo |
| data_pagamento | Não | date | Y-m-d H:i:s | Data de pagamento |
| data_vencimento | Não | date | Y-m-d H:i:s | Data de vencimento |
| fatura | Não | int | livre | Código da fatura |
| periodo | Não | int | 6 dígitos | Período |
| valor | Não | number | livre | Valor |
| valor_pago | Não | number | livre | Valor pago |
Buscar suspensão
Buscar dados de suspensão de um beneficiário.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sgu20/beneficiario/suspenso
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| cpf | Sim | string | 999.999.999-99 | CPF do beneficiário |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| unimed_responsavel | Sim | int | 1 a 4 dígitos | Código da Unimed responsável (carteira) |
| contrato | Sim | int | 1 a 4 dígitos | Código do contrato (carteira) |
| codigo | Sim | int | 1 a 6 dígitos | Código do beneficiário (carteira) |
| dependente | Sim | int | 1 a 2 dígitos | Código do dependente (carteira) |
| nome | Sim | string | livre | Nome completo |
| data_inicial | Sim | date | Y-m-d H:i:s | Data de início de vigência da suspensão |
| data_final | Sim | date | Y-m-d H:i:s | Data de fim de vigência da suspensão |
| motivo_suspensao | Sim | string | livre | Motivo de suspensão |