Contratos
Alterar situação
Alterar situação do contrato.
POST https://webservicehom.unimedgoiania.coop.br/api/sguweb/contrato/alterar_situacao
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição | ||||
|---|---|---|---|---|---|---|---|---|
| contrato_id | Não | int | 1 a 10 digítos | Identificador do contrato | ||||
| opcao_id | Sim | int |
|
Opção da operação | ||||
| beneficiario_id | Não | int | 1 a 10 digítos | Identificador do beneficiário |
Buscar contratos
Buscar dados de um ou mais contratos de venda.
GET|HEAD https://webservicehom.unimedgoiania.coop.br/api/sguweb/contrato/search
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| contrato_id | Não | int | 1 a 10 dígitos | Identificador do contrato |
Retorno (Array):
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| cv_nro | Sim | int | 1 a 10 dígitos | Contrato de venda |
| plano_nro_reg_ans | Sim | string | alfanumérico | min:1 | max:15 | Nº Registro ANS |
| cv_qtd_vida | Sim | int | 1 a 10 dígitos | Quantidade de vidas |
| cv_dat_inic_vigen | Sim | date | Y-m-d H:i:s | Data de início de vigência |
| cv_dat_prox_renov_cart | Sim | date | Y-m-d H:i:s | Data da próxima renovação do cartão |
Incluir contrato
Criar um contrato de venda, permitindo adicionar beneficiários e realizar movimentações.
POST https://webservicehom.unimedgoiania.coop.br/api/sguweb/contrato
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| registro_ans | Sim | string | alfanumérico | min:1 | max: 15 | Registro ANS |
| unimed_id | Sim | int | 1 a 4 dígitos | Identificador da Unimed |
| empresa_id | Não | int | 1 a 10 dígitos | Identificador da empresa |
| produto_tabela_id | Sim | int | 1 a 10 dígitos | Identificador da tabela de preço do produto |
| desconto | Não | int | 1 a 10 dígitos | Percentual de desconto adicional sobre a mensalidade |
| numero_proposta | Não | int | 1 a 10 digítos | Número da proposta |
| tabela_preco_vigencia | Não | date | d/m/Y | Data de início de vigência da tabela de preço de mensalidade |
| origem | Sim | string | Até 2 caracteres | Indica a origem do contrato |
| coparticipacao_opcao_id | Não | int | 1 a 10 dígitos | Opção da coparticipação |
Retorno :
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| contrato_id | Sim | int | 1 a 10 dígitos | Contrato de venda |
Responsável financeiro
Cadasto do responsável financeiro.
POST https://webservicehom.unimedgoiania.coop.br/api/sguweb/contrato/responsavel_financeiro
Parâmetros:
| Nome | Obrigatório | Tipo | Formato | Descrição |
|---|---|---|---|---|
| contrato_id | Sim | int | 1 a 10 digítos | Código identificador do contrato |
| cpf | Sim | string | 999.999.999-99 | CPF do responsável financeiro |
| nome | Sim | string | Até 120 caracteres | Nome do responsável financeiro |
| nome_mae | Sim | string | Até 70 caracteres | Nome da mãe |
| data_nascimento | Sim | date | d/m/Y | Data de nascimento |
| sexo | Sim | string | 1 caractere (M ou F) | Sexo |
| grau_parentesco | Sim | string | Até 3 caracteres | Grau de parentesco |
| estado_civil | Sim | string | Até 2 caracteres | Estado civil |
| telefone_principal | Sim | int | 10 a 11 digítos | Telefone principal |
| telefone_secundario | Não | int | 10 a 11 digítos | Telefone secundário |
| Sim | string | Até 70 caracteres | ||
| cep | Sim | int | 1 a 10 digítos | CEP |
| logradouro | Sim | string | Até 100 caracteres | Logradouro |
| logradouro_numero | Sim | string | Até 5 caracteres | Número |
| complemento | Não | string | Até 30 caracteres | Complemento |
| bairro | Sim | string | Até 40 caracteres | Bairro |
| ponto_referencia | Não | string | Até 40 caracteres | Ponto de referência |
| caixa_postal | Não | string | Até 30 caracteres | Caixa postal |
| inicio_vigencia | Sim | date | d/m/Y | Início da vigência do contrato |
| fatura_email | Sim | string | Até 2 caracteres | Indicador se a fatura é enviada por email |