1. Schemas
Goclin API
  • Raiz
    • Administration
      • Autenticate the current session to use the specified iframe application and returns te bearer
      • Create an solicitation
      • Exporta dados em JSON ou CSV
      • Returns the list of invoices with the filters
      • Returns the list of all masterUsers registered
      • Returns the list of all solicitations
      • Import materials or exams from JSON, CSV (raw) or CSV file upload
      • Import a new reference prices table from csv
      • Admin login
      • Manually marks an invoice to paid
      • Sets the authentication cookie and redirect to the application
      • Send a Message to inform actives users about new update at Goclin
      • Send an notification that an solicitation has been implemented
      • Sets if an account has manual bill from goclin, disabling the automatic credit card bill
      • Create admin user
      • Delete admin user
      • Update admin user
      • List admin users
    • Schedule
      • Attend Appointment
      • Block one or more time slots for a professional
      • Create Appointment
      • Generate finance record for a particular appointment
      • Create Self Appointment
      • Edit Appointment
      • Edit Appointment notes
      • Get the list of interactions with the insurance for an specific attendance
      • Patient confirm appointment
      • Patient remove appointment
      • Regress the attendance to waiting state
      • Remove Appointment
      • Resolve a reserved appointment
      • Publish an response for insurance interaction in a attendance
      • Send insurance token to patient
      • Set appointment copart
      • Check if the the patient has received the connection data, if not and it's been more than 10 seconds, the system will attempt to make an telephonic call to the patient
      • Manually ends the telemedicine call without finishing the attendance
      • Save the evaluation for the telemedicine experience
      • Start/Get the status of the telemedicine video call of an attendance
      • Unlock Blocked Appointments
      • Validate if an attendance is a return
      • Do an action with procedure request previously authorized
      • Manually authorize a procedure in contingency
      • Create a procedure request
      • Create a hospitalization request
      • Save a hospitalization request
      • Get procedure request status
      • Send email notification to patient
      • Send WhatsApp notification to patient with appointment confirmation or exam results
      • Accept Invite
      • Share
      • Returns all the shared routes currently implemented
      • Remove Share
      • Create WaitList
      • Edit WaitList
      • Remove WaitList
    • Totem
      • Start/Get the status of the telemedicine video call of an attendance and autoCheckin totem
      • Generate an attendance ticket PDF and return it
      • Returns the list of attendance places for the clinic
      • Generate a new attendance ticket and return it
      • Create SocketId Based In Clinic ID
    • Appointments
      • Update the payment method for an appointment
    • Authentication
      • Request plan configurations
      • Edit account configurations
      • Get the account configurations
      • Get the webhook integration configurations
      • Register schedule filter configuration
      • Delete schedule filter configuration
      • Get schedule filter configuration
      • Confirm Account
      • Create Account
      • Delete custom pesonal template
      • Forgot Password
      • Get the template for an specific name
      • Invalidate the current logged in token
      • Invalidate all the session for the current user, except this one
      • Reset Password
      • Create Personal Template
      • Create Access Token and Refresh Token for Clinic Users
    • Webhooks
      • Edit account webhook integration configurations
      • Get the webhook integration configurations
    • Integration WhatsApp
      • Remove WhatsApp integration credentials
    • WhatsApp Integration
      • Retrieve WhatsApp integration configuration
      • Configure WhatsApp integration (Twilio)
    • MedFlow
      • Delete MedFlow integration credentials
      • Get MedFlow integration configuration
      • Register MedFlow integration credentials
    • Billing
      • Add attendances to the passed batch
      • Add other expenses to attendance
      • Create manually a honorary attendance to bill
      • Create manually a procedure attendance to bill
      • Assign an authorization code to an attendance
      • Create a authorization batch to bill
      • Remove all attendences from the batch and deletes it
      • Gera um registro a receber para o lote
      • Justify or mark an attendance as return
      • Request an refusal appeal for the informed attendance or batch
      • Check the status of a refusal appeal resource
      • Request the protocol status checking job to run as soon as possible for the specified job
      • Revalue the price of attendances
    • Report Budget
      • Approve or disapprove a budget
      • Create a new budget
      • Create treatment from a budget
      • Edit an existing budget
      • Download PDF of budget
      • Logically delete a budget
      • Send budget to patient via email or WhatsApp
    • Chat
      • Returns the read status for the chat
      • Send a message to an specific user or chat
    • ChatBot
      • Get WhatsApp ChatBot configuration
      • Create ChatBot configuration
      • Get ChatBot Instance configuration
      • Get QR Code to connect chatbot instance
      • Delete instance
      • Update chatbot config
    • Clinic
      • Generate an new attendance ticket for place in clinic
      • Create Clinic
      • Retrieve documents for a clinic
      • Edit Clinic
      • List Clinic
      • Patch Clinic
      • Remove Clinic
      • Generate and return an new totem login for the clinic
      • Disables the totem login for the clinic
      • List Insurances details for the clinic, including the tissParams
      • Simply recall an ticket/patient on the clinic panel
      • Reset ticket for place in clinic
      • Returns the tickets control info for the clinic and place
      • Check the Asaas configuration status of the clinic
      • Clinic GraphQL
      • Retrieve customer data for NFE invoice
      • Update tenant invoice information
      • Returns the list of tickets to panel
      • Alter a prices table
      • Get an prices table
      • Create an empty prices table and returns its Id
      • Create an custom event for use by the tenant
      • Disable of a custom event of the tenant
      • Edit the name of a custom event of the tenant
      • Checks if exists an price for each passed event
      • Create an custom subspecialty for use by the tenant
      • Edit the name of a subspecialty of the tenant
      • Inactivate or active one subspecialty from tenant
    • Communication Center
      • Get WhatsApp Communication Center configuration
      • Create communication Center config
      • Config Communication Center Instance
      • Get QRCode for connect instance
      • Delete instance
    • Documents
      • Returns shared documents and attendance info by access key
    • Finance
      • Create Account
      • Edit Account
      • List Account
      • Remove Account
      • Create Category
      • Edit Category
      • List Category
      • Remove Category
      • List Category
      • Open a new register and start the closing proccess of the previous register
      • Confirm a financial transfer
      • Create bill to pay to the passed clinic
      • Create bill to receive to the passed clinic
      • Create an cash register withdraw to instantly remove money from it
      • Create an transfer of money from the cash register to an account
      • Create an cash register supply to instantly add money to it
      • Edit bill to pay
      • Edit a receivable bill
      • Get payment information for a patient
      • Retrieve PIX QR code
      • Returns the registers flux
      • parcel an finance register
      • Create an online payment for a patient receivable
      • mark an finance as payed with discount and increase details and refreshes the cash register preview
      • Pay an batch of finances with their expected values
      • Return extract of digital account
      • Open a new register and start the closing proccess of the previous register
      • refund an digital finance register
      • Resend a transfer token
      • Unmark a receivable as received
    • Inventory
      • Create a new reserve reason
      • Get a list of categories
      • Delete a category by ID
      • Update a category by ID
      • Export inventory data in CSV or PDF format
      • Get open inventory for the passed clinic
      • Get inventory movement
      • Create inventory movement
      • Recalculate inventory stock for the specified clinic
      • Create inventory product
      • Inactivate an inventory product
      • Edit an inventory product
      • Get an inventory product
      • Create supplier
      • Inactivate a supplier
      • Edit a supplier
    • Invoice
      • Add an insurance billing voucher to the account
      • Add an credit card to the account
      • Mark the tenant as cancelled, so at the end of the billing period it will be charged and blocked
      • Delete and invalidate an IUGU credit card
      • List all the details of the invoice
      • List the current billing plans
      • Retry to charge the main credit card of the account
      • Change the billing plan of the account
      • set the account payment method to 'manual'
    • Medical Record
      • Add a comment to an section of the medical record
      • Create and star a new instant medical attend
      • Delete a medical report from a not sent attendance
      • Save the medical report to record
      • Edit an attendance medical record
      • Get an attendance medical record
      • Generate attendance medical record Files
      • Finish attendance medical record
      • Generate attendance medical record pdfs
      • Get an attendance audio transcription
      • Get the url of an medical report based on the access url + key
      • Copy the pdf from the url and save on Goclin S3 and return url
      • Transfer attendance to another professional
      • Submits an audio file for transcription and adds it to the medical record.
      • Create an new custom form for the professional
      • List the custom forms for the professional
      • Delete an custom form for the professional
      • Edit an custom form for the professional
      • Get the medical record history
      • List the medical record configuration for the logged in professional
      • Save the medical record configuration for the logged in professional
      • Get the medical attend PDFs
      • Add protocol information to the medical record
      • Open a medical protocol
      • Extract questionnaire from bundle
      • Get suggested protocols based on illnesses, symptoms, and CIDs
      • Accept the Medical Record Share Invite
      • Share the Medical Record with the owner patient user or another professional
      • Delete a Medical Record Share
    • Attendance
      • Check the validity of the token and update it if necessary
    • Notification
      • Clear the new notifications counter
      • Change notification read status
      • CallBack SMS
      • Open a new websocket endpoint and return its unique ID, connect to it via /v1/websocket/endpoint?socket=:id
    • Patient
      • Create Patient
      • Create Patient
      • Edit Patient
      • List Patient
      • Edit one single field of the patient
      • Inactive Patient
      • Get patient information by attendance ID
      • Update patient information for the current attendance
      • Unify Patients Medical Redords
      • Register patient allergies
      • List Patient allergies
      • Update dental treatment information for a patient
      • Get dental treatment history of a patient
      • Get the name of a tooth by its ID.
      • Retrieve options for dental treatment.
      • List Patient gestations that the logged professional has access
      • Create Temporary Patient
      • Get Temp Patient
      • Put Temp Patient
      • Inactive Temp Patient
      • Complete Temporary Patient
      • Verify if a patient exists and is active by CPF
    • Patients
      • Create patient vaccines
      • List Patient's vaccines
    • Insurance
      • Create an billing plan for the insurance
      • Unregulated Insurance Solicitation
      • Cancel the sending of the batch
      • Tiss Eligibility
      • Get batch TISS XML
      • Get extra needed params for the TISS Integration
      • Tiss Integration Request
      • Get TISS Integration Status
      • Get Tiss Authorization Procedure Status
      • Tiss send billing batch
    • Price
      • Returns the price of events registered in the price table
    • Printer
      • /print/documents/{type}
      • /printGuide/{registerType}/{id}
      • Show User Schedules
    • Treatment
      • Create a serial treatment request
      • Execute serial treatment
      • Finish a serial treatment
      • Modify a phase of a serial treatment
      • Create a phase in a serial treatment
      • Edit a phase in a serial treatment
      • Delete a phase from a serial treatment
      • Schedule serial treatment
    • Procedure
      • Check if the patient has any requests created during the appointment.
    • Finance Dashboard
      • Retrieve financial reports for received payments
    • Report Dashboard
      • Get attendance data by place for a specific period
      • Get attendance count for a specific period
      • Get average time of attendance for a specific period
      • Get concluded attendance count by insurance for a specific period
      • Get presence attendance data
      • Get count of pending attendances by insurance for a specific period
      • Get pending solicitation statistics by insurance
      • Get receipt by event data for a specific period
      • Get receipt by insurance data for a specific period
      • Get returns count data for a specific period
      • Get wait time on waiting room data for a specific period
      • Get auto check-in attendance data
      • Get wait time on waiting room data for a specific period
    • Report
      • Attendance report
      • Generate an appointment author report based on specific filters.
      • Export ANS Deadline Report
      • Export attendance events report
      • Export document report
      • Generate a medical prescription report based on specific filters.
      • Generate a report for errors related to "no show" appointments
      • Generate a patient report based on filters and export it in CSV or PDF format
      • Generates attendance receipt reports
      • Generates receipts and payments reports
      • Retrieve duplicated treatment report based on specified filters
      • Generate a report of finished treatments
      • Generates a report for treatments in progress based on filters
      • Export survey responses to a file
      • Generate a survey report based on provided filters
    • Signature
      • Webhook to safeId authorize the application
      • Check if the current user is client of SafeID
      • Check if the current user has authorized goclin in SafeID
      • Check if the current user is client of VIDaaS
      • Check if the current user has authorized goclin in VIDaaS
    • Tax Invoice
      • Create a service for tax invoice
      • Inactivate a service for tax invoice
      • Edit a service for tax invoice
    • User
      • List tenant print settings
      • Save tenant print settings
      • Get all the attendance places linked to this user
      • Create User
      • Show User Profile
      • Effectivate an temp user to an definitive User of the tenant
      • Edit User
      • Remove User
      • Edit User Custom Nickname Events
      • Get know what initial steps are left for the user to complete the first journey
      • Get simple user by cpf if it is from another tenant or throws error if its the same
      • Send an solicitation to the user asking for his permission to become an user of the current tenant
      • Get the permissions of the specified user
      • Save user push notifications settings
      • The father user calls this method to accept an invitation to participate of a tenant
      • Validate an professional schedules
    • Payment
      • Delete an transfer
      • Creates a new payable linked to the passed medical transfers
      • Update an transfer
    • Unregulated
      • Generate XML file for a specific batch
    • Reward
      • Show User Reward and InvitationKey
    • Integration
      • Create an insurance interaction for the passed code in insurance
      • Returns the exams details for the attendance
      • Get the possible combinations for materials and exams
    • Whatsapp
      • Get the template for an specific name
      • Get the twilio status for template
  • Esquemas
    • Schemas
      • WebhookConfig
      • IntegrationsRequest
      • Account
      • AuthId
      • Authorization
      • Billing
      • Expense
      • Attendance
      • Requester
      • Transfer
      • Bank
      • Batch
      • BillingPlan
      • Budget
      • Category
      • Character
      • Chat
      • Ciap
      • Cid
      • Clinic
      • Council
      • Document
      • CustomMedicalRecordForm
      • ErrorsDescription
      • EventStep
      • EventDocument
      • EventCustom
      • Event
      • EventCustomEvents
      • EventNickname
      • Finance
      • Insurance
      • Inventory
      • InventoryMovement
      • Kit
      • Log
      • MaterialOrExam
      • MedicalRecordConfig
      • Message
      • Notification
      • CreateHolder
      • LinkHolder
      • Patient
      • PersonalTemplate
      • Price
      • Product
      • Register
      • createdAt
      • ReserveReason
      • Address
      • DigitalCertificate
      • PrintConfig
      • ServiceInfo
      • Treatment
      • Service
      • Share
      • Solicitation
      • Specialty
      • State
      • Supplier
      • TaxInvoice
      • TempPatient
      • User
      • WaitList
      • WebsocketEvent
      • WhatsAppChat
      • WhatsAppMessageHistory
  1. Schemas

Batch

{
    "protocol": "string",
    "batchNumber": "string",
    "status": 0,
    "lastStatusCheck": "2019-08-24T14:15:22.123Z",
    "clinic": "string",
    "pendingSendJob": true,
    "type": "string",
    "authorizationCount": 0,
    "total": 0,
    "insurance": "string",
    "generateReceivable": true,
    "receivable": "string",
    "demonstrative": {
        "attended": true,
        "approvedValue": 0,
        "refusedValue": 0,
        "attendances": {},
        "lastCheck": "2019-08-24T14:15:22.123Z"
    }
}
Built with