### Search Billing Guide (GET) Source: https://docs.feegow.com/ Retrieves billing guide information based on provided query parameters. Requires billing_type_id, insurance_id, and billing number. Returns a success status and content array. ```HTTP GET https://api.feegow.com/v1/api/billing/insurances-billing?billing_type_id=2&insurance_id=3&billing=101010 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### Create Account Response Example Source: https://docs.feegow.com/#autoriza--o This is an example of a successful response when creating a financial account. It includes a success flag, invoice ID, movement ID, a list of invoice items with their values, the total value, and the status of the created account. ```json { "success": true, "invoice_id": 5879572, "movement_id": 13735382, "itensInvoice": [ { "id": 23317, "ValorPagto": 30 } ], "valorTotal": 30, "status": "created" } ``` -------------------------------- ### Retrieve Plan Information via GET Request Source: https://docs.feegow.com/ This snippet demonstrates how to retrieve plan information using a GET request to the /external/plan/datagrid endpoint. It includes example request headers, query parameters, and the structure of a successful response. The endpoint allows filtering by page, items per page, and plan ID. ```http GET https://cartao-beneficios.feegow.com/external/plan/datagrid?perPage=1&page=1&id=ef166b40-b06f-47cc-807b-6e167612bf4e Host: cartao-beneficios.feegow.com x-access-token: "SEUTOKEN" ``` -------------------------------- ### Insert Billing Guide (POST) Source: https://docs.feegow.com/ Creates a new billing guide, currently only for SADT types. Requires comprehensive patient and insurance details, including IDs, dates, and codes. Returns a success status and the new GuiaID. ```HTTP POST https://api.feegow.com/v1/api/billing/insurances-billing Host: api.feegow.com/v1 Content-Type: application/json x-access-token: "SEUTOKEN" { "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": "" } ``` -------------------------------- ### POST Product Movement Request Example Source: https://docs.feegow.com/#autoriza--o This snippet shows an example of a POST request to the Feegow API for moving products. It includes the endpoint, host, content type, and an access token. The request body contains a list of product movements with specific details. ```HTTP POST https://core.feegow.com.br/financial2/external/financial-stock/product/movement Host: core.feegow.com.br/financial2 Content-Type: application/json x-access-token: "SEUTOKEN" ``` -------------------------------- ### Create Voucher Response Example Source: https://docs.feegow.com/#autoriza--o This is an example of a successful response after creating a voucher. It returns details of the created voucher, including system user, active status, reason ID, code, description, validity dates, limits, value, value type, associated units and specialties, and creation timestamp. ```json { "sysUser": 160061068, "sysActive": true, "motivoId": 1, "codigo": "LoremIpsum", "descricao": "Lorem Ipsum Description", "de": "2024-11-16", "ate": "2024-11-17", "limitar": "20", "valor": 50, "tipoValor": "V", "unidades": "|1|,|0|", "especialidades": "|83|", "ultilizacaoCpf": "22", "id": 26, "sysDate": "2024-11-07T19:08:19.000Z" } ``` -------------------------------- ### Product Exit Response Example Source: https://docs.feegow.com/ This JSON object represents a successful response from the product exit endpoint. It includes details about the inventory transaction (`estoquelancamentos`), confirming the product ID, quantity, and other relevant information. The `estoqueposicao` field is null in this example, indicating no specific position update was returned. ```json { "estoquelancamentos": { "produtoId": 53, "entSai": "S", "quantidade": 3, "tipoUnidade": "U", "data": "2024-08-02", "responsavel": "5_6", "validade": "2025-01-30", "lote": "#4455", "localizacaoId": 4, "fornecedorId": "", "nf": "n48484ad484sd4vfg481fe", "valor": 0, "unidadePagto": "U", "observacoes": "Teste Postman 01 S", "pacienteId": null, "lancar": "", "sysUser": 160061068, "quantidadeConjunto": 0, "quantidadeTotal": 3, "individualizar": "", "motivoId": 11, "tipoUnidadeOriginal": "U", "responsavelOriginal": "5_6", "localizacaoIdOriginal": 4, "cbid": "", "itemRequisicaoId": 0, "itemInvoiceId": 0, "funcaoRateioId": 0, "atendimentoId": 0, "posicaoS": "", "posicaoE": "", "posicaoAnte": "162=7|0, 163=4|0, 164=4|0, 173=15|0, 174=4|0", "produtoInvoiceId": 0, "itemGuiaId": 0, "cbids": "", "id": 412 }, "estoqueposicao": null } ``` -------------------------------- ### Listar contratos via GET HTTP Source: https://docs.feegow.com/#autoriza--o Realiza uma requisição GET para o endpoint de datagrid de contratos. Requer um token de acesso válido no cabeçalho e suporta múltiplos parâmetros de consulta para filtragem. ```http GET https://cartao-beneficios.feegow.com/external/contract/datagrid?document=12492684784&page=1&perPage=10 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### List Sales API Request (HTTP) Source: https://docs.feegow.com/ This snippet shows an example of a GET request to the Feegow API for listing sales. It includes the endpoint URL and query parameters for specifying the date range, unit ID, and amount. An x-access-token is required for authentication. ```HTTP GET https://api.feegow.com/v1/api/financial/list-sales?date_start=2024-01-01&date_end=2024-02-02&unidade_id=0&amount=70.00 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### Edit Billing Guide (PUT) Source: https://docs.feegow.com/ Updates attributes of an existing billing guide. Currently supports SADT guides. Requires billing_id, billing_type_id, and the attribute to be edited. Returns a success status and a confirmation message. ```HTTP PUT https://api.feegow.com/v1/api/billing/insurances-billing Host: api.feegow.com/v1 Content-Type: application/json x-access-token: "SEUTOKEN" { "billing_id": 1234, "billing_type_id": 2, "xxxxx": 1 // atributo a ser editado } ``` -------------------------------- ### List Proposals by Date - HTTP Request Source: https://docs.feegow.com/ This snippet shows an example HTTP GET request to the Feegow API to list proposals. It includes the endpoint URL, host, and an authorization token. The request filters proposals by 'data_proposta' and 'data_alteracao' and specifies a 'PacienteID'. ```http GET https://api.feegow.com/v1/api/proposal/list-dates?data_proposta=2023-12-07&data_alteracao=2023-12-07&PacienteID=0 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### Listar programas de saúde via GET Source: https://docs.feegow.com/ Realiza uma requisição GET para o endpoint de programas de saúde. Requer um token de acesso válido no cabeçalho e aceita diversos parâmetros de consulta para filtrar os resultados. ```HTTP GET https://api.feegow.com/v1/api/patient/health-programs?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 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### Edit Patient Request Example (JSON) Source: https://docs.feegow.com/ This JSON object demonstrates the structure of a request to the '/patient/edit' endpoint. It includes various patient details such as ID, name, CPF, contact information, and address. Note that some fields like 'nome_mae' are not explicitly defined in the parameters list but are shown in the example. ```json { "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" } ``` -------------------------------- ### GET /billing/insurances-billing Source: https://docs.feegow.com/ Retrieves medical billing guide details based on the provided insurance and billing parameters. ```APIDOC ## GET /billing/insurances-billing ### Description Busca guia de acordo com o convênio informado. ### Method GET ### Endpoint https://api.feegow.com/v1/api/billing/insurances-billing ### Parameters #### Query Parameters - **billing_type_id** (numeric) - Required - Tipo da guia (1 = 'Consulta', 2 = 'SADT', 3 = 'Honorarios', 4 = 'Internação', 5 = 'Quimioterapia') - **insurance_id** (numeric) - Required - ID do Convênio - **billing** (numeric) - Required - Numero da Guia ### Request Example GET https://api.feegow.com/v1/api/billing/insurances-billing?billing_type_id=2&insurance_id=3&billing=101010 ### Response #### Success Response (200) - **success** (boolean) - Operation status - **content** (array) - List of billing guides #### Response Example { "success": true, "content": [ { "id": 2, "PacienteID": 123456 } ], "total": 1 } ``` -------------------------------- ### Create Contract POST Request Example Source: https://docs.feegow.com/#autoriza--o This snippet shows the structure of a POST request to create a contract. It includes details about the contract, recurrence, and person information. Ensure you replace placeholder values like 'ID_DO_PLANO' and 'SEUTOKEN' with actual data. ```http POST https://cartao-beneficios.feegow.com/external/contract/create Host: api.feegow.com/v1 Content-Type: application/json x-access-token: "SEUTOKEN" { "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": {} } ] } ``` -------------------------------- ### GET Request to List Patients - Feegow API Source: https://docs.feegow.com/#autoriza--o This snippet demonstrates how to make a GET request to the Feegow API's /patient/list endpoint. It includes example headers and query parameters for filtering and pagination. The response is a JSON object containing patient data. ```http GET https://api.feegow.com/v1/api/patient/list?limit=50&offset=0&telefone=2155554321&cpf=22222222222&origem_id=1&alterado_em=2023-03-10&programa_saude=1&data_aniversario=01-30 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### Create Plan API Response Example Source: https://docs.feegow.com/ This snippet presents a sample JSON response from the Feegow API after a successful plan creation. It returns the details of the newly created plan, including its ID, name, associated values, and account information. ```json { "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 } ``` -------------------------------- ### List Procedure Groups API Request Source: https://docs.feegow.com/ This snippet demonstrates how to fetch procedure groups from the Feegow API using a GET request. It shows the necessary headers and an example of how to optionally filter by group ID. The response includes a list of procedure groups, each with its name and associated procedures. ```http GET https://api.feegow.com/v1/api/procedures/groups Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### List Procedure Bundles API Request Source: https://docs.feegow.com/ This snippet shows how to make a GET request to the Feegow API to list procedure bundles. It includes example query parameters for filtering by procedure ID and bundle ID. The response contains a list of bundles with their associated procedures and values. ```http GET https://api.feegow.com/v1/api/procedures/bundles?procedimento_id=1&pacote_id=15 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### List Vouchers API Request (HTTP) Source: https://docs.feegow.com/ This snippet demonstrates how to make a GET request to the Feegow API to list vouchers. It includes example URL, host, and headers. The query parameters allow filtering by page, limit, date range, voucher code, status, units, and ID. ```HTTP GET https://api.feegow.com/v1/api/core/financial/voucher/list?page=1&limit=3&data_inicio=2020-01-01&data_fim=2023-01-01&codigo_voucher=NOME_VOUCHER&status=expirado&unidades[]=0&id=0 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### Create Voucher - POST Request Source: https://docs.feegow.com/#autoriza--o This snippet shows how to create a promotional voucher. It includes details such as specialties, units, reason ID, code, description, validity dates, value, value type, and usage limits. An access token is required. ```http POST https://api.feegow.com/v1/api/core/financial/voucher/create Host: api.feegow.com/v1 Content-Type: application/json x-access-token: "SEUTOKEN" { "especialidades": [83], "unidades": [1,0], "motivoId": 1, "codigo": "LoremIpsum", "descricao": "Lorem Ipsum Description", "de": "2024-10-16", "ate": "2024-10-17", "valor": 50, "tipoValor": "V", "limite_quantidade": 20, "ultilizacaoCpf": "22" } ``` -------------------------------- ### List Professionals API Request Source: https://docs.feegow.com/ This snippet illustrates how to list professionals using the Feegow API. It shows a GET request with example query parameters to filter professionals by their active status, unit ID, and specialty ID. The response provides details about each professional, including their ID, name, and specialties. ```http GET https://api.feegow.com/v1/api/professional/list?ativo=1&unidade_id=2&especialidade_id=4 Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### GET /financial2/external/private-table/list Source: https://docs.feegow.com/ Endpoint to get information about private tables. ```APIDOC ## GET /financial2/external/private-table/list ### Description Endpoint to get information about private tables. ### Method GET ### Endpoint https://core.feegow.com/financial2/external/private-table/list ### Parameters #### Query Parameters - **unityId** (string) - Optional - ID da unidade (Opcional). - **page** (string) - Optional - Número da página (Opcional). - **perPage** (number) - Optional - Quantidade de itens por página (Opcional). ### Response #### Success Response (200) - **page** (number) - Número da página atual. - **pages** (number) - Número total de páginas disponíveis. - **perPage** (number) - Número de registros por página. - **data** (array) - Lista de objetos que representam as tabelas de preços. - **data[].id** (number) - ID da tabela de preços. - **data[].name** (string) - Nome da tabela de preços. - **data[].unities** (array) - Lista de IDs das unidades aplicáveis à tabela de preços. - **data[].needsValidation** (boolean) - Indica se a tabela necessita de validação. - **data[].needToRequestUsageAuthorization** (boolean) - Indica se a tabela requer solicitação de autorização de uso. - **count** (number) - Número total de registros. #### Response Example ```json { "page": 1, "pages": 1, "perPage": 10, "data": [ { "id": 4, "name": "Tabela 10%", "unities": [ 0, 1, 3 ], "needsValidation": false, "needToRequestUsageAuthorization": false }, { "id": 12, "name": "Tabela 20%", "unities": [ 0, 1, 8, 5, 10, 11, 2, 6, 7, 3, 9 ], "needsValidation": false, "needToRequestUsageAuthorization": false } ], "count": 2 } ``` ``` -------------------------------- ### Create Contract POST Response Example Source: https://docs.feegow.com/#autoriza--o This snippet illustrates a successful response from the contract creation API. It includes details about the created contract, associated person data, and webhook information. The response contains IDs for the contract, plan, and person, along with timestamps and status information. ```json { "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 } } } ] } } } ``` -------------------------------- ### Stock Launching and Positioning Details Source: https://docs.feegow.com/ This section details the parameters for stock launching and stock positioning within the Feegow project API. ```APIDOC ## Stock Launching and Positioning Details ### Description Provides detailed information about the parameters used for stock launching and stock positioning operations. ### Parameters #### Response Body (estoquelancamentos) - **[].estoquelancamentos.produtoId** (number) - ID of the product. - **[].estoquelancamentos.entSai** (string) - Type of movement (M for movement). - **[].estoquelancamentos.quantidade** (number) - Quantity of the product. - **[].estoquelancamentos.tipoUnidade** (string) - Type of product unit. - **[].estoquelancamentos.data** (string) - Transaction date (YYYY-MM-DD). - **[].estoquelancamentos.responsavel** (string) - Person responsible for the transaction (code). - **[].estoquelancamentos.validade** (string) - Product expiration date (YYYY-MM-DD). - **[].estoquelancamentos.lote** (string) - Product batch. - **[].estoquelancamentos.localizacaoId** (number) - ID of the product location. - **[].estoquelancamentos.fornecedorId** (string) - Supplier ID (empty in this case). - **[].estoquelancamentos.nf** (string) - Invoice (NF) of the transaction (empty in this case). - **[].estoquelancamentos.valor** (number) - Product value. - **[].estoquelancamentos.unidadePagto** (string) - Payment unit (empty in this case). - **[].estoquelancamentos.observacoes** (string) - Observations about the transaction. - **[].estoquelancamentos.lancar** (string) - Launch to patient account (S for yes). - **[].estoquelancamentos.sysUser** (number) - ID of the system user who made the entry. - **[].estoquelancamentos.quantidadeConjunto** (number) - Quantity in set. - **[].estoquelancamentos.quantidadeTotal** (number) - Total product quantity. - **[].estoquelancamentos.individualizar** (string) - Field for individualization (empty in this case). - **[].estoquelancamentos.tipoUnidadeOriginal** (string) - Original product unit type. - **[].estoquelancamentos.responsavelOriginal** (string) - Original responsible person (code). - **[].estoquelancamentos.localizacaoIdOriginal** (number) - Original product location ID. - **[].estoquelancamentos.cbid** (string) - Barcode ID (empty in this case). - **[].estoquelancamentos.itemRequisicaoId** (number) - Requisition item ID (0 in this case). - **[].estoquelancamentos.itemInvoiceId** (number) - Item ID in invoice (0 in this case). - **[].estoquelancamentos.funcaoRateioId** (number) - Allocation function ID (0 in this case). - **[].estoquelancamentos.atendimentoId** (number) - Attendance ID (0 in this case). - **[].estoquelancamentos.posicaoE** (string) - Stock position for entry (empty in this case). - **[].estoquelancamentos.posicaoS** (string) - Stock position for exit (empty in this case). - **[].estoquelancamentos.posicaoAnte** (string) - Previous positions (e.g., "162=7"). - **[].estoquelancamentos.produtoInvoiceId** (number) - Product ID in invoice (0 in this case). - **[].estoquelancamentos.itemGuiaId** (number) - Item ID in guide (0 in this case). - **[].estoquelancamentos.cbids** (string) - Barcode IDs (empty in this case). - **[].estoquelancamentos.id** (number) - Stock entry ID. #### Response Body (estoqueposicao) - **[].estoqueposicao.produtoId** (number) - ID of the product. - **[].estoqueposicao.quantidade** (number) - Quantity of the product. - **[].estoqueposicao.tipoUnidade** (string) - Type of product unit. - **[].estoqueposicao.responsavel** (string) - Person responsible for the transaction (code). - **[].estoqueposicao.cbid** (string) - Barcode ID (empty in this case). - **[].estoqueposicao.localizacaoId** (number) - ID of the product location. - **[].estoqueposicao.validade** (string) - Product expiration date (YYYY-MM-DD). - **[].estoqueposicao.valorPosicao** (number) - Position value. - **[].estoqueposicao.id** (number) - Stock position ID. ``` -------------------------------- ### Register Product Entry via HTTP POST Source: https://docs.feegow.com/ This endpoint allows users to record a new stock entry for a specific product. It requires an authentication token in the header and a JSON body containing product details such as quantity, batch, expiration date, and supplier information. ```http POST https://core.feegow.com.br/financial2/external/financial-stock/product/entry Host: core.feegow.com.br/financial2 Content-Type: application/json x-access-token: "SEUTOKEN" ``` ```json { "productId": 53, "quantity": 15, "date": "2024-08-02", "expirationDate": "2025-01-30", "locationId": 4, "paymentUnity": "U", "typeUnity": "U", "owner": "5_6", "supplierId": 19, "nf": "n48484ad484sd4vfg481fe", "value": 0, "batch": "#4455", "description": "Teste Postman 01", "patientId": null, "lancar": "", "reasonId": 2 } ``` -------------------------------- ### POST /billing/insurances-billing Source: https://docs.feegow.com/#autoriza--o Inserts a new insurance guide. Currently valid only for SADT guides. Procedures, attachments, and executants are not included. ```APIDOC ## POST /billing/insurances-billing ### Description Inserts a Guide (valid only for SADT guides at the moment). __procedures, attachments and executants not included__ ### Method POST ### Endpoint /v1/api/billing/insurances-billing ### Parameters #### Request Body - **patient_id** (string) - Required - Patient's ID. - **patient_birth_date** (string) - Required - Patient's birth date (YYYY-MM-DD). - **patient_cpf** (string) - Required - Patient's CPF. - **unit_id** (numeric) - Required - Unit ID. - **insurance_id** (string) - Required - Insurance ID. - **insurance_plan_id** (string) - Required - Insurance plan ID. - **billing_type_id** (numeric) - Required - Type of the guide (1 = 'Consulta', 2 = 'SADT', 3 = 'Honorarios', 4 = 'Internação', 5 = 'Quimioterapia'). - **newborn_care** (string) - Required - Newborn care indicator ('S' or 'N'). - **applicant_professional_council_id** (string) - Required - Applicant professional council ID. - **number_on_the_requesting_council** (string) - Required - Number on the requesting council. - **UF_Requesting_Council** (string) - Required - State of the requesting council. - **requesting_CBO_code** (string) - Required - Requesting CBO code. - **hired** (string) - Required - Hired status. - **carrier_code** (string) - Required - Carrier code. - **hired_requester_ID** (string) - Required - Hired requester ID. - **hired_requester_code_at_carrier** (string) - Required - Hired requester code at carrier. - **ANS_registry** (string) - Required - ANS registry number. - **CNES_code** (string) - Required - CNES code. - **requesting_professional_ID** (string) - Required - Requesting professional ID. - **request_date** (string) - Required - Request date (YYYY-MM-DD). - **observation** (string) - Optional - Observations. - **clinical_indication** (string) - Optional - Clinical indication. ### Request Example ```json { "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": "" } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **content** (object) - Contains the ID of the newly created guide. - **GuiaID** (numeric) - The ID of the newly created guide. - **total** (numeric) - Total number of results. #### Response Example ```json { "success": true, "content": { "GuiaID": 1234 }, "total": 1 } ``` ``` -------------------------------- ### PUT /billing/insurances-billing Source: https://docs.feegow.com/#autoriza--o Edits attributes of an insurance guide. Currently supports editing SADT guides only. Procedures, attachments, and executants are not included. ```APIDOC ## PUT /billing/insurances-billing ### Description Edits attributes of the Guide (only SADT for now). __procedures, attachments and executants not included__ ### Method PUT ### Endpoint /v1/api/billing/insurances-billing ### Parameters #### Request Body - **billing_id** (numeric) - Required - Guide ID - **billing_type_id** (numeric) - Required - Type of the guide (1 = 'Consulta', 2 = 'SADT', 3 = 'Honorarios', 4 = 'Internação', 5 = 'Quimioterapia') - **xxxxx** (numeric or string) - Required - Attribute to be edited. Ex: 'observation' ### Request Example ```json { "billing_id": 1234, "billing_type_id": 2, "xxxxx": 1 // attribute to be edited } ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. - **content** (object) - Contains the result of the update operation. - **result** (string) - Message indicating the update status. - **total** (numeric) - Total number of results. #### Response Example ```json { "success": true, "content": { "result": "update successful" }, "total": 1 } ``` ``` -------------------------------- ### Get Credit Card Flags Source: https://docs.feegow.com/ Retrieves a list of available credit card flags supported by the system. This is a simple GET request that requires an access token and returns a list of flags with their respective IDs. ```HTTP GET https://api.feegow.com/v1/api/financial/credit-card-flags Host: api.feegow.com/v1 x-access-token: "SEUTOKEN" ``` -------------------------------- ### Create Plan API Request Example Source: https://docs.feegow.com/ This snippet illustrates a POST request to the Feegow API for creating a new plan. It specifies the endpoint, headers, and the JSON payload containing the new plan's name, values, and optional parameters. ```http POST https://cartao-beneficios.feegow.com/external/plan/create Host: api.feegow.com/v1 Content-Type: application/json x-access-token: "SEUTOKEN" { "name": "Teste plano docs", "membershipValue": 0, "recurrenceValue": 0, "dependencyMembershipValue": 0, "dependencyRecurrenceValue": 0, "parameters": { "template": null } } ``` -------------------------------- ### POST /api/proposal/create Source: https://docs.feegow.com/#autoriza--o Creates a new proposal for a patient, including a list of procedures, values, and discounts. ```APIDOC ## POST /api/proposal/create ### Description Creates a new proposal defining the list of procedures with their respective values and discounts. Values are processed in BRL (R$). ### Method POST ### Endpoint https://api.feegow.com/v1/api/proposal/create ### Parameters #### Request Body - **proposer_id** (numeric) - Required - ID of the professional (sys_user). - **paciente_id** (numeric) - Required - ID of the patient. - **status_id** (numeric) - Required - ID of the proposal status. - **unidade_id** (numeric) - Optional - ID of the unit. - **proposal_date** (date) - Required - Date in dd/mm/YYYY format. - **procedimentos** (array) - Required - List of procedure objects. ### Request Example { "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" } ] } ### Response #### Success Response (200) - **success** (boolean) - Indicates operation success. - **proposal_id** (numeric) - The ID of the created proposal. #### Response Example { "success": true, "content": { "proposal_id": 25 } } ``` -------------------------------- ### Register Product Exit via POST Request Source: https://docs.feegow.com/#autoriza--o This snippet demonstrates the HTTP POST request to record a product exit. It requires an authentication token in the header and a JSON body containing product identification, quantity, and transaction details. ```http POST https://core.feegow.com.br/financial2/external/financial-stock/product/exit Host: core.feegow.com.br/financial2 Content-Type: application/json x-access-token: "SEUTOKEN" ``` ```json { "productId": 53, "quantity": 3, "positionId": 163, "typeUnity": "U", "value": 0, "paymentUnity": "U", "date": "2024-08-02", "nf": "n48484ad484sd4vfg481fe", "locationId": 4, "owner": "5_6", "originalOwner": "5_6", "expirationDate": "2025-01-30", "batch": "#4455", "originalLocationId": 4, "cbid": "", "originalTypeUnity": "U", "description": "Teste Postman 01 S", "patientId": null, "reasonId": 11 } ``` -------------------------------- ### Exemplo de resposta da API de contratos Source: https://docs.feegow.com/#autoriza--o Estrutura JSON retornada pelo endpoint contendo a lista de contratos, informações de paginação e os parâmetros encontrados na consulta. ```json { "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, "recurrenceId": "uf166b40-b06f-47cc-807b-6e167612bf4a", "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" ] } ``` -------------------------------- ### Query Parameters for Proposal Listing Source: https://docs.feegow.com/#autoriza--o This section outlines the query parameters available for filtering proposals. It includes optional parameters like `paciente_id`, `data_inicio`, and `data_fim`, along with `tipo_data` to specify the date type for filtering. ```Text 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. ```