Autorização
Para realizar requisições GET e POST nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de token.
Para ter acesso ao token, é necessário que o usuário master da licença efetue a liberação deste pela interface do Feegow Clinic.
Para utilizar o token basta adicioná-lo ao header nas requisições com a chave x-access-token.
Header
| Parâmetro | Token |
|---|---|
| x-access-token | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyTA... |
Em caso de dúvidas entre em contato com nosso suporte.
Agendamentos
Tipos de status
Exemplo Request
GET https://api.feegow.com/v1/api/appoints/status
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"status": "Marcado - não confirmado"
},
{
"id": 2,
"status": "Em atendimento"
},
{
"id": 3,
"status": "Atendido"
},
{
"id": 4,
"status": "Aguardando | Atendimento"
},
{
"id": 5,
"status": "Chamando | atendimento"
},
{
"id": 6,
"status": "Não compareceu"
},
{
"id": 7,
"status": "Marcado - confirmado"
},
{
"id": 11,
"status": "Desmarcado pelo paciente"
},
{
"id": 15,
"status": "Remarcado"
},
{
"id": 16,
"status": "Desmarcado pelo profissional"
},
{
"id": 101,
"status": "Aguardando | Triagem"
},
{
"id": 103,
"status": "Em atendimento | Triagem"
},
{
"id": 105,
"status": "Chamando | Triagem"
}
]
}
GET /appoints/status
Lista todos os tipos de status para o agendamento.
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Atualizar status
Exemplo Request
POST https://api.feegow.com/v1/api/appoints/statusUpdate
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"AgendamentoID": 100,
"StatusID": "7",
"Obs": "Paciente confirmou o comparecimento."
}
Exemplo Resposta
{
"success": true,
"content": {
"msg": "Agendamento alterado com sucesso"
}
}
Atualiza o status e insere uma nota na agenda.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| AgendamentoID | numeric | Identificação do agendamento |
| StatusID | numeric | Identificação do status |
| Obs | string | Observação da alteração do status |
| HoraChegada | string (hh:mm) |
Hora de Chegada informada na sala de espera (somente para status aguardando) |
Lista motivos
Exemplo Request
GET https://api.feegow.com/v1/api/appoints/motives
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"motivo": "Solicitado pelo paciente"
},
{
"id": 2,
"motivo": "Solicitado pelo profissional"
}
]
}
GET /appoints/motives
Lista todos os motivos para reagendamento ou cancelamento.
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar canais
Exemplo Request
GET https://api.feegow.com/v1/api/appoints/list-channel
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"canal": "Agendamento Online"
},
{
"id": 2,
"canal": "Clínica"
}
]
}
GET /appoints/list-channel
Lista todos canais de agendamento disponíveis.
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar agendamentos
Exemplo Request
GET https://api.feegow.com/v1/api/appoints/search
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"profissional_id": 1,
"paciente_id": 100003,
"data_start": "05-08-2018",
"data_end": "08-08-2018"
}
Exemplo Resposta
{
"success": true,
"content": [
{
"agendamento_id": 30,
"data": "07-08-2018",
"horario": "09:00:00",
"paciente_id": 100003,
"procedimento_id": 3,
"status_id": 1,
"local_id": 0,
"profissional_id": 1,
"unidade_id": 1,
"nome_fantasia": "Filial 1",
"procedimentos": [
{
"procedimentoID": 3,
"plano": 0
},
{
"procedimentoID": 20,
"plano": 0
}
]
},
{
"agendamento_id": 35,
"data": "06-08-2018",
"horario": "08:00:00",
"paciente_id": 100003,
"procedimento_id": 3,
"status_id": 1,
"local_id": 0,
"profissional_id": 1,
"unidade_id": 1,
"nome_fantasia": "Filial 2",
"procedimentos": [
{
"procedimentoID": 3,
"plano": 0
}
]
}
]
}
GET /appoints/search
Lista agendamentos por filtros.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| agendamento_id | numeric | ID do agendamento |
| data_start (opcional com agendamento_id) |
date | Data inicio do filtro. DD-MM-YYYY |
| data_end (opcional com agendamento_id) |
date | Data final do filtro. DD-MM-YYYY |
| profissional_id (opcional) |
numeric | Identificação do profissional |
| paciente_id (opcional) |
numeric | Identificação do paciente |
| unidade_id (opcional) |
numeric | Identificação da unidade |
| local_id (opcional) |
numeric | Identificação do Local |
| especialidade_id (opcional) |
numeric | Identificação da especialidade |
| canal_id (opcional) |
numeric | Identificação do canal |
| procedimento_id (opcional) |
numeric | Identificação do procedimento |
| list_procedures (opcional) |
numeric | 1 = Listar procedimentos 0 = Não listar procedimentos (Ao utilizar este parâmetro a lista de agendamento automaticamente faz paginação do resultado. Utilizar os parâmetros "start" e "offset" para paginar. Por padrão a API inicia com os valores de paginação: start=0, offset=50) |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Disponibilidade de horários
Exemplo Request
GET https://api.feegow.com/v1/api/appoints/available-schedule
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"tipo": "P",
"procedimento_id": 5,
"unidade_id": 0,
"data_start": "08-08-2018",
"data_end": "10-08-2018",
"convenio_id": 1
}
Exemplo Resposta
{
"success": true,
"content": {
"profissional_id": {
"1": {
"local_id": [
{
"2018-08-10": [
"08:00:00",
"08:30:00",
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00",
"11:30:00",
"12:00:00"
],
"2018-08-17": [
"08:00:00",
"08:30:00",
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00",
"11:30:00",
"12:00:00"
],
"2018-08-24": [
"08:00:00",
"08:30:00",
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00",
"11:30:00",
"12:00:00"
],
"2018-08-11": [
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00",
"11:30:00"
],
"2018-08-18": [
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00",
"11:30:00"
],
"2018-08-25": [
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00",
"11:30:00"
]
}
]
},
"39": {
"local_id": {
"0": {
"2018-08-17": [
"21:00:00",
"21:30:00",
"22:00:00"
],
"2018-08-10": [
"15:00:00",
"15:30:00",
"16:00:00",
"16:30:00",
"17:00:00",
"17:30:00",
"18:00:00"
],
"2018-08-24": [
"15:00:00",
"15:30:00",
"16:00:00",
"16:30:00",
"17:00:00",
"17:30:00",
"18:00:00"
]
},
"15": {
"2018-08-11": [
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00"
],
"2018-08-18": [
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00"
],
"2018-08-25": [
"09:00:00",
"09:30:00",
"10:00:00",
"10:30:00",
"11:00:00"
]
}
}
}
}
}
}
GET /appoints/available-schedule
Lista todos os horários disponíveis para uma especialidade ou procedimento.
Pode ser filtrado por unidade e profissional, possui um período de data para pesquisa.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| tipo | numeric | E = Especialidade P = Procedimento |
| especialidade_id caso tipo = E |
numeric | Identificação da especialidade |
| procedimento_id caso tipo = P |
numeric | Identificação do procedimento |
| data_start | date | Listar a partir dessa data dd-mm-YYYY |
| data_end | date | Limitar consulta até essa data dd-mm-YYYY |
| unidade_id | numeric | Identificação da unidade |
| profissional_id (opcional) |
numeric | Identificação do profissional |
| convenio_id (opcional) |
numeric | Identificação do convênio |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Criar novo agendamento
Exemplo Request
POST https://api.feegow.com/v1/api/appoints/new-appoint
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"local_id": 0,
"paciente_id": 5,
"profissional_id": 10,
"especialidade_id": 95,
"procedimento_id": 5,
"data": "08-08-2018",
"horario": "15:00:00",
"valor": 550,
"plano": 1,
"convenio_id": 13,
"convenio_plano_id": 3,
"canal_id": 5,
"tabela_id": 8,
"notas": "texto",
"celular": "(12) 34567-8912)",
"telefone": "(12) 3456-891)",
"email": "email@email.com",
"sys_user": 123456
}
Exemplo Resposta
{
"success": true,
"content": {
"agendamento_id": 43
}
}
POST /appoints/new-appoint
Cria um novo agendamento.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| local_id | numeric | Identificação do local |
| paciente_id | numeric | Identificação do paciente |
| profissional_id | numeric | Identificação do profissional |
| especialidade_id | numeric | Identificação da especialidade |
| procedimento_id | numeric | Identificação do procedimento |
| data | date | Data do agendamento dd-mm-YYYY |
| hora | hour | Horário do agendamento HH:MM:SS - Formato 24hrs |
| valor | numeric | Valor do agendamento centavos |
| plano | numeric | 0 = Sem convênio 1 = Com convênio |
| convenio_id (caso plano = 1) |
numeric | Identificação do convênio |
| convenio_plano_id (caso plano = 1) |
numeric | Se Plano = 1, convenio_plano_id é a identificação do plano utilizado pelo convênio |
| canal_id (opcional) |
numeric | Identificação do profissional |
| tabela_id | numeric | Identificação da tabela do agendamento (opcional) |
| notas (opcional) |
string | Obeservação do agendamento |
| celular | string | Numero do celular do paciente (opcional) |
| telefone | string | Numero de telefone do paciente (opcional) |
| string | Endereço de email do paciente (opcional) |
|
| sys_user | numeric | sys_user do profissional (opcional) |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
| 409 | erro | Paciente não encontrado Horário ocupado |
Cancelar agendamento
Exemplo Request
POST https://api.feegow.com/v1/api/appoints/cancel-appoint
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"agendamento_id": 41,
"motivo_id": 1,
"obs" : "Paciente tinha uma reunião marcada."
}
Exemplo Resposta
{
"success": true,
"content": "Agendamento cancelado"
}
POST /appoints/cancel-appoint
Cancela um agendamento existente.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| agendamento_id | numeric | Identificação do paciente |
| motivo_id |
numeric | ID Motivo do cancelamento |
| obs (opcional) |
string | Observação do cancelamento |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
| 409 | erro | Agendamento não existe |
Remarcar agendamento
Exemplo Request
POST https://api.feegow.com/v1/api/appoints/reschedule
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"agendamento_id": 42,
"motivo_id": 1,
"data": "15-08-2018",
"horario": "19:00:00",
"obs": "Paciente tinha uma reunião marcada"
}
Exemplo Resposta
{
"success": true,
"content": "Agendamento cancelado"
}
POST /appoints/reschedule
Remarca um agendamento existente.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| agendamento_id | numeric | Identificação do paciente |
| motivo_id | numeric | ID Motivo reagendamento |
| obs (opcional) |
string | Observação do reagendamento |
| horario | hour | Novo horario do agendamento HH:MM:SS 24hrs |
| data | date | Nova data do agendamento DD-MM-YYYY |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
| 409 | erro | Agendamento não existe |
Gerar senha de atendimento
Exemplo Request
GET https://api.feegow.com/v1/api/appoints/queue-position
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"unidade_id": 0,
"tipo_senha": 1
}
Exemplo Resposta
{
"sucess": true,
"content": {
"posicao": 1,
"tipoSenha": 1,
"tipoFormatado": "P"
}
}
GET /appoints/queue-position
Gerar uma senha de atendimento.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| unidade_id | numeric | Identificação da unidade |
| tipo_senha (Tipos: 0 = G, 1 = P, 2 = C, 3 = E, 4 = R) |
numeric | Tipo de senha |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Bloqueios
Listar bloqueios
Exemplo Request
GET https://api.feegow.com/v1/api/lock/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"date_start": "2023-05-10",
"date_end": "2023-05-29",
"profissional_id": 0,
"unidade_Id": 3,
"bloqueio_id": 13843
}
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 13843,
"date_start": "2023-05-10",
"date_end": "2023-05-29",
"time_start": "17:50:00",
"time_end": "23:59:00",
"holiday_id": 0,
"professional_id": 0,
"description": "",
"week_day": [
"1",
"2",
"3",
"4",
"5",
"6",
"7"
],
"units": [
"3"
]
}
]
}
GET /lock/list
Lista bloqueios por filtros.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| bloqueio_id | numeric | ID do bloqueio |
| date_start (opcional com bloqueio_id) |
date | Data inicio do filtro. DD-MM-YYYY |
| date_end (opcional com bloqueio_id) |
date | Data final do filtro. DD-MM-YYYY |
| profissional_id (opcional) |
numeric | Identificação do profissional |
| unidade_id (opcional) |
numeric | Identificação da unidade |
| bloqueio_id (opcional) |
numeric | Identificação do bloqueio |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Cartão de Benefício
Listagem de Contratos
Exemplo Request
GET https://cartao-beneficios.feegow.com/external/contract/datagrid?document=12492684784
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros de Consulta GET
{
"page": 1,
"perPage": 10,
"document": "12492684784",
"planId": "ID_DO_PLANO",
"name": "NOME_DO_BENEFICIÁRIO",
"personID": "ID_DA_PESSOA",
"accountOwner": "ID_DO_PROPRIETÁRIO_DA_CONTA",
"registrationNumber": "NUMERO_DE_REGISTRO",
"initialDate": "DATA_INICIAL",
"endDate": "DATA_FINAL",
"statusContractId": "ID_DO_STATUS_DO_CONTRATO",
"unity": "UNIDADE",
"user": "USUÁRIO",
"accountPayer": "CONTA_PAGADORA"
}
Exemplo Resposta
{
"data": [
{
"contractId": "50cd888e-6506-493d-991a-ca9ac88fa2f6",
"contractDate": "2022-12-26T17:43:40.000Z",
"registrationNumber": 10100131,
"contractPersonId": "c781f7cd-7df0-409a-94f4-f7cc1e14a873",
"accountOwner": 1,
"name": "Ana Laura Pezzoni Sene",
"phone": "21974515490",
"document": "12492684784",
"birthdate": "1982-09-13T00:00:00.000Z",
"planId": "ef166b40-b06f-47cc-807b-6e167612bf4e",
"plan": "Blue Marine (Importação)",
"statusContract": "Aprovado",
"statusContractId": "3",
"amountMembership": 40,
"amountRecurrence": 20,
"recurrenceValue": 20,
"membershipValue": 40,
"contract_parameters": {
"userId": 160051555,
"licenseId": 105
},
"statusRecurrenceId": "3",
"statusRecurrenceDescription": "Inadimplente",
"eligible": 1,
"finalStatusDescription": "Inadimplente"
}
],
"count": 1,
"page": 1,
"perPage": 1,
"pages": 1,
"version": "v2.0",
"foundParameters": [
"planId",
"name",
"document",
"personID",
"accountOwner",
"registrationNumber",
"initialDate",
"endDate",
"statusContractId",
"unity",
"user",
"accountPayer",
"perPage",
"page"
]
}
GET https://cartao-beneficios.feegow.com/external/contract/datagrid
Endpoint para obter detalhes do contrato de benefícios.
Parâmetros de Consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| page | number | Número da página. O padrão é 1. |
| perPage | number | Número de registros por página. O padrão é 1. |
| document | string | Número do documento do beneficiário. |
| planId | string | ID do plano associado ao contrato. |
| name | string | Nome do beneficiário. |
| personID | string | ID da pessoa associada ao contrato. |
| accountOwner | string | ID do proprietário da conta associada ao contrato. |
| registrationNumber | string | Número de registro do contrato. |
| initialDate | string | Data inicial do contrato. |
| endDate | string | Data final do contrato. |
| statusContractId | string | ID do status do contrato. |
| unity | string | Unidade associada ao contrato. |
| user | string | Usuário associado ao contrato. |
| accountPayer | string | Conta pagadora associada ao contrato. |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data | array | Lista de objetos que representam os detalhes do contrato |
| data.contractId | string | Identificador único do contrato |
| data.contractDate | string | Data de criação do contrato |
| data.registrationNumber | number | Número de registro do contrato |
| data.contractPersonId | string | Identificador único da pessoa associada ao contrato |
| data.accountOwner | number | ID do proprietário da conta associada ao contrato |
| data.name | string | Nome do beneficiário |
| data.phone | string | Número de telefone do beneficiário |
| data.document | string | Número do documento do beneficiário |
| data.birthdate | string | Data de nascimento do beneficiário |
| data.planId | string | Identificador único do plano |
| data.plan | string | Nome do plano |
| data.statusContract | string | Status do contrato |
| data.statusContractId | string | Identificador único do status do contrato |
| data.amountMembership | number | Valor da adesão do contrato |
| data.amountRecurrence | number | Valor da recorrência do contrato |
| data.recurrenceValue | number | Valor da recorrência |
| data.membershipValue | number | Valor da adesão |
| data.contract_parameters | object | Parâmetros adicionais do contrato |
| data.statusRecurrenceId | string | Identificador único do status da recorrência |
| data.statusRecurrenceDescription | string | Descrição do status da recorrência |
| data.eligible | number | Identifica se o contrato está elegivel (0 => Não,1 => Sim) |
| data.finalStatusDescription | string | Descrição final do status |
| count | number | Total de registros |
| page | number | Número da página |
| perPage | number | Número de registros por página |
| pages | number | Número de páginas |
| version | string | Versão da API |
| foundParameters | array | Lista de parâmetros encontrados na requisição |
Criação da Contrato
Exemplo Request
POST https://cartao-beneficios.feegow.com/external/contract/create
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros POST
{
"contract": {
"planId": "ID_DO_PLANO",
"parameters": {
"unity": []
},
"statusId": "1"
},
"recurrence": {
"type": "2",
"firstPayment": "2024-04-03",
"dateRecurrenceFirstPayment": "2024-04-03",
"dateMembershipPayment": "2024-04-03",
"intervalNumber": "1",
"paymentMethodId": "1",
"parameters": {
"unity": 0,
"subscribe": {
"config": 1,
"sysActive": 1
}
},
"forceEligibility": false
},
"people": [
{
"contractData": {
"membershipValue": 100,
"recurrenceValue": 100,
"accountOwner": true,
"relationshipWithTheOwner": ""
},
"personData": {
"address": {
"zipCode": "28615650",
"city": "Nova Friburgo",
"streetAddress": "Rua Jonas Salck",
"neighborhood": "Debossan",
"state": "RJ",
"houseNumber": "556"
},
"document": "56885204005",
"email": "ze@email.com",
"phone": "22 5544-77884",
"name": "zé pacheco G",
"birthdate": "2024-04-01",
"maritalStatus": 2,
"parameters": {}
},
"parameters": {}
}
]
}
Exemplo Resposta
{
"contract": {
"id": "ID_DO_CONTRATO",
"planId": "ID_DO_PLANO",
"parameters": {
"unity": [],
"createUserId": "ID do usuário",
"createAt": "2024-04-01T18:47:48.956Z",
"userId": "ID do usuário",
"licenseId": 105
},
"statusId": "1",
"active": 1,
"contractDate": "2024-04-01T18:47:48.956Z"
},
"contractPerson": [
{
"id": "ID da pessoa associada ao contrato",
"personId": "ID da pessoa",
"contractId": "ID do contrato associado",
"recurrenceValue": 100,
"membershipValue": 100,
"registrationNumber": 10114280,
"relationshipWithTheOwner": 0,
"accountOwner": true,
"active": 1,
"parameters": {
"userId": "ID do usuário",
"licenseId": 105
}
}
],
"webHook": {
"status": 1,
"response": {},
"type": "createContract",
"parameters": {
"licenseId": 105,
"userId": "ID do usuário"
},
"payload": {
"auth": {
"userId": "ID do usuário",
"licenseId": 105
},
"contract": {
"id": "ID_DO_CONTRATO",
"planId": "ID_DO_PLANO",
"parameters": {
"unity": [],
"createUserId": "ID do usuário",
"createAt": "2024-04-01T18:47:48.956Z",
"userId": "ID do usuário",
"licenseId": 105
},
"statusId": "1",
"active": 1,
"contractDate": "2024-04-01T18:47:48.956Z"
},
"plan": {
"id": "ID do plano",
"name": "CCB"
},
"person": [
{
"address": {
"zipCode": "28615650",
"city": "Nova Friburgo",
"streetAddress": "Rua Jonas Salck",
"neighborhood": "Debossan",
"state": "RJ",
"houseNumber": "556"
},
"document": "56885204005",
"email": "ze@email.com",
"phone": "22 5544-77884",
"name": "zé pacheco G",
"birthdate": "2024-04-01",
"maritalStatus": 2,
"parameters": {},
"id": "ID da pessoa",
"contractPerson": {
"id": "ID da pessoa associada ao contrato",
"personId": "ID da pessoa",
"contractId": "ID do contrato associado",
"recurrenceValue": 100,
"membershipValue": 100,
"registrationNumber": 10114280,
"relationshipWithTheOwner": 0,
"accountOwner": true,
"active": 1,
"parameters": {
"userId": "ID do usuário",
"licenseId": 105
}
}
}
],
"recurrence": {
"type": "2",
"firstPayment": "2024-04-03",
"dateRecurrenceFirstPayment": "2024-04-03",
"dateMembershipPayment": "2024-04-03",
"intervalNumber": "1",
"paymentMethodId": "1",
"parameters": {
"unity": 0,
"subscribe": {
"config": 1,
"sysActive": 1
},
"userId": "ID do usuário",
"licenseId": 105
},
"forceEligibility": false,
"id": "ID da recorrência"
}
},
"singleParameters": "Parâmetro único do webhook",
"id": "ID do webhook"
}
}
POST https://cartao-beneficios.feegow.com/external/contract/create
Endpoint para criação do contrato de benefícios.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| contract.planId | string | ID do plano contratado |
| contract.parameters.unity | array | Unidades relacionadas ao contrato (opcional) |
| contract.statusId | string | ID do status do contrato |
| recurrence.type | string | Tipo de recorrência do contrato |
| recurrence.firstPayment | string | Data do primeiro pagamento |
| recurrence.dateRecurrenceFirstPayment | string | Data da recorrência do pagamento |
| recurrence.dateMembershipPayment | string | Data de pagamento da associação |
| recurrence.intervalNumber | string | Número de intervalos de pagamento |
| recurrence.paymentMethodId | string | ID do método de pagamento |
| recurrence.forceEligibility | boolean | Força a elegibilidade |
| recurrence.parameters.unity | number | Unidade (opcional) |
| recurrence.parameters.subscribe.config | number | Configuração de inscrição (opcional) |
| recurrence.parameters.subscribe.sysActive | number | Ativo no sistema (opcional) |
| people[].contractData.membershipValue | number | Valor da associação |
| people[].contractData.recurrenceValue | number | Valor da recorrência |
| people[].contractData.accountOwner | boolean | Dono da conta associada |
| people[].contractData.relationshipWithTheOwner | string | Relação com o proprietário da conta |
| people[].personData.address.zipCode | string | CEP do endereço |
| people[].personData.address.city | string | Cidade do endereço |
| people[].personData.address.streetAddress | string | Endereço |
| people[].personData.address.neighborhood | string | Bairro do endereço |
| people[].personData.address.state | string | Estado do endereço |
| people[].personData.address.houseNumber | string | Número da casa/apto do endereço |
| people[].personData.document | string | Documento de identificação |
| people[].personData.email | string | Endereço de e-mail |
| people[].personData.phone | string | Número de telefone |
| people[].personData.name | string | Nome completo do cliente |
| people[].personData.birthdate | string | Data de nascimento do cliente |
| people[].personData.maritalStatus | number | Estado civil do cliente |
| people[].personData.parameters | object | Parâmetros adicionais (opcional) |
| people[].parameters | object | Parâmetros adicionais (opcional) |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| contract.id | string | ID do contrato |
| contract.planId | string | ID do plano contratado |
| contract.parameters.unity | array | Unidades relacionadas ao contrato |
| contract.parameters.createUserId | number | ID do usuário que criou o contrato |
| contract.parameters.createAt | string | Data de criação do contrato |
| contract.parameters.userId | number | ID do usuário associado ao contrato |
| contract.parameters.licenseId | number | ID da licença associada ao contrato |
| contract.statusId | string | ID do status do contrato |
| contract.active | number | Status de ativação do contrato |
| contract.contractDate | string | Data do contrato |
| contractPerson[].id | string | ID da pessoa associada ao contrato |
| contractPerson[].personId | string | ID da pessoa |
| contractPerson[].contractId | string | ID do contrato associado |
| contractPerson[].recurrenceValue | number | Valor da recorrência |
| contractPerson[].membershipValue | number | Valor da associação |
| contractPerson[].registrationNumber | number | Número de registro |
| contractPerson[].relationshipWithTheOwner | string | Relação com o proprietário da conta |
| contractPerson[].accountOwner | boolean | Dono da conta associada |
| contractPerson[].active | number | Status de ativação da pessoa associada |
| contractPerson[].parameters.userId | number | ID do usuário associado à pessoa |
| contractPerson[].parameters.licenseId | number | ID da licença associada à pessoa |
| webHook.status | number | Status do webhook |
| webHook.response | object | Resposta do webhook |
| webHook.type | string | Tipo do webhook |
| webHook.parameters.licenseId | number | ID da licença associada ao webhook |
| webHook.parameters.userId | number | ID do usuário associado ao webhook |
| webHook.singleParameters | string | Parâmetro único do webhook |
| webHook.id | string | ID do webhook |
| webHook.payload.auth.userId | number | ID do usuário do payload |
| webHook.payload.auth.licenseId | number | ID da licença do payload |
| webHook.payload.contract.id | string | ID do contrato do payload |
| webHook.payload.contract.planId | string | ID do plano do contrato do payload |
| webHook.payload.contract.parameters.unity | array | Unidades relacionadas ao contrato do payload |
| webHook.payload.contract.parameters.createUserId | number | ID do usuário que criou o contrato do payload |
| webHook.payload.contract.parameters.createAt | string | Data de criação do contrato do payload |
| webHook.payload.contract.parameters.userId | number | ID do usuário associado ao contrato do payload |
| webHook.payload.contract.parameters.licenseId | number | ID da licença associada ao contrato do payload |
| webHook.payload.contract.statusId | string | ID do status do contrato do payload |
| webHook.payload.contract.active | number | Status de ativação do contrato do payload |
| webHook.payload.contract.contractDate | string | Data do contrato do payload |
| webHook.payload.plan.id | string | ID do plano do payload |
| webHook.payload.plan.name | string | Nome do plano do payload |
| webHook.payload.person[].address.zipCode | string | CEP do endereço |
| webHook.payload.person[].address.city | string | Cidade do endereço |
| webHook.payload.person[].address.streetAddress | string | Endereço |
| webHook.payload.person[].address.neighborhood | string | Bairro do endereço |
| webHook.payload.person[].address.state | string | Estado do endereço |
| webHook.payload.person[].address.houseNumber | string | Número da casa/apto do endereço |
| webHook.payload.person[].document | string | Documento de identificação |
| webHook.payload.person[].email | string | Endereço de e-mail |
| webHook.payload.person[].phone | string | Número de telefone |
| webHook.payload.person[].name | string | Nome completo do cliente |
| webHook.payload.person[].birthdate | string | Data de nascimento do cliente |
| webHook.payload.person[].maritalStatus | number | Estado civil do cliente |
| webHook.payload.person[].parameters | object | Parâmetros adicionais (opcional) |
| webHook.payload.person[].id | string | ID da pessoa |
| webHook.payload.person[].contractPerson.id | string | ID da pessoa associada ao contrato |
| webHook.payload.person[].contractPerson.personId | string | ID da pessoa |
| webHook.payload.person[].contractPerson.contractId | string | ID do contrato associado |
| webHook.payload.person[].contractPerson.recurrenceValue | number | Valor da recorrência |
| webHook.payload.person[].contractPerson.membershipValue | number | Valor da associação |
| webHook.payload.person[].contractPerson.registrationNumber | number | Número de registro |
| webHook.payload.person[].contractPerson.relationshipWithTheOwner | string | Relação com o proprietário da conta |
| webHook.payload.person[].contractPerson.accountOwner | boolean | Dono da conta associada |
| webHook.payload.person[].contractPerson.active | number | Status de ativação da pessoa associada |
| webHook.payload.person[].contractPerson.parameters.userId | number | ID do usuário associado à pessoa associada |
| webHook.payload.person[].contractPerson.parameters.licenseId | number | ID da licença associada à pessoa associada |
| webHook.payload.recurrence.type | string | Tipo de recorrência do payload |
| webHook.payload.recurrence.firstPayment | string | Data do primeiro pagamento do payload |
| webHook.payload.recurrence.dateRecurrenceFirstPayment | string | Data da recorrência do pagamento do payload |
| webHook.payload.recurrence.dateMembershipPayment | string | Data de pagamento da associação do payload |
| webHook.payload.recurrence.intervalNumber | string | Número de intervalos de pagamento do payload |
| webHook.payload.recurrence.paymentMethodId | string | ID do método de pagamento do payload |
| webHook.payload.recurrence.parameters.unity | number | Unidade do payload |
| webHook.payload.recurrence.parameters.subscribe.config | number | Configuração |
| webHook.payload.recurrence.parameters.subscribe.sysActive | number | Atividade do sistema |
| webHook.payload.recurrence.parameters.userId | number | ID do usuário associado |
| webHook.payload.recurrence.parameters.licenseId | number | ID da licença associada |
| webHook.payload.recurrence.forceEligibility | boolean | Elegibilidade forçada do payload |
| webHook.payload.recurrence.id | string | ID da recorrência do payload |
Listagem de Planos
Exemplo Request
GET https://cartao-beneficios.feegow.com/external/plan/datagrid?perPage=1&page=1&id=ef166b40-b06f-47cc-807b-6e167612bf4e
Host: cartao-beneficios.feegow.com
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros Get
{
"page": 1,
"perPage": 1,
"id": "ef166b40-b06f-47cc-807b-6e167612bf4e"
}
Exemplo Resposta
{
"data": [
{
"id": "ef166b40-b06f-47cc-807b-6e167612bf4e",
"name": "Blue Marine (Importação)",
"membershipValue": 10.2,
"recurrenceValue": 10.3,
"dependencyMembershipValue": 1.25,
"dependencyRecurrenceValue": 2.25,
"creationDate": "2022-12-12T18:06:44.000Z",
"countContract": "26"
}
],
"count": 1,
"page": 1,
"perPage": 500,
"pages": 1,
"version": "v2.0",
"foundParameters": [
"id",
"perPage",
"page"
]
}
GET https://cartao-beneficios.feegow.com/external/plan/datagrid
Endpoint para obter informações de um plano.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| page | number | Número da página. O padrão é 1. |
| perPage | number | Número de registros por página. O padrão é 500. |
| id | string | ID do plano |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data | array | Lista de objetos que representam os dados do plano |
| data.id | string | ID do plano |
| data.name | string | Nome do plano |
| data.membershipValue | number | Valor da mensalidade do plano |
| data.recurrenceValue | number | Valor da recorrência do plano |
| data.dependencyMembershipValue | number | Valor da mensalidade da dependência do plano |
| data.dependencyRecurrenceValue | number | Valor da recorrência da dependência do plano |
| data.creationDate | string | Data de criação do plano (formato ISO 8601) |
| data.countContract | string | Contagem de contratos associados ao plano |
| count | number | Total de registros |
| page | number | Número da página |
| perPage | number | Número de registros por página |
| pages | number | Número de páginas |
| version | string | Versão da API |
| foundParameters | array | Lista de parâmetros encontrados na requisição |
Alteração da Contrato
Exemplo Request
POST https://cartao-beneficios.feegow.com/external/contract/update
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros POST
{
"contract": {
"planId": "ID_DO_PLANO",
"parameters": {
"unity": [
0
],
"userId": "ID do usuário",
"createAt": "2024-04-01T18:47:48.956Z",
"licenseId": 105,
"createUserId": "ID do usuário"
},
"id": "ID_DO_CONTRATO",
"statusId": "1"
},
"recurrence": {
"type": "2",
"firstPayment": "2024-04-03",
"dateRecurrenceFirstPayment": "2024-04-03",
"dateMembershipPayment": "2024-04-03",
"lastPayment": "2099-12-31",
"id": "ID da recorrência",
"intervalNumber": "1",
"paymentMethodId": "1",
"parameters": {
"unity": 0,
"userId": "ID do usuário",
"licenseId": 105,
"subscribe": {
"config": 1,
"sysActive": 1
},
"UpdateUserId": "ID do usuário"
},
"forceEligibility": false
},
"people": [
{
"contractData": {
"id": "ID do contrato da pessoa",
"membershipValue": 100,
"recurrenceValue": 100,
"accountOwner": true,
"relationshipWithTheOwner": 0
},
"personData": {
"address": {
"city": "Nova Friburgo",
"state": "RJ",
"zipCode": "28615650",
"houseNumber": "556",
"neighborhood": "Debossan",
"streetAddress": "Rua Jonas Salck"
},
"document": "56885204005",
"email": "ze@email.com",
"phone": "22 5544-77884",
"name": "zé pacheco G",
"birthdate": "2024-04-01",
"maritalStatus": 2,
"parameters": {}
},
"parameters": {}
}
]
}
Exemplo Resposta
{
"contract": {
"id": "ID_DO_CONTRATO",
"planId": "ID_DO_PLANO",
"parameters": {
"unity": [],
"createUserId": "ID do usuário",
"createAt": "2024-04-01T18:47:48.956Z",
"userId": "ID do usuário",
"licenseId": 105
},
"statusId": "1",
},
"contractPerson": [
{
"id": "ID da pessoa associada ao contrato",
"personId": "ID da pessoa",
"contractId": "ID do contrato associado",
"recurrenceValue": 100,
"membershipValue": 100,
"registrationNumber": 10114280,
"relationshipWithTheOwner": 0,
"accountOwner": true,
"active": 1,
"parameters": {
"userId": "ID do usuário",
"licenseId": 105
}
}
],
"webHook": {
"status": 1,
"response": {},
"type": "createContract",
"parameters": {
"licenseId": 105,
"userId": "ID do usuário"
},
"payload": {
"auth": {
"userId": "ID do usuário",
"licenseId": 105
},
"contract": {
"id": "ID_DO_CONTRATO",
"planId": "ID_DO_PLANO",
"parameters": {
"unity": [],
"createUserId": "ID do usuário",
"createAt": "2024-04-01T18:47:48.956Z",
"userId": "ID do usuário",
"licenseId": 105
},
"statusId": "1",
},
"plan": {
"id": "ID do plano",
"name": "CCB"
},
"person": [
{
"address": {
"zipCode": "28615650",
"city": "Nova Friburgo",
"streetAddress": "Rua Jonas Salck",
"neighborhood": "Debossan",
"state": "RJ",
"houseNumber": "556"
},
"document": "56885204005",
"email": "ze@email.com",
"phone": "22 5544-77884",
"name": "zé pacheco G",
"birthdate": "2024-04-01",
"maritalStatus": 2,
"parameters": {},
"id": "ID da pessoa",
"contractPerson": {
"id": "ID da pessoa associada ao contrato",
"personId": "ID da pessoa",
"contractId": "ID do contrato associado",
"recurrenceValue": 100,
"membershipValue": 100,
"registrationNumber": 10114280,
"relationshipWithTheOwner": 0,
"accountOwner": true,
"active": 1,
"parameters": {
"userId": "ID do usuário",
"licenseId": 105
}
}
}
],
"recurrence": {
"type": "2",
"firstPayment": "2024-04-03",
"dateRecurrenceFirstPayment": "2024-04-03",
"dateMembershipPayment": "2024-04-03",
"lastPayment": "2099-12-31",
"id": "ID da recorrência",
"intervalNumber": "1",
"paymentMethodId": "1",
"parameters": {
"unity": 0,
"userId": "ID do usuário",
"licenseId": 105,
"subscribe": {
"config": 1,
"sysActive": 1
},
"UpdateUserId": "ID do usuário"
},
"forceEligibility": false
}
},
"singleParameters": "Parâmetro único do webhook",
"id": "ID do webhook"
}
}
POST https://cartao-beneficios.feegow.com/external/contract/update
Endpoint para alteração do contrato de benefícios.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| contract.id | string | ID do contrato |
| contract.planId | string | ID do plano contratado |
| contract.parameters.unity | array | Unidades relacionadas ao contrato |
| contract.parameters.userId | number | ID do usuário relacionado ao contrato |
| contract.parameters.createAt | string | Data de criação do contrato |
| contract.parameters.licenseId | number | ID da licença associada ao contrato |
| contract.parameters.createUserId | number | ID do usuário que criou o contrato |
| recurrence.type | string | Tipo de recorrência |
| recurrence.firstPayment | string | Data do primeiro pagamento |
| recurrence.dateRecurrenceFirstPayment | string | Data de recorrência do primeiro pagamento |
| recurrence.dateMembershipPayment | string | Data de pagamento da adesão |
| recurrence.lastPayment | string | Último pagamento |
| recurrence.id | string | ID da recorrência |
| recurrence.intervalNumber | string | Número do intervalo |
| recurrence.paymentMethodId | string | ID do método de pagamento |
| recurrence.parameters.unity | number | Unidade |
| recurrence.parameters.userId | number | ID do usuário |
| recurrence.parameters.licenseId | number | ID da licença |
| recurrence.parameters.subscribe.config | number | Configuração |
| recurrence.parameters.subscribe.sysActive | number | Ativo no sistema |
| recurrence.parameters.UpdateUserId | number | ID do usuário de atualização |
| recurrence.forceEligibility | boolean | Elegibilidade forçada |
| people[].contractData.id | string | ID do contrato da pessoa |
| people[].contractData.membershipValue | number | Valor da adesão |
| people[].contractData.recurrenceValue | number | Valor da recorrência |
| people[].contractData.accountOwner | boolean | Dono da conta |
| people[].contractData.relationshipWithTheOwner | number | Relação com o dono da conta |
| people[].personData.address.city | string | Cidade |
| people[].personData.address.state | string | Estado |
| people[].personData.address.zipCode | string | CEP |
| people[].personData.address.houseNumber | string | Número da casa |
| people[].personData.address.neighborhood | string | Bairro |
| people[].personData.address.streetAddress | string | Endereço |
| people[].personData.document | string | Documento |
| people[].personData.email | string | |
| people[].personData.phone | string | Telefone |
| people[].personData.name | string | Nome |
| people[].personData.birthdate | string | Data de nascimento |
| people[].personData.maritalStatus | number | Estado civil |
| people[].personData.parameters | object | Parâmetros adicionais da pessoa |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| contract.id | string | ID do contrato |
| contract.planId | string | ID do plano contratado |
| contract.parameters.unity | array | Unidades relacionadas ao contrato |
| contract.parameters.createUserId | number | ID do usuário que criou o contrato |
| contract.parameters.createAt | string | Data de criação do contrato |
| contract.parameters.userId | number | ID do usuário associado ao contrato |
| contract.parameters.licenseId | number | ID da licença associada ao contrato |
| contract.statusId | string | ID do status do contrato |
| contract.active | number | Status de ativação do contrato |
| contract.contractDate | string | Data do contrato |
| contractPerson[].id | string | ID da pessoa associada ao contrato |
| contractPerson[].personId | string | ID da pessoa |
| contractPerson[].contractId | string | ID do contrato associado |
| contractPerson[].recurrenceValue | number | Valor da recorrência |
| contractPerson[].membershipValue | number | Valor da associação |
| contractPerson[].registrationNumber | number | Número de registro |
| contractPerson[].relationshipWithTheOwner | string | Relação com o proprietário da conta |
| contractPerson[].accountOwner | boolean | Dono da conta associada |
| contractPerson[].active | number | Status de ativação da pessoa associada |
| contractPerson[].parameters.userId | number | ID do usuário associado à pessoa |
| contractPerson[].parameters.licenseId | number | ID da licença associada à pessoa |
| webHook.status | number | Status do webhook |
| webHook.response | object | Resposta do webhook |
| webHook.type | string | Tipo do webhook |
| webHook.parameters.licenseId | number | ID da licença associada ao webhook |
| webHook.parameters.userId | number | ID do usuário associado ao webhook |
| webHook.singleParameters | string | Parâmetro único do webhook |
| webHook.id | string | ID do webhook |
| webHook.payload.auth.userId | number | ID do usuário do payload |
| webHook.payload.auth.licenseId | number | ID da licença do payload |
| webHook.payload.contract.id | string | ID do contrato do payload |
| webHook.payload.contract.planId | string | ID do plano do contrato do payload |
| webHook.payload.contract.parameters.unity | array | Unidades relacionadas ao contrato do payload |
| webHook.payload.contract.parameters.createUserId | number | ID do usuário que criou o contrato do payload |
| webHook.payload.contract.parameters.createAt | string | Data de criação do contrato do payload |
| webHook.payload.contract.parameters.userId | number | ID do usuário associado ao contrato do payload |
| webHook.payload.contract.parameters.licenseId | number | ID da licença associada ao contrato do payload |
| webHook.payload.contract.statusId | string | ID do status do contrato do payload |
| webHook.payload.contract.active | number | Status de ativação do contrato do payload |
| webHook.payload.contract.contractDate | string | Data do contrato do payload |
| webHook.payload.plan.id | string | ID do plano do payload |
| webHook.payload.plan.name | string | Nome do plano do payload |
| webHook.payload.person[].address.zipCode | string | CEP do endereço |
| webHook.payload.person[].address.city | string | Cidade do endereço |
| webHook.payload.person[].address.streetAddress | string | Endereço |
| webHook.payload.person[].address.neighborhood | string | Bairro do endereço |
| webHook.payload.person[].address.state | string | Estado do endereço |
| webHook.payload.person[].address.houseNumber | string | Número da casa/apto do endereço |
| webHook.payload.person[].document | string | Documento de identificação |
| webHook.payload.person[].email | string | Endereço de e-mail |
| webHook.payload.person[].phone | string | Número de telefone |
| webHook.payload.person[].name | string | Nome completo do cliente |
| webHook.payload.person[].birthdate | string | Data de nascimento do cliente |
| webHook.payload.person[].maritalStatus | number | Estado civil do cliente |
| webHook.payload.person[].parameters | object | Parâmetros adicionais (opcional) |
| webHook.payload.person[].id | string | ID da pessoa |
| webHook.payload.person[].contractPerson.id | string | ID da pessoa associada ao contrato |
| webHook.payload.person[].contractPerson.personId | string | ID da pessoa |
| webHook.payload.person[].contractPerson.contractId | string | ID do contrato associado |
| webHook.payload.person[].contractPerson.recurrenceValue | number | Valor da recorrência |
| webHook.payload.person[].contractPerson.membershipValue | number | Valor da associação |
| webHook.payload.person[].contractPerson.registrationNumber | number | Número de registro |
| webHook.payload.person[].contractPerson.relationshipWithTheOwner | string | Relação com o proprietário da conta |
| webHook.payload.person[].contractPerson.accountOwner | boolean | Dono da conta associada |
| webHook.payload.person[].contractPerson.active | number | Status de ativação da pessoa associada |
| webHook.payload.person[].contractPerson.parameters.userId | number | ID do usuário associado à pessoa associada |
| webHook.payload.person[].contractPerson.parameters.licenseId | number | ID da licença associada à pessoa associada |
| webHook.payload.recurrence.type | string | Tipo de recorrência do payload |
| webHook.payload.recurrence.firstPayment | string | Data do primeiro pagamento do payload |
| webHook.payload.recurrence.dateRecurrenceFirstPayment | string | Data da recorrência do pagamento do payload |
| webHook.payload.recurrence.dateMembershipPayment | string | Data de pagamento da associação do payload |
| webHook.payload.recurrence.intervalNumber | string | Número de intervalos de pagamento do payload |
| webHook.payload.recurrence.paymentMethodId | string | ID do método de pagamento do payload |
| webHook.payload.recurrence.parameters.unity | number | Unidade do payload |
| webHook.payload.recurrence.parameters.subscribe.config | number | Configuração |
| webHook.payload.recurrence.parameters.subscribe.sysActive | number | Atividade do sistema |
| webHook.payload.recurrence.parameters.userId | number | ID do usuário associado |
| webHook.payload.recurrence.parameters.licenseId | number | ID da licença associada |
| webHook.payload.recurrence.parameters.UpdateUserId | number | ID do usuário de atualização |
| webHook.payload.recurrence.forceEligibility | boolean | Elegibilidade forçada do payload |
| webHook.payload.recurrence.id | string | ID da recorrência do payload |
Alteração de Plano
Exemplo Request
POST https://cartao-beneficios.feegow.com/external/plan/update
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros de Consulta POST
{
"id": "ID do plano",
"name": "Teste plano docs",
"membershipValue": 0,
"recurrenceValue": 0,
"dependencyMembershipValue": 0,
"dependencyRecurrenceValue": 0,
"parameters": {
"template": null
}
}
Exemplo Resposta
{
"id": "ID do plano",
"name": "Teste plano docs",
"membershipValue": 0,
"recurrenceValue": 0,
"dependencyMembershipValue": 0,
"dependencyRecurrenceValue": 0,
"parameters": {
"template": null,
"userId": "ID do usuário",
"userIdUpdate": "ID do usuário"
},
"accountId": "ID da conta",
"active": 1
}
POST https://cartao-beneficios.feegow.com/external/plan/update
Endpoint para alteração de plano.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | string | ID do plano |
| name | string | Nome do plano |
| membershipValue | number | Valor da associação |
| recurrenceValue | number | Valor da recorrência |
| dependencyMembershipValue | number | Valor da associação dependente |
| dependencyRecurrenceValue | number | Valor da recorrência dependente |
| parameters | object | Parâmetros adicionais do plano |
| parameters.template | object | Modelo de plano |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | string | ID do plano criado |
| name | string | Nome do plano |
| membershipValue | number | Valor da associação |
| recurrenceValue | number | Valor da recorrência |
| dependencyMembershipValue | number | Valor da associação dependente |
| dependencyRecurrenceValue | number | Valor da recorrência dependente |
| parameters | object | Parâmetros adicionais do plano |
| parameters.template | object | Modelo de plano |
| parameters.userId | number | ID do usuário associado ao plano |
| parameters.userIdUpdate | number | ID do usuário |
| accountId | string | ID da conta associada ao plano |
| active | number | Indicador de ativação do plano |
Criação de Plano
Exemplo Request
POST https://cartao-beneficios.feegow.com/external/plan/create
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros de Consulta POST
{
"name": "Teste plano docs",
"membershipValue": 0,
"recurrenceValue": 0,
"dependencyMembershipValue": 0,
"dependencyRecurrenceValue": 0,
"parameters": {
"template": null
}
}
Exemplo Resposta
{
"id": "ID do plano",
"name": "Teste plano docs",
"membershipValue": 0,
"recurrenceValue": 0,
"dependencyMembershipValue": 0,
"dependencyRecurrenceValue": 0,
"parameters": {
"template": null,
"userId": "ID do usuário"
},
"accountId": "ID da conta",
"active": 1
}
POST https://cartao-beneficios.feegow.com/external/plan/create
Endpoint para criação de plano.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| name | string | Nome do plano |
| membershipValue | number | Valor da associação (se houver) |
| recurrenceValue | number | Valor da recorrência (se houver) |
| dependencyMembershipValue | number | Valor da associação dependente (se houver) |
| dependencyRecurrenceValue | number | Valor da recorrência dependente (se houver) |
| parameters | object | Parâmetros adicionais do plano (opcional) |
| parameters.template | object | Modelo de plano (opcional) |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | string | ID do plano criado |
| name | string | Nome do plano |
| membershipValue | number | Valor da associação (se houver) |
| recurrenceValue | number | Valor da recorrência (se houver) |
| dependencyMembershipValue | number | Valor da associação dependente (se houver) |
| dependencyRecurrenceValue | number | Valor da recorrência dependente (se houver) |
| parameters | object | Parâmetros adicionais do plano (opcional) |
| parameters.template | object | Modelo de plano (opcional) |
| parameters.userId | number | ID do usuário associado ao plano |
| accountId | string | ID da conta associada ao plano |
| active | number | Indicador de ativação do plano (1 para ativo, 0 para inativo) |
Convênios
Listar convênios
Exemplo Request
GET https://api.feegow.com/v1/api/insurance/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"unidade_id": 41
}
Exemplo Resposta
{
"success": true,
"content": [
{
"convenio_id": 152,
"nome": "Bradesco Saúde",
"exibir_agendamento_online": 1,
"permite_telemedicina": 1,
"registro_ans": "999009",
"CNPJ": "99909099999990909",
"endereco": "Avenida Primeiro Endereço",
"numero": "12",
"complemento": "12",
"bairro": "Parque Fluminense",
"cidade": "Duque de Caxias",
"estado": "RJ",
"CEP": "25045-100",
"planos": []
},
{
"convenio_id": 152,
"nome": "Bradesco Saúde",
"exibir_agendamento_online": 1,
"permite_telemedicina": 1,
"registro_ans": "999009",
"CNPJ": "99909099999990909",
"endereco": "Avenida Primeiro Endereço",
"numero": "12",
"complemento": "12",
"bairro": "Parque Fluminense",
"cidade": "Duque de Caxias",
"estado": "RJ",
"CEP": "25045-100",
"planos": [
{
"plano_id": 2,
"plano": "Alfa"
},
{
"plano_id": 7,
"plano": "Beta"
},
{
"plano_id": 8,
"plano": "Delta"
}
]
}
]
}
GET /insurance/list
Busca todos convênios aceitos e seus respectivos planos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| unidade_id (opcional) |
numeric | Identificação da Unidade |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Empresa
Listar unidades
Exemplo Request
GET https://api.feegow.com/v1/api/company/list-unity
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Parâmetros
{
"endereco": "Avenida das américas, 3500, Barra da Tijuca, RJ",
"cep": "24315-000"
}
Exemplo Resposta - 200
{
"success": true,
"content": {
"matriz": [
{
"unidade_id": 0,
"nome_fantasia": "Principal-teste",
"cnpj": "96.481.175.0001-37",
"endereco": "Avenida das Américas",
"foto": null,
"cep": "22640-102",
"numero": "3500",
"bairro": "Barra da Tijuca",
"estado": "RJ",
"cidade": "Rio de Janeiro",
"regiao": "",
"zona": "",
"telefone_1": "",
"telefone_2": "",
"email_1": "",
"email_2": "",
"complemento": "",
"mapa": "",
"ExibirAgendamentoOnline": 1
}
],
"unidades": [
{
"unidade_id": 1,
"nome_fantasia": "Filial-Teste-2",
"cnpj": "87.727.461.0001-49",
"endereco": "Avenida das Américas",
"foto": null,
"cep": "22640-102",
"numero": "3500",
"bairro": "Barra da Tijuca",
"estado": "RJ",
"cidade": "Rio de Janeiro",
"regiao": "",
"zona": "",
"telefone_1": "",
"telefone_2": "",
"email_1": "",
"email_2": "",
"complemento": "",
"mapa": "",
"ExibirAgendamentoOnline": 1
},
{
"unidade_id": 2,
"nome_fantasia": "Filial-Teste-1",
"cnpj": "71.078.404.0001-46",
"endereco": "Avenida das Américas",
"foto": null,
"cep": "22640-102",
"numero": "3500",
"bairro": "Barra da Tijuca",
"estado": "RJ",
"cidade": "Rio de Janeiro",
"regiao": "",
"zona": "",
"telefone_1": "",
"telefone_2": "",
"email_1": "",
"email_2": "",
"complemento": "",
"mapa": "",
"ExibirAgendamentoOnline": null
}
]
}
}
Exemplo Resposta - 5xx
{
"success": false,
"content": "Busca por endereço insdiponível no momento."
}
GET /company/list-unity
Lista informações de unidades e matriz da sua clínica.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| endereco | string | Endereço escrito por extenso |
| cep | string | 22000-000 |
Listar locais
Exemplo Request
GET https://api.feegow.com/v1/api/company/list-local
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"local": "Sala 01",
"unidade_id": 6
},
{
"id": 2,
"local": "Sala 02",
"unidade_id": 6
},
{
"id": 3,
"local": "Sala 01",
"unidade_id": 0
},
{
"id": 4,
"local": "Sala 04",
"unidade_id": 0
},
{
"id": 5,
"local": "Sala 05",
"unidade_id": 0
},
{
"id": 6,
"local": "Sala 06",
"unidade_id": 0
},
{
"id": 7,
"local": "Sala 07",
"unidade_id": 0
}
]
}
GET /company/list-local
Lista locais cadastrados nas unidades da sua clínica.
Especialidades
Listar especialidades
Exemplo Request
GET https://api.feegow.com/v1/api/specialties/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"especialidade_id": 262,
"nome": "Psicólogo",
"consulta_id": 740,
"consulta_online_id": 426,
"exibir_agendamento_online": 1,
"codigo_tiss": null
},
{
"especialidade_id": 148,
"nome": "Médico urologista",
"consulta_id": 740,
"consulta_online_id": 426,
"exibir_agendamento_online": 1,
"codigo_tiss": "225285"
}
],
"total": 2
}
GET /specialties/list
Lista todas especialidades disponíveis para agendamento.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| unidade_id (opcional) |
numeric | Identificação da Unidade desejada |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Estoque
Movimentação de Produtos
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/base/product/movement
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"perPage": 1,
"page": 1,
"fabricante": 11,
"categoria": 1,
"dataInicio": "2023-01-01",
"dataFim": "2023-01-02",
"produto": 13,
"sysUser": 6223,
"localizacao": 91234,
"grupo": 62345
}
Exemplo Resposta
{
"data": [
{
"ApresentacaoNome": "036 - Unidade",
"PacienteFornecedor": "Abaldo Gomes",
"Nome": "Ton Peroli",
"CategoriaID": 3,
"FabricanteID": 2,
"UsuarioID": 111,
"ProdutoID": 6,
"FornecedorID": "1",
"PacienteID": 4297,
"id": 110,
"QuantidadeTotal": 5,
"Data": "2017-07-04",
"Quantidade": 5,
"TipoUnidade": "U",
"Lote": "1214",
"Validade": "2017-07-01T03:00:00.000Z",
"Valor": 7,
"ValorTotal": 35,
"UnidadePagto": "U",
"AccountName": "CLAUDIA THURY",
"sysUser": 111,
"sysDate": "2017-07-04",
"Observacoes": "Examplo de Observação",
"QuantidadeConjunto": 12,
"CBID": "1800001",
"AtendimentoID": 231,
"ProdutoInvoiceID": 23312,
"InvoiceAccountID": null,
"InvoiceAssociationAccountID": null,
"NomeProduto": "Rolo de maca",
"UnidadeMedida": "036 - Unidade",
"nroNFe": "1241",
"ItemInvoiceID": 32312,
"NomeProcedimento": "Rolo de maca",
"Executante": "José Aparecido",
"NumeroInvoice": 12312,
"ProfissionalID": 12331,
"TipoProduto": "Geral",
"ProcedimentoID": 123,
"NomeCategoria": "Insumo",
"NomeFabricante": "Kimberly Klark",
"EntSai": "Entrada"
}
],
"count": "107",
"page": 1,
"perPage": 1,
"pages": 107,
"version": "3.0",
"foundParameters": [
"fabricante",
"categoria",
"dataInicio",
"dataFim",
"produto",
"sysUser",
"localizacao",
"grupo",
"perPage",
"page"
]
}
POST /core/financial/base/product/movement
Endpoint para obter a movimentação de produtos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| perPage | number | Número de registros por página. O padrão é 100. |
| page | number | Número da página. O padrão é 1. |
| fabricante | number | ID do fabricante do produto. |
| categoria | number | ID da categoria do produto. |
| dataInicio | string | Data de início para consulta. |
| dataFim | string | Data de fim para consulta. |
| produto | number | ID do produto. |
| sysUser | number | ID do usuário do sistema. |
| localizacao | number | ID da localização do produto. |
| grupo | number | ID do grupo do produto. |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data | array | Lista de objetos que representam a posição do produto |
| data.ApresentacaoNome | string | Nome de apresentação do produto |
| data.PacienteFornecedor | string | Nome do fornecedor do paciente |
| data.Nome | string | Nome do produto |
| data.CategoriaID | number | ID da categoria do produto |
| data.FabricanteID | number | ID do fabricante do produto |
| data.UsuarioID | number | ID do usuário |
| data.ProdutoID | number | ID do produto |
| data.FornecedorID | string | ID do fornecedor |
| data.PacienteID | number | ID do paciente |
| data.id | number | ID da posição do produto |
| data.QuantidadeTotal | number | Quantidade total do produto |
| data.Data | string | Data da posição do produto |
| data.Quantidade | number | Quantidade do produto |
| data.TipoUnidade | string | Tipo de unidade do produto |
| data.Lote | string | Número do lote do produto |
| data.Validade | string | Data de validade do produto |
| data.Valor | number | Valor do produto |
| data.ValorTotal | number | Valor total do produto |
| data.UnidadePagto | string | Unidade de pagamento do produto |
| data.AccountName | string | Nome da conta do produto |
| data.sysUser | number | ID do usuário do sistema |
| data.sysDate | string | Data do sistema |
| data.Observacoes | string | Observações do produto |
| data.QuantidadeConjunto | number | Quantidade do conjunto do produto |
| data.CBID | string | ID CB do produto |
| data.AtendimentoID | number | ID do atendimento do produto |
| data.ProdutoInvoiceID | number | ID do produto na fatura |
| data.InvoiceAccountID | number | ID da conta na fatura |
| data.InvoiceAssociationAccountID | number | ID da associação de conta na fatura |
| data.NomeProduto | string | Nome do produto |
| data.UnidadeMedida | string | Unidade de medida do produto |
| data.nroNFe | string | Número da Nota Fiscal |
| data.ItemInvoiceID | number | ID do item na fatura |
| data.NomeProcedimento | string | Nome do procedimento do produto |
| data.Executante | string | Nome do executante do produto |
| data.NumeroInvoice | number | Número da fatura |
| data.ProfissionalID | number | ID do profissional do produto |
| data.TipoProduto | string | Tipo do produto |
| data.ProcedimentoID | number | ID do procedimento do produto |
| data.NomeCategoria | string | Nome da categoria do produto |
| data.NomeFabricante | string | Nome do fabricante do produto |
| data.EntSai | string | Tipo de movimentação (Entrada ou Saída) |
| count | string | Total de registros |
| page | number | Número da página |
| perPage | number | Número de registros por página |
| pages | number | Número de páginas |
| version | string | Versão da API |
| foundParameters | array | Lista de parâmetros encontrados na requisição |
Obter Posição de Produtos
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/base/product/position
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"perPage": 100,
"page": 1,
"fabricante": 223,
"produto": 4233,
"categoria": 542,
"localizacao": 151,
"dataInicio": "2023-01-01",
"dataFim": "2023-01-02"
}
Exemplo Resposta
{
"data": [
{
"ApresentacaoNome": "036 - Unidade",
"CategoriaID": 67,
"PosicaoID": 23,
"Lote": "10101012",
"FabricanteID": 71,
"ProdutoID": 9,
"Validade": "2023-05-10",
"Quantidade": 21,
"LocalizacaoID": 16,
"CBID": "1470002",
"Responsavel": "",
"TipoUnidade": "U",
"NomeLocalizacao": "fin",
"UnidadeID": 62,
"QuantidadeItens": 21,
"PrecoMedioCompra": 8,
"ValorPosicao": 168,
"NomeProduto": "FICHA PAUTADA 6X9 ",
"UnidadeMedida": "036 - Unidade",
"NomeCategoria": "Materiais",
"NomeFabricante": "Tilibra",
"NomeUnidade": "tarefa 1957"
}
],
"count": "107",
"page": 1,
"perPage": 1,
"pages": 107,
"version": "3.0",
"foundParameters": [
"fabricante",
"produto",
"categoria",
"localizacao",
"dataInicio",
"dataFim",
"perPage",
"page"
]
}
POST /core/financial/base/product/position
Endpoint para obter a posição de produtos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| perPage | number | Número de registros por página. O padrão é 100. |
| page | number | Número da página. O padrão é 1. |
| fabricante | number | ID do fabricante do produto. |
| categoria | number | ID da categoria do produto. |
| dataInicio | string | Data de início para consulta. |
| dataFim | string | Data de fim para consulta. |
| produto | number | ID do produto. |
| localizacao | number | ID da localização do produto. |
Respostas
| Campo | Tipo | Descrição |
|---|---|---|
| data | array | Lista de objetos que representam a posição de produtos |
| data.ApresentacaoNome | string | Nome da apresentação do produto |
| data.CategoriaID | number | ID da categoria do produto |
| data.PosicaoID | number | ID da posição do produto |
| data.Lote | string | Lote do produto |
| data.FabricanteID | number | ID do fabricante do produto |
| data.ProdutoID | number | ID do produto |
| data.Validade | string | Data de validade do produto (pode ser nulo) |
| data.Quantidade | number | Quantidade do produto |
| data.LocalizacaoID | number | ID da localização do produto |
| data.CBID | string | CBID do produto |
| data.Responsavel | string | Responsável pelo produto (pode ser nulo) |
| data.TipoUnidade | string | Tipo de unidade do produto |
| data.NomeLocalizacao | string | Nome da localização do produto (pode ser nulo) |
| data.UnidadeID | string | ID da unidade do produto (pode ser nulo) |
| data.QuantidadeItens | number | Quantidade de itens do produto |
| data.PrecoMedioCompra | number | Preço médio de compra do produto |
| data.ValorPosicao | number | Valor da posição do produto |
| data.NomeProduto | string | Nome do produto |
| data.UnidadeMedida | string | Unidade de medida do produto |
| data.NomeCategoria | string | Nome da categoria do produto (pode ser nulo) |
| data.NomeFabricante | string | Nome do fabricante do produto (pode ser nulo) |
| data.NomeUnidade | string | Nome da unidade do produto (pode ser nulo) |
| count | string | Total de registros |
| page | number | Número da página |
| perPage | number | Número de registros por página |
| pages | number | Número de páginas |
| version | string | Versão da API |
| foundParameters | array | Lista de parâmetros encontrados na requisição |
Obter Lista de Produtos
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/base/product/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"perPage": 1,
"page": 1,
"id": 11,
"location": 11,
"category": 1,
"producer": 13,
"type": 6223
}
Exemplo Resposta
{
"data": [
{
"ApresentacaoNome": "vacina",
"ApresentacaoQuantidade": 1,
"CategoriaID": 9,
"NomeCategoria": "Vacina",
"FabricanteID": 67,
"NomeFabricante": "Bayer",
"ProdutoID": 717,
"NomeProduto": "vacina teste vitor",
"TipoProduto": "Produto",
"UnidadeMedida": "001 - Ampola",
"CodigoProduto": "123123",
"DiasAvisoValidade": 7,
"PrincipioAtivo": "clofibrato de etofilina",
"NomeLocalizacao": "UNIDADE TIJUCA",
"TissCD": "02 - Medicamentos",
"EstoqueMinimo": 0,
"EstoqueMinimoTipo": "U",
"EstoqueMaximo": 100,
"EstoqueMaximoTipo": "U",
"PrecoCompra": 10,
"PrecoVenda": 120
}
],
"count": "107",
"page": 1,
"perPage": 1,
"pages": 107,
"version": "3.0",
"foundParameters": [
"id",
"category",
"location",
"producer",
"type",
"perPage",
"page"
]
}
POST /core/financial/base/product/list
Endpoint para obter a lista de produtos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| perPage | number | Número de registros por página. O padrão é 100. |
| page | number | Número da página. O padrão é 1. |
| id | number | ID do produto. |
| location | number | ID da localização do produto. |
| category | number | ID da categoria do produto. |
| producer | number | ID do produtor do produto. |
| type | number | Tipo do produto. |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data | array | Lista de objetos que representam os produtos |
| data.ApresentacaoNome | string | Nome da apresentação do produto |
| data.ApresentacaoQuantidade | number | Quantidade da apresentação do produto |
| data.CategoriaID | number | ID da categoria do produto |
| data.NomeCategoria | string | Nome da categoria do produto |
| data.FabricanteID | number | ID do fabricante do produto |
| data.NomeFabricante | string | Nome do fabricante do produto |
| data.ProdutoID | number | ID do produto |
| data.NomeProduto | string | Nome do produto |
| data.TipoProduto | string | Tipo do produto |
| data.UnidadeMedida | string | Unidade de medida do produto |
| data.CodigoProduto | string | Código do produto |
| data.DiasAvisoValidade | number | Dias de aviso de validade do produto |
| data.PrincipioAtivo | string | Princípio ativo do produto |
| data.NomeLocalizacao | string | Nome da localização do produto |
| data.TissCD | string | Código Tiss do produto |
| data.EstoqueMinimo | number | Estoque mínimo do produto |
| data.EstoqueMinimoTipo | string | Tipo do estoque mínimo do produto |
| data.EstoqueMaximo | number | Estoque máximo do produto |
| data.EstoqueMaximoTipo | string | Tipo do estoque máximo do produto |
| data.PrecoCompra | number | Preço de compra do produto |
| data.PrecoVenda | number | Preço de venda do produto |
| count | string | Total de registros |
| page | number | Número da página |
| perPage | number | Número de registros por página |
| pages | number | Número de páginas |
| version | string | Versão da API |
| foundParameters | array | Lista de parâmetros encontrados na requisição |
Faturamento
Buscar Guia
Exemplo Request
GET https://api.feegow.com/v1/api/billing/insurances-billing
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"billing_type_id": 2,
"insurance_id": 3,
"billing": 101010
}
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 2,
"PacienteID": 123456,
"CNS": "",
"NumeroCarteira": "123123123123123",
"ValidadeCarteira": null,
"AtendimentoRN": "N",
"ConvenioID": 3,
"RegistroANS": "000001",
"NGuiaPrestador": "2",
"NGuiaOperadora": "",
"Contratado": 0,
"CodigoNaOperadora": "00.000.000.0000-00",
"CodigoCNES": "1234567",
"ProfissionalID": 25252,
"Conselho": 1,
"DocumentoConselho": "12341234",
"UFConselho": "rj",
"CodigoCBO": "123123",
"IndicacaoAcidenteID": 9,
"DataAtendimento": "2020-01-01",
"TipoConsultaID": 1,
"ProcedimentoID": 1,
"TabelaID": 22,
"CodigoProcedimento": "10101012",
"ValorProcedimento": 50,
"Observacoes": "",
"LoteID": 02,
"sysUser": 123123,
"ProfissionalEfetivoID": null,
"sysActive": 1,
"sysDate": "2020-01-01 00:00:00",
"AgendamentoID": 1234,
"PlanoID": 1234,
"AtendimentoID": 123,
"UnidadeID": 2,
"ValorPago": null,
"Glosado": 0,
"MotivoGlosa": null,
"identificadorBeneficiario": "",
"GuiaStatus": 0,
"DHUp": "2020-01-01 00:00:00",
"GuiaSimplificada": 0,
"TipoIdentificador": 1,
"regimeAtendimentoID": 1
}
],
"total": 1
}
GET /billing/insurances-billing
Busca guia de acordo com o convênio informado.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| billing_type_id (obrigatorio) |
numeric | Tipo da guia (1 = 'Consulta', 2 = 'SADT', 3 = 'Honorarios', 4 = 'Internação', 5 = 'Quimioterapia') |
| insurance_id (obrigatorio) |
numeric | ID do Convênio |
| billing (obrigatorio) |
numeric | Numero da Guia |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Editar Guia
Exemplo Request
PUT https://api.feegow.com/v1/api/billing/insurances-billing
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"billing_id": 1234,
"billing_type_id": 2,
"xxxxx": 1 // atributo a ser editado
}
Exemplo Resposta
{
"success": true,
"content": {
"result": "update successful"
},
"total": 1
}
PUT /billing/insurances-billing
Edita Atributos da Guia (apenas SADT até o momento).
procedimentos, anexos e executantes não inclusos
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| billing_id (obrigatorio) |
numeric | Guia ID |
| billing_type_id (obrigatorio) |
numeric | Tipo da guia (1 = 'Consulta', 2 = 'SADT', 3 = 'Honorarios', 4 = 'Internação', 5 = 'Quimioterapia') |
| xxxxx (obrigatorio) |
numeric or string | Atributo a ser editado Ex: 'observation' |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Inserir Guia
Exemplo Request
POST https://api.feegow.com/v1/api/billing/insurances-billing
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"patient_id": "12345" ,
"patient_birth_date": "2020-01-01",
"patient_cpf":"12345678912",
"unit_id": 0,
"insurance_id": "1",
"insurance_plan_id": "1234",
"billing_type_id": 2,
"newborn_care": "N",
"applicant_professional_council_id": "1",
"number_on_the_requesting_council": "123456",
"UF_Requesting_Council": "RJ",
"requesting_CBO_code": "123456",
"hired": "0",
"carrier_code": "123456",
"hired_requester_ID": "0",
"hired_requester_code_at_carrier": "1234567",
"ANS_registry": "123456",
"CNES_code": "1234567",
"requesting_professional_ID": "12345",
"request_date": "2020-01-01",
"observation": "",
"clinical_indication": ""
}
Exemplo Resposta
{
"success": true,
"content": {
"GuiaID": 1234
},
"total": 1
}
POST /billing/insurances-billing
Insere Guia (válido somente para guias SADT no momento).
procedimentos, anexos e executantes não inclusos
Parâmetros
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Financeiro
Listar fornecedores
Exemplo Request
GET https://api.feegow.com/v1/api/financial/list-suppliers
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"nome_fornecedor": "Teste",
"CEP": null,
"endereco": null,
"numero": null,
"complemento": null,
"cidade": null,
"CNPJ": null
},
{
"id": 3,
"nome_fornecedor": "Teste",
"CEP": "111111-11",
"endereco": "rua teste",
"numero": "12",
"complemento": "",
"cidade": "Joinville",
"CNPJ": "11.111.111/0001-42"
}
]
}
GET /financial/list-suppliers
Lista os fornecedores da clínica.
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Informações do fornecedor
Exemplo Request
GET https://api.feegow.com/v1/api/financial/search-supplier
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"fornecedor_id": 1
}
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"nome_fornecedor": "Teste",
"CEP": null,
"endereco": null,
"numero": null,
"complemento": null,
"cidade": null,
"CNPJ": null
}
]
}
GET /financial/search-supplier
Busca informações de um fornecedor específico.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| fornecedor_id | numeric | ID do fornecedor |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Associação de conta financeira
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/account/association
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"account": 15,
"association": 3
}
Exemplo Resposta
{
"id": 15,
"email": "casa@pedra.com.br",
"address": {
"zipCode": "21031760",
"city": "Gloria de Dourados",
"additionalAddressLine1": "Lt 15 Qd 12",
"houseNumber": "23",
"streetAddress": "Marechal Rondao 622",
"neighborhood": "Centro",
"state": "MS"
},
"birthDate": "1988-12-06",
"cellphone": "21 999999915",
"type": {
"id": 3,
"description": "Paciente"
},
"name": "Anderson Dos Santos Greco",
"document": "52872505091"
}
POST /core/financial/account/association
Associa uma conta financeira a um paciente.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| account | numeric | Id da Conta Financeira |
| association | numeric | Id do Tipo de Conta |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | number | Código indentificador da conta financeira |
| string | E-mail do paciente | |
| address | object | Objeto com informações de endereço |
| address.zipCode | string | Cep |
| address.city | string | Cidade |
| address.additionalAddressLine1 | string | Complemento |
| address.houseNumber | string | Numero |
| address.streetAddress | string | Endereço |
| address.neighborhood | string | Bairro |
| address.state | string | Estado |
| birthDate | string | Data de nascimento do paciente (AAAA-MM-DD) |
| cellphone | string | Número de telefone celular do paciente |
| type | object | Objeto com informações do tipo do paciente |
| type.id | number | ID do tipo de paciente |
| type.description | string | Descrição do tipo de paciente |
| name | string | Nome do paciente |
| document | string | CPF do paciente |
Categoria financeira (Plano de contas)
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/base/financial-category
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"page": 1,
"perPage": 1000,
"id": 122,
"type": "expense"
}
Exemplo Resposta
{
"data": [
{
"type": "expense",
"id": 19,
"name": "MATERIAL HOSPITALAR",
"position": "2.1.4",
"parentId": 258,
"description": "Descrição da categoria Material Hospitalar"
},
{
"type": "income",
"id": 173,
"name": "vitor",
"position": "1.16",
"parentId": 0
}
],
"count": 157,
"page": 1,
"perPage": 1000,
"pages": 1,
"version": "3.0",
"foundParameters": [
"id",
"type",
"perPage",
"page"
]
}
POST /core/financial/base/financial-category
Busca as categorias financeiras com base nos filtros.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| page | number | Número da página desejada. |
| perPage | number | Quantidade de registros por página. |
| id | number | ID da categoria financeira. |
| type | string | Tipo da categoria financeira. (income, expense) |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data | array | Lista de categorias financeiras encontradas. |
| data.type | string | Tipo da categoria financeira. |
| data.id | number | ID da categoria financeira. |
| data.name | string | Nome da categoria financeira. |
| data.position | string | Posição da categoria financeira. |
| data.parentId | number | ID da categoria pai da categoria financeira. |
| data.description | string | Descrição da categoria financeira. |
| count | number | Quantidade total de categorias financeiras encontradas. |
| page | number | Número da página atual. |
| perPage | number | Quantidade de registros por página. |
| pages | number | Quantidade total de páginas. |
| version | string | Versão da API utilizada. |
| foundParameters | array | Lista de parâmetros encontrados na pesquisa. |
Centros de Custos
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/base/cost-center
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"perpage": 10,
"page": 1
}
Exemplo Resposta
{
"data": [
{
"id": 18,
"name": "Feegow - DevOps"
}
],
"count": 19,
"page": 1,
"perPage": 100,
"pages": 1,
"version": "3.0",
"foundParameters": [
"perPage",
"page"
]
}
POST /core/financial/base/cost-center
Endpoint para obter a lista de centros de custos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| perpage | number | Número de registros por página. O padrão é 100. |
| page | number | Número da página. O padrão é 1. |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data | array | Lista de objetos que representam os centros de custos |
| data.id | number | Código indentificador do centro de custo |
| data.name | string | Nome do centro de custo |
| count | number | Total de registros |
| page | number | Número da página |
| perPage | number | Número de registros por página |
| pages | number | Número de páginas |
| version | string | Versão da API |
| foundParameters | array | Lista de parâmetros encontrados na requisição |
Listar repasses
Exemplo Request
GET https://api.feegow.com/v1/api/financial/list-medical-transfer
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"success": true,
"content": [
{
"funcao": "executante",
"valor": 9000,
"associacao_id": 5,
"conta_id": 59,
"criado_em": "2018-01-01 09:10:30",
"situacao": "PAGO"
},
{
"funcao": "executante",
"valor": 9500,
"associacao_id": 5,
"conta_id": 13,
"criado_em": "2018-01-01 09:13:30",
"situacao": "NAO PAGO"
}
]
}
GET /financial/list-medical-transfer
Busca a listagem de repasses. Os valores são tratados em centavos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data_start | date | Listar a partir dessa data dd-mm-YYYY |
| data_end | date | Limitar consulta até essa data dd-mm-YYYY |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar contas
Exemplo Request
GET https://api.feegow.com/v1/api/financial/list-invoice
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"data_start": "15-05-2018",
"data_end": "15-05-2019",
"tipo_transacao": "D",
"unidade_id": 0
}
Exemplo Resposta
{
"success": true,
"content": [
{
"detalhes": [
{
"responsavel": null,
"movement_id": 13740609,
"invoice_id": 5883722,
"tipo_conta": 3,
"conta_id": 999889213,
"valor": 200,
"NFe": 1233,
"descricao": "",
"data": "12-03-2024",
"dataNFe": null
}
],
"pagamentos": [
{
"pagamento_id": 13740615,
"descricao": null,
"valor": 200,
"data": "12-03-2024",
"forma_pagamento": 8,
"tipo_conta": 3,
"conta_id": 999889213,
"tipo_conta_destino": 1,
"conta_id_destino": 454,
"parcelas": null,
"bandeira_id": 9,
"transacao_numero": "108113",
"transacao_autorizacao": "17241081133126",
"transacao_parcelas": 1
}
],
"itens": [
{
"item_id": 28688,
"agendamento_id": 0,
"procedimento_id": 1970,
"descricao": "",
"tipo": "S",
"valor": 200,
"desconto": 0,
"acrescimo": 0,
"quantidade": 1,
"is_executado": false,
"is_cancelado": false,
"dados_de_cancelamento": [],
"data_execucao": "12-03-2024",
"executante_id": 0,
"associacao_executante_id": 0,
"pacote_id": null,
"centro_custo_id": 0,
"categoria_id": 0
}
]
}
],
"total": 1
}
GET /financial/list-invoice
Lista informações de contas no sistema.
forma_pagamento
| forma_id | Descrição |
|---|---|
| 1 | Dinheiro |
| 2 | Cheque |
| 3 | Transferência |
| 4 | Boleto |
| 5 | DOC |
| 6 | TED |
| 7 | Transferência Bancária |
| 8 | Cartão de Crédito |
| 9 | Cartão de Débito |
| 10 | Cartão de Crédito |
| 11 | Débito Automático |
| 12 | Crédito em Conta |
| 13 | Débito em Conta |
| 14 | Débito em Conta |
| 15 | PIX |
tipo_conta
| tipo_id | Descrição |
|---|---|
| 1 | Conta Corrente |
| 2 | Fornecedor |
| 3 | Paciente |
| 4 | Funcionário |
| 5 | Profissional |
| 6 | Convênios |
| 7 | Caixa |
| 8 | Profissional externo |
| 9 | Contatos |
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data_start | date | Data de início do filtro |
| data_end | date | Data de fim do filtro |
| tipo_transacao | numeric | C = Contas a receber D = Contas a pagar |
| unidade_id (opcional) |
numeric | ID da unidade |
| invoice_id (opcional) |
numeric | ID da invoice |
| agendamento_id (opcional) |
numeric | ID do Agendamento |
| item_id (opcional) |
numeric | ID do Item |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| success | boolean | Indica se a requisição foi bem-sucedida ou não |
| content | array | Lista de faturas |
| content.detalhes[] | array | Detalhes específicos das faturas |
| content.detalhes[].responsavel | any | Responsável pela fatura |
| content.detalhes[].movement_id | number | ID do movimento da fatura |
| content.detalhes[].invoice_id | number | ID da fatura |
| content.detalhes[].tipo_conta | number | Tipo de conta da fatura |
| content.detalhes[].conta_id | number | ID da conta relacionada à fatura |
| content.detalhes[].valor | number | Valor da fatura |
| content.detalhes[].NFe | number | Número da nota fiscal associada à fatura |
| content.detalhes[].descricao | string | Descrição da fatura |
| content.detalhes[].data | string | Data da fatura |
| content.detalhes[].dataNFe | string | Data da nota fiscal associada à fatura |
| content.pagamentos[] | array | Detalhes específicos dos pagamentos da fatura |
| content.pagamentos[].pagamento_id | number | ID do pagamento |
| content.pagamentos[].descricao | string | Descrição do pagamento |
| content.pagamentos[].valor | number | Valor do pagamento |
| content.pagamentos[].data | string | Data do pagamento |
| content.pagamentos[].forma_pagamento | number | Forma de pagamento |
| content.pagamentos[].tipo_conta | number | Tipo de conta relacionada ao pagamento |
| content.pagamentos[].conta_id | number | ID da conta relacionada ao pagamento |
| content.pagamentos[].tipo_conta_destino | number | Tipo de conta de destino do pagamento |
| content.pagamentos[].conta_id_destino | number | ID da conta de destino do pagamento |
| content.pagamentos[].parcelas | any | Parcelas do pagamento |
| content.pagamentos[].bandeira_id | number | ID da bandeira do pagamento |
| content.pagamentos[].transacao_numero | any | Número da transação do pagamento |
| content.pagamentos[].transacao_autorizacao | string | Autorização da transação do pagamento |
| content.pagamentos[].transacao_parcelas | number | Parcelas da transação do pagamento |
| content.itens[] | array | Detalhes específicos dos itens da fatura |
| content.itens[].item_id | number | ID do item da fatura |
| content.itens[].agendamento_id | number | ID do agendamento do item da fatura |
| content.itens[].procedimento_id | number | ID do procedimento do item da fatura |
| content.itens[].descricao | string | Descrição do item da fatura |
| content.itens[].tipo | string | Tipo do item da fatura |
| content.itens[].valor | number | Valor do item da fatura |
| content.itens[].desconto | number | Desconto do item da fatura |
| content.itens[].acrescimo | number | Acréscimo do item da fatura |
| content.itens[].quantidade | number | Quantidade do item da fatura |
| content.itens[].is_executado | boolean | Indica se o item foi executado |
| content.itens[].is_cancelado | boolean | Indica se o item foi cancelado |
| content.itens[].dados_de_cancelamento | array | Dados do cancelamento do item da fatura |
| content.itens[].data_execucao | string | Data de execução do item da fatura |
| content.itens[].executante_id | number | ID do executante do item da fatura |
| content.itens[].associacao_executante_id | number | ID da associação do executante do item da fatura |
| content.itens[].pacote_id | any | ID do pacote relacionado ao item da fatura |
| content.itens[].centro_custo_id | number | ID do centro de custo do item da fatura |
| content.itens[].categoria_id | number | ID da categoria do item da fatura |
| total | number | Total de faturas retornadas |
Obter Contas Correntes
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/base/current-accounts
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"accountType": 3,
"unity": 1,
"perpage": 10,
"page": 1
}
Exemplo Resposta
{
"data": [
{
"id": 1,
"AccountName": "Tesouraria (Caixinha)",
"AccountType": 1,
"APIEnabled": 0,
"PercentageDeducted": 0,
"Empresa": 0,
"CategoriadTaxaID": null
}
],
"count": 433,
"page": 1,
"perPage": 1,
"pages": 433,
"version": "3.0",
"foundParameters": [
"unity",
"accountType",
"perPage",
"page"
]
}
POST /core/financial/base/current-accounts
Endpoint para obter a lista de contas correntes.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| accountType | number | Código do tipo de conta corrente. Os valores possíveis são: 1, 2 ou 3. |
| unity | number | Identificador da unidade. |
| perPage | number | Número de registros por página. O padrão é 100. |
| page | number | Número da página. O padrão é 1. |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| data | array | Lista de objetos que representam as contas correntes. |
| data.id | number | Código indentificador da conta corrente. |
| data.AccountName | string | Nome da conta corrente. |
| data.AccountType | number | Código do tipo de conta corrente. Os valores possíveis são: 1 - Conta Corrente, 2 - Poupança, 3 - Outras |
| data.APIEnabled | number | Indica se a API está habilitada para a conta corrente. Os valores possíveis são: 0 ou 1. |
| data.PercentageDeducted | number | Valor em porcentagem deduzido na transação. |
| data.Empresa | number | Identificador da empresa. |
| data.CategoriadTaxaID | number | Identificador da categoria de taxa. |
| count | number | Total de registros |
| page | number | Número da página |
| perPage | number | Número de registros por página |
| pages | number | Número de páginas |
| version | string | Versão da API |
| foundParameters | array | Lista de parâmetros possíveis encontrados na requisição |
Obter invoices por nota fiscal
Exemplo Request
GET https://api.feegow.com/v1/api/financial/find-invoice-by-nfse-number
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"data": [
{
"id": 111111,
"Name": null,
"AccountID": 1,
"AssociationAccountID": 2,
"Value": 2600,
"Tax": 1,
"Currency": "BRL",
"Description": "",
"AccountPlanID": null,
"CompanyUnitID": 1,
"Recurrence": 1,
"RecurrenceType": "m",
"CD": "D",
"Sta": null,
"sysActive": 1,
"sysUser": 141851,
"FormaID": 0,
"ContaRectoID": 0,
"sysDate": "2021-06-28",
"CaixaID": null,
"FixaID": null,
"TabelaID": null,
"NumeroFatura": null,
"ProfissionalSolicitante": "",
"FixaNumero": null,
"nroNFe": 10,
"statusNFe": null,
"dataNFe": null,
"valorNFe": null,
"DataHora": "2021-06-28 08:59:28",
"DHUp": "2021-06-28 09:01:44",
"Rateado": 0,
"MotivoCancelamento": null,
"sysUserCancelamento": null,
"DataCancelamento": null,
"Voucher": null,
"tributo_info": [
{
"ValorISS": 100.01,
"ValorCsll": 100.01,
"ValorCofins": 100.01,
"ValorInss": 100.01,
"ValorIr": 100.01,
"ValorPis": 100.01
}
]
}
]
}
POST /financial/find-invoice-by-nfse-number
Obtém as invoices da licença de buscando pelo número da nota fiscal.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nfse_numero | numeric | Número da NFSE |
| tributo_info (opcional) | numeric | S = Exibir Valores de Tributos |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Obter bandeiras de cartão de crédito
Exemplo Request
GET https://api.feegow.com/v1/api/financial/credit-card-flags
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"Bandeira": "Visa"
},
{
"id": 2,
"Bandeira": "Mastercard"
},
{
"id": 3,
"Bandeira": "American Express"
},
{
"id": 4,
"Bandeira": "Elo"
}
],
"total": 30
}
GET /financial/credit-card-flags
Endpoint para obter a lista de bandeiras de cartão de crédito.
Parâmetros
Nenhum parâmetro é necessário para esta requisição.
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| success | boolean | Indica se a requisição foi bem sucedida ou não. |
| content | array | Lista de objetos que representam as bandeiras. |
| content[].id | number | Código indentificador da bandeira. |
| content[].Bandeira | string | Nome da bandeira. |
| total | number | Total de registros encontrados. |
Remover Fatura
Exemplo Request
DELETE https://api.feegow.com/v1/api/core/financial/invoice/remove
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"invoiceId": 5880015
}
Exemplo Resposta
{
"success": true,
"message": "invoiceId deleted 5880015"
}
DELETE /core/financial/invoice/remove
Endpoint para remover uma fatura.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| invoiceId | number | Código identificador da fatura a remover. |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| success | boolean | Indica se a operação teve êxito |
| message | string | Mensagem de retorno |
Remover Pagamento
Exemplo Request
DELETE https://api.feegow.com/v1/api/core/financial/payment/remove
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paymentId": 2804
}
Exemplo Resposta
{
"success": true,
"message": "payment deleted 2804"
}
DELETE /core/financial/payment/remove
Endpoint para remover um pagamento.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paymentId | number | ID do pagamento que será removido. |
Respostas
| Parâmetro | Tipo | Descrição |
|---|---|---|
| success | boolean | Indica se o pagamento foi removido com sucesso |
| message | string | Mensagem com informações da operação. |
Pagamento de Conta
Exemplo Request
POST https://api.feegow.com/v1/api/financial/pay-movement
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"invoiceId": "5879221",
"movementId": "13734894",
"amount": 6900,
"associationId": "3",
"accountId": "2375",
"paymentMethod": "1",
"paymentDate": "2022-12-27",
"paymentName": "Pagamento",
"creditCardTransaction": {
"transactionNumber": "434812",
"authorizationNumber":"40513692283017",
"flagCardId":1,
"installments": 2
}
"force": true
}
Exemplo Resposta
{
"payment": 13735185
}
POST /financial/pay-movement
Pagamento de conta.
Forma de Pagamento (paymentMethod)
| paymentMethod | Descrição |
|---|---|
| 1 | Dinheiro |
| 2 | Cheque |
| 3 | Transferência |
| 4 | Boleto |
| 5 | DOC |
| 6 | TED |
| 7 | Transferência Bancária |
| 8 | Cartão de Crédito |
| 9 | Cartão de Débito |
| 10 | Cartão de Crédito |
| 11 | Débito Automático |
| 12 | Crédito em Conta |
| 13 | Débito em Conta |
| 14 | Débito em Conta |
| 15 | PIX |
Tipo de Conta (associationId)
| associationId | Descrição |
|---|---|
| 1 | Conta Corrente |
| 2 | Fornecedor |
| 3 | Paciente |
| 4 | Funcionário |
| 5 | Profissional |
| 6 | Convênios |
| 7 | Caixa |
| 8 | Profissional externo |
| 9 | Contatos |
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| invoiceId | numeric | Id da invoice (Conta) |
| movementId | numeric | Id da Movement (Parcela) |
| amount | numeric | Valor do Pagamento em Centavos |
| associationId | numeric | Tipo de Conta |
| accountId | numeric | Id da Conta |
| paymentMethod | numeric | Id da Forma de Pagamento |
| paymentDate | date | Data de Pagamento |
| paymentName | string | Descrição do Pagamento |
| creditCardTransaction | object | Dados da transação com cartão de crédito |
| creditCardTransaction.transactionNumber | string | Número da transação |
| creditCardTransaction.authorizationNumber | string | Número de autorização da transação |
| creditCardTransaction.flagCardId | number | Identificador da bandeira |
| creditCardTransaction.installments | number | Numero de parcelas |
| force (opcional) |
boolean | Forçar pagamento com valor e data já existente |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Criação da Conta
Exemplo Request
POST https://api.feegow.com/v1/api/core/financial/invoice/create
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"type": "C",
"date": "2023-01-26",
"description": "Pagamento de Março",
"name": "Pagamento de Março",
"table": 101,
"voucher": "1212323",
"user": 4087,
"nFiscal": {
"number": "123123123",
"valueCents": 123123,
"date": "2023-01-26"
},
"unity": 0,
"account": {
"association": 3,
"id": 23
},
"requestingProfessionalAccount": {
"association": 5,
"id": 396
},
"items": [
{
"appointment": 11111,
"type": "S",
"itemId": 123,
"description": "Lote(s): 2147483647",
"category": 11111,
"costCenter": 11111,
"execution": {
"executed": true,
"account": {
"association": 5,
"id": 396
},
"specialty": 4,
"initialDate": "2023-01-26T12:59:09.573Z",
"finishDate": "2023-01-26T15:59:09.573Z",
"description": "Observação."
},
"quantity": 1,
"valueCents": 160,
"discountCents": 0,
"extraValueCents": 0
}
],
"installments": [
{
"description": "Mes de Março",
"expirationDate": "2023-03-25",
"valueCents": 160
}
]
}
Exemplo Resposta
{
"id": 5879510,
"nFiscal": {
"number": "123123123",
"valueCents": 123100,
"date": "2023-01-26T03:00:00.000Z"
},
"date": "2023-01-26T03:00:00.000Z",
"table": 101,
"description": "Pagamento de Março",
"name": "Pagamento de Março",
"voucher": "1212323",
"type": {
"code": "C",
"typeDescription": "Credit"
},
"account": {
"id": 23,
"email": "teste@exemplo.com.br",
"address": {
"zipCode": "21031-760",
"city": "Rio de Janeiro",
"additionalAddressLine1": "casa 7",
"houseNumber": "7889",
"streetAddress": "Travessa Horácio",
"neighborhood": "Ramos",
"state": "RJ"
},
"birthDate": "1988-01-14",
"cellphone": "21992538660",
"type": {
"id": 3,
"description": "Paciente"
},
"name": "Ariane Benicio Moreira",
"document": "80722282770"
},
"installments": [
{
"id": 13735311,
"name": "Mes de Março",
"obs": null,
"description": "Mes de Março",
"expirationDate": "2023-03-25T03:00:00.000Z",
"valueCents": 160,
"paidAmount": 0,
"payments": []
}
],
"itens": [
{
"id": 23251,
"valueCents": 160,
"discountCents": 0,
"extraValueCents": 0,
"quantity": 1,
"category": 11111,
"execution": {
"executed": true,
"initialDate": "2023-01-26T12:59:00.000Z",
"finishDate": "2023-01-26T15:59:00.000Z"
},
"type": {
"code": "S",
"description": "Serviço"
},
"description": "Lote(s): 2147483647"
}
],
"user": {
"id": 16,
"email": "vim@hotmail.com",
"address": {
"zipCode": "21000-090",
"city": "Rio de Janeiro",
"additionalAddressLine1": "Condomínio Z - Tol",
"houseNumber": "198",
"streetAddress": "RUA PROJETADA Z",
"neighborhood": "PENHA",
"state": "RJ"
},
"birthDate": "1973-01-05",
"cellphone": "2194968964",
"type": {
"id": 5,
"description": "Profissional"
},
"name": "Vanessa Teixeira",
"document": "61827266520"
},
"active": true
}
POST /core/financial/invoice/create
Criação da conta.
Tipo de Conta (association)
| association | Descrição |
|---|---|
| 1 | Conta Corrente |
| 2 | Fornecedor |
| 3 | Paciente |
| 4 | Funcionário |
| 5 | Profissional |
| 6 | Convênios |
| 7 | Caixa |
| 8 | Profissional externo |
| 9 | Contatos |
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| type | string | C (receber) ou D (pagar) |
| date | date | Data da Conta |
| name | string | Nome da Conta (descrição) |
| description | string | Descrição |
| table | integer | Id da Tabela |
| voucher | string | Código de Promocional |
| user | integer | Id do usuário responsável pela criação / alteração |
| nFiscal.number | string | Número da Nota Fiscal |
| nFiscal.valueCents | integer | Valor inteiro em centavos da nota fiscal |
| nFiscal.date | date | Data de emissão da nota fiscal |
| unity | integer | Id da Unidade da Conta |
| account.association | integer | Tipo de Cliente da Conta |
| account.id | integer | Id do Cliente |
| requestingProfessionalAccount.id | integer | Id do Profissional Solicitante |
| requestingProfessionalAccount.association | integer | Tipo de Profissional Solicitante |
| items.appointment | integer | Id do agendamento |
| items.type | string | (S) Procedimento, (M) Material, (K) kit, (O) Outros |
| items.itemId | integer | Id do Item |
| items.description | string | Descrição do Item |
| items.category | integer | Id do Plano de Contas |
| items.costCenter | integer | Id do Centro de Custo |
| items.quantity | numeric | Quantidade de itens |
| items.valueCents | integer | Valor em Centavos |
| items.discountCents | integer | Desconto em Centavos |
| items.extraValueCents | integer | Valor Adicional em Centávos |
| items.execution.executed | boolean | Informa se o item foi executado |
| items.execution.specialty | integer | Id da especialidade do executante na execução |
| items.execution.initialDate | date | Data Hora Início da execução |
| items.execution.finishDate | date | Data Hora Fim da execução |
| items.execution.description | string | Descrição |
| items.execution.account.association | string | Tipo do Profissional Executante |
| items.execution.account.id | string | Id do Profissional Executante |
| installments.description | string | Descrição da Parcela |
| installments.expirationDate | date | Data de Vencimento da Parcela |
| installments.valueCents | integer | Valor da Parcela em Centávos |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Criar Conta por Agendamento
Exemplo Request
POST https://api.feegow.com/v1/api/financial/create-account
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"agendamento_id":286583
}
Exemplo Resposta
{
"success": true,
"invoice_id": 5879572,
"movement_id": 13735382,
"itensInvoice": [
{
"id": 23317,
"ValorPagto": 30
}
],
"valorTotal": 30,
"status": "created"
}
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| agendamento_id | integer | Id do Agendamento |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Funcionários
Listar funcionários
Exemplo Request
GET https://api.feegow.com/v1/api/employee/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Parâmetros
{
"ativo": true,
"unidade_id": 2
}
Exemplo Resposta - 200
{
"success": true,
"content": [
{
"employee_id": 1,
"sys_user": 34242342,
"nome": "João Teste",
"email": "",
"ativo": true,
"cpf": "444335544545"
},
{
"employee_id": 3,
"sys_user": 6665654545,
"nome": "Carlos Teste",
"email": "",
"ativo": true,
"cpf": "345353453453"
},
]
}
GET /employee/list
Lista os nomes e IDs dos funcionários.
Você deve filtrar por funcionário ativo ou inativo.
Você pode filtrar por unidade.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ativo * | numeric | 0 = Funcionário inativo 1 = Funcionário ativo |
| unidade_id | numeric | ID da unidade |
* Parâmetros obrigatórios
Laudos
Registrar laudo
POST /medical-reports/create
Registrar laudo no Feegow a partir do agendamento. No body, deverão ser enviados os atributos do documento.
Exemplo Request
GET https://api.feegow.com/v1/api/medical-reports/create
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"agendamento_id": 107,
"laudo_base64": "JVBERi0xLjUKJb/3ov4KMiAwIG9iago8PCAvTGluZWFyaXplZCAxIC9MIDExOTczIC9IIFsgNjg3IDEyNSBdIC9PIDYgL0UgMTE2OTggL04gMSAvVCAxMTY5NyA+PgplbmRvYmoKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKMyAwIG9iago8PCAvVHlwZSAvWFJlZiAvTGVuZ3RoIDUwIC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9EZWNvZGVQYXJtcyA8PCAvQ29sdW1ucyA0IC9QcmVkaWN0b3IgMTIgPj4gL1cgWyAxIDIgMSBdIC9JbmRleCBbIDIgMTUgXSAvSW5mbyAxMSAwIFIgL1Jvb3QgNCAwIFIgL1NpemUgMTcgL1ByZXYgMTE2OTggICAgICAgICAgICAgICAgIC9JRCBbPDNlYTNlMjllZmI0N2EwZjJjNjc2ZGEzYjA5MDYyNGQ4PjwzZWEzZTI5ZWZiNDdhMGYyYzY3NmRhM2IwOTA2MjRkOD5dID4+CnN0cmVhbQp4nGNiZOBnYGJgOAkkmJaCWEZAgrEWRNwHEbxAQvUXiBXNwMR4dS5ICQMjNgIAFBQGMAplbmRzdHJlYW0KZW5kb2JqCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCjQgMCBvYmoKPDwgL1BhZ2VzIDE0IDAgUiAvVHlwZSAvQ2F0YWxvZyA+PgplbmRvYmoKNSAwIG9iago8PCAvRmlsdGVyIC9GbGF0ZURlY29kZSAvUyAzNiAvTGVuZ3RoIDQ4ID4+CnN0cmVhbQp4nGNgYGBlYGBazwAEWm0McABlMwMxC0IUpBaMGRjuM/AB9b1kO1DDOoMBAI7cBd8KZW5kc3RyZWFtCmVuZG9iago2IDAgb2JqCjw8IC9Db250ZW50cyA3IDAgUiAvTWVkaWFCb3ggWyAwIDAgNTk2IDg0MyBdIC9QYXJlbnQgMTQgMCBSIC9SZXNvdXJjZXMgPDwgL0V4dEdTdGF0ZSA8PCAvRzMgMTIgMCBSID4+IC9Gb250IDw8IC9GNCAxMyAwIFIgPj4gL1Byb2NTZXQgWyAvUERGIC9UZXh0IC9JbWFnZUIgL0ltYWdlQyAvSW1hZ2VJIF0gPj4gL1N0cnVjdFBhcmVudHMgMCAvVHlwZSAvUGFnZSA+PgplbmRvYmoKNyAwIG9iago8PCAvRmlsdGVyIC9GbGF0ZURlY29kZSAvTGVuZ3RoIDE5OCA+PgpzdHJlYW0KeJydj90KwjAMhe/7FLkWtiVt0x8QLwZu10rBB1AnCBOc7w+m22AKIiKhTfqlJ6clQImCZAvWwLFXd5UJRydAl5E9MQxndVjBTXqlZ3Q6ej3q3k8iJsixb2EqhouqWgOXxzjTRwtE2uRx3d9EHjYi1H65hNlzKsSzTqpqLNgAqVO0/BAh9Ur0BVkN6QRrlCGIrBGtkxxkodQ5k6y5h2Zm9ZwFcWZN7m8gXdU2fTdl40pNwfOrN5rftDaWbF0In7U7iSd6t1rJZW5kc3RyZWFtCmVuZG9iago4IDAgb2JqCjw8IC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGgxIDE4NDA0IC9MZW5ndGggOTM3OSA+PgpzdHJlYW0KeJztewl4VEXW9qm6t/fu9O1O0t1JOumbdBIkzZoEQkIkHZKwGNkjkyCRBIgEBBII64xiUBGNKMgoKuMI7ts4NgExoH5mlHEUUHAfUdnEhXEy4HyK45L099btDoaZMfg88//P98//zL193jpV59xaTp06VbfTIUZECkAmmjBlYPbGAa0LiZgVpVOnlo6rnLhx3lfIzyZy3DZrQW0jWWkUkfNvkPebtWyJuqnxjWVEselE+kGXN85ZsLzPo9BPqCDShebUNjWSh0xEPlm0Mmf+yssbTsofEKlGImtL/ewFK469V7QRVd1GZDLW19XO3pt/Zj30D0J/aD0KnAush4mG3I18ev2CJSuGntSVI9+OPjXOb5hVm3vj4EuhHwf57gW1Kxp13PpLorxByKsLaxfU1RZbk5CfiP4samxoWhLOok1EhXuEvHFxXePnTyw6jvwJInMnMekGtoF00N2sy0ELSZFUep0u506jjlv0MheXGM0517iGhQ0UDOPSvdk1ieUYRrDWIDHkowoSSUxcOklinDHy6P5saae/GcNkJGO4CzYyhTvJTGaghSxAK1mBNrIBYzS0UwxQITvQAfyenOQAxpITGEexwHjgd+SiOKCb4oEe4LeUQG7wiZQAPokSgV4NkykJmELe8Dfk01ClZGAq+YBppAL9wL9ROqUCMygNmAn8mvqQH3gBpQP7UiYwS8MA9QmfoX50AbC/hgMoCziQAsBB1B84GPgVZdMAYA4NBObSoPCXNETDoTQYmEc5wGGUG/5vytewgIYAh2tYSEOBF1IecAQNAxZRfvivFKQCYDENB46kQmAJ8AsqpQuBZTQCOIqKwqdpNGbsNI2hYuBYGgm8SMNyKgFeTKXAcTQqfIrGaziBRgMn0hjgJBob/gtN1nAKXQSsoPJwB11C44BTNfwZjQdW0oTwn6mKJgKnATvoUpoEfjpNAVZTBfAyDWfQJeHPqYamAmvpZ8CZwD/RLKoCzqZpwDq6FHg5TQ+fpDka1lM1cC5dFv6M5lEN+Cs0nE+1wAU0E+ULaRawQcNGmh3+lBZRHXAxzQE2abiE6sOf0FKaC1xG84DLgR/TCroCuJIWAH9OC4G/0PBKagBeRY3AVbQofIKu1rCZmoCraQnwGloa/oiupWXA6zRcQ8vDx+l6WgFcSyuBN9DPgTfSL8LHqIWuBN5EV6FkHfAY3UyrgLfQ1cD1tBq4AXiUbqVrgBvpWuAv6brwEbpNw9tpDXATrQXeQTdAeifwCN1FNwI3U0v4MP2KbgLeTeuAv9bwHroFuIXWA7fSBuC9wA/pProVeD9tBD5AvwQ+SLeFP6CH6Pbw+/QwbQI+QncAH9XwMboT+DjdBfwN/Qr4hIa/pbuBT9KvgSG6B7gNeIhaaQtwO20F7qD7wu/RU3R/+I+0U8On6QFgGz0I3EUPAXdr+Aw9AnyWHg2/S8/RY8D/0vB5ehzYTr8B/o6eAL5AvwW+SE+G36E9FAL+nraF36aXNPwDtQJfpu3ht+gV2gHcS08B99FO4H56GvgqtQFfo13AAxoepN3A1+lZ4Bv0XPhNehP4Br1F/wV8m54HvkPt4dfpXQ3/SC8A36MXgYdoD/B9DT+g3wM/pJeAh+kP4YN0RMOj9Er4AB2jvcDjtA/4kYYnaD/wY3oV+Am9BvyUDoZfo880PEmvA/9Eb4Rfpc/pTeCfNeygt4B/oXfC++kUvQs8reEX9EfgX+k94H/TIeCXGn5FH4T30Rn6EPg1HQb+DbiXvqEjwG/pKPA7Ogb8XsNO+ij8CnXRCWCYPgb+J6b/34/pX/ybx/TPf3JMP/kjMf3kP8T0z34kpn/6DzH9k58Q00+cjemLz4npH/1ITP9Ii+kf/UNMP67F9OM9YvpxLaYf12L68R4x/dg/xPSjWkw/qsX0o/+GMf29/6WY/tZ/Yvp/Yvq/XUz/dz+n//vG9B87p/8npv8npv/zmP7y/wcxnYhr38sQIrJETEtlRGFRLiQkvrsBQaLbTQmgRN3DlCBnCh2sQMLqRNo1N/yZkIuU/wmPtUWJ4HFPsLnwrOfpBXYaTz0J79iBeXQjxt2NdXkbVpYeseZlrKrJuHUov40lhHcgAt+LPt2LWXUjOq2CP7mYB/HhalojvYmn1mC/SUPsnIhYcTO7OLwUUeqIfC0i8cWIIY2sOVwZviW8MfwA1sEu6WVtr0pEfJqFWfmL7o9YGf3xxO1YbUfYRtNTiMU/QzzYJf0akWazVC2z8BzsNhJ2l+Xog4zo+ipr5wHUXkefMg+7UipBLfeHQ+E90PIiOtZjze5mQ9honqqbHh6HuXShjRWo9S6snp2427AGDjGr7nT4AcTrBOw7YzGeHfQaa5e6Old3FcFiOlipL/aQsRjXf8HvDzI/+x1v0Fl12bqg7ufw5DjsSJegtw/jyU/Y13wV7qull+RR4ZHYfdcg3sDaWD3HWCIbyCawqbwvb+D3SIuxf/fDs4MRn+fC3nei9sMswHZyKz8g3S8/Ln+nT+46Go7BjGQi8vyafsdsGKnKmtg17B32ES/hM/iv+HHpNvlR+Q1DLUZ9GaL2zYgiXzMnG8YmsUtZPbuSrWW3srvYq+wg+4wX8wp+BT8l1UuLpOfkkbinyE3ytbrrdTfpP+uq7NrT9XrX1+Hs8PXYp65ELL4Vc3IPRrYLa/g93EfoONMxC4vBrbJUdgn7Be5V7GZ2H3uEPcp2oJWD7Dg7yf7KvmLfCcflep7EU3kabj9fzJfz2/jd/ADug/zP/BvJLaVJAWmIVChVSQ3o1VppA+6npGNyonxADsPO2bpNui26R3SP617QndZbDdfg4LP/+/s7szoPd1HXDV2bulq7diCyx2MOE2EFH3b4SdgHa7GrrUBEfxB+/iazwnaJLIuNYBfDMjPYPLaIrYAlr2Ob2YNa33/LnoWV3mWn0Gcb92p9HsCH8JF8Au7LeB1fxDfwjXwHf4d/Kxkki2SX4qUsabRULdVJS6SV0iYpJO2XPpSOS2ek73GHZbPsk9PkTDkgj5ZnyEvle+RP5U9103X7dB/rzfoF+uv1bfovDEMNIwwTDZMM1Yb1hp2Gt4w18M4XEdGf7vmNLjsqrZbKpKfoFp4jJ/DX+Gvw5xk0WxrH4an8EXYDv4rt4Om6FfrhfDgbT6flTNj6Jb6Fn+HDpXGsnE2heXxwpDZ9nPwYkkL5ReqQn8XYXkPNK/RWtoqf0luplRHPR5u/lwbJAWkfHZKOMIN8L70vm5mbdfCHpYnwgufkEbpKSpXupt9Ki9hV9BQvIzJ/Z1wHPx7PHkNcqGDZ7G9SmCQ+Hl6UJ4k9/Qr+R0TX5di/72Cz5TnYo3PYlYjJD2FV9NUt1Gfp49krfK7cwmPZDuLyoxhdPktnki6OrmPV0mb9Kf4ezhsHZDMdln6D3h/gv5XGyad1k1k9VsBVOCUsCq+mlbpK+Q02hyQ2lTJksc9fKWXLqUhx3kC0GQgrexDJ2qhYGocSDzznYvjFJYgQm3HfiTghw4PmYo3/DFHsNdqhr+BtNEcXwxB1iOR9XZNxtnoIu/YcnGw24mT6Fs4PV6LGR7DfrKdH2JquX+DclIKVc5hdrBvFD+hGhfvzFv4en8I3nTu/sHYG82An+hN2/VE0QvcMtcjv4oxYFF6HPTce5+U09GwmzponMMq/oIUxUjvldI3n28KjpEaM9wjOhw+HfcyME9l8nDqfpQcNOqo1BILFxcGiERcWDi/IH5Y3JDcne/CggQP69wtk9b2gT2ZGuj8tVfWlJHuTEhM8bld8XKzTodhjbFaL2WQ06HWyxBn1K/OPqlFDmTUhOdM/Zkx/kffXoqC2R0FNSEXRqHN1QmqNpqaeqxmE5uV/pxmMaAbPajJFLaTC/v3UMr8aerXUr7axaZMqwd9c6q9SQx0aP07jN2i8DXxqKh5Qyzz1pWqI1ahloVHL6lvKakpR3TaLucRfUmfu34+2mS1gLeBCbn/jNuYewTSGu8sKtnEy2tCpUKK/tCyU4C8VPQhJGWW1s0MTJ1WWlSalplb17xdiJbP8M0PkHxmyBzQVKtGaCelLQgatGXWuGA3dpG7r196yrk2hmTUB62z/7NrplSGptkq04Qig3dKQ++cnPD9kUbmzpHJtT2mS1FLmmauKbEvLWjW0dVJlT2mqwKoq1IFnecaompZRaHodjFg+RUVrfE1VZYitQZOqGIkYVWR8df4yUVIzTw2Z/CP99S3zajA1iS0hmrwytTUxMbgLh+HEMrWlotKfGipK8lfVlnq3xVHL5JXbE4JqwrmS/v22KY6IYbfF2KOM1daTqTsr0zhNXXDlk89aloke+cfCIULqLBU9qfRjTMME1A2jllnDoIariuGp0GzMyNyQqaSmRSkQ5eL5kC5D8astXxE8wN/x53NLaqMl+gzlKxKs8JOzrgZ5Nx8KBEJZWcJFDCWYU/RxhJYf0r/fsjbu9zcqKhKYjybCtrVVBQNh/tRUMcE3tQVpJjKh5kmVkbxKM5NaKTgwUBXiNULS3i2Jv0RImrslZx+v8cOTd2hHwfiQMfPsx664YsvqC0LM1Yu4LiIvn+IvnzStUi1rqYnatrzinFxEPuysLMqFYksqpSQe5XiSpEnhlNPPKotMpTUkZ+Cj15x6dpvBCK/USpg6KqTUjIlglTk19Sc+1BY+LZ7Skh8ei3YzVBA4Nz/8nPw53bO2SOgwNsHyimktLeZzZHC1SINjowk8nioqU9WSEF2ClZmBT1u4fZigqqRQECYrEQrwv0hRNHuOYlKUr8IlvLN/v1EIdC0to/zqqJaaltq2cPNMv6r4W3bxF/gLLY1lNd2O0xbefVNSaNS6KtiqnhX0194DjDg8OcSfbLV3gqH/R+/H/pWbXYj7eM+b5/J90iU4s62M3kd0deLWl4ltTbzBvP7nW0obKmbYC78yJhm13e6+j/pkifSpC1tf/vbJzjlKgfFiZE2avrg40w7gOmELA43cwdkJvaGN3xWMJZ18QiKzQT7BKMGo153g0rM42JhwzB1AnoByprCzcLzyZeG4zkIqAq98Dxg8KNWR6sgAMGzr36tS+/dBHV7JVLldvGHdg7am4b3JTsl0XTBT9bESozc5hTPuUFLsZHRnqiZmSvQlKypT0cfqlOHTRVPVov4z1R1aQ0VaOyUrg0OlJINRb9QZZaOsT/AkerjeYraabWZJH++Kc8W6JH2S5E5lzhiAx+hNZS6zI5UCARYIZOFazapzHKnZbpfb5YyP4zHcn5GaPTRv6NAhuZl9Mv2p97BvHp+2qmpJ0/if3/rqmq5tLP/WBweXjbtj/vgnuvbrdscnXzyz68Ceh7u6Hq3NfmLo4LKTD33ydVaKmIuJ4c+kDnkETsqvBkebrMznLYktcU+JneKuia1x/4r/Stpse0B5INFqtCWY5/G50jzdUmujrdn2kPUp007zU1ary3q99SMuxaTNsDfYr7ZLdtbGHwuOHYSXtolUg+POBtqKl/HTmEq73YJjktNrMXi8ssVrZ/b0mLQk9CLdEvAxRoyxsd749AMG5jMUGbhhcFLuHs2oizoAi6OLfBcWAVZVx+IvOxZTUUdRhzN/oCN/oFJ9Ap/Bg6h6EcPHrdf708iR6xyak+1yGzIz/Wn6+DhXTvZQqXBb8qnfHur6evHJG5/4wPdkwtXTbnjsgevm3cLWuJ8+wJKZ+TeMr37y3qQr5r/45jsvXANvKA9/JqfASvHwhsPB2T7yxvNLpGpdtekSS510ha7BVGcxKqQwhfdxvqf7Nu5MomGwsyBhsLfYOS6x2DvJOT1hsrfWuSCx1rtCvyL+DD/jUfDObLe53RNdNa5Gl+Ty2jcoWxWuKHKS12wgYUQTuz0WhnIHbYgjQVOfrNyQjdkSfchtz8jMFWkwOcWfO8jHfK4cJd0QTM/KFaabYJAMCSm5eZ4A/L46MK7zxHhlUSBwZlFgHDyzo/OEZjT46qJC5nDm5zvzBw9i1VTNFi3uNpxCOdnkiDOkuoTNWKrwszS9dNnufn/ZdbLrFIv74G289H3/mbl1zax1nYf4JOuwqTde+Sib6r5/B/MxCW9YF3Qd7vpGUZ/cXc9uv76k/iHhb9cC8rCuJFq3i3QYR96wXJ0YT+6QSDpocCRNy9DSYEa8O9eu8+GV74hOngA4rZN8ukZdsy6skxESzFzKYNQWqUmkwcScIblbiLXD5TiRSuKrIJnGy6MnRnxpcSBQKCJBkRizyOHKceQ4rt2h2/3tKPRxLd6HMjHbfnppF5nCfwwWW2y5GfIJ+YTpmPtjVfe27ozK3UbVb/IkqSZJ8qd49fFei0VvYHp/YoJiPpjBNmRszeAZbndiTMYGB3O0seqnPBkbklgSuGAC8Rx/BjtITKwN7qMinM4lSkjPaGMrtqeKjgbGf4m+IWSdwAR2fFndOb6srvSTRXD4wsLCoqLCcUqH0uFw54vpE7OHIBNjjYvNjLM6kpjTFp/ESASP1WJWxejih2rrQEC8w+/IjawHjQMDbu292Q/NW3aHb9Xeex7b7p8+ovG2HZWzL15dIGfePn7GzMrdT+7s7MN/PX9Gwe0PdN7BW1esmLj51s73ItaSPoG1XLQ/GKuT9LH8EaVN+Uj6NPa0dCZWL2PnDg6GAVcq7E7loOeoJ+yRVWNcTJzL6dXBYi6b2RZjjUm3BHOG5oYtDB/LeI82kblDc0Oe0x7e6NnqCXnaPbJH4jnxrsh8B53QPy22h7NT7BbTKyb3y0IFjMh0FCoi6BcVdTjyWdRQLr3DZDaaDYi+SqZDH5PE7GZn1GAi1C6iQPUizWawFkJuT4OtvW/phzX3TlTMO7KuGNP0sJx5x5NljeOyr+ps4tcvXFC8cX/ns/C6UsSLPrCJjRLod8Fqp8GcYB2tH2Ocqq8yztHPNRpzlQJngWuIp0wpd5a7yjzTddNNk5VqZ7VrsmeBboFptrLAucA127OcxZv0OtulUoWuwnypdb6EXdQ832p2e2WDAy4Xl24QpohNz8gdZGBkUAwqlv7gI8LRUJ4gggP4mHQKQkU4GqfBiSIwwFSBDgSF6jPVYLQ4ivWwqJoW4UAWNE3RTTHN1M00yay6KlbJgyUoPk6LDLFaEB2i+U3pAzf+/n3m+sXnNx3p6tjVuvb61u1r1rbiRb3PLcu6jnW++vk1LIXZ9u/b//rv9+1F02u75sqpsIsT78AHgg9alf7KhUq5IhepIZX71L5Wf3J2fHbyyORGdYNqLHAXJF3kviipynipdbp7etI84xXWucoC9xVJ7eqbcR96Pkx8M+VE3ImUo2pYdfnlgBKIHyIXKKPki5RpyseWz5O7FIsjBpHVK1amyxtjoZiE9INmppiD5hpzs1k2L2GxOTzHmUHUztgGtpWF2Gkm+1gRm4AQluAbnedhWgwVa1Hp/PKE0onNCLGjQ/Mo4VCImpDSotjuRYY3Zg5DZfZxSD1MtfaBgo31Nxyct/TIL6atH+B4aNmKxx9e0rSta67uuZZJk9aF77y/67ubLi7o/E564NU9+97et/ddsS+G/8qzdHeRm5p3kRkxzp+ZaxITWwymOQE7ptVmZhK5FFPAbsYQJYtdSaM0ZnNmWFnYYCwzldUYGg3Nhg0GmeAbWw0hQ7vhoEFv2M3nkYcN3XZ5JChiZB3i6HLiy0LhC2DF6Bw5OcorIkwGAhluMabMIQ7/kBxHHsbqd8SJrYEriRcXzpzf77rrtj/1VGzggpR7tygj6u7js9Yxw/yum9d1/nJcv0Qt8uOkcVT7dvq5XZQo9jNEdq7GunLtIkT0dcblBmJZujHWZWWxLouezA4Mh3JcGR63FhrcrN3N3OMTxfjjRWhIPJ3IGxO3JoYSw4lyojVDs0y8iAomRibVdNB01CSbxid0B374ezQqFHaeEKMsKszXAqgWFRJlJcZmt3F95KSG2CBbk8hmdCSRiAw4hGGmsVWkDtEM0QemyHHEubXtcajgpaIr377s/gmKZYfFsXDSpFuG77h7x5gFE4Y08Y2d228ePHrSlPU38PzvDsEWdsTML2ALhS1/2u5k9rSEfH1b+HBwZ0L+NPsmeZPxrpjN9nZdu77dsM9usgdd+YlSrCnelqgMYQWW1ewWi3Gg82dylaHKUhlzB7vTfKflad5mfdmyN2a/ckh62/S67X3lY7PTqddLBqPJxPR6k06W4B12DNLG7HabYoGNuM0iWRWz3s7tZuUlesnElQwyxeHYLXHbSzhrZFilOKtVMpuwzXG9YrNZrWSe4GTOsbZV1jSzvVZvWhU0t7Gkp4P6ifpmvaRv4yXBGFVaxdMmYKBjHVdGTnBfdiQmdFZ3Jno6lI+VLzs+qUZQVnBHcK1uQKB67VV71g7wBKqvUvaQOJTY7WuNe9bGKHsiiMQQoxQWGnGkZohRO2I8yfkWYTVLcr41zZ0vgUS+NTVfEZ5gjs9naan5pqA3PxC9qrTYjmN1dQ5jOThOD83LA+eX+jA7u67rrmP3D/D2y9j+btet7KYPDxV0neQXsK5vRg8amfNdl7XzNXZRVVd15G1E/B2mxmI0Rv5Cc77L0LtYjzvyjmPU6wUr6UUhWS2mn1a/6Xz1RzsgWQwGwUoG8SpFNotZ+131v1q/4e/rlw3amO02y0+r39K72EjGaP02ozA5yUatfsVm/Wn1W89Xv+ls/SbTD/U7bDbNTv9q/aYf6jdF6jdp9ccqMT+t/pjexeZuA8qK2SJYnVmbs3hFoW7X6vWy9y62dA9QVixWUb/eIholT5zzvL6tXY7exVYclLRLHxdjE2M1xGg+keSKo+6p7/WK610c0z1AvctuF6zRrs1ZcoLrp9Uf37vYTkqEMSQowuSEd0ExJDXJc961o13u3sVKtwENSU6HYE1OzSdSkxJ+Wv2e3sWOnvU7o/XDRBk+rzbP572SehfHdk+QwRcfL2xpjtd8IitdPe/a0a6U3sXx3QY0p7vdgrUCMLUDMv3U7Vq9Xqm9i92UGK0/MzFRsLZEbc6yL8g879rUrvTexQnkjTDWC7xewcZ4tTkb2r/vedemdvXpXZzUbUBb/+QUwdqTSQypYHA/6nbdXq+s3sXJeAWL1D9YVQWrADCEkvxsMfnnvwb1Lk6jjAhjz8/IEGxshnjro/KiYeddm9o1tHdxZvcAHUVZWYKNz9LmbMroEeddm9pV2Ls4iwZEGOfoAQME6x6g2XT6uDLqdq1er5G9iwdQToSJG5eTI9hEQH+i2RXl1O1avV5jehdn07AI46oYNkywXoD4yzFevg0jusZTiULfPtmVoxSc/ba2+5qu71Ek/ob8/9Kl+4P4nvd/58KxZaKWNlH5j+mwP9C1+sdoLXQElYq0pxz2TEfZtT3qtGvmng4oolk4W3Cs74HCf2SruRNnSfHLoQFc+GDkXNkl/kav8YzMfHiU5xTD+0d5iS5jB6K83ENHh9fHp6O8nmLYo2cn+mqWFeUZ6VhGlOdkYClRXkKfTkV5uYeODrvBR1FeHFo/EL98kkWvrXRQ4yMjatd4vVa+Q+MNWvkDGm/U+Ns03hQdY4SPjDHCR8YY4SNjjPByD53IGCN8ZIyCN/foj0Vr6zqNt/Yoj9H4FRqviLZonsbHgndSpcbH9dCP1+oZo/GuHuUJ2rMFGp+k6WRpfHIPHV8PPl3T92p8lsbHaHx/jReWZ8Ye/Tf2aMvao9zaPZZiWox7KS2kJVQrftvJQuxeTPlCmkPjUbIMNBu5BuQaoLmAjtF85OvkFHmwXC6Pli8E5p+V1mrSlTRFq28hnhW/zFmMtKdG3Tm1/SARsrnSZmmb9Jz0PGiXtFv6zTl1LY72prumBppJK5kNNc5D+cmerRQvnls7f1zF1LrFTXMbFqrZA4Zli3+TXLKysa5Ak6mT6+YsnV+7uKCninrBuLmzFjc0NVy+pG9UrilX4LHLa2fVqY+qFfV1andNaknD4saGxbVLxPON82cNUEtrl9SeR2mgqEyd0jB/qShpUscuxHOD8/MH9QdkD1CL56Nvc+fUL2lCF5vqFi+rm61N1FxtyOOogqZiwIupCSUNGLYqfiCNGJ4NWYNmniWYgkboFPR4TqXJKJmDyZ6vGbLgR2tR6QLUNBcBZjEkTaDLUWPfv3v+h5oroq1djtwspCo9Cqqgeo3/+z6pVKJNUqOGwum6229EXbPQB5VKtfLaf7GmgWd7psKJGlC29KxOE8rGih88a+0Npnzcg7CpRrhsrbQYT0TsNhfjrsezTVErNmmWWwacTWdjLYX7iP/t/cer2E92yU2nQGGQRD7gQNAE0AzQetAWkF7TEyUNoKtBz4NOa5Kg5G7dmBNsQ3KTlmyfNz9by9ZGstOrtez2n1VF0nGTImnp2IhaQURtcG6keMDISNqnXyR1ZmQ3i9Rsy24vdkkuOiiJ4NEIZHwP2RkjH22V4ikE4pI+WhKUnNvTM7O3PC/JxCQuMVjEF26XWKvNkV1s5mF+CgHRx//COyIS3rE9xpG9pfgifpyeBD0Pkvhx3Mf4MbqaHxXfnwGLQFtAz4MOgE6B9Pwo7iO4D/PD0PqQBoKKQDNAW0DPg06BDPxDoMI/ELuNhoIvAnH+AVDh72NY7wPt/BC4Q/wQuvZma15+9i6NCQyMMr6MKONOijJOV3Ybf6P1m76+Nv7RdjXg21o8iL9FIRC2X6ACUkETQTWgRpAe3Dvg3qFm0AbQVlAIhBd4oAJS+V7QftA7NAgUBE0EGfnBVjTTxg+0Zo70Fbv4a/wPOLf6+Kv8ZS3dz1/S0n3891r6CtIUpHv5S60pPiq2QE54RkGqIB0IuY7/bnu60xcudvDnYR4fcCCoCDQBNAO0HqTnz/O01tk+Jyp5hvbibdrHW+mklj5E9xkpOM8XzCyBj6kCMgsuBAfYom7J5MHMTXchKyDzlo3gBGRetw6cgMyfrwYnIHP+MnACMmfPAycgc9oMcAIyJ1SAA7Txe55O7+PLm3AFU4vtfDmstBxWWg4rLSeZLxc3fSOLvv2qNSsLFtscDPTN8jXvZs3PsubJrPk+1lzHmlex5tWsuZA1X8aaA6zZy5pTWHOQNT/DhsEUzSy445xsftDDmvey5idYcxNrzmTNGaw5nTWrLC/YxlNbx+ZoSZmWbC8W6wrphSOy7ehjKiyaCrdOxbJ/HngAFNZyQSipaRHlhBSRpm3PKorkBxRkNxSP4S/iwRcxDS/SEZCMCXoRbvQiKnkRFdiBRaAZoHbQKVAYpId2Gjq+XkM7cCCoCDQDdDXoFEivdecUiFNDtItPah0bGO30BJHjL+IWv+ZN5anBZMWrBJQx0novs6ewCSnhFJ5HLryJk9NhdLQx286vbX/72kamYhO/ha/Hi6OPb4im61u/Sfa1sTtbM5/xFcezOyhFhtexfMrE8dAHSzdp+SHkNYo0l7z8caTZrd6peMzemtnPt5vFiKd2+r7xnvCd9LZxsJ95n/G9q7bJrNX3Nkoe3+l7y3uj75WBbUaUPJvZxpDsVjXVXd5hvif2aqqrIdjc6lslkp2+q7yjfVd4NUFdRHBZE3JBu29y5jTfGNRX6p3pCzahzp2+Iu9lvsKI1hDxzE7fIHQhEGGz0Nm+Xq1Rf4pW4SV5baw+2M+wyVBpmGAYasg29DOkGnyGZEOSIc7oNCrGGKPVaDYajXqjbORGMsa1hY8GA+JwHadXRKKXBcoar3CBXDt7E2dGThdRKFYq5+VTRrLyUPssKp+phs5M8bcx86RpIZ1/JAs5y6m8YmRoWKC8zRCeHMoLlIcMEy+t3MbYLVUoDfEb2hhVVLaxsChakyR+iriLGHOsuTlJpBesubmqijyuZUWeIucIR/6o0n8CNVEM/HB5zuGTQ5vKp1SGHkuuCmULJpxcVR76pfit4i72V3a6rHQX+0IkVZW7pBHsr2WTRbk0orSqqryNTdX0SGVfQA8e84WmZ0whVeiRakyJ6G2O6GXgeeiliwR6JhNlaHoZJpOmJzOht60pvax0W3q6puNWqUnTaXKrPXX2ZkAnI0PTcTXTXk1nr6tZ6IRGaCpeL1RSvJoKSySvpuJliZrK1B9UBkZVbjyrcqPWksR+0PFGdGxHu3VsR6ET+KlX3chAgG0fXjVruvidZ42/rA5UE7ppWb0n1DxTVbfNqor+ADSzZuasepHW1oWq/HWloVn+UnXb8On/RDxdiIf7S7fR9LKKym3Tg3WlrcODw8v8taVV20dPzM07p60bz7aVO/GfVDZRVJYr2hqd90/EeUI8WrSVJ9rKE22NDo7W2iLNxydWbjPSyKqS6ZF0O7eY4a81SalVI11K4wjNeYenelYl7caB5BGyBKpCVv/IkA0kRP2L+xcLEdaUEMWIH/NGRZ5Vw1OTdrNHoiIFxQ7/SAosWdq0lDxlc0sjnyZcKFqyVBg8goGmH7sgKwsFa0ublhCVh7KmlIeKJk2r3GYwoLRGDClU0F1msZS1hdsjhQNQWCAKJemsoigrFGUmU1TxH+d/aTQtEaugmT+znQVTGI6tVVIopbyCIxRURH81uRvHJbE9NFVhgE0swJq669C6TRGexHi7acnSKBe1w5JoGnkKjzR1m+PshWcQqv4HUWaVF2VuZHN0cmVhbQplbmRvYmoKOSAwIG9iago8PCAvRmlsdGVyIC9GbGF0ZURlY29kZSAvTGVuZ3RoIDI3NiA+PgpzdHJlYW0KeJxdkc9qhDAQxu95ijluD4uuq+4eRNhaFjz0D7V9gJiMNlBjiPHg2zdOrIUGEvgx830zmYmq+qnWykH0ZkfRoINOaWlxGmcrEFrslWanBKQSbiN6xcANi7y4WSaHQ627kRUFQPTuo5OzCxxucmzxgUWvVqJVuofDZ9V4bmZjvnFA7SBmZQkSO+/0zM0LHxAikh1r6ePKLUev+cv4WAxCQnwK3YhR4mS4QMt1j6yI/SmhuPtTMtTyXzwLqrYTX9xS9tlnx3ESlyslF6I0JUpzovwc6BooI8oeiS5XqrL5Jb/uezPpndKyUCWvgjZUyYLhJd0sgmjteZ3tPhAxW+tnQQugIazfVxr3HZnRrKr1/gBZeouxZW5kc3RyZWFtCmVuZG9iagoxMCAwIG9iago8PCAvVHlwZSAvT2JqU3RtIC9MZW5ndGggNDgwIC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9OIDYgL0ZpcnN0IDM4ID4+CnN0cmVhbQp4nH1Sy27bMBC89yv2aB/MN0UKCALYcd0YhVMjdptD4ANjMSpRWRIkGqj/vks5cdweCkIktDu7M5wl58CAC5AcuAStgSvgBg8NgufAM1CKfbq5AbrumuK49x2MNr+Co+v5Ag5Wj+H2dkjPVkAfmu7gKqB7B/wSd71fNHUEOu2Cq1ZboHPf731duDqmRA/PiYbBI+yAfq73TRHqEuiy8HUM8TS5B7o5vsRT64FucWd4NN/rgEAP+VA4xIEOPG+8d80RfzjQr6FIFBeGM3TtSt+/Y6dJT4ScaSKMVAqrXXvvQ/kzguGaWMHQnzfdESaCc5JzxTKkrFzZgzpzz2bNb6SaZJkiWjNjYSKFIoYZJkEwYYnETsCZNISzXNqkJxUuQuUF2PNdUuDBHfyVY8voqrCf1mXlEUM30R9+gEJhuVXY5er6SWMX2th0/xnA3XK+OfXYZFm/NpBA37rCd8n20bvtY6CPvgx97E4wmhbNix+nObRt5Q/JBIb9h07b5styvnLtx8TQqack8x89+KSG+12GicUJksSLv0ZIn9BFhp/RDNISxhA7eLcDmaeEEIRnJjcYMAmpWcJpnRGuhVQpnHDigrNSEoYj4ZjCzcorsDUJeuH4SAw9sfMOF9r5B58d2vZlbmRzdHJlYW0KZW5kb2JqCjEgMCBvYmoKPDwgL1R5cGUgL1hSZWYgL0xlbmd0aCAxNiAvRmlsdGVyIC9GbGF0ZURlY29kZSAvRGVjb2RlUGFybXMgPDwgL0NvbHVtbnMgNCAvUHJlZGljdG9yIDEyID4+IC9XIFsgMSAyIDEgXSAvU2l6ZSAyIC9JRCBbPDNlYTNlMjllZmI0N2EwZjJjNjc2ZGEzYjA5MDYyNGQ4PjwzZWEzZTI5ZWZiNDdhMGYyYzY3NmRhM2IwOTA2MjRkOD5dID4+CnN0cmVhbQp4nGNiAAImRt1NDAACFwDlCmVuZHN0cmVhbQplbmRvYmoKICAgICAgICAgICAgICAgCnN0YXJ0eHJlZgoyMTYKJSVFT0YK",
"profissional_laudador": 1,
"procedimento_id": 1
}
Exemplo Resposta
{
"success": true,
"message": "Laudo registrado com sucesso"
}
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| agendamento_id |
numeric | número do agendamento no Feegow |
| laudo_base64 | string | Conteúdo do arquivo em formato base 64 |
| profissional_laudador (opcional) |
numeric | Identificação do profissional laudador |
| procedimento_id (opcional) |
numeric | Identificação do procedimento (para agendamentos com mais de um procedimento envolvido |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Visualizar laudo registrado
GET /medical-reports/search
Visualizar laudo registrado no Feegow a partir do agendamento.
Exemplo Request
GET https://api.feegow.com/v1/api/medical-reports/search
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"agendamento_id": 27015,
"procedimento_id": 1
}
Exemplo Resposta
{
"success": true,
"url": "https://functions.feegow.com/load-image?licenseId=100000&folder=laudos&file=136.pdf"
}
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| agendamento_id |
numeric | número do agendamento na feegow |
| procedimento_id (opcional) |
numeric | Identificação do procedimento (para agendamentos com mais de um procedimento envolvido |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Pacientes
Informações
Exemplo Request
GET https://api.feegow.com/v1/api/patient/search
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paciente_id": 5,
"photo": true
}
Exemplo Resposta
{
"success": true,
"content": {
"nome": "JOSE RENATO BARONI",
"nascimento": "18-07-1998",
"sexo": "Masculino",
"endereco": "AV THIAGO CASTRO",
"numero": "05",
"complemento": "CASA",
"bairro": "CENTRO",
"cidade": "NATAL",
"estado": "RJ",
"cep": "59022020",
"profissao": "Funcionário Público",
"foto": "https://clinic7.feegow.com.br//uploads/105/Perfil/2a0f36efcad971ada76383844d963285.jpg",
"telefones": [
"2907-1177",
null
],
"celulares": [
"99762-1587",
null
],
"documentos": {
"rg": "11111111111111",
"cpf": "11111111"
},
"email": [
"josebaroni@feegow.com.br",
null
],
"convenios": [
{
"convenio_id": 5,
"plano_id": 3,
"matricula": 21212121,
"titular": "JOSE BARONI",
"validade": "2018-05-18"
},
{
"convenio_id": null,
"plano_id": null,
"matricula": null,
"titular": null,
"validade": null
},
{
"convenio_id": null,
"plano_id": null,
"matricula": null,
"titular": null,
"validade": null
}
]
}
}
GET /patient/search
Busca informações de paciente específico.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paciente_id | numeric | Identificação do paciente |
| photo (opcional) |
string | true = retornar url da foto do paciente |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
| 409 | erro | Paciente não existe |
Listar pacientes
Exemplo Request
GET https://api.feegow.com/v1/api/patient/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"limit": 50,
"offset": 0,
"telefone": "2155554321",
"cpf": "22222222222",
"origem_id": 1,
"alterado_em": "2023-03-10",
"programa_saude": 1,
"data_aniversario": "01-30"
}
Exemplo Resposta
{
"success": true,
"content": [
{
"patient_id": 999889071,
"nome": "JOSE Re. BARONI",
"nome_social": "Zé BARONI",
"nascimento": "1994-01-30",
"bairro": "BAIRRO SEM NOME",
"tabela_id": 2,
"sexo_id": 1,
"email": "josebaroni@novoemail.com",
"celular": "(21) 95555-4321",
"criado_em": "2023-03-10 14:04:00",
"alterado_em": "2023-03-10 18:30:05",
"programa_de_saude": [
{
"programa_id": 10,
"nome_programa": "Programa de Saúde",
"tipo_programa_id": 3,
"programa_convenio_id": 152,
"data_inicio_programa": "2023-07-03",
"data_fim_programa": "2023-07-31"
}
]
}
],
"total": 1
}
GET /patient/list
Lista todos pacientes cadastrados.
Para utilizar o sistema de pagination defina a posição inicial (offset) e o limite de resultados (limit).
Exemplo
offset: 5
limit: 10
Irá retornar 10 registros a partir do quinto.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| limit (opcional) |
numeric | Limite na quantidade de resultados que irão ser retornados |
| offset (opcional) |
numeric | Número de registros que irão ser pulados na requisição |
| telefone (opcional) |
string | Filtro por telefone (apenas números) |
| cpf (opcional) |
string | Filtro por CPF (apenas números) |
| origem_id (opcional) |
numeric | Filtro por origem |
| alterado_em (opcional) |
string | Filtro por data de alteração (yyy-mm-dd) |
| data_aniversario (opcional) |
string | Filtro por data de aniversário (dd-mm) |
| programa_saude (opcional) |
boolean | Retorna o programa de saúde |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Buscar paciente
Exemplo Request
GET https://api.feegow.com/v1/api/patient/search
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paciente_cpf": 34888015864,
"paciente_id": 6563,
"programa_saude": 1,
"photo": false
}
Exemplo Resposta
{
"success": true,
"content": {
"id": 6563,
"nome": "Carlos Luiz",
"nome_social": "Carlos",
"nascimento": "27-02-1986",
"sexo": "Masculino",
"origem_id": "85",
"documento": "",
"endereco": "",
"numero": "",
"complemento": "",
"bairro": "",
"cidade": "",
"estado": "",
"pais": 1,
"observacao": "",
"cep": "",
"profissao": "",
"indicado_por": "",
"convenio_id": 98,
"matricula": "3333",
"foto": "",
"telefones": [
"yy999998988",
"(21)"
],
"celulares": [
"12999888888",
"21"
],
"documentos": {
"rg": "",
"cpf": "01234567890"
},
"email": [
"carlosluiz@email.com.br",
""
],
"programa_de_saude": [
{
"programa_id": 10,
"nome_programa": "Programa de Saúde",
"tipo_programa_id": 3,
"programa_convenio_id": 152,
"data_inicio_programa": "2023-07-03",
"data_fim_programa": "2023-07-31"
}
],
"convenios": [
{
"convenio_id": 98,
"plano_id": 0,
"matricula": "4444",
"titular": "",
"validade": null
},
{
"convenio_id": 133,
"plano_id": 261,
"matricula": "34234242342222",
"titular": "",
"validade": "2022-05-19"
}
]
}
}
Buscar paciente passando por cpf e celular.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paciente_cpf (opcional se informar id) |
numeric | CPF do paciente, 11 digitos sem pontos e hífen |
| paciente_id (opcional se informar cpf) |
numeric | Id do paciente |
| photo (opcional) |
boolean | Retorna a foto do paciente quando houver |
| programa_saude (opcional) |
boolean | Retorna o programa de saúde |
Criar paciente
Exemplo Request
POST https://api.feegow.com/v1/api/patient/create
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"nome_completo": "JOSE RENATO BARONI",
"cpf": "11111111111",
"data_nascimento": "1998-09-03",
"genero": "M",
"origem_id": 1,
"tabela_id": 5,
"nome_social": "Zé BARONI",
"peso": "88.50",
"altura": "1.83",
"celular1": "21955551234",
"celular2": "21955551235",
"telefone1": "2155551234",
"telefone2": "2155551235",
"email1": "ze@baroni.com",
"email2": "zebaroni@email.com",
"documento": "12345",
"endereco": "Rua Sem Nome",
"numero": "1",
"complemento": "AP 101",
"bairro": "Bairro Sem Nome",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"pais": "1",
"cep": "20000-000",
"observacao": "Esta é uma observação sobre esta cadastro",
"indicado_por": "Nome de quem indicou",
"convenio_id": "1",
"plano_id": "1",
"matricula": "11111111111",
"titular": "JOSE RENATO BARONI",
"validade": "2023-01-30",
"id_importado": "1"
}
Exemplo Resposta
{
"success": true,
"content": {
"paciente_id": 6655
}
}
POST /patient/create
Cria um novo paciente e retorna o paciente_id.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nome_completo | string | Nome do paciente (máx 200 caracteres) |
| cpf | numeric | CPF do paciente (máx 11 digitos) apenas números |
| data_nascimento (opcional) |
date | Data de nascimento do paciente (yyyy-mm-dd) |
| genero (opcional) |
string | M = Masculino F = Feminino |
| origem_id (opcional) |
numeric | ID da origem |
| tabela_id (opcional) |
numeric | ID da tabela particular |
| nome_social (opcional) |
string | Nome social do paciente (máx 200 caracteres) |
| peso (opcional) |
numeric | Peso do paciente |
| altura (opcional) |
numeric | Altura do paciente |
| celular (opcional) |
string | Celular do paciente apenas números |
| celular2 (opcional) |
string | Segundo Celular do paciente apenas números |
| telefone (opcional) |
string | Telefone do paciente apenas números |
| telefone2 (opcional) |
string | Segundo Telefone do paciente apenas números |
| email (opcional) |
string | E-mail do paciente |
| email2 (opcional) |
string | Segundo E-mail do paciente |
| documento (opcional) |
string | Documento do paciente |
| endereco (opcional) |
string | Endereço do paciente |
| numero (opcional) |
string | Número do endereço do paciente |
| complemento (opcional) |
string | Complemento do endereço do paciente |
| bairro (opcional) |
string | Bairro do paciente |
| cidade (opcional) |
string | Cidade do paciente |
| estado (opcional) |
string | Estado do paciente |
| pais (opcional) |
numeric | id do País do paciente |
| cep (opcional) |
string | CEP do paciente (máx 9 caracteres) |
| observacao (opcional) |
string | Observação sobre o paciente |
| indicado_por (opcional) |
string | Nome de quem indicou o paciente |
| convenio_id (opcional) |
numeric | ID do convênio |
| plano_id (opcional) |
numeric | ID do plano do convênio |
| matricula (opcional) |
string | Matrícula do paciente no convênio |
| titular (opcional) |
string | Nome do titular do convênio |
| validade (opcional) |
date | Data de validade do convênio (yyyy-mm-dd) |
| id_importado (opcional) |
numeric | ID do paciente no sistema de origem |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Editar paciente
Exemplo Request
POST https://api.feegow.com/v1/api/patient/edit
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paciente_id": 6655,
"nome_completo": "JOSE RENATO BARONI",
"cpf": "22222222222",
"data_nascimento": "1994-01-30",
"genero": "M",
"telefone": "2155554321",
"email": "josebaroni@novoemail.com",
"celular": "21955554321",
"telefone2": "2155554322",
"celular2": "21955554322",
"tabela_id": "2",
"cep": "20000-001",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"endereco": "Rua Sem Nome",
"numero": "2",
"complemento": "AP 102",
"bairro": "Bairro Sem Nome",
"nome_mae": "Sra Baroni"
}
Exemplo Resposta
{
"success": true,
"content": "Paciente atualizado"
}
{
"success": false,
"content": "Paciente não atualizado"
}
POST /patient/edit
Editar novo paciente e retorno do status.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paciente_id | numeric | Id do paciente |
| nome_completo (opcional) |
string | Nome do paciente (máx 200 caracteres) |
| cpf (opcional) |
numeric | CPF do paciente (máx 11 digitos) apenas números |
| email (opcional) |
string | E-mail do paciente |
| data_nascimento (opcional) |
date | Data de nascimento do paciente (yyyy-mm-dd) |
| genero (opcional) |
string | M = Masculino F = Feminino |
| telefone (opcional) |
string | Telefone do paciente apenas números (máx 20 caracteres) |
| celular (opcional) |
string | Celular do paciente apenas números (máx 20 caracteres) |
| telefone2 (opcional) |
string | Segundo Telefone do paciente apenas números (máx 20 caracteres) |
| celular2 (opcional) |
string | Segundo Celular do paciente apenas números (máx 20 caracteres) |
| tabela_id (opcional) |
numeric | ID da tabela particular |
| cep (opcional) |
string | CEP do paciente (máx 9 caracteres) |
| cidade (opcional) |
string | Cidade do paciente |
| estado (opcional) |
string | Estado do paciente |
| endereco (opcional) |
string | Endereço do paciente |
| numero (opcional) |
string | Número do endereço do paciente |
| complemento (opcional) |
string | Complemento do endereço do paciente |
| bairro (opcional) |
string | Bairro do paciente |
| nome_mae (opcional) |
string | Nome da mãe do paciente (máx 200 caracteres) |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar origens
Exemplo Request
GET https://api.feegow.com/v1/api/patient/list-sources
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"origem_id": 1,
"nome_origem": "Eventos2"
}
],
"total": 1
}
GET /patient/list-sources
Lista todas origens.
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar dependentes
Exemplo Request
GET https://api.feegow.com/v1/api/patient/list-dependents
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paciente_id": 5
}
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"nome": "LITTLE JONH DOE",
"paciente_id": 45,
"responsavel_financeiro": ""
},
{
"id": 4,
"nome": "JONES DOE",
"paciente_id": 145,
"responsavel_financeiro": "S"
}
],
"total": 2
}
GET /patient/list-dependents
Lista todos dependentes cadastrados para um paciente.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paciente_id | numeric | Id do paciente |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar tabelas particulares
Exemplo Request
GET https://api.feegow.com/v1/api/patient/list-privates
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"tabela_id": 1,
"nome_tabela": "Exemplo"
}
],
"total": 1
}
GET /patient/list-privates
Lista todas tabelas particulares.
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Upload de arquivo para o prontuário do paciente
Exemplo Request
POST https://api.feegow.com/v1/api/patient/upload-base64
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paciente_id": 6563,
"cpf": 34888015864,
"nascimento": "2000-01-31",
"base64_file": "data:application/pdf;base64,JVBERi0xLjcKCjQgMCBvYmoKKElW50addo4ID...",
"arquivo_descricao": "Exame de sangue",
"arquivo_id": 1
}
Exemplo Resposta
{
"success": true,
"fileId": 6255,
"content": "Arquivo enviado com sucesso."
}
Buscar paciente passando por cpf e celular.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paciente_id (opcional se informar cpf e nascimento) |
numeric | Id do paciente |
| cpf (opcional se informar id) |
numeric | CPF do paciente, 11 digitos sem pontos e hífen |
| nascimento (opcional se informar id) |
numeric | Data de Nascimento do paciente, formato yyyy-mm-dd |
| base64_file | string | hash base64 do arquivo incluindo data:content/type;base64, |
| arquivo_descricao (opcional) |
string | Descrição do arquivo |
| arquivo_id (opcional) |
numeric | Id do arquivo a ser substituído. |
Listar programas de saúde
Exemplo Request
GET https://api.feegow.com/v1/api/patient/health-programs
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"program_id": 10,
"nome_programa": "Teste",
"status": 1,
"convenio_id": 152,
"tipo_programa_id": 3,
"data_start": "2023-07-03",
"data_end": "2023-07-3"
}
Exemplo Resposta
{
"success": true,
"content": [
{
"programa_id": 6,
"nome_programa": "Novo",
"tipo_programa_id": 7,
"programa_convenio_id": 98,
"data_inicio_programa": "2020-11-29",
"data_fim_programa": "2021-01-15"
},
{
"programa_id": 7,
"nome_programa": "Novo Prog",
"tipo_programa_id": 7,
"programa_convenio_id": 45,
"data_inicio_programa": "2020-11-15",
"data_fim_programa": "2021-01-15"
},
{
"programa_id": 9,
"nome_programa": "Teste Novo",
"tipo_programa_id": 2,
"programa_convenio_id": 98,
"data_inicio_programa": "2022-04-01",
"data_fim_programa": "2022-04-30"
},
{
"programa_id": 10,
"nome_programa": "Teste",
"tipo_programa_id": 3,
"programa_convenio_id": 152,
"data_inicio_programa": "2023-07-03",
"data_fim_programa": "2023-07-31"
}
],
"total": 4
}
GET /patient/health-programs
Lista todos os programas de saúde cadastrados.
Para utilizar o sistema de pagination defina a posição inicial (offset) e o limite de resultados (limit).
Exemplo
offset: 5
limit: 10
Irá retornar 10 registros a partir do quinto.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| limit (opcional) |
numeric | Limite na quantidade de resultados que irão ser retornados |
| offset (opcional) |
numeric | Número de registros que irão ser pulados na requisição |
| programa_id (opcional) |
numeric | Filtro por id do programa (apenas números) |
| nome_programa (opcional) |
string | Filtro por nome do programa |
| convenio_id (opcional) |
numeric | Filtro por id do convênio (apenas números) |
| status (opcional) |
numeric | Filtro por status ativo ou inativo (Ativo = 1, Inativo = 0) |
| tipo_programa_id (opcional) |
string | Filtro por id do tipo do programa (apenas números) |
| data_start (opcional) |
string | Filtro por data inicial do programa (yyyy-mm-dd) |
| data_end (opcional) |
string | Filtro por data final do programa (yyyy-mm-dd) |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar pedidos de exâmes
Exemplo Request
GET https://api.feegow.com/v1/api/patient/exam-requests
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paciente_id": "2155554321",
"paciente_cpf": "22222222222",
"data_inicio": "2023-03-10",
"data_fim": "2023-03-10",
"tipo_pedido": 1
}
Exemplo Resposta Pedido de Exâme Padrão
{
"success": true,
"content": [
{
"TipoPedido": 1,
"PedidoExameID": 821,
"PacienteID": 3333,
"AtendimentoID": null,
"ExecutanteID": "55",
"ExetutanteTipo": "Profissional",
"ObservacaoPedido": "Hemograma completo<br /><br /><br /><p>Rotina</p><br /><br />Unidades: <br />Glicose em urina (24 horas)<br /><br /><br /><p></p><br /><br />Unidades: <br />Triglicerídeos<br /><br /><br /><p></p><br /><br />Unidades: ",
"DataPedido": "2023-12-01 15:32:41",
"IndicacaoClinica": null,
"ConvenioID": null,
"ProfissionalSolicitanteID": null,
"DataSolicitacao": null,
"GuiaID": null,
"ExameID": null,
"ExameCodigo": null,
"DescricaoExame": null,
"ObservacaoExame": null,
"QuantidadeExame": null,
"PedidoExame": [
{
"ExameID": 2,
"ExameCodigo": null,
"DescricaoExame": "Biopsia",
"ObservacaoExame": "Com atenção",
"QuantidadeExame": null
}
]
}
],
"total": 1
}
Exemplo Resposta Pedido de Exâme SADT
{
"success": true,
"content": [
{
"TipoPedido": 2,
"PedidoExameID": 674,
"PacienteID": 999888915,
"AtendimentoID": null,
"ExecutanteID": "",
"ExetutanteTipo": null,
"ObservacaoPedido": null,
"DataPedido": "2023-11-01 18:16:27",
"IndicacaoClinica": "",
"ConvenioID": 140,
"ProfissionalSolicitanteID": 140,
"DataSolicitacao": null,
"GuiaID": null,
"ExameID": null,
"ExameCodigo": "10101012",
"DescricaoExame": "Consulta em consultório (no horário normal ou preestabelecido)",
"ObservacaoExame": null,
"QuantidadeExame": "1",
"PedidoExame": [
{
"ExameID": null,
"ExameCodigo": "10101012",
"DescricaoExame": "Consulta em consultório (no horário normal ou preestabelecido)",
"ObservacaoExame": null,
"QuantidadeExame": "1"
}
]
}
],
"total": 1
}
GET /patient/exam-requests
Lista pedidos de exames.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paciente_id | numeric | ID do paciente |
| paciente_cpf (opcional com paciente_id) |
numeric | CPF do paciente (Somente números) |
| data_inicio | date | Data inicio do filtro. YYYY-MM-DD |
| data_fim | date | Data final do filtro. YYYY-MM-DD |
| tipo_pedido | numeric | Tipo de Pedido. 1 - Pedido Padrão 2 - Pedido SADT |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Procedimentos
Listar procedimentos
Exemplo Request
GET https://api.feegow.com/v1/api/procedures/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"unidade_id": 0,
"paciente_id": 15,
"tipo_procedimento": 2,
"especialidade_id": 5,
"profissional_id": 35,
"tabela_id": 123
}
Exemplo Resposta
{
"success": true,
"content": [
{
"procedimento_id": 12,
"nome": "Mamogragia",
"tipo_procedimento": 3,
"opcoes_agendamento": 4,
"permite_agendamento_online": false,
"preparo": "",
"dias_retorno": null,
"codigo": "40901521",
"grupo_procedimento": 1,
"tempo": "",
"valor": 1200,
"especialidade_id": [
"84"
]
}
]
}
GET /procedures/list
Lista todos procedimentos e seus valores, os valores são determinados de acordo com o valor dos parâmetros enviados na solicitação.
Os valores são tratados em centavos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| tipo_procedimento | numeric | Tipo de procedimento |
| procedimento_id (Caso não possua tipo_procedimento) |
numeric | Tipo de procedimento |
| unidade_id (opcional) |
numeric | Identificação da unidade |
| paciente_id (opcional) |
numeric | Identificação do paciente |
| especialidade_id (opcional) |
numeric | Identificação da especialidade |
| profissional_id (opcional) |
numeric | Identificação do profissional |
| tabela_id (opcional) |
numeric | id da tabela particular |
| nome_procedimento (opcional) |
string | Nome do procedimento para filtro de busca |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Tipos de procedimentos
Exemplo Request
GET https://api.feegow.com/v1/api/procedures/types
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 1,
"tipo": "Cirurgia"
},
{
"id": 2,
"tipo": "Consulta"
},
{
"id": 3,
"tipo": "Exame"
},
{
"id": 4,
"tipo": "Procedimento"
},
{
"id": 9,
"tipo": "Retorno"
}
]
}
GET /procedures/types
Busca todos os tipos de procedimento. Essa identificação é utilizada em outros métodos como (/procedures/list)
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar Convênios do procedimento
Exemplo Request
GET https://api.feegow.com/v1/api/procedures/insurance-procedures-list?procedimentoID=13777&nomeProcedimento=Infusão Intravítrea de Medicação Anti-Inflamatória
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"procedimentoID": 13777,
"nomeProcedimento": "Infusão Intravítrea de Medicação Anti-Inflamatória"
}
Exemplo Resposta
{
"success": true,
"content": [
{
"procedimento_id": "13777",
"nome_procedimento": "Infusão Intravítrea de Medicação Anti-Inflamatória",
"Convenios": "1, 2, 6, 21",
"Nao_aceita_particular": 0,
"Nao_aceita_convenio": 0,
"Convenios_nome": "A Sua Saude, Aeronautica - H C A, Amil, Cassi"
]
}
]
}
GET /procedures/insurance-procedures-list
Lista todos os Convênios que são aceitos para um procedimento.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| procedimentoID (Opcional, porém, caso não informado o nomeProcedimento deve ser informado) |
numeric | ID do procedimento |
| nomeProcedimento (Caso o ID não seja informado pode-se usar o nome exato do procedimento) |
Sr=tring | Nome do procedimento |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 400 | False | O Id ou nome do procedimento devem ser informados |
| 400 | False | Não foi encontrado nenhum procedimento |
Listar procedimentos importados franquia
Exemplo Request
GET https://api.feegow.com/v1/api/procedures/imported-franchise-records
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"unidade_id": 1,
"procedimento_id": 2234
}
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 113343,
"unidade": 19,
"tabela": "procedimentos",
"idProcedimento": 1000,
"idDestino": null
},
{
"id": 113518,
"unidade": 19,
"tabela": "procedimentos",
"idProcedimento": 1179,
"idDestino": null
}
],
"total": 2
}
GET /procedures/imported-franchise-records
Lista todos procedimentos e seus valores, os valores são determinados de acordo com o valor dos parâmetros enviados na solicitação.
Os valores são tratados em centavos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| unidade_id | numeric | ID da Unidade |
| procedimento_id (opcional) |
numeric | ID do procedimento |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
| 400 | False | O Id da unidade deve ser informada |
| 400 | False | O Id da unidade deve ser do tipo numérico |
| 400 | False | O Id do procedimento deve ser do tipo numérico |
| 400 | False | Não foi encontrado nenhum procedimento |
Listar pacotes
Exemplo Request
GET https://api.feegow.com/v1/api/procedures/bundles
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"procedimento_id": 1,
"pacote_id": 15
}
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 159,
"nome": "PACOTE TESTE CAMILA",
"dataUltimaAlteracao": "2022-10-13 15:25:11",
"procedimentos": [
{
"itemID": 943,
"procedimentoID": 1917,
"valor": 1000
},
{
"itemID": 944,
"procedimentoID": 2013,
"valor": 500
},
{
"itemID": 945,
"procedimentoID": 2018,
"valor": 500
}
]
},
{
"id": 154,
"nome": "Limpeza CAMILA - 50%",
"dataUltimaAlteracao": "2022-06-13 10:12:29",
"procedimentos": [
{
"itemID": 899,
"procedimentoID": 1833,
"valor": 50
},
{
"itemID": 939,
"procedimentoID": 1872,
"valor": 60
}
]
}
],
"total": 2
}
GET /procedures/bundles
Lista os pacotes de procedimentos.
Os valores são tratados em centavos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| procedimento_id*(opcional)* | numeric | ID do procedimento |
| pacote_id*(opcional)* | numeric | ID do pacote |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Grupos de procedimentos
Exemplo Request
GET https://api.feegow.com/v1/api/procedures/groups
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta
{
"success": true,
"content": [
{
"id": 96,
"NomeGrupo": "exames",
"DescricaoNFSe": "",
"procedimentos": [
{
"id": 1557,
"procedimento": "AAPE - APOLIPOPROTEINA E (DOSAGEM)"
},
{
"id": 1554,
"procedimento": "AA1 - APOLIPOPROTEINA A 1 (DOSAGEM)"
},
{
"id": 1556,
"procedimento": "AAE - APOLIPOPROTEINA E -POLIMORFISMO"
},
{
"id": 1555,
"procedimento": "AAB - APOLIPOPROTEINA B (DOSAGEM)"
}
],
"modalidade": {
"id": 2,
"Modalidade": "TC"
}
}
],
"total": 1
}
GET /procedures/groups
Lista os grupos de procedimentos.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| grupo_id*(opcional)* | numeric | ID do grupo de procedimento |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Profissionais
Listar profissionais
Exemplo Request
GET https://api.feegow.com/v1/api/professional/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Parâmetros
{
"ativo": true,
"unidade_id": 2,
"especialidade_id": 4
}
Exemplo Resposta - 200
{
"success": true,
"content": [
{
"profissional_id": 14,
"sys_user": 123456,
"nome": null,
"tratamento": null,
"rqe": null,
"conselho": null,
"documento_conselho": null,
"uf_conselho": null,
"foto": null,
"sexo": "Feminino",
"especialidades": [
{
"especialidade_id": 4,
"nome_especialidade": "Acupuntura",
"CBOS": "225105"
}
]
},
{
"profissional_id": 11,
"sys_user": 213423,
"nome": "Bruno Teste",
"tratamento": null,
"rqe": "",
"conselho": null,
"documento_conselho": "",
"uf_conselho": "",
"foto": null,
"sexo": "Feminino",
"especialidades": [
{
"especialidade_id": 4,
"nome_especialidade": "Acupuntura",
"CBOS": "225105"
}
]
},
]
}
GET /professional/list
Lista os nomes e IDs dos profissionais.
Você deve filtrar por profissional ativo ou inativo.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| ativo * | numeric | 0 = Profissional inativo 1 = Profissional ativo |
| unidade_id | numeric | ID da unidade |
| especialidade_id | numeric | ID da da especialidade |
* Parâmetros obrigatórios
Informações e Especialidades
Exemplo Request
GET https://api.feegow.com/v1/api/professional/search
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Parâmetros
{
"profissional_id": 1
}
Exemplo Resposta - 200
{
"success": true,
"content": {
"informacoes": [
{
"rqe": "",
"conselho": null,
"documento_conselho": "",
"uf_conselho": "",
"CPF": "000.000.000-00",
"nome": "SANDBOX",
"foto": null,
"data_nascimento": "02-02-1990",
"sexo": "Feminino",
"telefones": [
"",
""
],
"celulares": [
"",
""
],
"email": "",
"idade_minima": null,
"rua": "",
"numero_rua": "",
"complemento": "",
"cidade": "",
"bairro": "",
"CEP": ""
}
],
"especialidades": [
{
"especialidade_id": 286,
"nome_especialidade": "Ginecologia",
"CBOS": "",
"rqe": "1111111",
"conselho": "CRM",
"documento_conselho": "546564",
"uf_conselho": "RJ"
}
]
}
}
Exemplo Resposta - 409
{
"success": false,
"content": "Profissional não encontrado."
}
GET /professional/search
Lista as informações e especialidades do profissional informado.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| profissional_id | numeric | Identificação do profissional |
Convênios aceitos
Exemplo Request
GET https://api.feegow.com/v1/api/professional/insurance
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"profissional_id": 1
}
Exemplo Resposta - 200
{
"success": true,
"content": [
{
"convenio_id": 16,
"registro_ans": "simplificado",
"nome": "BRADESCO"
}
]
}
GET /professional/insurance
Lista todos convênios aceitos por um profissional específico.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| profissional_id | numeric | Identificação do profissional |
Propostas
Listar propostas
Exemplo Request
GET https://api.feegow.com/v1/api/proposal/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"paciente_id": 15,
"data_inicio": "08-12-2022",
"data_fim": "08-12-2022",
"tipo_data": "I"
}
Exemplo Resposta
{
"success": true,
"content": [
{
"proposal_id": 14,
"proposal_date": "2019-03-13",
"PacienteID": 1,
"value": 850,
"proposer_id": 13052,
"proposer_name": "José da Silva",
"proposer_role": "Profissional",
"status": "Aguardando aprovação do cliente",
"private_table_name": null,
"proposal_last_update": "2019-03-13",
"procedimentos": {
"label": "Exames",
"data": [
{
"procedimento_id": 2,
"nome": "ECG",
"valor": 750,
"desconto": "0,00"
},
{
"procedimento_id": 17,
"nome": "Hemograma",
"valor": 100,
"desconto": "10,00"
}
]
},
"unidade": {
"unidade_id" : 6,
"nome_fantasia": "Filial",
"cnpj": "11.111.111.0001-16",
"endereco": "Estrada do Guanumbi",
"cep": "22745-200",
"numero": "000",
"bairro": "Freguesia (Jacarepaguá)",
"telefone_1": "(21) 1111-1111",
"telefone_2": "(21) 2222-2222",
"email_1": "josebaroni@feegow.com.br",
"email_2": "maiavinicius@feegow.com.br",
"complementos": "",
"mapa": "https://goo.gl/maps/jKThTS8QQny"
}
}
]
}
GET /proposal/list
Lista todas propostas feitas para um paciente e seus valores, os valores são determinados de acordo com o valor dos parâmetros enviados na solicitação.
Os valores são tratados em reais (R$).
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| paciente_id (opcional com data_inicio e data_fim) |
numeric | Identificação do paciente |
| data_inicio (obrigatório sem paciente_id) |
date | Data inicio do filtro. DD-MM-YYYY |
| data_fim (obrigatório com data_inicio) |
date | Data final do filtro. DD-MM-YYYY |
| tipo_data (opcional) |
string | A = Filtra por última alteração I = Filtra por data de criação. |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Criar proposta
Exemplo Request
POST https://api.feegow.com/v1/api/proposal/create
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"proposer_id": 3531,
"paciente_id": 4412,
"unidade_id": 21,
"status_id": 5,
"proposal_date": "12-03-2018",
"procedimentos": [
{
"procedimento_id": 17,
"quantidade": 2,
"valor": 1111,
"desconto": 111,
"descricao": "Aplicação na clínica"
},
{
"procedimento_id": 17,
"quantidade": 3,
"valor": 3211,
"desconto": 2211,
"descricao": "Aplicação em casa"
},
{
"procedimento_id": 35,
"quantidade": 3,
"valor": 1411,
"desconto": 411,
"descricao": "Tratamento"
},
{
"procedimento_id": 1,
"quantidade": 1,
"valor": 1121,
"desconto": 121,
"descricao": "Consulta"
}
]
}
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| proposer_id | numeric | O ID deste campo precisa ser solicitado ao time técnico via chamado para API |
| paciente_id | numeric | Identificação do paciente |
| status_id | numeric | Identificação do status da proposta |
| unidade_id (opcional) |
numeric | Identificação da unidade da proposta |
| proposal_date | date | dd/mm/YYYY |
| procedimentos (deve conter pelo menos um objeto) |
array | Lista com objetos definindo os procedimentos ofertados na proposta |
Parâmetros dos procedimentos
| Parâmetro | Tipo | Descrição |
|---|---|---|
| procedimento_id | numeric | Identificação do procedimento |
| quantidade (opcional) |
numeric | Quantidade de procedimentos a serem passados |
| valor (opcional) |
numeric | Custo total deste procedimento |
| desconto (opcional) |
numeric | Desconto total oferecido ao procedimento |
| descricao (opcional) |
string | Campo para descrever quaisquer detalhes do procedimento nesta proposta |
Lista de status
| id | status |
|---|---|
| 1 | Aguardando aprovação do cliente |
| 2 | Aprovada pelo cliente |
| 3 | Rejeitada pelo cliente |
| 4 | Aguardando aprovação de financiamento |
| 5 | Executada |
Respostas
Exemplo Resposta
{
"success": true,
"content": {
"proposal_id": 25
}
}
GET /proposals/create
Cria uma proposta definindo a lista de procedimentos com seus valores e descontos.
Os valores são tratados em reais (R$).
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Mudar status da proposta
Exemplo Request
POST https://api.feegow.com/v1/api/proposal/change-status
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"proposal_id": 24,
"status_id": 3
}
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| proposal_id | numeric | Identificação do profissional |
| status_id | numeric | Identificação do status da proposta |
Respostas
Exemplo Resposta
{
"success": true,
"content": {
"content": "Status atualizado para: Rejeitada pelo cliente"
}
}
GET /proposals/change-status
Modifica o status de uma proposta.
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Listar URL de proposta por id
Exemplo Request
GET https://api.feegow.com/v1/api/proposal/proposal-url
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Parâmetros
{
"proposta_id": 15
}
Exemplo Resposta
{
"success": true,
"content": "https://app.feegow.com/pre-v8/?P=PacientesPropostas&Pers=1&I=&PropostaID=2058"
}
GET /proposal/proposal-url
Lista a url da proposta.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| proposta_id | numeric | Identificação da proposta |
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 200 | sucesso | Operação bem sucedida |
Relatórios
Listar relatórios
Exemplo Request
GET https://api.feegow.com/v1/api/reports/list
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Resposta - 200
[
{
"id": 53,
"Ct": "Agenda",
"Relatorio": "Agendamentos",
"Arquivo": "schedule-appointments",
"sysActive": 1,
"Permissoes": "relatoriosagendamentoV",
"StatusRelatorioID": 1,
"NomeStatus": "DisponÃvel",
"CorStatus": null,
"Habilitado": 1
},
{
"id": 49,
"Ct": "Agenda",
"Relatorio": "Atendimentos",
"Arquivo": "duration-of-service",
"sysActive": 1,
"Permissoes": "relatoriosatendimentosV",
"StatusRelatorioID": 1,
"NomeStatus": "DisponÃvel",
"CorStatus": null,
"Habilitado": 1
}
]
GET /reports/list
Lista os relatórios disponíveis para utilização.
Gerar Relatório
Exemplo Request
POST https://api.feegow.com/v1/api/reports/generate
Host: api.feegow.com/v1
Content-Type: application/json
x-access-token: "SEUTOKEN"
Exemplo Parâmetros
{
"report": "vaccines"
}
Exemplo Resposta - 200
{
"success": true,
"reportId": 49,
"route": "duration-of-service",
"reportName": "Atendimentos",
"columns": false,
"filters": false,
"data": [
{
"id": 2274,
"PacienteID": 4059073,
"AgendamentoID": 20168920,
"Data": "22/11/2018",
"HoraInicio": "08:08",
"HoraFim": "08:54",
"Obs": "",
"sysUser": 13184,
"ProfissionalID": 8386,
"Triagem": "N",
"UsuariosNotificados": null,
"UnidadeID": 1,
"TabelaID": null,
"DHUp": "2018-11-22 08:54:51",
"TempoProcedimento": "0",
"DataMensal": "2018-11-22",
"NomePaciente": "TESTE FEEGOW",
"Tel1": "(47) 00000-0000",
"Origem": "",
"NomeLocal": "Sala 1",
"LocalID": 21,
"Quantidade": "1",
"Valor": 30,
"Duracao": "46",
"TempoPermanencia": "55",
"TempoAtraso": 0,
"TipoCompromissoID": 96267,
"EspecialidadeID": 109,
"NomeProfissional": "JOSÉ SILVA",
"ProcedimentoID": 96267,
"TempoEspera": "9",
"HoraSta": "07:59",
"Hora": "08:20",
"PeriodoHora": "Manhã",
"HoraArredondada": "08:00",
"NomeProcedimento": "Retorno",
"NomeUnidade": "CLINICA DE TESTE"
}
]
}
Exemplo Resposta - 200
[]
POST /reports/generate
Gera um relatório específico.
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| report * | string | Parâmetro arquivo do relatório obtido pelo método listar relatórios |
| DATA_INICIO | date | dd/mm/YYYY |
| DATA_FIM | date | dd/mm/YYYY |
* Parâmetros obrigatórios
Erros
Exemplo Error 409
{
"success": false,
"content": "String do erro"
}
Exemplo Error 422
{
"paciente_id": [
"validation.required"
]
}
Respostas
| Código | Tipo | Descrição |
|---|---|---|
| 422 | erro | Input inválido |
| 409 | erro | Conflito interno, específico para cada método |
| 401 | erro | Chave da API não está definida no header |
| 403 | erro | Chave da API inativa |
| 5xx | erro | Erro interno, contate o suporte |