POST api/Contratos?codClienteSSN={codClienteSSN}&idCliente={idCliente}
Monta e grava um novo contrato: cabeçalho global (tabContratosCabecalho) com placeholders substituídos + cláusulas do modelo selecionado (tabContratosClausulas, em ordem), e gera um código de acesso único (mesmo algoritmo do desktop: 20 caracteres alfanuméricos aleatórios).
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| codClienteSSN |
Código do cliente SSN. |
string |
Required |
| idCliente |
ID do cliente. |
integer |
Required |
Body Parameters
Dados do contrato.
CriarContratoRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| IDModelo |
ID do modelo (tabContratosModelo) cujas cláusulas serão usadas. |
integer |
None. |
| Titulo |
Título do contrato. |
string |
None. |
| NomeContratado |
Nome da contratada (a clínica) — placeholder {contratada}. |
string |
None. |
| Contratante |
Nome do contratante (o cliente/paciente) — placeholder {contratante}. |
string |
None. |
| DataNasc |
Data de nascimento (texto livre, já formatado) — placeholder {dataNasc}. |
string |
None. |
| NomeResponsavel |
Nome do responsável financeiro — placeholder {responsavel}. |
string |
None. |
| CpfResponsavel |
CPF do responsável — placeholder {cpf}, também gravado em CPFCliente. |
string |
None. |
| Endereco |
Endereço — placeholder {endereco}. |
string |
None. |
| InicioContrato |
Início do contrato (dd/MM/yyyy) — placeholder {inicio} e coluna InicioContrato. |
string |
None. |
| FimContrato |
Fim do contrato (dd/MM/yyyy) — placeholder {fim} e coluna FimContrato. |
string |
None. |
| PossuiAtendimentoVinculado |
Se o contrato está vinculado a um tipo de atendimento (bloco opcional de valor). |
boolean |
None. |
| IDEvento |
Tipo de atendimento vinculado (tabTiposDeEventosComCliente). |
integer |
None. |
| TipoDeValor |
1 = valor do atendimento, 2 = valor total, 3 = valor mensal. |
integer |
None. |
| ValorContrato |
Valor do contrato (usado no placeholder {Valor}, por extenso). |
decimal number |
None. |
Request Formats
application/json, text/json
{
"IDModelo": 1,
"Titulo": "sample string 2",
"NomeContratado": "sample string 3",
"Contratante": "sample string 4",
"DataNasc": "sample string 5",
"NomeResponsavel": "sample string 6",
"CpfResponsavel": "sample string 7",
"Endereco": "sample string 8",
"InicioContrato": "sample string 9",
"FimContrato": "sample string 10",
"PossuiAtendimentoVinculado": true,
"IDEvento": 1,
"TipoDeValor": 1,
"ValorContrato": 1.0
}
application/xml, text/xml
<CriarContratoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/webService2.Models"> <Contratante>sample string 4</Contratante> <CpfResponsavel>sample string 7</CpfResponsavel> <DataNasc>sample string 5</DataNasc> <Endereco>sample string 8</Endereco> <FimContrato>sample string 10</FimContrato> <IDEvento>1</IDEvento> <IDModelo>1</IDModelo> <InicioContrato>sample string 9</InicioContrato> <NomeContratado>sample string 3</NomeContratado> <NomeResponsavel>sample string 6</NomeResponsavel> <PossuiAtendimentoVinculado>true</PossuiAtendimentoVinculado> <TipoDeValor>1</TipoDeValor> <Titulo>sample string 2</Titulo> <ValorContrato>1</ValorContrato> </CriarContratoRequest>
application/x-www-form-urlencoded
Response Information
Resource Description
ContratoDetalhe| Name | Description | Type | Additional information |
|---|---|---|---|
| IDContrato | integer |
None. |
|
| IDClienteFK | integer |
None. |
|
| Titulo | string |
None. |
|
| InicioContrato | string |
None. |
|
| FimContrato | string |
None. |
|
| IDModeloFK | integer |
None. |
|
| Texto | string |
None. |
|
| FoiAceito | boolean |
None. |
|
| Hash | string |
None. |
|
| DataHoraAceito | string |
None. |
|
| CodigoDeAcesso | string |
None. |
|
| FoiEnviado | boolean |
None. |
|
| CPFCliente | string |
None. |
|
| PossuiAtendimentoVinculado | boolean |
None. |
|
| IDEvento | integer |
None. |
|
| DescricaoEvento | string |
None. |
|
| TipoDeValor | integer |
None. |
|
| ValorContrato | decimal number |
None. |
Response Formats
application/json, text/json
{
"IDContrato": 1,
"IDClienteFK": 2,
"Titulo": "sample string 3",
"InicioContrato": "sample string 4",
"FimContrato": "sample string 5",
"IDModeloFK": 1,
"Texto": "sample string 6",
"FoiAceito": true,
"Hash": "sample string 8",
"DataHoraAceito": "sample string 9",
"CodigoDeAcesso": "sample string 10",
"FoiEnviado": true,
"CPFCliente": "sample string 12",
"PossuiAtendimentoVinculado": true,
"IDEvento": 1,
"DescricaoEvento": "sample string 14",
"TipoDeValor": 1,
"ValorContrato": 1.0
}
application/xml, text/xml
<ContratoDetalhe xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/webService2.Models"> <CPFCliente>sample string 12</CPFCliente> <CodigoDeAcesso>sample string 10</CodigoDeAcesso> <DataHoraAceito>sample string 9</DataHoraAceito> <DescricaoEvento>sample string 14</DescricaoEvento> <FimContrato>sample string 5</FimContrato> <FoiAceito>true</FoiAceito> <FoiEnviado>true</FoiEnviado> <Hash>sample string 8</Hash> <IDClienteFK>2</IDClienteFK> <IDContrato>1</IDContrato> <IDEvento>1</IDEvento> <IDModeloFK>1</IDModeloFK> <InicioContrato>sample string 4</InicioContrato> <PossuiAtendimentoVinculado>true</PossuiAtendimentoVinculado> <Texto>sample string 6</Texto> <TipoDeValor>1</TipoDeValor> <Titulo>sample string 3</Titulo> <ValorContrato>1</ValorContrato> </ContratoDetalhe>