{"info":{"title":"Inbox Health Partner API","version":"v2"},"swagger":"2.0","produces":["application/json"],"securityDefinitions":{"api_key":{"type":"apiKey","name":"x-api-key","in":"header"}},"host":"api.demo.inboxhealth.com","tags":[{"name":"users","description":"Operations about users"},{"name":"patients","description":"Operations about patients"},{"name":"payments","description":"Operations about payments"},{"name":"invoices","description":"Operations about invoices"},{"name":"line_items","description":"Operations about line_items"},{"name":"account_managers","description":"Operations about account_managers"},{"name":"events","description":"Operations about events"},{"name":"endpoints","description":"Operations about endpoints"},{"name":"enterprises","description":"Operations about enterprises"},{"name":"appointments","description":"Operations about appointments"},{"name":"practices","description":"Operations about practices"},{"name":"doctors","description":"Operations about doctors"},{"name":"payers","description":"Operations about payers"},{"name":"partner_organizations","description":"Operations about partner_organizations"},{"name":"patient_encounters","description":"Operations about patient_encounters"},{"name":"patient_plans","description":"Operations about patient_plans"},{"name":"attachments","description":"Operations about attachments"},{"name":"referring_doctors","description":"Operations about referring_doctors"},{"name":"imported_payers","description":"Operations about imported_payers"},{"name":"write_offs","description":"Operations about write_offs"},{"name":"write_off_codes","description":"Operations about write_off_codes"},{"name":"admin_organizations","description":"Operations about admin_organizations"},{"name":"payment_reasons","description":"Operations about payment_reasons"},{"name":"tickets","description":"Operations about tickets"},{"name":"changelogs","description":"Operations about changelogs"},{"name":"invoice_payments","description":"Operations about invoice_payments"},{"name":"account_types","description":"Operations about account_types"},{"name":"saved_line_items","description":"Operations about saved_line_items"},{"name":"sftp_uploads","description":"Operations about sftp_uploads"},{"name":"intents","description":"Operations about intents"},{"name":"charge_categories","description":"Operations about charge_categories"},{"name":"notifications","description":"Operations about notifications"},{"name":"import_jobs","description":"Operations about import_jobs"},{"name":"import_batches","description":"Operations about import_batches"},{"name":"payment_adjustments","description":"Operations about payment_adjustments"},{"name":"setup_intents","description":"Operations about setup_intents"}],"paths":{"/partner/v2/users/{id}":{"put":{"description":"Update a user","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the User to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"user[email]","description":"The primary email address of the user","type":"string","required":false},{"in":"formData","name":"user[first_name]","description":"First name of the user","type":"string","required":false},{"in":"formData","name":"user[middle_name]","description":"Middle name of the user","type":"string","required":false},{"in":"formData","name":"user[last_name]","description":"Last name of the user","type":"string","required":false}],"responses":{"200":{"description":"Update a user"}},"tags":["users"],"operationId":"putPartnerV2UsersId"},"delete":{"description":"Delete a user","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the User to get","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a user"}},"tags":["users"],"operationId":"deletePartnerV2UsersId"},"get":{"description":"Display an individual user","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the User to get","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Display an individual user"}},"tags":["users"],"operationId":"getPartnerV2UsersId"}},"/partner/v2/users":{"get":{"description":"User index","produces":["application/json"],"parameters":[{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false}],"responses":{"200":{"description":"User index"}},"tags":["users"],"operationId":"getPartnerV2Users"},"post":{"description":"Create a fellow partner user to join your partner organization. An email to confirm the account, and set the password, will be sent.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"type","description":"The type of user to create.","type":"string","enum":["partner","practice manager","practice_manager"],"required":false},{"in":"formData","name":"enterprise_id","description":"Only applicable for practice manager users.","type":"integer","format":"int32","required":false},{"in":"formData","name":"user[email]","description":"The primary email address of the user","type":"string","required":true},{"in":"formData","name":"user[first_name]","description":"First name of the user","type":"string","required":true},{"in":"formData","name":"user[middle_name]","description":"Middle name of the user","type":"string","required":false},{"in":"formData","name":"user[last_name]","description":"Last name of the user","type":"string","required":true}],"responses":{"201":{"description":"Create a fellow partner user to join your partner organization. An email to confirm the account, and set the password, will be sent."}},"tags":["users"],"operationId":"postPartnerV2Users"}},"/partner/v2/patients/contact_info":{"patch":{"description":"Update bulk patients contact information using ehr_id as identifier, Sending empty or null values will reset the existing values","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"patients[ehr_id]","description":"ehr_id of patient","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"patients[email]","description":"Valid email","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"patients[cell_phone]","description":"10-digit cell phone number","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"patients[secondary_phone]","description":"10-digit secondary phone number","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"enterprise_id","description":"Enterprise id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Update bulk patients contact information using ehr_id as identifier, Sending empty or null values will reset the existing values"}},"tags":["patients"],"operationId":"patchPartnerV2PatientsContactInfo"}},"/partner/v2/patients/{id}":{"put":{"description":"Update a patient","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient id","type":"integer","format":"int32","required":true},{"name":"putPartnerV2PatientsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putPartnerV2PatientsId"}}],"responses":{"200":{"description":"Update a patient","schema":{"$ref":"#/definitions/PatientEntity"}}},"tags":["patients"],"operationId":"putPartnerV2PatientsId"},"delete":{"description":"Delete a patient. This will subsequently cancel any payment plans associated with the patient to be deleted","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The Id of the patient to delete","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete a patient. This will subsequently cancel any payment plans associated with the patient to be deleted","schema":{"$ref":"#/definitions/PatientEntity"}}},"tags":["patients"],"operationId":"deletePartnerV2PatientsId"},"get":{"description":"Return a single patient","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single patient","schema":{"$ref":"#/definitions/PatientEntity"}}},"tags":["patients"],"operationId":"getPartnerV2PatientsId"}},"/partner/v2/patients":{"post":{"description":"Create a new patient","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postPartnerV2Patients","in":"body","required":true,"schema":{"$ref":"#/definitions/postPartnerV2Patients"}}],"responses":{"201":{"description":"Create a new patient","schema":{"$ref":"#/definitions/PatientEntity"}}},"tags":["patients"],"operationId":"postPartnerV2Patients"},"get":{"description":"Return a list of all patients for the user's enterprises based on the URL parameters","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"fetch_time_bucket","description":"Whether to include patients' `time_in_billing_status` field","type":"boolean","required":false},{"in":"query","name":"last_billing_cycle_template_id","description":"Filter patients by their last used billing cycle","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Return a list of all patients for the user's enterprises based on the URL parameters","schema":{"$ref":"#/definitions/GetPatientsEntity"}}},"tags":["patients"],"operationId":"getPartnerV2Patients"}},"/partner/v2/patients/{id}/statement_token":{"get":{"description":"Get the last patient confirmation token","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get the last patient confirmation token"}},"tags":["patients"],"operationId":"getPartnerV2PatientsIdStatementToken"}},"/partner/v2/patients/{id}/statement":{"get":{"description":"Get the current statement for a given patient","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient id","type":"integer","format":"int32","required":true},{"in":"query","name":"invoices_start_date","description":"Start of date range for invoices","type":"string","format":"date","required":false},{"in":"query","name":"invoices_end_date","description":"End of date range for invoices","type":"string","format":"date","required":false}],"responses":{"200":{"description":"Get the current statement for a given patient"}},"tags":["patients"],"operationId":"getPartnerV2PatientsIdStatement"}},"/partner/v2/patients/{id}/merge":{"put":{"description":"Merge two patient accounts, deleting the patient Id in the route and moves their relationships to merging_patient_id defined within the request body","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of patient that will be merged into merging_patient_id and then deleted","type":"integer","format":"int32","required":true},{"in":"formData","name":"merging_patient_id","description":"Id of patient that will accept the merging and will remain active","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Merge two patient accounts, deleting the patient Id in the route and moves their relationships to merging_patient_id defined within the request body","schema":{"$ref":"#/definitions/PatientEntity"}}},"tags":["patients"],"operationId":"putPartnerV2PatientsIdMerge"}},"/partner/v2/patients/{id}/patient_payment_infos":{"get":{"description":"Get all patient payment infos for a patient","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all patient payment infos for a patient","schema":{"type":"array","items":{"$ref":"#/definitions/GetPatientPaymentInfosEntity"}}}},"tags":["patients"],"operationId":"getPartnerV2PatientsIdPatientPaymentInfos"}},"/partner/v2/patients/{id}/notifications":{"get":{"description":"Get all notifications for a patient","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all notifications for a patient","schema":{"$ref":"#/definitions/GetNotificationsEntity"}}},"tags":["patients"],"operationId":"getPartnerV2PatientsIdNotifications"}},"/partner/v2/patients/{id}/payments":{"get":{"description":"Get all the payments for a patient","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the payments for a patient","schema":{"$ref":"#/definitions/GetPaymentsEntity"}}},"tags":["patients"],"operationId":"getPartnerV2PatientsIdPayments"}},"/partner/v2/patients/{id}/invoices":{"get":{"description":"Get all the invoices for a patient","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the invoices for a patient","schema":{"$ref":"#/definitions/GetInvoicesEntity"}}},"tags":["patients"],"operationId":"getPartnerV2PatientsIdInvoices"}},"/partner/v2/payments/{id}":{"put":{"description":"Update a payment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment Id","type":"integer","format":"int32","required":true},{"name":"putPartnerV2PaymentsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putPartnerV2PaymentsId"}}],"responses":{"200":{"description":"Update a payment","schema":{"$ref":"#/definitions/PaymentEntity"}}},"tags":["payments"],"operationId":"putPartnerV2PaymentsId"},"get":{"description":"Return a single payment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single payment","schema":{"$ref":"#/definitions/PaymentEntity"}}},"tags":["payments"],"operationId":"getPartnerV2PaymentsId"}},"/partner/v2/payments/quick_pay":{"post":{"description":"Create a new payment/invoice (Quickpay)","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postPartnerV2PaymentsQuickPay","in":"body","required":true,"schema":{"$ref":"#/definitions/postPartnerV2PaymentsQuickPay"}}],"responses":{"201":{"description":"Create a new payment/invoice (Quickpay)","schema":{"$ref":"#/definitions/QuickPayEntity"}}},"tags":["payments"],"operationId":"postPartnerV2PaymentsQuickPay"}},"/partner/v2/payments":{"post":{"description":"Create a payment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postPartnerV2Payments","in":"body","required":true,"schema":{"$ref":"#/definitions/postPartnerV2Payments"}}],"responses":{"201":{"description":"Create a payment","schema":{"$ref":"#/definitions/PaymentEntity"}}},"tags":["payments"],"operationId":"postPartnerV2Payments"},"get":{"description":"Get a list of payments","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"start_date","description":"Defines the start date for time range","type":"string","required":false},{"in":"query","name":"end_date","description":"Defines the end date for the time range","type":"string","required":false}],"responses":{"200":{"description":"Get a list of payments","schema":{"$ref":"#/definitions/GetPaymentsEntity"}}},"tags":["payments"],"operationId":"getPartnerV2Payments"}},"/partner/v2/payments/{id}/invoice_payments":{"get":{"description":"Get all invoice payments for payment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all invoice payments for payment","schema":{"$ref":"#/definitions/GetInvoicePaymentsEntity"}}},"tags":["payments"],"operationId":"getPartnerV2PaymentsIdInvoicePayments"}},"/partner/v2/payments/{id}/invoices":{"get":{"description":"Get all invoices for payment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all invoices for payment","schema":{"$ref":"#/definitions/GetInvoicesEntity"}}},"tags":["payments"],"operationId":"getPartnerV2PaymentsIdInvoices"}},"/partner/v2/payments/{id}/payment_adjustments":{"get":{"description":"Get associated payment adjustments","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated payment adjustments","schema":{"$ref":"#/definitions/GetPaymentAdjustmentsEntity"}}},"tags":["payments"],"operationId":"getPartnerV2PaymentsIdPaymentAdjustments"}},"/partner/v2/payments/{id}/patient":{"get":{"description":"Get associated patient","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get associated patient","schema":{"$ref":"#/definitions/PatientEntity"}}},"tags":["payments"],"operationId":"getPartnerV2PaymentsIdPatient"}},"/partner/v2/invoices/{id}":{"put":{"description":"Update an invoice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the invoice to update","type":"integer","format":"int32","required":true},{"name":"putPartnerV2InvoicesId","in":"body","required":true,"schema":{"$ref":"#/definitions/putPartnerV2InvoicesId"}}],"responses":{"200":{"description":"Update an invoice","schema":{"$ref":"#/definitions/InvoiceEntity"}}},"tags":["invoices"],"operationId":"putPartnerV2InvoicesId"},"delete":{"description":"Delete an invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The Id of the invoice to delete","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete an invoice","schema":{"$ref":"#/definitions/InvoiceEntity"}}},"tags":["invoices"],"operationId":"deletePartnerV2InvoicesId"},"get":{"description":"Return a single invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single invoice","schema":{"$ref":"#/definitions/InvoiceEntity"}}},"tags":["invoices"],"operationId":"getPartnerV2InvoicesId"}},"/partner/v2/invoices":{"post":{"description":"Create a new invoice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postPartnerV2Invoices","in":"body","required":true,"schema":{"$ref":"#/definitions/postPartnerV2Invoices"}}],"responses":{"201":{"description":"Create a new invoice","schema":{"$ref":"#/definitions/InvoiceEntity"}}},"tags":["invoices"],"operationId":"postPartnerV2Invoices"},"get":{"description":"Return a list of all invoices for the user's enterprises based on the URL parameters","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Return a list of all invoices for the user's enterprises based on the URL parameters","schema":{"$ref":"#/definitions/GetInvoicesEntity"}}},"tags":["invoices"],"operationId":"getPartnerV2Invoices"}},"/partner/v2/invoices/{id}/notifications":{"get":{"description":"Get all notifications for an invoices","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all notifications for an invoices","schema":{"$ref":"#/definitions/GetNotificationsEntity"}}},"tags":["invoices"],"operationId":"getPartnerV2InvoicesIdNotifications"}},"/partner/v2/invoices/{id}/invoice_payments":{"get":{"description":"Get all invoice payments for an invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all invoice payments for an invoice","schema":{"$ref":"#/definitions/GetInvoicePaymentsEntity"}}},"tags":["invoices"],"operationId":"getPartnerV2InvoicesIdInvoicePayments"}},"/partner/v2/invoices/{id}/payments":{"get":{"description":"Get all payments for an invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all payments for an invoice","schema":{"$ref":"#/definitions/GetPaymentsEntity"}}},"tags":["invoices"],"operationId":"getPartnerV2InvoicesIdPayments"}},"/partner/v2/invoices/{id}/line_items":{"get":{"description":"Get all line items for an invoice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all line items for an invoice","schema":{"$ref":"#/definitions/GetLineItemsEntity"}}},"tags":["invoices"],"operationId":"getPartnerV2InvoicesIdLineItems"}},"/partner/v2/line_items/{id}":{"put":{"description":"Updates a line item","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the line item to be updated","type":"integer","format":"int32","required":true},{"in":"formData","name":"line_item[invoice_id]","description":"Invoice Id that owns this line item","type":"integer","format":"int32","required":true},{"in":"formData","name":"line_item[description]","description":"Description of this line item","type":"string","required":true},{"in":"formData","name":"line_item[date_of_service]","description":"Date of service for this line item","type":"string","required":true},{"in":"formData","name":"line_item[total_charge_amount_cents]","description":"Total amount charged for this line item","type":"integer","format":"int32","required":true},{"in":"formData","name":"line_item[covered_amount_cents]","description":"The total amount covered for this line item","type":"integer","format":"int32","required":true},{"in":"formData","name":"line_item[service_code]","description":"Line item service code","type":"string","required":false},{"in":"formData","name":"line_item[saved_line_item_id]","description":"Line item template Id (if applicable)","type":"integer","format":"int32","required":false},{"in":"formData","name":"line_item[tax_amount_cents]","description":"The total tax amount for this line item","type":"integer","format":"int32","required":false},{"in":"formData","name":"line_item[quantity]","description":"Quantity for this line item","type":"integer","format":"int32","default":1,"required":true},{"in":"formData","name":"line_item[insurance_owed_amount_cents]","description":"The amount that is owed by insurance","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Updates a line item"}},"tags":["line_items"],"operationId":"putPartnerV2LineItemsId"},"delete":{"description":"Delete a single line item","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Line item Id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a single line item"}},"tags":["line_items"],"operationId":"deletePartnerV2LineItemsId"},"get":{"description":"Return a single line item","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Line item Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single line item"}},"tags":["line_items"],"operationId":"getPartnerV2LineItemsId"}},"/partner/v2/line_items":{"post":{"description":"Creates a line item","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"line_item[invoice_id]","description":"Invoice Id that owns this line item","type":"integer","format":"int32","required":true},{"in":"formData","name":"line_item[description]","description":"Description of this line item","type":"string","required":true},{"in":"formData","name":"line_item[date_of_service]","description":"Date of service for this line item","type":"string","required":true},{"in":"formData","name":"line_item[total_charge_amount_cents]","description":"Total amount charged for this line item","type":"integer","format":"int32","required":true},{"in":"formData","name":"line_item[covered_amount_cents]","description":"The total amount covered for this line item","type":"integer","format":"int32","required":true},{"in":"formData","name":"line_item[service_code]","description":"Line item service code","type":"string","required":false},{"in":"formData","name":"line_item[saved_line_item_id]","description":"Line item template Id (if applicable)","type":"integer","format":"int32","required":false},{"in":"formData","name":"line_item[tax_amount_cents]","description":"The total tax amount for this line item","type":"integer","format":"int32","required":false},{"in":"formData","name":"line_item[quantity]","description":"Quantity for this line item","type":"integer","format":"int32","default":1,"required":true},{"in":"formData","name":"line_item[insurance_owed_amount_cents]","description":"The amount that is owed by insurance","type":"integer","format":"int32","required":false}],"responses":{"201":{"description":"Creates a line item"}},"tags":["line_items"],"operationId":"postPartnerV2LineItems"}},"/partner/v2/account_managers/{id}":{"delete":{"description":"Delete an account manager. This will subsequently set any Enterprises the account manager maintains to have a nil account manager assigned to them","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Account Manager Id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete an account manager. This will subsequently set any Enterprises the account manager maintains to have a nil account manager assigned to them"}},"tags":["account_managers"],"operationId":"deletePartnerV2AccountManagersId"},"get":{"description":"Retrieve account manager for a particular ID","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of account manager to fetch","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Retrieve account manager for a particular ID"}},"tags":["account_managers"],"operationId":"getPartnerV2AccountManagersId"},"put":{"description":"Update attributes for an account manager","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Account Manager id","type":"integer","format":"int32","required":true},{"in":"formData","name":"account_manager[name]","description":"Name","type":"string","required":true},{"in":"formData","name":"account_manager[sender_id]","description":"Unique ID assigned by the creator of the account manager","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Update attributes for an account manager"}},"tags":["account_managers"],"operationId":"putPartnerV2AccountManagersId"}},"/partner/v2/account_managers":{"get":{"description":"Index of account managers that belong to the partner user's organization","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Index of account managers that belong to the partner user's organization"}},"tags":["account_managers"],"operationId":"getPartnerV2AccountManagers"},"post":{"description":"Create a new account manager","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_manager[name]","description":"Name","type":"string","required":true},{"in":"formData","name":"account_manager[sender_id]","description":"Unique ID assigned by the creator of the account manager","type":"integer","format":"int32","required":false}],"responses":{"201":{"description":"Create a new account manager"}},"tags":["account_managers"],"operationId":"postPartnerV2AccountManagers"}},"/partner/v2/events/{id}":{"get":{"description":"Get single event","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the event","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get single event"}},"tags":["events"],"operationId":"getPartnerV2EventsId"}},"/partner/v2/events/test_webhook":{"post":{"description":"Post test webhook","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"event_type","description":"Name of the event","type":"string","enum":["patient_payment_processed","enterprise_trial_will_end","enterprise_plan_updated","enterprise_plan_changed","enterprise_payment_processed","enterprise_created","enterprise_updated","account_manager_created","patient_created","patient_updated","invoice_created","invoice_updated","payment_created","payment_updated","doctor_created","doctor_updated","line_item_created","line_item_updated","invoice_payment_created","invoice_payment_updated","write_off_created","ticket_created","ticket_updated","attachment_created","attachment_updated","patient_merged","patient_billing_status_updated","batched_in_collections_patient_ids"],"required":true}],"responses":{"201":{"description":"Post test webhook"}},"tags":["events"],"operationId":"postPartnerV2EventsTestWebhook"}},"/partner/v2/events/types":{"get":{"description":"Get types of events","produces":["application/json"],"responses":{"200":{"description":"Get types of events"}},"tags":["events"],"operationId":"getPartnerV2EventsTypes"}},"/partner/v2/events":{"get":{"description":"Get index of events","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get index of events"}},"tags":["events"],"operationId":"getPartnerV2Events"}},"/partner/v2/endpoints/{id}":{"delete":{"description":"Delete an existing endpoint","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the endpoint to delete","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete an existing endpoint"}},"tags":["endpoints"],"operationId":"deletePartnerV2EndpointsId"},"put":{"description":"Update an existing endpoint","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the endpoint to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"endpoint[url]","description":"The url of the endpoint","type":"string","required":true},{"in":"formData","name":"endpoint[registered_webhooks]","description":"List of event types to send to the endpoint","type":"array","items":{"type":"string"},"required":false}],"responses":{"200":{"description":"Update an existing endpoint"}},"tags":["endpoints"],"operationId":"putPartnerV2EndpointsId"},"get":{"description":"Get single endpoint","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the endpoint","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get single endpoint"}},"tags":["endpoints"],"operationId":"getPartnerV2EndpointsId"}},"/partner/v2/endpoints":{"post":{"description":"Create a new endpoint","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"endpoint[url]","description":"The url for the endpoint","type":"string","required":true},{"in":"formData","name":"endpoint[registered_webhooks]","description":"List of event types to send to the endpoint","type":"array","items":{"type":"string"},"required":false}],"responses":{"201":{"description":"Create a new endpoint"}},"tags":["endpoints"],"operationId":"postPartnerV2Endpoints"},"get":{"description":"Get index of endpoints","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get index of endpoints"}},"tags":["endpoints"],"operationId":"getPartnerV2Endpoints"}},"/partner/v2/enterprises":{"post":{"description":"Create a new enterprise","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postPartnerV2Enterprises","in":"body","required":true,"schema":{"$ref":"#/definitions/postPartnerV2Enterprises"}}],"responses":{"201":{"description":"Create a new enterprise","schema":{"$ref":"#/definitions/EnterpriseEntity"}}},"tags":["enterprises"],"operationId":"postPartnerV2Enterprises"},"get":{"description":"Show the enterprise index","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Show the enterprise index","schema":{"$ref":"#/definitions/GetEnterprisesEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2Enterprises"}},"/partner/v2/enterprises/{id}":{"put":{"description":"Update an existing enterprise","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Inbox Health ID of the Enterprise to update","type":"integer","format":"int32","required":true},{"name":"putPartnerV2EnterprisesId","in":"body","required":true,"schema":{"$ref":"#/definitions/putPartnerV2EnterprisesId"}}],"responses":{"200":{"description":"Update an existing enterprise","schema":{"$ref":"#/definitions/EnterpriseEntity"}}},"tags":["enterprises"],"operationId":"putPartnerV2EnterprisesId"},"get":{"description":"Show one particular enterprise","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the enterprise","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Show one particular enterprise","schema":{"$ref":"#/definitions/EnterpriseEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesId"}},"/partner/v2/enterprises/{id}/logo":{"delete":{"description":"Delete the saved logo for this enterprise","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete the saved logo for this enterprise","schema":{"$ref":"#/definitions/EnterpriseEntity"}}},"tags":["enterprises"],"operationId":"deletePartnerV2EnterprisesIdLogo"},"post":{"description":"Create the saved logo for this enterprise","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Create the saved logo for this enterprise","schema":{"$ref":"#/definitions/EnterpriseEntity"}}},"tags":["enterprises"],"operationId":"postPartnerV2EnterprisesIdLogo"},"get":{"description":"Get the saved logo for this enterprise","produces":["application/octet-stream"],"parameters":[{"in":"path","name":"id","description":"Enterprise id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get the saved logo for this enterprise","schema":{"type":"file"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdLogo"}},"/partner/v2/enterprises/{id}/saved_line_items":{"get":{"description":"Get associated saved line items types","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated saved line items types","schema":{"$ref":"#/definitions/SavedLineItemEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdSavedLineItems"}},"/partner/v2/enterprises/{id}/account_types":{"get":{"description":"Get associated account types","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated account types","schema":{"$ref":"#/definitions/AccountTypeEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdAccountTypes"}},"/partner/v2/enterprises/{id}/deposit_accounts":{"get":{"description":"Get associated deposit accounts","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated deposit accounts","schema":{"$ref":"#/definitions/GetDepositAccountsEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdDepositAccounts"}},"/partner/v2/enterprises/{id}/write_off_codes":{"get":{"description":"Get associated write off codes","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated write off codes","schema":{"$ref":"#/definitions/GetWriteOffCodesEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdWriteOffCodes"}},"/partner/v2/enterprises/{id}/billing_cycle_templates":{"get":{"description":"Get associated billing cycle templates","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated billing cycle templates","schema":{"$ref":"#/definitions/GetBillingCycleTemplatesEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdBillingCycleTemplates"}},"/partner/v2/enterprises/{id}/payment_reasons":{"get":{"description":"Get associated enterprise payment reasons","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated enterprise payment reasons","schema":{"$ref":"#/definitions/GetPaymentReasonsEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdPaymentReasons"}},"/partner/v2/enterprises/{id}/admin_organizations":{"get":{"description":"Get associated enterprise admin organizations","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated enterprise admin organizations","schema":{"$ref":"#/definitions/GetAdminOrganizationsEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdAdminOrganizations"}},"/partner/v2/enterprises/{id}/transfers":{"get":{"description":"Get associated enterprise transfers","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated enterprise transfers","schema":{"$ref":"#/definitions/GetTransfersEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdTransfers"}},"/partner/v2/enterprises/{id}/enterprise_payments":{"get":{"description":"Get associated enterprise payments","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated enterprise payments","schema":{"$ref":"#/definitions/GetEnterprisePaymentsEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdEnterprisePayments"}},"/partner/v2/enterprises/{id}/enterprise_payment_infos":{"get":{"description":"Get associated enterprise payment infos","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated enterprise payment infos","schema":{"$ref":"#/definitions/GetEnterprisePaymentInfosEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdEnterprisePaymentInfos"}},"/partner/v2/enterprises/{id}/enterprise_invoices":{"get":{"description":"Get associated enterprise invoices","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated enterprise invoices","schema":{"$ref":"#/definitions/GetEnterpriseInvoicesEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdEnterpriseInvoices"}},"/partner/v2/enterprises/{id}/appointment_templates":{"get":{"description":"Get associated appointment templates","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated appointment templates","schema":{"$ref":"#/definitions/AppointmentTemplateEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdAppointmentTemplates"}},"/partner/v2/enterprises/{id}/patients":{"get":{"description":"Get associated patients","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated patients","schema":{"$ref":"#/definitions/GetPatientsEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdPatients"}},"/partner/v2/enterprises/{id}/doctors":{"get":{"description":"Get associated doctors","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated doctors","schema":{"$ref":"#/definitions/GetDoctorsEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdDoctors"}},"/partner/v2/enterprises/{id}/practices":{"get":{"description":"Get associated practices","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Enterprise Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get associated practices","schema":{"$ref":"#/definitions/GetPracticesEntity"}}},"tags":["enterprises"],"operationId":"getPartnerV2EnterprisesIdPractices"}},"/partner/v2/appointments/{id}":{"put":{"description":"Update an appointment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Appointment ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"appointment[practice_id]","description":"Practice that the appointment is associated with","type":"integer","format":"int32","required":false},{"in":"formData","name":"appointment[patient_id]","description":"Patient that the appointment is scheduled for","type":"integer","format":"int32","required":false},{"in":"formData","name":"appointment[start_time_scheduled_for]","description":"Start Date/Time of appointment","type":"string","format":"date-time","required":false},{"in":"formData","name":"appointment[end_time_scheduled_for]","description":"End Date/Time of appointment","type":"string","format":"date-time","required":false},{"in":"formData","name":"appointment[status]","description":"Status of new appointment","type":"string","enum":["Confirmed","Not Confirmed","Cancelled","Complete","In Session","No Show","","Not Insured","Arrived","Other"],"required":false},{"in":"formData","name":"appointment[external_id]","description":"ID assigned to the appointment by outside PM and/or EHR","type":"string","required":false},{"in":"formData","name":"appointment[note]","description":"Appointment notes","type":"string","required":false},{"in":"formData","name":"appointment[exam_room]","description":"Exam room","type":"string","required":false},{"in":"formData","name":"appointment[appointment_type]","description":"Appointment type","type":"string","required":false},{"in":"formData","name":"appointment[appointment_description]","description":"Appointment description","type":"string","required":false},{"in":"formData","name":"appointment[service_code]","description":"Service code that is used to run eligibility batch queries","type":"string","required":false},{"in":"formData","name":"appointment[appointment_reminders_attributes][scheduled_for]","description":"Date and time of reminder","type":"array","required":true,"items":{"type":"string","format":"date-time"}},{"in":"formData","name":"appointment[appointment_reminders_attributes][id]","description":"reminder Id","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"appointment[appointment_reminders_attributes][_destroy]","description":"if this reminder should be destroyed","type":"array","required":false,"items":{"type":"boolean"}},{"in":"formData","name":"appointment[appointment_reminders_attributes][status]","description":"Status of new appointment reminder","type":"array","required":true,"items":{"type":"string","enum":["sent","scheduled","cancelled"]}},{"in":"formData","name":"appointment[scheduled_eligibility_requests_attributes][scheduled_for]","description":"Date and time of request","type":"array","required":true,"items":{"type":"string","format":"date-time"}},{"in":"formData","name":"appointment[scheduled_eligibility_requests_attributes][status]","description":"Status of new request","type":"array","required":true,"items":{"type":"string","enum":["verified","scheduled","cancelled","failed","error"]}},{"in":"formData","name":"appointment[scheduled_eligibility_requests_attributes][id]","description":"request Id","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"appointment[scheduled_eligibility_requests_attributes][_destroy]","description":"if this request should be destroyed","type":"array","required":false,"items":{"type":"boolean"}}],"responses":{"200":{"description":"Update an appointment"}},"tags":["appointments"],"operationId":"putPartnerV2AppointmentsId"},"get":{"description":"Retrieve an appointment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the appointment to retrieve","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Retrieve an appointment"}},"tags":["appointments"],"operationId":"getPartnerV2AppointmentsId"}},"/partner/v2/appointments":{"get":{"description":"Get index of appointments","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"enterprise_id","description":"The partner enterprise to get appointments for","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Get index of appointments"}},"tags":["appointments"],"operationId":"getPartnerV2Appointments"},"post":{"description":"Create a new appointment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"appointment[practice_id]","description":"Practice that the appointment is associated with","type":"integer","format":"int32","required":true},{"in":"formData","name":"appointment[patient_id]","description":"Patient that the appointment is scheduled for","type":"integer","format":"int32","required":true},{"in":"formData","name":"appointment[start_time_scheduled_for]","description":"Start Date/Time of appointment","type":"string","format":"date-time","required":true},{"in":"formData","name":"appointment[end_time_scheduled_for]","description":"End Date/Time of appointment","type":"string","format":"date-time","required":true},{"in":"formData","name":"appointment[status]","description":"Status of new appointment","type":"string","default":"Not Confirmed","enum":["Confirmed","Not Confirmed","Cancelled","Complete","In Session","No Show","","Not Insured","Arrived","Other"],"required":false},{"in":"formData","name":"appointment[note]","description":"Appointment notes","type":"string","required":false},{"in":"formData","name":"appointment[external_id]","description":"ID assigned to the appointment by outside PM and/or EHR","type":"string","required":false},{"in":"formData","name":"appointment[exam_room]","description":"Exam room","type":"string","required":false},{"in":"formData","name":"appointment[appointment_type]","description":"Appointment type","type":"string","required":false},{"in":"formData","name":"appointment[appointment_description]","description":"Appointment description","type":"string","required":false},{"in":"formData","name":"appointment[service_code]","description":"Service code that is used to run eligibility batch queries","type":"string","required":false},{"in":"formData","name":"appointment[appointment_reminders_attributes][scheduled_for]","description":"Date and time of reminder","type":"array","required":true,"items":{"type":"string","format":"date-time"}},{"in":"formData","name":"appointment[appointment_reminders_attributes][status]","description":"Status of new appointment reminder","type":"array","required":false,"items":{"type":"string","enum":["sent","scheduled","cancelled"]}},{"in":"formData","name":"appointment[scheduled_eligibility_requests_attributes][scheduled_for]","description":"Date and time of request","type":"array","required":true,"items":{"type":"string","format":"date-time"}},{"in":"formData","name":"appointment[scheduled_eligibility_requests_attributes][status]","description":"Status of new request","type":"array","required":false,"items":{"type":"string","enum":["verified","scheduled","cancelled","failed","error"]}}],"responses":{"201":{"description":"Create a new appointment"}},"tags":["appointments"],"operationId":"postPartnerV2Appointments"}},"/partner/v2/appointments/{id}/notifications":{"get":{"description":"Get all notifications for an appointment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Appointment Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all notifications for an appointment"}},"tags":["appointments"],"operationId":"getPartnerV2AppointmentsIdNotifications"}},"/partner/v2/practices":{"post":{"description":"Create a new practice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"practice[name]","description":"Name of the practice","type":"string","required":true},{"in":"formData","name":"practice[address_line_1]","description":"Street address of the practice","type":"string","required":true},{"in":"formData","name":"practice[city]","description":"City of the practice","type":"string","required":true},{"in":"formData","name":"practice[state]","description":"State(location) of the practice","type":"string","required":true},{"in":"formData","name":"practice[enterprise_id]","description":"ID of the parent enterprise object","type":"integer","format":"int32","required":true},{"in":"formData","name":"practice[time_zone]","description":"Time zone of the practice","type":"string","required":true},{"in":"formData","name":"practice[npi]","description":"NPI (National Provider Identifier)","type":"string","required":false},{"in":"formData","name":"practice[address_line_2]","description":"Additional address parameters of the practice","type":"string","required":false},{"in":"formData","name":"practice[zip]","description":"ZIP code of the practice","type":"string","required":false}],"responses":{"201":{"description":"Create a new practice"}},"tags":["practices"],"operationId":"postPartnerV2Practices"},"get":{"description":"Index of practices that belong to partner user","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Index of practices that belong to partner user"}},"tags":["practices"],"operationId":"getPartnerV2Practices"}},"/partner/v2/practices/{id}/doctors":{"get":{"description":"Get all doctors for a practice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Practice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all doctors for a practice"}},"tags":["practices"],"operationId":"getPartnerV2PracticesIdDoctors"}},"/partner/v2/practices/{id}/users":{"get":{"description":"Get all users for a practice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Practice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all users for a practice"}},"tags":["practices"],"operationId":"getPartnerV2PracticesIdUsers"}},"/partner/v2/practices/{id}/practice_users":{"get":{"description":"Get all the practice users for a practice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Practice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the practice users for a practice"}},"tags":["practices"],"operationId":"getPartnerV2PracticesIdPracticeUsers"}},"/partner/v2/practices/{id}/invoices":{"get":{"description":"Get all the invoices for a practice","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Practice Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the invoices for a practice"}},"tags":["practices"],"operationId":"getPartnerV2PracticesIdInvoices"}},"/partner/v2/practices/{id}":{"get":{"description":"Get practice that belongs to an Enterprise managed by this partner user","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of practice to fetch","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get practice that belongs to an Enterprise managed by this partner user"}},"tags":["practices"],"operationId":"getPartnerV2PracticesId"},"delete":{"description":"Delete a practice. This will subsequently cancel any payment plans associated with the practice to be deleted","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Practice Id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a practice. This will subsequently cancel any payment plans associated with the practice to be deleted"}},"tags":["practices"],"operationId":"deletePartnerV2PracticesId"},"put":{"description":"Update attributes for a Practice","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the practice to show","type":"integer","format":"int32","required":true},{"in":"formData","name":"practice[name]","description":"Name of the practice","type":"string","required":false},{"in":"formData","name":"practice[logo]","description":"filename of the practice logo","type":"string","required":false},{"in":"formData","name":"practice[address_line_1]","description":"Street address of the practice","type":"string","required":false},{"in":"formData","name":"practice[address_line_2]","description":"Additional address parameters of the practice","type":"string","required":false},{"in":"formData","name":"practice[city]","description":"City of the practice","type":"string","required":false},{"in":"formData","name":"practice[state]","description":"State(location) of the practice","type":"string","required":false},{"in":"formData","name":"practice[zip]","description":"ZIP code of the practice","type":"string","required":false},{"in":"formData","name":"practice[practice_summary]","description":"general summary of the practice","type":"string","required":false},{"in":"formData","name":"practice[monday_open]","description":"Opening time for the practice on Monday","type":"string","required":false},{"in":"formData","name":"practice[tuesday_open]","description":"Opening time for the practice on Tuesday","type":"string","required":false},{"in":"formData","name":"practice[wednesday_open]","description":"Opening time for the practice on Wednesday","type":"string","required":false},{"in":"formData","name":"practice[thursday_open]","description":"Opening time for the practice on Thursday","type":"string","required":false},{"in":"formData","name":"practice[friday_open]","description":"Opening time for the practice on Friday","type":"string","required":false},{"in":"formData","name":"practice[saturday_open]","description":"Opening time for the practice on Saturday","type":"string","required":false},{"in":"formData","name":"practice[sunday_open]","description":"Opening time for the practice on Sunday","type":"string","required":false},{"in":"formData","name":"practice[monday_close]","description":"Closing time for the practice on Monday","type":"string","required":false},{"in":"formData","name":"practice[tuesday_close]","description":"Closing time for the practice on Tuesday","type":"string","required":false},{"in":"formData","name":"practice[wednesday_close]","description":"Closing time for the practice on Wednesday","type":"string","required":false},{"in":"formData","name":"practice[thursday_close]","description":"Closing time for the practice on Thursday","type":"string","required":false},{"in":"formData","name":"practice[friday_close]","description":"Closing time for the practice on Friday","type":"string","required":false},{"in":"formData","name":"practice[saturday_close]","description":"Closing time for the practice on Saturday","type":"string","required":false},{"in":"formData","name":"practice[sunday_close]","description":"Closing time for the practice on Sunday","type":"string","required":false},{"in":"formData","name":"practice[email]","description":"Practice email address","type":"string","required":false},{"in":"formData","name":"practice[website]","description":"Practice website address","type":"string","required":false},{"in":"formData","name":"practice[phone]","description":"Primary practice phone number","type":"string","required":false},{"in":"formData","name":"practice[npi]","description":"NPI (National Provider Identifier)","type":"string","required":false},{"in":"formData","name":"practice[time_zone]","description":"Time zone of the practice","type":"string","required":false}],"responses":{"200":{"description":"Update attributes for a Practice"}},"tags":["practices"],"operationId":"putPartnerV2PracticesId"}},"/partner/v2/doctors/{id}":{"put":{"description":"Update a doctor's information","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the doctor to update","type":"integer","format":"int32","required":true},{"name":"putPartnerV2DoctorsId","in":"body","required":true,"schema":{"$ref":"#/definitions/putPartnerV2DoctorsId"}}],"responses":{"200":{"description":"Update a doctor's information","schema":{"$ref":"#/definitions/DoctorEntity"}}},"tags":["doctors"],"operationId":"putPartnerV2DoctorsId"},"delete":{"description":"Delete a doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The Id of the doctor to delete","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Delete a doctor","schema":{"$ref":"#/definitions/DoctorEntity"}}},"tags":["doctors"],"operationId":"deletePartnerV2DoctorsId"},"get":{"description":"Return a single doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Doctor Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single doctor","schema":{"$ref":"#/definitions/DoctorEntity"}}},"tags":["doctors"],"operationId":"getPartnerV2DoctorsId"}},"/partner/v2/doctors":{"post":{"description":"Create a new doctor","produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"postPartnerV2Doctors","in":"body","required":true,"schema":{"$ref":"#/definitions/postPartnerV2Doctors"}}],"responses":{"201":{"description":"Create a new doctor","schema":{"$ref":"#/definitions/DoctorEntity"}}},"tags":["doctors"],"operationId":"postPartnerV2Doctors"},"get":{"description":"Return a list of all doctors for the user's enterprises based on the URL parameters.","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Return a list of all doctors for the user's enterprises based on the URL parameters.","schema":{"$ref":"#/definitions/GetDoctorsEntity"}}},"tags":["doctors"],"operationId":"getPartnerV2Doctors"}},"/partner/v2/doctors/{id}/shifts":{"get":{"description":"Get all the shifts for a doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Doctor Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the shifts for a doctor","schema":{"$ref":"#/definitions/GetShiftsEntity"}}},"tags":["doctors"],"operationId":"getPartnerV2DoctorsIdShifts"}},"/partner/v2/doctors/{id}/invoices":{"get":{"description":"Get all the invoices for a doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Doctor Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the invoices for a doctor","schema":{"$ref":"#/definitions/GetInvoicesEntity"}}},"tags":["doctors"],"operationId":"getPartnerV2DoctorsIdInvoices"}},"/partner/v2/doctors/{id}/practices":{"get":{"description":"Get all the practices for a doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Doctor Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the practices for a doctor","schema":{"$ref":"#/definitions/GetPracticesEntity"}}},"tags":["doctors"],"operationId":"getPartnerV2DoctorsIdPractices"}},"/partner/v2/payers":{"get":{"description":"Return a list of Inbox Health Payers based on the URL parameters.","produces":["application/json"],"parameters":[{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false}],"responses":{"200":{"description":"Return a list of Inbox Health Payers based on the URL parameters."}},"tags":["payers"],"operationId":"getPartnerV2Payers"}},"/partner/v2/partner_organizations/{id}":{"get":{"description":"Get a single partner organization","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Partner organization ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get a single partner organization"}},"tags":["partner_organizations"],"operationId":"getPartnerV2PartnerOrganizationsId"}},"/partner/v2/patient_encounters":{"post":{"description":"Create Patient Encounters","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"data_source","description":"The name of the data vendor. See DATA_SOURCE_VENDOR_VALUES for values","type":"string","enum":["other","solv","experity"],"required":true},{"in":"formData","name":"enterprise_id","description":"Enterprise that practice the patient will be visiting","type":"integer","format":"int32","required":true},{"in":"formData","name":"encounters[encounter_at]","description":"The datetime of the appointment/encounter for the patient formatted in ISO 8601 (ie: 2025-09-30T08:15:00Z)","type":"array","required":true,"items":{"type":"string","format":"date-time"}},{"in":"formData","name":"encounters[first_name]","description":"First name of the patient","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"encounters[last_name]","description":"Last name of the patient","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"encounters[health_record_id]","description":"The health record ID of the patient if it is known","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[patient_id]","description":"The IH ID of the patient if we can determine it","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[practice_id]","description":"The practice the patient will be visiting","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[phone_number]","description":"Phone Number of the patient. Generally cell phone.","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[email]","description":"Email of the patient","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[date_of_birth]","description":"Birth Date of the patient formatted in ISO 8601","type":"array","required":false,"items":{"type":"string","format":"date-time"}},{"in":"formData","name":"encounters[doctor_id]","description":"The IH internal ID of the provider","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[provider_first_name]","description":"First name of the provider for the encounter","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[provider_last_name]","description":"Last name of the provider for the encounter","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[provider_npi]","description":"NPI of the provider for the encounter","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[status]","description":"The internal encounter status value","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[encounter_obligations][charge_category_id]","description":"ID of the charge category","type":"array","required":true,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_obligations][total_paid_amount_cents]","description":"Amount paid in cents","type":"array","required":true,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_obligations][total_charge_amount_cents]","description":"Total potential charge amount in cents","type":"array","required":true,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_obligations][description]","description":"Description of the potential charge","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[encounter_obligations][service_code]","description":"Service code for the potential charge","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[external_ids][issuer]","description":"Name of the external system issuing the ID","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"encounters[external_ids][external_id]","description":"ID assigned to the encounter by the external system","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"encounters[external_ids][external_status]","description":"The encounter status value from the external system","type":"array","required":false,"items":{"type":"string"}}],"responses":{"201":{"description":"Create Patient Encounters"}},"tags":["patient_encounters"],"operationId":"postPartnerV2PatientEncounters"}},"/partner/v2/patient_encounters/bulk_update":{"put":{"description":"Update Patient Encounters","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"data_source","description":"The name of the data vendor. See DATA_SOURCE_VENDOR_VALUES for values","type":"string","enum":["other","solv","experity"],"required":true},{"in":"formData","name":"enterprise_id","description":"Enterprise that practice the patient will be visiting","type":"integer","format":"int32","required":true},{"in":"formData","name":"encounters[id]","description":"The Inbox Health ID of the patient encounter","type":"array","required":true,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_at]","description":"The datetime of the appointment/encounter for the patient formatted in ISO 8601 (ie: 2025-09-30T08:15:00Z)","type":"array","required":true,"items":{"type":"string","format":"date-time"}},{"in":"formData","name":"encounters[first_name]","description":"First name of the patient","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[last_name]","description":"Last name of the patient","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[health_record_id]","description":"The health record ID of the patient if it is known","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[practice_id]","description":"The practice the patient will be visiting","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[phone_number]","description":"Phone Number of the patient. Generally cell phone.","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[email]","description":"Email of the patient","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[doctor_id]","description":"The IH internal ID of the provider","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[provider_first_name]","description":"First name of the provider for the encounter","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[provider_last_name]","description":"Last name of the provider for the encounter","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[provider_npi]","description":"NPI of the provider for the encounter","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[status]","description":"The internal encounter status value","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[encounter_obligations][id]","description":"Inbox Health potential charge ID","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_obligations][_destroy]","description":"Set to true to delete the potential charge.","type":"array","required":false,"items":{"type":"boolean"}},{"in":"formData","name":"encounters[encounter_obligations][charge_category_id]","description":"ID of the charge category","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_obligations][total_paid_amount_cents]","description":"Amount paid in cents","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_obligations][total_charge_amount_cents]","description":"Total potential charge amount in cents","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounters[encounter_obligations][description]","description":"Description of the potential charge","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[encounter_obligations][service_code]","description":"Service code for the potential charge","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounters[external_ids][issuer]","description":"Name of the external system issuing the ID","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"encounters[external_ids][external_id]","description":"ID assigned to the encounter by the external system","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"encounters[external_ids][external_status]","description":"The encounter status value from the external system","type":"array","required":false,"items":{"type":"string"}}],"responses":{"200":{"description":"Update Patient Encounters"}},"tags":["patient_encounters"],"operationId":"putPartnerV2PatientEncountersBulkUpdate"}},"/partner/v2/patient_encounters/{encounter_id}":{"get":{"description":"Retrieve a Patient Encounter","produces":["application/json"],"parameters":[{"in":"path","name":"encounter_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Retrieve a Patient Encounter"}},"tags":["patient_encounters"],"operationId":"getPartnerV2PatientEncountersEncounterId"},"delete":{"description":"Delete Patient Encounter","produces":["application/json"],"parameters":[{"in":"path","name":"encounter_id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete Patient Encounter"}},"tags":["patient_encounters"],"operationId":"deletePartnerV2PatientEncountersEncounterId"},"put":{"description":"Update Single Patient Encounter","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"data_source","description":"The name of the data vendor. See DATA_SOURCE_VENDOR_VALUES for values","type":"string","enum":["other","solv","experity"],"required":true},{"in":"formData","name":"enterprise_id","description":"Enterprise that practice the patient will be visiting","type":"integer","format":"int32","required":true},{"in":"formData","name":"encounter_at","description":"The datetime of the appointment/encounter for the patient formatted in ISO 8601 (ie: 2025-09-30T08:15:00Z)","type":"string","format":"date-time","required":true},{"in":"formData","name":"first_name","description":"First name of the patient","type":"string","required":false},{"in":"formData","name":"last_name","description":"Last name of the patient","type":"string","required":false},{"in":"formData","name":"health_record_id","description":"The health record ID of the patient if it is known","type":"string","required":false},{"in":"formData","name":"practice_id","description":"The practice the patient will be visiting","type":"integer","format":"int32","required":false},{"in":"formData","name":"phone_number","description":"Phone Number of the patient. Generally cell phone.","type":"string","required":false},{"in":"formData","name":"email","description":"Email of the patient","type":"string","required":false},{"in":"formData","name":"done","description":"Is the encounter completed?","type":"boolean","required":false},{"in":"formData","name":"doctor_id","description":"The IH internal ID of the provider","type":"integer","format":"int32","required":false},{"in":"formData","name":"provider_first_name","description":"First name of the provider for the encounter","type":"string","required":false},{"in":"formData","name":"provider_last_name","description":"Last name of the provider for the encounter","type":"string","required":false},{"in":"formData","name":"provider_npi","description":"NPI of the provider for the encounter","type":"string","required":false},{"in":"formData","name":"status","description":"The internal encounter status value","type":"string","required":false},{"in":"formData","name":"encounter_obligations[id]","description":"Inbox Health potential charge ID","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounter_obligations[_destroy]","description":"Set to true to delete the potential charge.","type":"array","required":false,"items":{"type":"boolean"}},{"in":"formData","name":"encounter_obligations[charge_category_id]","description":"ID of the charge category","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounter_obligations[total_paid_amount_cents]","description":"Amount paid in cents","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounter_obligations[total_charge_amount_cents]","description":"Total potential charge amount in cents","type":"array","required":false,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"encounter_obligations[description]","description":"Description of the potential charge","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"encounter_obligations[service_code]","description":"Service code for the potential charge","type":"array","required":false,"items":{"type":"string"}},{"in":"formData","name":"external_ids[issuer]","description":"Name of the external system issuing the ID","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"external_ids[external_id]","description":"ID assigned to the encounter by the external system","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"external_ids[external_status]","description":"The encounter status value from the external system","type":"array","required":false,"items":{"type":"string"}},{"in":"path","name":"encounter_id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Update Single Patient Encounter"}},"tags":["patient_encounters"],"operationId":"putPartnerV2PatientEncountersEncounterId"}},"/partner/v2/patient_plans/{id}":{"put":{"description":"Update attributes for a patient plan","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Plan ID to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"patient_plan[patient_id]","description":"Patient ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"patient_plan[first_name]","description":"First Name","type":"string","required":false},{"in":"formData","name":"patient_plan[middle_name]","description":"Middle Name","type":"string","required":false},{"in":"formData","name":"patient_plan[last_name]","description":"Last Name","type":"string","required":false},{"in":"formData","name":"patient_plan[date_of_birth]","description":"Date of Birth","type":"string","required":false},{"in":"formData","name":"patient_plan[payer_id]","description":"Payer ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"patient_plan[imported_payer_id]","description":"Imported Payer ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"patient_plan[member_id]","description":"Member ID","type":"string","required":false},{"in":"formData","name":"patient_plan[group_id]","description":"Group ID","type":"string","required":false},{"in":"formData","name":"patient_plan[primary]","description":"Active primary insurance plan?","type":"boolean","required":false},{"in":"formData","name":"patient_plan[secondary]","description":"Active secondary insurance plan?","type":"boolean","required":false},{"in":"formData","name":"patient_plan[dependent]","description":"Does this plan belong to a different account holder?","type":"boolean","required":false}],"responses":{"200":{"description":"Update attributes for a patient plan"}},"tags":["patient_plans"],"operationId":"putPartnerV2PatientPlansId"},"delete":{"description":"Delete a patient plan","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Plan id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a patient plan"}},"tags":["patient_plans"],"operationId":"deletePartnerV2PatientPlansId"},"get":{"description":"Retrieve a patient plan based on Id","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Plan id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Retrieve a patient plan based on Id"}},"tags":["patient_plans"],"operationId":"getPartnerV2PatientPlansId"}},"/partner/v2/patient_plans":{"post":{"description":"Create a new patient plan associated with a particular patient","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"patient_plan[patient_id]","description":"Patient ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"patient_plan[first_name]","description":"First Name","type":"string","required":true},{"in":"formData","name":"patient_plan[middle_name]","description":"Middle Name","type":"string","required":false},{"in":"formData","name":"patient_plan[last_name]","description":"Last Name","type":"string","required":true},{"in":"formData","name":"patient_plan[date_of_birth]","description":"Date of Birth","type":"string","required":true},{"in":"formData","name":"patient_plan[payer_id]","description":"Payer ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"patient_plan[imported_payer_id]","description":"Payer ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"patient_plan[member_id]","description":"Member ID","type":"string","required":false},{"in":"formData","name":"patient_plan[group_id]","description":"Group ID","type":"string","required":false},{"in":"formData","name":"patient_plan[primary]","description":"Active primary insurance plan?","type":"boolean","required":false},{"in":"formData","name":"patient_plan[secondary]","description":"Active secondary insurance plan?","type":"boolean","required":false},{"in":"formData","name":"patient_plan[dependent]","description":"Does this plan belong to a different account holder?","type":"boolean","required":false}],"responses":{"201":{"description":"Create a new patient plan associated with a particular patient"}},"tags":["patient_plans"],"operationId":"postPartnerV2PatientPlans"}},"/partner/v2/patient_plans/{id}/reactivate":{"put":{"description":"Undelete a patient plan","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Plan Id","type":"integer","format":"int32","required":true},{"in":"formData","name":"type","description":"Patient Plan type","type":"string","enum":["secondary","primary"],"required":true}],"responses":{"200":{"description":"Undelete a patient plan"}},"tags":["patient_plans"],"operationId":"putPartnerV2PatientPlansIdReactivate"}},"/partner/v2/patient_plans/{id}/eligibility_responses":{"get":{"description":"Retrieve eligibility responses for patient plan","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Plan Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Retrieve eligibility responses for patient plan"}},"tags":["patient_plans"],"operationId":"getPartnerV2PatientPlansIdEligibilityResponses"}},"/partner/v2/patient_plans/{id}/verify":{"put":{"description":"Verify a patient plan's insurance eligibility","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Patient Plan Id","type":"integer","format":"int32","required":true},{"in":"formData","name":"service_code","description":"Service Type(s) for the inquiry","type":"string","required":false},{"in":"formData","name":"service_code_label","description":"Label associated with the (primary) submitted service type","type":"string","required":false},{"in":"formData","name":"npi","description":"Specific provider NPI for which we are submiting an insurance eligibility request","type":"string","required":false},{"in":"formData","name":"network","description":"A three-value enum that indicates network status of the eligibility request","type":"string","required":false},{"in":"formData","name":"additional_service_codes","description":"A three-value enum that indicates network status of the eligibility request","type":"array","items":{"type":"string"},"required":false},{"in":"formData","name":"selected_procedure_codes","description":"A three-value enum that indicates network status of the eligibility request","type":"array","items":{"type":"string"},"required":false},{"in":"formData","name":"date","description":"Specific date you're looking to process the eligibility query for (YYYY-MM-DD).","type":"string","required":false},{"in":"formData","name":"from_date","description":"Specify a lower bound for dates (YYYY-MM-DD).","type":"string","required":false},{"in":"formData","name":"to_date","description":"Specify an upper bound for dates (YYYY-MM-DD).","type":"string","required":false}],"responses":{"200":{"description":"Verify a patient plan's insurance eligibility"}},"tags":["patient_plans"],"operationId":"putPartnerV2PatientPlansIdVerify"}},"/partner/v2/attachments":{"post":{"description":"Create a new attachment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"attachment[enterprise_id]","type":"string","required":true},{"in":"formData","name":"attachment[display_name]","type":"string","required":true},{"in":"formData","name":"attachment[category]","type":"string","required":true},{"in":"formData","name":"attachment[patient_id]","description":"Associate attachment with this patient id","type":"integer","format":"int32","required":false},{"in":"formData","name":"attachment[ticket_id]","description":"Associate attachment with this ticket id","type":"integer","format":"int32","required":false},{"in":"formData","name":"attachment[user_id]","description":"Associate attachment with this user id","type":"integer","format":"int32","required":false},{"in":"formData","name":"is_statement_addendum","description":"Attachment is for statement addendum","type":"boolean","required":false}],"responses":{"201":{"description":"Create a new attachment"}},"tags":["attachments"],"operationId":"postPartnerV2Attachments"},"get":{"description":"Return a list of attachments based on the URL parameters.","produces":["application/json"],"parameters":[{"in":"query","name":"practice_id","description":"Fetch attachments based on this practice id","type":"integer","format":"int32","required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false}],"responses":{"200":{"description":"Return a list of attachments based on the URL parameters."}},"tags":["attachments"],"operationId":"getPartnerV2Attachments"}},"/partner/v2/attachments/{id}/view":{"get":{"description":"View a single attachment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Attachment Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"View a single attachment"}},"tags":["attachments"],"operationId":"getPartnerV2AttachmentsIdView"}},"/partner/v2/attachments/{id}/download":{"get":{"description":"Download a single attachment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Attachment Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Download a single attachment"}},"tags":["attachments"],"operationId":"getPartnerV2AttachmentsIdDownload"}},"/partner/v2/attachments/{id}":{"delete":{"description":"Delete an existing attachment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Attachment Id","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete an existing attachment"}},"tags":["attachments"],"operationId":"deletePartnerV2AttachmentsId"},"put":{"description":"Update a attachment's information","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the attachment to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"attachment[display_name]","type":"string","required":true},{"in":"formData","name":"attachment[category]","type":"string","required":true}],"responses":{"200":{"description":"Update a attachment's information"}},"tags":["attachments"],"operationId":"putPartnerV2AttachmentsId"},"get":{"description":"Return a single attachment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of attachment to fetch","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single attachment"}},"tags":["attachments"],"operationId":"getPartnerV2AttachmentsId"}},"/partner/v2/attachments/{id}/fileupload":{"post":{"description":"Accepts the actual file content for the specified attachment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Attachment id","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Accepts the actual file content for the specified attachment"}},"tags":["attachments"],"operationId":"postPartnerV2AttachmentsIdFileupload"}},"/partner/v2/referring_doctors/{id}":{"put":{"description":"Update a referring doctor's information","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the referring doctor to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"referring_doctor[first_name]","description":"First name of the referring doctor","type":"string","required":false},{"in":"formData","name":"referring_doctor[middle_name]","description":"Middle name of the referring doctor","type":"string","required":false},{"in":"formData","name":"referring_doctor[last_name]","description":"Last name of the referring doctor","type":"string","required":false},{"in":"formData","name":"referring_doctor[phone]","description":"Phone number","type":"string","required":false},{"in":"formData","name":"referring_doctor[specialty]","description":"Referring doctor's speciality","type":"string","required":false},{"in":"formData","name":"referring_doctor[email]","description":"Referring doctor's email","type":"string","required":false},{"in":"formData","name":"referring_doctor[suffix]","description":"Suffix","type":"string","required":false},{"in":"formData","name":"referring_doctor[npi]","description":"Referring doctor NPI","type":"string","required":false},{"in":"formData","name":"referring_doctor[enterprise_id]","description":"The Enterprise Id that the referring doctor will be associated with","type":"integer","format":"int32","required":false},{"in":"formData","name":"referring_doctor[provider_code]","description":"The provider code of the referring doctor","type":"string","required":false},{"in":"formData","name":"referring_doctor[doctor_external_id]","description":"The external Id of the referring doctor.","type":"string","required":false}],"responses":{"200":{"description":"Update a referring doctor's information"}},"tags":["referring_doctors"],"operationId":"putPartnerV2ReferringDoctorsId"},"delete":{"description":"Delete a referring doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"The Id of the referring doctor to delete","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a referring doctor"}},"tags":["referring_doctors"],"operationId":"deletePartnerV2ReferringDoctorsId"},"get":{"description":"Return a single referring doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Doctor Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single referring doctor"}},"tags":["referring_doctors"],"operationId":"getPartnerV2ReferringDoctorsId"}},"/partner/v2/referring_doctors":{"post":{"description":"Create a new referring doctor","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"referring_doctor[first_name]","description":"First name of the referring doctor","type":"string","required":true},{"in":"formData","name":"referring_doctor[middle_name]","description":"Middle name of the referring doctor","type":"string","required":false},{"in":"formData","name":"referring_doctor[last_name]","description":"Last name of the referring doctor","type":"string","required":true},{"in":"formData","name":"referring_doctor[phone]","description":"Phone number","type":"string","required":false},{"in":"formData","name":"referring_doctor[specialty]","description":"Referring doctor's speciality","type":"string","required":false},{"in":"formData","name":"referring_doctor[email]","description":"Referring doctor's email","type":"string","required":false},{"in":"formData","name":"referring_doctor[suffix]","description":"Suffix","type":"string","required":false},{"in":"formData","name":"referring_doctor[npi]","description":"Referring doctor NPI","type":"string","required":false},{"in":"formData","name":"referring_doctor[enterprise_id]","description":"The Enterprise Id that the referring doctor will be associated with","type":"integer","format":"int32","required":true},{"in":"formData","name":"referring_doctor[provider_code]","description":"The provider code of the referring doctor","type":"string","required":false},{"in":"formData","name":"referring_doctor[doctor_external_id]","description":"The external Id of the referring doctor.","type":"string","required":false}],"responses":{"201":{"description":"Create a new referring doctor"}},"tags":["referring_doctors"],"operationId":"postPartnerV2ReferringDoctors"},"get":{"description":"Return a list of all referring doctors for the user's enterprises based on the URL parameters.","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Return a list of all referring doctors for the user's enterprises based on the URL parameters."}},"tags":["referring_doctors"],"operationId":"getPartnerV2ReferringDoctors"}},"/partner/v2/referring_doctors/{id}/invoices":{"get":{"description":"Get all the invoices for a referring doctor","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Referring doctor Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all the invoices for a referring doctor"}},"tags":["referring_doctors"],"operationId":"getPartnerV2ReferringDoctorsIdInvoices"}},"/partner/v2/imported_payers/{id}":{"put":{"description":"Update an imported payer","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Imported payer id for lookup","type":"integer","format":"int32","required":true},{"in":"formData","name":"imported_payer[raw_payer_name]","description":"Raw payer name for the imported payer","type":"string","required":false},{"in":"formData","name":"imported_payer[display_in_ui]","description":"Display boolean for the imported payer","type":"boolean","required":false},{"in":"formData","name":"imported_payer[display_name]","description":"Display payer name for the imported payer","type":"string","required":false},{"in":"formData","name":"imported_payer[is_favorite]","description":"Is favorite boolean for the imported payer","type":"boolean","required":false},{"in":"formData","name":"imported_payer[payer_id]","description":"Actual payer_id for the raw name","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Update an imported payer"}},"tags":["imported_payers"],"operationId":"putPartnerV2ImportedPayersId"},"get":{"description":"Return a single imported payer","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the imported payer","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single imported payer"}},"tags":["imported_payers"],"operationId":"getPartnerV2ImportedPayersId"}},"/partner/v2/imported_payers":{"post":{"description":"Create a new imported payer","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"imported_payer[enterprise_id]","description":"Enterprise associated with imported payer","type":"integer","format":"int32","required":true},{"in":"formData","name":"imported_payer[raw_payer_name]","description":"Raw payer name for the imported payer","type":"string","required":true},{"in":"formData","name":"imported_payer[display_in_ui]","description":"Display boolean for the imported payer","type":"boolean","required":true},{"in":"formData","name":"imported_payer[display_name]","description":"Display payer name for the imported payer","type":"string","required":false},{"in":"formData","name":"imported_payer[is_favorite]","description":"Is favorite boolean for the imported payer","type":"boolean","required":false},{"in":"formData","name":"imported_payer[payer_id]","description":"Actual payer_id for the raw name","type":"integer","format":"int32","required":false}],"responses":{"201":{"description":"Create a new imported payer"}},"tags":["imported_payers"],"operationId":"postPartnerV2ImportedPayers"},"get":{"description":"Return a list of payers based on the URL parameters.","produces":["application/json"],"parameters":[{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false}],"responses":{"200":{"description":"Return a list of payers based on the URL parameters."}},"tags":["imported_payers"],"operationId":"getPartnerV2ImportedPayers"}},"/partner/v2/write_offs":{"post":{"description":"Create a new write off","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"write_off[patient_id]","description":"Patient that the write off is associated with","type":"integer","format":"int32","required":true},{"in":"formData","name":"write_off[date]","description":"Date associated with write off","type":"string","format":"date-time","required":true},{"in":"formData","name":"write_off[write_off_code_id]","description":"Write off code associated with write off","type":"integer","format":"int32","required":true},{"in":"formData","name":"write_off[amount_cents]","description":"Integer amount for the write off","type":"integer","format":"int32","required":true},{"in":"formData","name":"write_off[apply_preference]","description":"Apply preference associated with write off","type":"string","enum":["full","manual","oldest_to_newest"],"required":false}],"responses":{"201":{"description":"Create a new write off"}},"tags":["write_offs"],"operationId":"postPartnerV2WriteOffs"},"get":{"description":"Get write offs","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get write offs"}},"tags":["write_offs"],"operationId":"getPartnerV2WriteOffs"}},"/partner/v2/write_offs/{id}/line_items":{"get":{"description":"Get associated line items","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Write off id","type":"integer","format":"int32","required":true},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false}],"responses":{"200":{"description":"Get associated line items"}},"tags":["write_offs"],"operationId":"getPartnerV2WriteOffsIdLineItems"}},"/partner/v2/write_offs/{id}":{"get":{"description":"Return a single write off","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the write off","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single write off"}},"tags":["write_offs"],"operationId":"getPartnerV2WriteOffsId"}},"/partner/v2/write_off_codes/{id}":{"put":{"description":"Update a write off code","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the write off code to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"write_off_code[enterprise_id]","description":"Enterprise that the write off code is associated with","type":"integer","format":"int32","required":false},{"in":"formData","name":"write_off_code[code]","description":"The code value","type":"string","required":false},{"in":"formData","name":"write_off_code[description]","description":"The description","type":"string","required":false},{"in":"formData","name":"write_off_code[issuer]","description":"The issuer that the write off code is associated with","type":"string","required":false},{"in":"formData","name":"write_off_code[external_id]","description":"The external Id of the write off code","type":"string","required":false}],"responses":{"200":{"description":"Update a write off code"}},"tags":["write_off_codes"],"operationId":"putPartnerV2WriteOffCodesId"},"get":{"description":"Return a single write off code","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the write off code","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single write off code"}},"tags":["write_off_codes"],"operationId":"getPartnerV2WriteOffCodesId"}},"/partner/v2/write_off_codes":{"post":{"description":"Create a new write off code","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"write_off_code[enterprise_id]","description":"Enterprise that the write off code is associated with","type":"integer","format":"int32","required":true},{"in":"formData","name":"write_off_code[code]","description":"The code value","type":"string","required":true},{"in":"formData","name":"write_off_code[description]","description":"The description","type":"string","required":true},{"in":"formData","name":"write_off_code[issuer]","description":"The issuer that the write off code is associated with","type":"string","required":false},{"in":"formData","name":"write_off_code[external_id]","description":"The external Id of the write off code","type":"string","required":false}],"responses":{"201":{"description":"Create a new write off code"}},"tags":["write_off_codes"],"operationId":"postPartnerV2WriteOffCodes"},"get":{"description":"Get write off codes","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get write off codes"}},"tags":["write_off_codes"],"operationId":"getPartnerV2WriteOffCodes"}},"/partner/v2/admin_organizations/{id}":{"put":{"description":"Update an admin organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Admin organization id","type":"integer","format":"int32","required":true},{"in":"formData","name":"admin_organization[name]","description":"Name of the Admin organization","type":"string","required":false},{"in":"formData","name":"admin_organization[enterprise_ids]","description":"Array of enterprise ids to associate with admin organization","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"admin_organization[email]","description":"Email for the admin organization customer","type":"string","required":false},{"in":"formData","name":"admin_organization[auto_charge]","description":"Auto-charge setting for the admin org","type":"boolean","default":true,"required":false},{"in":"formData","name":"admin_organization[contract_start_date]","description":"Contract start date for the admin org","type":"string","format":"date-time","required":false},{"in":"formData","name":"admin_organization[days_until_due]","description":"Number of days a customer has to pay invoices","type":"integer","format":"int32","required":false},{"in":"formData","name":"admin_organization[gross_payment_rate]","description":"Gross payment rate for the admin org","type":"number","format":"double","required":false},{"in":"formData","name":"admin_organization[included_gross_payment_amount_cents]","description":"Included gross payment amount cents for the admin org","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Update an admin organization"}},"tags":["admin_organizations"],"operationId":"putPartnerV2AdminOrganizationsId"},"get":{"description":"Return a single admin organization","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the admin organization","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single admin organization"}},"tags":["admin_organizations"],"operationId":"getPartnerV2AdminOrganizationsId"}},"/partner/v2/admin_organizations":{"post":{"description":"Create a new admin organization","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"admin_organization[name]","description":"Name of the Admin organization","type":"string","required":true},{"in":"formData","name":"admin_organization[enterprise_ids]","description":"Array of enterprise ids to associate with admin organization","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"admin_organization[email]","description":"Email for the admin organization customer","type":"string","required":false},{"in":"formData","name":"admin_organization[auto_charge]","description":"Auto-charge setting for the admin org","type":"boolean","default":true,"required":false},{"in":"formData","name":"admin_organization[contract_start_date]","description":"Contract start date for the admin org","type":"string","format":"date-time","required":false},{"in":"formData","name":"admin_organization[days_until_due]","description":"Number of days a customer has to pay invoices","type":"integer","format":"int32","required":false},{"in":"formData","name":"admin_organization[gross_payment_rate]","description":"Gross payment rate for the admin org","type":"number","format":"double","required":false},{"in":"formData","name":"admin_organization[included_gross_payment_amount_cents]","description":"Included gross payment amount cents for the admin org","type":"integer","format":"int32","required":false}],"responses":{"201":{"description":"Create a new admin organization"}},"tags":["admin_organizations"],"operationId":"postPartnerV2AdminOrganizations"},"get":{"description":"Index admin organizations","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Index admin organizations"}},"tags":["admin_organizations"],"operationId":"getPartnerV2AdminOrganizations"}},"/partner/v2/admin_organizations/{id}/users":{"get":{"description":"Get all users for admin organization","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Admin Organization Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all users for admin organization"}},"tags":["admin_organizations"],"operationId":"getPartnerV2AdminOrganizationsIdUsers"}},"/partner/v2/admin_organizations/{id}/enterprises":{"get":{"description":"Get all enterprises for admin organization","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Admin Organization Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all enterprises for admin organization"}},"tags":["admin_organizations"],"operationId":"getPartnerV2AdminOrganizationsIdEnterprises"}},"/partner/v2/payment_reasons/{id}":{"put":{"description":"Update a payment reason.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the payment reason to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"payment_reason[enterprise_id]","description":"The Enterprise Id that the payment reason will be associated with","type":"integer","format":"int32","required":false},{"in":"formData","name":"payment_reason[code]","description":"Code value of the payment reason","type":"string","required":false},{"in":"formData","name":"payment_reason[description]","description":"Description of the payment reason","type":"string","required":false}],"responses":{"200":{"description":"Update a payment reason."}},"tags":["payment_reasons"],"operationId":"putPartnerV2PaymentReasonsId"},"get":{"description":"Return a single payment reason.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment reason Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single payment reason."}},"tags":["payment_reasons"],"operationId":"getPartnerV2PaymentReasonsId"}},"/partner/v2/payment_reasons":{"post":{"description":"Create a new payment reason.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"payment_reason[enterprise_id]","description":"The Enterprise Id that the payment reason will be associated with","type":"integer","format":"int32","required":true},{"in":"formData","name":"payment_reason[code]","description":"Code value of the payment reason","type":"string","required":true},{"in":"formData","name":"payment_reason[description]","description":"Description of the payment reason","type":"string","required":true}],"responses":{"201":{"description":"Create a new payment reason."}},"tags":["payment_reasons"],"operationId":"postPartnerV2PaymentReasons"},"get":{"description":"Return a list of all payment reason codes for the user's enterprises based on the URL parameters.","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Return a list of all payment reason codes for the user's enterprises based on the URL parameters."}},"tags":["payment_reasons"],"operationId":"getPartnerV2PaymentReasons"}},"/partner/v2/payment_reasons/{id}/payment_reasons_invoice_payments":{"get":{"description":"Return associated payment reasons invoice payments.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment reason Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Return associated payment reasons invoice payments."}},"tags":["payment_reasons"],"operationId":"getPartnerV2PaymentReasonsIdPaymentReasonsInvoicePayments"}},"/partner/v2/tickets/{id}":{"get":{"description":"Get a single ticket","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Ticket Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get a single ticket"}},"tags":["tickets"],"operationId":"getPartnerV2TicketsId"}},"/partner/v2/changelogs":{"get":{"description":"Display a changelog for a model ID","produces":["application/json"],"parameters":[{"in":"query","name":"id","description":"ID of the model to get a changelog for","type":"string","required":true},{"in":"query","name":"model_type","description":"Type of the model","type":"string","required":true},{"in":"query","name":"full_logs","description":"Whether to load full changelog history or just recent changes (current and previous quarters)","type":"boolean","default":false,"required":false}],"responses":{"200":{"description":"Display a changelog for a model ID"}},"tags":["changelogs"],"operationId":"getPartnerV2Changelogs"}},"/partner/v2/changelogs/types":{"get":{"description":"Get types of models that have a changelog","produces":["application/json"],"responses":{"200":{"description":"Get types of models that have a changelog"}},"tags":["changelogs"],"operationId":"getPartnerV2ChangelogsTypes"}},"/partner/v2/invoice_payments/{id}":{"get":{"description":"Return a single invoice payment.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Invoice payment Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Return a single invoice payment."}},"tags":["invoice_payments"],"operationId":"getPartnerV2InvoicePaymentsId"},"put":{"description":"Update an invoice payment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Id of the invoice payment to update","type":"integer","format":"int32","required":true},{"in":"formData","name":"invoice_payment[paid_amount_cents]","description":"Amount paid","type":"integer","format":"int32","required":false},{"in":"formData","name":"invoice_payment[reversal]","description":"if the payment was reversed","type":"boolean","required":false},{"in":"formData","name":"invoice_payment[reversal_date]","description":"date invoice payment was reversed","type":"integer","format":"int32","required":false},{"in":"formData","name":"invoice_payment[payment_reasons_invoice_payments_attributes][payment_reason_id]","description":"payment reason id for this invoice payment","type":"array","required":true,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"invoice_payment[payment_reasons_invoice_payments_attributes][amount_cents]","description":"Amount the payment reason covers, defaults 0 if not given","type":"array","required":false,"items":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Update an invoice payment"}},"tags":["invoice_payments"],"operationId":"putPartnerV2InvoicePaymentsId"}},"/partner/v2/invoice_payments":{"post":{"description":"Create a new invoice payment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"invoice_payment[payment_id]","description":"ID of the payment","type":"integer","format":"int32","required":true},{"in":"formData","name":"invoice_payment[invoice_id]","description":"ID of the invoice","type":"integer","format":"int32","required":true},{"in":"formData","name":"invoice_payment[paid_amount_cents]","description":"Amount paid","type":"integer","format":"int32","required":true},{"in":"formData","name":"invoice_payment[reversal]","description":"if the payment was reversed","type":"boolean","required":false},{"in":"formData","name":"invoice_payment[reversal_date]","description":"date invoice payment was reversed","type":"integer","format":"int32","required":false},{"in":"formData","name":"invoice_payment[payment_reasons_invoice_payments_attributes][payment_reason_id]","description":"payment reason id for this invoice payment","type":"array","required":true,"items":{"type":"integer","format":"int32"}},{"in":"formData","name":"invoice_payment[payment_reasons_invoice_payments_attributes][amount_cents]","description":"Amount the payment reason covers, defaults 0 if not given","type":"array","required":false,"items":{"type":"integer","format":"int32"}}],"responses":{"201":{"description":"Create a new invoice payment"}},"tags":["invoice_payments"],"operationId":"postPartnerV2InvoicePayments"}},"/partner/v2/account_types/{id}":{"delete":{"description":"Delete an account type","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Record ID","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete an account type"}},"tags":["account_types"],"operationId":"deletePartnerV2AccountTypesId"},"put":{"description":"Update an account type","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Record ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"account_type[incoming_billing_status]","description":"Incoming Billing Status","type":"string","required":false},{"in":"formData","name":"account_type[outgoing_billing_status]","description":"Outgoing Billing Status","type":"string","required":false},{"in":"formData","name":"account_type[code]","description":"Account Type Code","type":"string","required":true},{"in":"formData","name":"account_type[description]","description":"Account Type Description","type":"string","required":true},{"in":"formData","name":"account_type[uid]","description":"Unique ID","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Update an account type"}},"tags":["account_types"],"operationId":"putPartnerV2AccountTypesId"},"get":{"description":"Get account type data for an entry","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the entry","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get account type data for an entry"}},"tags":["account_types"],"operationId":"getPartnerV2AccountTypesId"}},"/partner/v2/account_types":{"post":{"description":"Create account type for an enterprise","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"account_type[enterprise_id]","description":"Enterprise ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"account_type[incoming_billing_status]","description":"Incoming Billing Status","type":"string","required":false},{"in":"formData","name":"account_type[outgoing_billing_status]","description":"Outgoing Billing Status","type":"string","required":false},{"in":"formData","name":"account_type[code]","description":"Account Type Code","type":"string","required":true},{"in":"formData","name":"account_type[description]","description":"Account Type Description","type":"string","required":true},{"in":"formData","name":"account_type[uid]","description":"Unique ID","type":"integer","format":"int32","required":false}],"responses":{"201":{"description":"Create account type for an enterprise"}},"tags":["account_types"],"operationId":"postPartnerV2AccountTypes"},"get":{"description":"Get account types for all enterprises for this partner","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get account types for all enterprises for this partner"}},"tags":["account_types"],"operationId":"getPartnerV2AccountTypes"}},"/partner/v2/saved_line_items/{id}":{"delete":{"description":"Delete a saved line item","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Record ID","type":"integer","format":"int32","required":true}],"responses":{"204":{"description":"Delete a saved line item"}},"tags":["saved_line_items"],"operationId":"deletePartnerV2SavedLineItemsId"},"put":{"description":"Update a saved line item type","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"Record ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"saved_line_item[covered_amount_cents]","description":"Covered Amount (in cents)","type":"integer","format":"int32","required":false},{"in":"formData","name":"saved_line_item[total_charge_amount_cents]","description":"Total Charged Amount (in cents)","type":"integer","format":"int32","required":false},{"in":"formData","name":"saved_line_item[service_code]","description":"Service Code","type":"string","required":false},{"in":"formData","name":"saved_line_item[created_by_user_id]","description":"Created by User ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"saved_line_item[description]","description":"Description","type":"string","required":false},{"in":"formData","name":"saved_line_item[tax_amount_cents]","description":"Tax Amount (in cents)","type":"integer","format":"int32","required":true},{"in":"formData","name":"saved_line_item[code_type]","description":"Code Type","type":"string","required":false},{"in":"formData","name":"saved_line_item[category]","description":"Category","type":"string","required":false},{"in":"formData","name":"saved_line_item[ignored_by_collections]","description":"Ignored by Collections","type":"boolean","required":false}],"responses":{"200":{"description":"Update a saved line item type"}},"tags":["saved_line_items"],"operationId":"putPartnerV2SavedLineItemsId"},"get":{"description":"Get saved line item data for an entry","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the entry","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get saved line item data for an entry"}},"tags":["saved_line_items"],"operationId":"getPartnerV2SavedLineItemsId"}},"/partner/v2/saved_line_items":{"post":{"description":"Create saved line item for an enterprise","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"saved_line_item[enterprise_id]","description":"Enterprise ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"saved_line_item[covered_amount_cents]","description":"Covered Amount (in cents)","type":"integer","format":"int32","required":false},{"in":"formData","name":"saved_line_item[total_charge_amount_cents]","description":"Total Charged Amount (in cents)","type":"integer","format":"int32","required":false},{"in":"formData","name":"saved_line_item[service_code]","description":"Service Code","type":"string","required":false},{"in":"formData","name":"saved_line_item[created_by_user_id]","description":"Created by User ID","type":"integer","format":"int32","required":false},{"in":"formData","name":"saved_line_item[description]","description":"Description","type":"string","required":false},{"in":"formData","name":"saved_line_item[tax_amount_cents]","description":"Tax Amount (in cents)","type":"integer","format":"int32","required":true},{"in":"formData","name":"saved_line_item[code_type]","description":"Code Type","type":"string","required":false},{"in":"formData","name":"saved_line_item[category]","description":"Category","type":"string","required":false},{"in":"formData","name":"saved_line_item[ignored_by_collections]","description":"Ignored by Collections","type":"boolean","required":false}],"responses":{"201":{"description":"Create saved line item for an enterprise"}},"tags":["saved_line_items"],"operationId":"postPartnerV2SavedLineItems"},"get":{"description":"Get saved line items for all enterprises for this partner","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get saved line items for all enterprises for this partner"}},"tags":["saved_line_items"],"operationId":"getPartnerV2SavedLineItems"}},"/partner/v2/sftp_uploads/create_import_batch":{"post":{"description":"Create an import batch (with single/multiple files / import jobs) for an existing sftp uploaded files","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"enterprise_id","description":"The enterprise ID to create the import batch for","type":"integer","format":"int32","required":true},{"in":"formData","name":"filename","description":"The Array of names of the file that were uploaded via sftp. You can obtain the available file names by making a GET request to /partner/v2/sftp_uploads","type":"array","items":{"type":"string"},"required":true},{"in":"formData","name":"input_format","description":"Input parsing format","type":"string","default":"invoice","enum":["patient","invoice","payment","saved_line_item","invoice_payment","balance","prcode"],"required":false},{"in":"formData","name":"delete_file","description":"Delete source files when processing","type":"boolean","default":false,"required":false},{"in":"formData","name":"start","description":"Start the import batch immediately","type":"boolean","default":false,"required":false}],"responses":{"201":{"description":"Create an import batch (with single/multiple files / import jobs) for an existing sftp uploaded files"}},"tags":["sftp_uploads"],"operationId":"postPartnerV2SftpUploadsCreateImportBatch"}},"/partner/v2/sftp_uploads":{"get":{"description":"List available sftp uploads for enterprise","produces":["application/json"],"parameters":[{"in":"query","name":"enterprise_ids","description":"Array of enterprise ids retrieve available sftp uploads for","type":"#\u003cSet: {Integer}\u003e","default":[],"required":false}],"responses":{"200":{"description":"List available sftp uploads for enterprise"}},"tags":["sftp_uploads"],"operationId":"getPartnerV2SftpUploads"}},"/partner/v2/intents/{id}/cancel":{"put":{"description":"Cancel an Inbox Health intent, and with Stripe","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"The Inbox Health intent ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Cancel an Inbox Health intent, and with Stripe"}},"tags":["intents"],"operationId":"putPartnerV2IntentsIdCancel"}},"/partner/v2/intents":{"post":{"description":"Create a new Inbox Health payment intent and an accompanying Stripe PaymentIntent","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"do_not_save_payment_method","description":"A boolean to determine whether to save the Intent's payment method","type":"boolean","required":false},{"in":"formData","name":"intent[enterprise_id]","description":"The enterprise ID for the intent","type":"integer","format":"int32","required":true},{"in":"formData","name":"intent[amount_cents]","description":"The amount of the intent, in cents","type":"integer","format":"int32","required":true},{"in":"formData","name":"intent[patient_id]","description":"The patient ID to be associated with the intent","type":"integer","format":"int32","required":false},{"in":"formData","name":"intent[payment_id]","description":"The Inbox Health payment id to be associated with the intent","type":"integer","format":"int32","required":false},{"in":"formData","name":"intent[first_name]","description":"The patient's first name","type":"string","required":false},{"in":"formData","name":"intent[last_name]","description":"The patient's last name","type":"string","required":false},{"in":"formData","name":"intent[date_of_birth]","description":"The patient's date of birth","type":"string","format":"date-time","required":false},{"in":"formData","name":"intent[email_address]","description":"The patient's email address","type":"string","required":false},{"in":"formData","name":"intent[cell_phone]","description":"The patient's cell phone number","type":"string","required":false},{"in":"formData","name":"intent[contact_preference]","description":"Contact preference on how patient will receive their bills","type":"string","enum":["none","sms","email","both"],"required":false},{"in":"formData","name":"intent[description]","description":"The description for the intent","type":"string","required":false},{"in":"formData","name":"intent[idempotency_key]","description":"The Stripe idempotency key for the intent","type":"string","required":false},{"in":"formData","name":"intent[card_present]","description":"Boolean indicating whether the card is present at the time of intent creation","type":"boolean","default":false,"required":false},{"in":"formData","name":"intent[deposit_account_id]","description":"The deposit account ID to set as the payment destination","type":"integer","format":"int32","required":false},{"in":"formData","name":"intent[patient_payment_info_id]","description":"The ID of the saved patient payment info object to associate with this intent","type":"integer","format":"int32","required":false},{"in":"formData","name":"intent[patient_agreement_ids]","description":"Array of Patient Agreement IDs associated with this Payment Intent","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"formData","name":"intent[health_record_id]","description":"Patient's health record id","type":"string","required":false},{"in":"formData","name":"intent[card_reader_id]","description":"The card reader ID (Stripe ID) to associate with this intent","type":"string","required":false}],"responses":{"201":{"description":"Create a new Inbox Health payment intent and an accompanying Stripe PaymentIntent"}},"tags":["intents"],"operationId":"postPartnerV2Intents"},"get":{"description":"Return a list of all intents for the user's enterprises based on the URL parameters","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Return a list of all intents for the user's enterprises based on the URL parameters"}},"tags":["intents"],"operationId":"getPartnerV2Intents"}},"/partner/v2/intents/{id}":{"get":{"description":"Get an Inbox Health Intent","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Intent ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get an Inbox Health Intent"}},"tags":["intents"],"operationId":"getPartnerV2IntentsId"}},"/partner/v2/charge_categories":{"get":{"description":"Return all charge_categories.","produces":["application/json"],"parameters":[{"in":"query","name":"enterprise_id","description":"ID of the enterprise this charge belongs to","type":"integer","format":"int32","required":false}],"responses":{"200":{"description":"Return all charge_categories."}},"tags":["charge_categories"],"operationId":"getPartnerV2ChargeCategories"}},"/partner/v2/charge_categories/{id}":{"get":{"description":"Retrieve a single charge category","produces":["application/json"],"parameters":[{"in":"path","name":"id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Retrieve a single charge category"}},"tags":["charge_categories"],"operationId":"getPartnerV2ChargeCategoriesId"}},"/partner/v2/notifications/{id}":{"get":{"description":"Get a single notification","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Notification ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get a single notification"}},"tags":["notifications"],"operationId":"getPartnerV2NotificationsId"}},"/partner/v2/notifications/sent_emails/{id}":{"get":{"description":"Get all sent emails","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the patient to get sent notifications for","type":"string","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all sent emails"}},"tags":["notifications"],"operationId":"getPartnerV2NotificationsSentEmailsId"}},"/partner/v2/notifications/sent_sms/{id}":{"get":{"description":"Get all sent sms","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the patient to get sent notifications for","type":"string","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all sent sms"}},"tags":["notifications"],"operationId":"getPartnerV2NotificationsSentSmsId"}},"/partner/v2/notifications/sent_calls/{id}":{"get":{"description":"Get all sent voice calls","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the patient to get sent notifications for","type":"string","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all sent voice calls"}},"tags":["notifications"],"operationId":"getPartnerV2NotificationsSentCallsId"}},"/partner/v2/notifications/sent_paper_bills/{id}":{"get":{"description":"Get all sent paper bills","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the patient to get sent notifications for","type":"string","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all sent paper bills"}},"tags":["notifications"],"operationId":"getPartnerV2NotificationsSentPaperBillsId"}},"/partner/v2/notifications/sent/{id}":{"get":{"description":"Get all sent notifications","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the patient to get sent notifications for","type":"string","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all sent notifications"}},"tags":["notifications"],"operationId":"getPartnerV2NotificationsSentId"}},"/partner/v2/notifications":{"get":{"description":"Get a list of notifications","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get a list of notifications"}},"tags":["notifications"],"operationId":"getPartnerV2Notifications"}},"/partner/v2/notifications/{id}/notification_logs":{"get":{"description":"Get all notification logs for a notification","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Notification Id","type":"integer","format":"int32","required":true},{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get all notification logs for a notification"}},"tags":["notifications"],"operationId":"getPartnerV2NotificationsIdNotificationLogs"}},"/partner/v2/import_jobs/import_jobs_for_import_batch":{"post":{"description":"Create up to 5 new import jobs","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"import_jobs[input_format]","description":"Input parsing format","type":"array","required":true,"items":{"type":"string","enum":["patient","invoice","payment","saved_line_item","invoice_payment","balance","prcode"]}},{"in":"formData","name":"import_jobs[path_to_raw_file]","description":"Path to AWS S3 file","type":"array","required":true,"items":{"type":"string"}},{"in":"formData","name":"enterprise_id","description":"ID of the Enterprise the job belongs to","type":"integer","format":"int32","required":true},{"in":"formData","name":"import_batch_id","description":"ID of the ImportBatch the job belongs to","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Create up to 5 new import jobs"}},"tags":["import_jobs"],"operationId":"postPartnerV2ImportJobsImportJobsForImportBatch"}},"/partner/v2/import_batches":{"post":{"description":"Creates an import batch","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"import_batch[status]","description":"The initial status of the import batch","type":"string","required":true},{"in":"formData","name":"import_batch[import_template_group_id]","description":"The import template group id running within this import batch","type":"integer","format":"int32","required":true},{"in":"formData","name":"import_batch[enterprise_id]","description":"The enterprise ID this import batch belongs to","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Creates an import batch"}},"tags":["import_batches"],"operationId":"postPartnerV2ImportBatches"},"get":{"description":"Get the import batches index","produces":["application/json"],"parameters":[{"in":"query","name":"sort","description":"Which model attribute to sort the results by","type":"string","required":false},{"in":"query","name":"q","description":"String to search records by","type":"string","required":false},{"in":"query","name":"do_nulls_last","description":"The nulls last query is a slow one, only want to fire it when explicitly wanted","type":"boolean","required":false},{"in":"formData","name":"workspace_enterprise_ids","description":"Array of Enterprise IDs to filter results on","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"query","name":"cbo","description":"DANGER: Request OptimizerHints check","type":"boolean","default":false,"required":false},{"in":"query","name":"page","description":"Page number to retrieve, default 10 results per page","type":"integer","format":"int32","required":false},{"in":"query","name":"per_page","description":"How many results per page to return","type":"integer","format":"int32","required":false},{"in":"query","name":"get_total_pages_and_count","description":"Do get total pages and count for request","type":"boolean","required":false}],"responses":{"200":{"description":"Get the import batches index"}},"tags":["import_batches"],"operationId":"getPartnerV2ImportBatches"}},"/partner/v2/import_batches/{id}":{"post":{"description":"Start an import batch","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"ID of the import batch to start","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Start an import batch"}},"tags":["import_batches"],"operationId":"postPartnerV2ImportBatchesId"}},"/partner/v2/payment_adjustments/{id}":{"get":{"description":"Get payment adjustment","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Payment Adjustment Id","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get payment adjustment"}},"tags":["payment_adjustments"],"operationId":"getPartnerV2PaymentAdjustmentsId"}},"/partner/v2/payment_adjustments":{"post":{"description":"Create a new payment adjustment","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"voided","description":"Should this payment be voided?","type":"boolean","required":false},{"in":"formData","name":"payment_adjustment[payment_id]","description":"Payment id","type":"integer","format":"int32","required":true},{"in":"formData","name":"payment_adjustment[amount_cents]","description":"Amount to be refunded","type":"integer","format":"int32","required":true},{"in":"formData","name":"payment_adjustment[refund_reason]","description":"Entered reason for this refund","type":"string","required":false}],"responses":{"201":{"description":"Create a new payment adjustment"}},"tags":["payment_adjustments"],"operationId":"postPartnerV2PaymentAdjustments"}},"/partner/v2/setup_intents/finalize_setup":{"post":{"description":"Finalize a setup intent and create the associated payment method.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"id","description":"Intent ID","type":"integer","format":"int32","required":true}],"responses":{"201":{"description":"Finalize a setup intent and create the associated payment method."}},"tags":["setup_intents"],"operationId":"postPartnerV2SetupIntentsFinalizeSetup"}},"/partner/v2/setup_intents/{id}":{"put":{"description":"Update an existing Inbox Health setup intent.","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"path","name":"id","description":"The Inbox Health setup intent ID","type":"integer","format":"int32","required":true},{"in":"formData","name":"setup_intent[email_address]","description":"The patient's email address","type":"string","required":false},{"in":"formData","name":"setup_intent[cell_phone]","description":"The patient's cell phone number","type":"string","required":false},{"in":"formData","name":"setup_intent[contact_preference]","description":"Contact preference on how patient will receive their bills","type":"string","enum":["none","sms","email","both"],"required":false},{"in":"formData","name":"setup_intent[health_record_id]","description":"Patient's health record id","type":"string","required":false}],"responses":{"200":{"description":"Update an existing Inbox Health setup intent."}},"tags":["setup_intents"],"operationId":"putPartnerV2SetupIntentsId"},"get":{"description":"Get a single setup intent.","produces":["application/json"],"parameters":[{"in":"path","name":"id","description":"Intent ID","type":"integer","format":"int32","required":true}],"responses":{"200":{"description":"Get a single setup intent."}},"tags":["setup_intents"],"operationId":"getPartnerV2SetupIntentsId"}},"/partner/v2/setup_intents":{"post":{"description":"Create a new Inbox Health setup intent and an accompanying Stripe SetupIntent","produces":["application/json"],"consumes":["application/json"],"parameters":[{"in":"formData","name":"setup_intent[enterprise_id]","description":"The enterprise ID for the intent","type":"integer","format":"int32","required":true},{"in":"formData","name":"setup_intent[patient_id]","description":"The patient ID to be associated with the intent","type":"integer","format":"int32","required":false},{"in":"formData","name":"setup_intent[first_name]","description":"The patient's first name","type":"string","required":false},{"in":"formData","name":"setup_intent[last_name]","description":"The patient's last name","type":"string","required":false},{"in":"formData","name":"setup_intent[date_of_birth]","description":"The patient's date of birth","type":"string","format":"date-time","required":false},{"in":"formData","name":"setup_intent[card_present]","description":"Boolean indicating whether the card is present at the time of intent creation","type":"boolean","required":false},{"in":"formData","name":"setup_intent[deposit_account_id]","description":"The deposit account ID to set as the payment destination","type":"integer","format":"int32","required":false},{"in":"formData","name":"setup_intent[patient_agreement_ids]","description":"Array of Patient Agreement IDs associated with setup intent","type":"array","items":{"type":"integer","format":"int32"},"required":false},{"in":"formData","name":"setup_intent[health_record_id]","description":"Patient's health record id","type":"string","required":false}],"responses":{"201":{"description":"Create a new Inbox Health setup intent and an accompanying Stripe SetupIntent"}},"tags":["setup_intents"],"operationId":"postPartnerV2SetupIntents"}}},"definitions":{"putPartnerV2PatientsId":{"type":"object","properties":{"patient":{"type":"object","properties":{"first_name":{"type":"string","description":"Patient's first name"},"middle_name":{"type":"string","description":"Patient's middle name"},"last_name":{"type":"string","description":"Patient's last name"},"address_line_1":{"type":"string","description":"Patient's address line 1"},"address_line_2":{"type":"string","description":"Patient's address line 2"},"city":{"type":"string","description":"Patient's city"},"state":{"type":"string","description":"Patient's state"},"zip":{"type":"string","description":"Patient's zip code"},"sex":{"type":"string","description":"Patient's sex"},"ssn":{"type":"string","description":"Patient's social security number"},"primary":{"type":"boolean","description":"Patient's primary boolean. This is deprecated and no longer used."},"cell_phone":{"type":"string","description":"Patient's cell phone number"},"secondary_phone":{"type":"string","description":"Patient's secondary phone number"},"email":{"type":"string","description":"Patient's email"},"date_of_birth":{"type":"string","format":"date","description":"Patient's date of birth"},"health_record_id":{"type":"string","description":"Patient's health record id"},"notes":{"type":"string","description":"Patient notes"},"race":{"type":"string","description":"Patient race"},"ethnicity":{"type":"string","description":"Patient ethnicity"},"language":{"type":"string","description":"Patient language"},"marital_status":{"type":"string","description":"Patient marital status"},"employment_status":{"type":"string","description":"Patient employment status"},"employer_name":{"type":"string","description":"Patient employer"},"contact_preference":{"type":"string","description":"Contact preference","enum":["none","sms","email","both"]},"occupation":{"type":"string","description":"Patient occupation"},"pharmacy_name":{"type":"string","description":"Patient pharmacy"},"pharmacy_address_line_1":{"type":"string","description":"Patient pharmacy address"},"pharmacy_address_line_2":{"type":"string","description":"Patient pharmacy address"},"pharmacy_city":{"type":"string","description":"Patient pharmacy city"},"pharmacy_state":{"type":"string","description":"Patient pharmacy state"},"pharmacy_phone_number":{"type":"string","description":"Patient pharmacy phone number"},"maiden_name":{"type":"string","description":"Patient maiden name"},"home_phone":{"type":"string","description":"Patient home phone number"},"work_phone":{"type":"string","description":"Patient work phone number"},"practice_id":{"type":"string","description":"Patient's practice id"},"sms_opt_out":{"type":"boolean","description":"Patient sms opt out boolean"},"phone_opt_out":{"type":"boolean","description":"Patient robocall opt out boolean"},"guarantor_id":{"type":"integer","format":"int32","description":"Patient ID of responsible party (financially/and as a guardian)"},"emergency_contacts_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"ID of emergency contact"},"first_name":{"type":"string","description":"Emergency Contact first name"},"last_name":{"type":"string","description":"Emergency Contact last name"},"cell_phone":{"type":"string","description":"Emergency Contact cell phone"},"secondary_phone":{"type":"string","description":"Emergency Contact secondary phone"},"relationship":{"type":"string","description":"Emergency Contact relationship to patient"}}}},"billing_error_message":{"type":"string","description":"Determines the billing error message"},"billing_status":{"type":"string","description":"Determines what state of the billing life cycle this patient account is in","enum":["billable","scheduled","complete","error","pending_insurance","excluded","collections","no_response"]},"auto_charge":{"type":"boolean","description":"Enable/disable automatically charging a patient their balance remainder"},"auto_charge_max_cents":{"type":"integer","format":"int32","description":"Specifies a maximum amount to charge a patient automatically via the auto_charge action"},"primary_care_provider_name":{"type":"string","description":"Name of patient's primary care provider"},"primary_care_provider_city":{"type":"string","description":"City of patient's primary care provider"},"primary_care_provider_state":{"type":"string","description":"State of patient's primary care provider"},"statement_cycle_started_at":{"type":"string","format":"date-time","description":"Statement cycle date of patient"},"collection_warning_letter_date":{"type":"string","format":"date-time","description":"Collection warning letter date of patient"},"past_due":{"type":"boolean","description":"Whether patient is in past_due"},"precollection":{"type":"boolean","description":"Whether patient is in precollection"},"hold_until":{"type":"string","format":"date-time","description":"Hold Date"},"corrected_address_line_1":{"type":"string","description":"The patient's corrected address line 1, most likely per a address validation tool"},"corrected_address_line_2":{"type":"string","description":"The patient's corrected address line 2, most likely per a address validation tool"},"corrected_city":{"type":"string","description":"The patient's corrected city, most likely per a address validation tool"},"corrected_state":{"type":"string","description":"The patient's corrected state abbreviation, most likely per a address validation tool"},"corrected_zip":{"type":"string","description":"The patient's corrected zip, most likely per a address validation tool"},"force_bad_address_mailing":{"type":"boolean","description":"Whether to force mailing of patient's statements regardless of bad address"},"allow_self_directed_payment_plan":{"type":"boolean","description":"Specifies if the patient is allowed to self direct their own payment plan"},"next_billing_cycle_template_id":{"type":"integer","format":"int32","description":"Specifies patient next billing cycle template id"}}}},"required":["patient"],"description":"Update a patient"},"PatientEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"user_id":{"type":"integer","format":"int32"},"enterprise_id":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"first_name_legal":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"cell_phone":{"type":"string"},"secondary_phone":{"type":"string"},"date_of_birth":{"type":"string"},"primary":{"type":"boolean"},"ssn":{"type":"string"},"sex":{"type":"string"},"removed":{"type":"boolean"},"email":{"type":"string"},"zip":{"type":"string"},"email_two":{"type":"string"},"health_record_id":{"type":"integer","format":"int32"},"notes":{"type":"string"},"balance_cents":{"type":"integer","format":"int32"},"soft_delete":{"type":"string"},"patient_plans":{"type":"array","items":{"$ref":"#/definitions/PatientPlanEntity"}},"last_notified_at":{"type":"string"},"race":{"type":"string"},"language":{"type":"string"},"ethnicity":{"type":"string"},"marital_status":{"type":"string"},"employment_status":{"type":"string"},"employer_name":{"type":"string"},"contact_preference":{"type":"string"},"occupation":{"type":"string"},"pharmacy_name":{"type":"string"},"pharmacy_address_line_1":{"type":"string"},"pharmacy_address_line_2":{"type":"string"},"pharmacy_city":{"type":"string"},"pharmacy_state":{"type":"string"},"pharmacy_phone_number":{"type":"string"},"maiden_name":{"type":"string"},"home_phone":{"type":"string"},"work_phone":{"type":"string"},"practice_id":{"type":"string"},"sms_opt_out":{"type":"boolean"},"phone_opt_out":{"type":"boolean"},"emergency_contacts":{"type":"array","items":{"$ref":"#/definitions/EmergencyContactEntity"}},"external_ids":{"type":"array","items":{"$ref":"#/definitions/ExternalIdEntity"}},"statement_cycle_started_at":{"type":"string"},"collection_warning_letter_date":{"type":"string"},"needs_card_update":{"type":"boolean"},"cached_balance_cents":{"type":"integer","format":"int32"},"balance_error_message":{"type":"string"},"allow_self_directed_payment_plan":{"type":"string"},"force_bad_address_mailing":{"type":"string"},"last_collection_report_sent_at":{"type":"string"},"guarantor_id":{"type":"string"},"merged_patient_id":{"type":"string"},"corrected_address_line_1":{"type":"string"},"corrected_address_line_2":{"type":"string"},"corrected_city":{"type":"string"},"corrected_state":{"type":"string"},"corrected_zip":{"type":"string"},"billing_status":{"type":"string"},"billing_error_message":{"type":"string"},"auto_charge":{"type":"string"},"auto_charge_max_cents":{"type":"string"},"current_billing_cycle_paper_bills_count":{"type":"string"},"hold_until":{"type":"string"},"is_auto_applying_payments":{"type":"string"},"precollection":{"type":"string"},"links":{"type":"object","properties":{"invoices":{"type":"string"},"payments":{"type":"string"},"notifications":{"type":"string"},"patient_payment_infos":{"type":"string"},"tickets":{"type":"string"}}}},"description":"PatientEntity model"},"PatientPlanEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"member_id":{"type":"string"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"date_of_birth":{"type":"string"},"payer_id":{"type":"integer","format":"int32"},"imported_payer_id":{"type":"integer","format":"int32"},"group_id":{"type":"string"},"primary":{"type":"boolean"},"patient_id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"secondary":{"type":"boolean"},"dependent":{"type":"boolean"},"soft_delete":{"type":"boolean"},"eligibility_responses":{"$ref":"#/definitions/EligibilityResponseEntity"}}},"EligibilityResponseEntity":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"patient_plan_id":{"type":"string"},"eligible_request":{"type":"string"},"eligible_response":{"type":"string"},"service_code":{"type":"string"},"service_code_label":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"enterprise_id":{"type":"string"},"successful":{"type":"string"},"invoice_id":{"type":"string"},"service_location":{"type":"string"},"service_location_label":{"type":"string"},"scheduled_eligibility_request_id":{"type":"string"}}},"EmergencyContactEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"last_name":{"type":"string"},"cell_phone":{"type":"string"},"secondary_phone":{"type":"string"},"relationship":{"type":"string"},"patient_id":{"type":"integer","format":"int32"}}},"ExternalIdEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"issuer":{"type":"string"},"external_id":{"type":"string"}}},"postPartnerV2Patients":{"type":"object","properties":{"force":{"type":"boolean","description":"Force create patient. This is ignored and not used for the Partner API","default":false},"patient":{"type":"object","properties":{"first_name":{"type":"string","description":"First Name"},"last_name":{"type":"string","description":"Last Name"},"date_of_birth":{"type":"string","description":"Date of Birth"},"enterprise_id":{"type":"integer","format":"int32","description":"Enterprise id"},"middle_name":{"type":"string","description":"Patient's middle name"},"address_line_1":{"type":"string","description":"Patient's address line 1"},"address_line_2":{"type":"string","description":"Patient's address line 2"},"city":{"type":"string","description":"Patient's city"},"state":{"type":"string","description":"Patient's state"},"zip":{"type":"string","description":"Patient's zip code"},"sex":{"type":"string","description":"Patient's sex"},"ssn":{"type":"string","description":"Patient's social security number"},"primary":{"type":"boolean","description":"Patient's primary boolean. This is deprecated and no longer used."},"cell_phone":{"type":"string","description":"Patient's cell phone number"},"secondary_phone":{"type":"string","description":"Patient's secondary phone number"},"email":{"type":"string","description":"Patient's email"},"health_record_id":{"type":"string","description":"Patient's health record id"},"notes":{"type":"string","description":"Patient notes"},"race":{"type":"string","description":"Patient race"},"marital_status":{"type":"string","description":"Patient marital status"},"language":{"type":"string","description":"Patient language"},"ethnicity":{"type":"string","description":"Patient ethnicity"},"employment_status":{"type":"string","description":"Patient employment status"},"employer_name":{"type":"string","description":"Patient employer"},"contact_preference":{"type":"string","description":"Contact preference","enum":["none","sms","email","both"]},"occupation":{"type":"string","description":"Patient occupation"},"pharmacy_name":{"type":"string","description":"Patient pharmacy"},"pharmacy_address_line_1":{"type":"string","description":"Patient pharmacy address"},"pharmacy_address_line_2":{"type":"string","description":"Patient pharmacy address"},"pharmacy_city":{"type":"string","description":"Patient pharmacy city"},"pharmacy_state":{"type":"string","description":"Patient pharmacy state"},"pharmacy_phone_number":{"type":"string","description":"Patient pharmacy phone number"},"maiden_name":{"type":"string","description":"Patient maiden name"},"home_phone":{"type":"string","description":"Patient home phone number"},"work_phone":{"type":"string","description":"Patient work phone number"},"practice_id":{"type":"string","description":"Patient's practice id"},"sms_opt_out":{"type":"boolean","description":"Patient sms opt out boolean"},"phone_opt_out":{"type":"boolean","description":"Patient robocall opt out boolean"},"emergency_contacts_attributes":{"type":"array","items":{"type":"object","properties":{"first_name":{"type":"string","description":"Emergency Contact first name"},"last_name":{"type":"string","description":"Emergency Contact last name"},"cell_phone":{"type":"string","description":"Emergency Contact cell phone"},"secondary_phone":{"type":"string","description":"Emergency Contact seconday phone"},"relationship":{"type":"string","description":"Emergency Contact relationship to patient"}}}},"billing_status":{"type":"string","description":"Determines what state of the billing life cycle this patient account is in","enum":["billable","scheduled","complete","error","pending_insurance","excluded","collections","no_response"]},"primary_care_provider_name":{"type":"string","description":"Name of patient's primary care provider"},"primary_care_provider_city":{"type":"string","description":"City of patient's primary care provider"},"primary_care_provider_state":{"type":"string","description":"State of patient's primary care provider"},"hold_until":{"type":"string","format":"date-time","description":"Hold Date"},"force_bad_address_mailing":{"type":"boolean","description":"Whether to force mailing of patient's statements regardless of bad address"},"allow_self_directed_payment_plan":{"type":"boolean","description":"Specifies if the patient is allowed to self direct their own payment plan"}},"required":["first_name","last_name","date_of_birth","enterprise_id"]}},"required":["patient"],"description":"Create a new patient"},"GetPatientsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"patients":{"type":"array","items":{"$ref":"#/definitions/PatientEntity"}}},"description":"GetPatientsEntity model"},"MetaEntity":{"type":"object","properties":{"total_pages":{"type":"integer","format":"int32"},"current_page":{"type":"integer","format":"int32"},"per_page":{"type":"integer","format":"int32"},"has_more":{"type":"boolean"}}},"GetPatientPaymentInfosEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"patient_payment_infos":{"type":"array","items":{"$ref":"#/definitions/PatientPaymentInfoEntity"}}},"description":"GetPatientPaymentInfosEntity model"},"PatientPaymentInfoEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"last_4_digits":{"type":"string"},"expiration_month":{"type":"string"},"expiration_year":{"type":"string"},"account_holder_name":{"type":"string"},"primary":{"type":"boolean"},"payment_processing_instrument_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"patient_id":{"type":"integer","format":"int32"},"brand":{"type":"string"},"funding":{"type":"string"},"card_label":{"type":"string"},"created_by_user_id":{"type":"integer","format":"int32"},"bank_name":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"initial_intent_id":{"type":"string"},"soft_delete":{"type":"string"},"links":{"type":"object","properties":{"payments":{"type":"string"},"enterprise_payments":{"type":"string"}}}}},"GetNotificationsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"notifications":{"type":"array","items":{"$ref":"#/definitions/NotificationEntity"}}},"description":"GetNotificationsEntity model"},"NotificationEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"patient_id":{"type":"integer","format":"int32"},"start_date":{"type":"string"},"end_date":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"patient_zip":{"type":"integer","format":"int32"},"patient_state":{"type":"string"},"patient_city":{"type":"string"},"notification_type":{"type":"string"},"opened_event_count":{"type":"integer","format":"int32"},"clicked_event_count":{"type":"integer","format":"int32"},"unsubscribed_event_count":{"type":"integer","format":"int32"},"delivered_event_count":{"type":"integer","format":"int32"},"complained_event_count":{"type":"integer","format":"int32"},"bounced_event_count":{"type":"integer","format":"int32"},"dropped_event_count":{"type":"integer","format":"int32"},"notification_email_count":{"type":"integer","format":"int32"},"appointment_id":{"type":"integer","format":"int32"},"sent_type":{"type":"string"},"status":{"type":"string"},"paper_bill_json_response":{"type":"string"},"paper_bill_page_count":{"type":"integer","format":"int32"},"email":{"type":"string"},"phone_number":{"type":"string"},"created_by_user_id":{"type":"integer","format":"int32"},"billing_action_id":{"type":"integer","format":"int32"},"final_notice":{"type":"boolean"},"cost_calculated":{"type":"string"},"source":{"type":"string"},"paper_bill_name":{"type":"string"},"paper_bill_address_line_1":{"type":"string"},"paper_bill_address_line_2":{"type":"string"},"paper_bill_city":{"type":"string"},"paper_bill_state":{"type":"string"},"paper_bill_zip":{"type":"string"},"paper_bill_mode":{"type":"string"},"paper_bill_force_bad_address_mailing":{"type":"string"},"paper_bill_statement_vendor":{"type":"string"},"paper_bill_status_summary":{"type":"string"},"last_log_in_at":{"type":"string"},"message_content":{"type":"string"},"preview_record_id":{"type":"string"},"type":{"type":"string"}}},"GetPaymentsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"payments":{"type":"array","items":{"$ref":"#/definitions/PaymentEntity"}}},"description":"GetPaymentsEntity model"},"PaymentEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"date_scheduled":{"type":"string"},"patient_payment_info_id":{"type":"string"},"intent_id":{"type":"string"},"payment_plan_length":{"type":"integer","format":"int32"},"payment_plan_id":{"type":"integer","format":"int32"},"status":{"type":"string"},"successful":{"type":"boolean"},"submitted_at":{"type":"string"},"transfer_id":{"type":"integer","format":"int32"},"date_cancelled":{"type":"string"},"card_brand":{"type":"string"},"bank_number":{"type":"string"},"payment_method_type":{"type":"string"},"description":{"type":"string"},"batch_number":{"type":"integer","format":"int32"},"is_inbox_payment":{"type":"string"},"did_post":{"type":"string"},"secondary_patient_payment_info_id":{"type":"string"},"created_by_user_id":{"type":"integer","format":"int32"},"total_fee_cents":{"type":"integer","format":"int32"},"expected_amount_cents":{"type":"integer","format":"int32"},"refunded_amount_cents":{"type":"integer","format":"int32"},"refund_date":{"type":"string","format":"date"},"adjusted_fee_cents":{"type":"integer","format":"int32"},"enterprise_id":{"type":"integer","format":"int32"},"patient_id":{"type":"integer","format":"int32"},"transferred_at":{"type":"string"},"gift_card_number":{"type":"string"},"applied_amount_cents":{"type":"integer","format":"int32"},"practice_id":{"type":"integer","format":"int32"},"doctor_id":{"type":"integer","format":"int32"},"voided":{"type":"boolean"},"signed":{"type":"string"},"dispute_status":{"type":"string"},"dispute_id":{"type":"integer","format":"int32"},"reversal_amount_cents":{"type":"integer","format":"int32"},"tag":{"type":"string"},"payer_description":{"type":"string"},"merged_payment_id":{"type":"integer","format":"int32"},"deposit_account_id":{"type":"integer","format":"int32"},"sub_type":{"type":"string"},"is_posting":{"type":"boolean"},"posting_status":{"type":"string"},"last_4_digits":{"type":"string"},"has_attachments":{"type":"string"},"can_change_submitted_at_date":{"type":"boolean"},"additional_fees":{"$ref":"#/definitions/AdditionalFeeEntity"},"links":{"type":"object","properties":{"payment_adjustments":{"type":"string"},"invoices":{"type":"string"},"invoice_payments":{"type":"string"},"charges":{"type":"string"},"attachments":{"type":"string"}}},"is_archive_pending":{"type":"string"},"external_ids":{"type":"string"},"custom_fields":{"type":"string"}},"description":"PaymentEntity model"},"AdditionalFeeEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"payment_id":{"type":"integer","format":"int32"},"amount_cents":{"type":"integer","format":"int32"},"rate":{"type":"decimal"},"fee_type":{"type":"string"},"status":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"GetInvoicesEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"invoices":{"type":"array","items":{"$ref":"#/definitions/InvoiceEntity"}}},"description":"GetInvoicesEntity model"},"InvoiceEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"date_billed":{"type":"string"},"practice_id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"patient_id":{"type":"integer","format":"int32"},"date_of_service":{"type":"string"},"physician_name":{"type":"string"},"doctor_id":{"type":"integer","format":"int32"},"notes":{"type":"string"},"created_by_user_id":{"type":"integer","format":"int32"},"balance_cents":{"type":"integer","format":"int32"},"paid_amount_cents":{"type":"integer","format":"int32"},"expected_balance_cents":{"type":"integer","format":"int32"},"owed_amount_cents":{"type":"integer","format":"int32"},"expected_amount_cents":{"type":"integer","format":"int32"},"copay_amount_paid_cents":{"type":"integer","format":"int32"},"estimate":{"type":"boolean"},"line_items":{"type":"array","items":{"$ref":"#/definitions/LineItemEntity"}},"estimate_conversion":{"type":"string"},"soft_delete":{"type":"integer","format":"int32"},"total_insurance_balance_cents":{"type":"integer","format":"int32"},"patient_paid_amount_cents":{"type":"integer","format":"int32"},"insurance_paid_amount_cents":{"type":"integer","format":"int32"},"referring_doctor_id":{"type":"integer","format":"int32"},"total_insurance_owed_amount_cents":{"type":"integer","format":"int32"},"invoice_record_id":{"type":"integer","format":"int32"},"account_type_id":{"type":"string"},"account_type":{"$ref":"#/definitions/AccountTypeEntity"},"sent_to_collections_at":{"type":"string"},"patient_facing_memo":{"type":"string"},"latest_collections_transfer_capture_date":{"type":"string"},"latest_collections_transfer_ack_date":{"type":"string"},"notification_ids":{"type":"string"},"notification_counts":{"type":"string"},"status":{"type":"string"},"links":{"type":"object","properties":{"line_items":{"type":"string"},"payments":{"type":"string"},"invoice_payments":{"type":"string"},"notifications":{"type":"string"}}},"eligibility_updated_at":{"type":"string"},"eligibility_response":{"type":"string"},"eligibility_request":{"type":"string"},"service_code":{"type":"string"},"service_code_label":{"type":"string"},"service_location":{"type":"string"},"service_location_label":{"type":"string"},"enterprise_id":{"type":"string"}},"description":"InvoiceEntity model"},"LineItemEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"invoice_id":{"type":"integer","format":"int32"},"service_code":{"type":"string"},"description":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"date_of_service":{"type":"string"},"total_charge_amount_cents":{"type":"integer","format":"int32"},"covered_amount_cents":{"type":"integer","format":"int32"},"saved_line_item_id":{"type":"integer","format":"int32"},"tax_amount_cents":{"type":"integer","format":"int32"},"quantity":{"type":"integer","format":"int32"},"discount_amount_cents":{"type":"integer","format":"int32"},"discount_percent":{"type":"number","format":"double"},"tax_percent":{"type":"number","format":"double"},"insurance_balance_cents":{"type":"integer","format":"int32"},"write_off_id":{"type":"integer","format":"int32"},"insurance_owed_amount_cents":{"type":"integer","format":"int32"},"memo":{"type":"string"},"enterprise_id":{"type":"string"},"ignored_by_collections":{"type":"string"}}},"AccountTypeEntity":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"enterprise_id":{"type":"string"},"incoming_billing_status":{"type":"string"},"outgoing_billing_status":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"}},"description":"AccountTypeEntity model"},"putPartnerV2PaymentsId":{"type":"object","properties":{"payment":{"type":"object","properties":{"description":{"type":"string","description":"Description of the payment"},"practice_id":{"type":"integer","format":"int32","description":"Practice id that this payment will be attached to"},"doctor_id":{"type":"integer","format":"int32","description":"Doctor id that this payment will be attached to"},"voided":{"type":"boolean","description":"Should this payment be voided?"},"posting_status":{"type":"string","description":"Whether or not this payment has been posted to an external system","enum":["unposted","posting","posted","failed"]},"invoice_payments_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Id of the invoice payment"},"invoice_id":{"type":"integer","format":"int32","description":"Id of invoice to apply this payment to"},"paid_amount_cents":{"type":"integer","format":"int32","description":"Integer amount from this payment applied to a given invoice"},"_destroy":{"type":"boolean","description":"Should this invoice_payment be removed entirely?"}},"required":["invoice_id","paid_amount_cents"]}}}}},"required":["payment"],"description":"Update a payment"},"postPartnerV2PaymentsQuickPay":{"type":"object","properties":{"appointment_id":{"type":"integer","format":"int32","description":"Appointment ID that payment/invoice will be applied to"},"invoice":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"ID of the patient this invoice belongs to"},"practice_id":{"type":"integer","format":"int32","description":"ID of the practice this invoice belongs to"},"date_of_service":{"type":"string","description":"When this service took place"},"estimate":{"type":"boolean","description":"If the invoice is an estimate","default":false},"doctor_id":{"type":"integer","format":"int32","description":"ID of the doctor associated with this invoice"},"notes":{"type":"string","description":"Invoice notes"},"line_items_attributes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of this line item"},"date_of_service":{"type":"string","description":"Date of service for this line item"},"total_charge_amount_cents":{"type":"integer","format":"int32","description":"Total amount charged for this line item"},"covered_amount_cents":{"type":"integer","format":"int32","description":"The total amount covered for this line item"},"quantity":{"type":"integer","format":"int32","description":"Quantity for this line item","default":1},"service_code":{"type":"string","description":"Line item service code"},"saved_line_item_id":{"type":"integer","format":"int32","description":"Line item template ID (if applicable)"},"tax_amount_cents":{"type":"integer","format":"int32","description":"The total tax amount for this line item"},"discount_amount_cents":{"type":"integer","format":"int32","description":"Discount that is applied to this line item"},"discount_percent":{"type":"number","format":"double","description":"Percentage representation of the discount"},"tax_percent":{"type":"number","format":"double","description":"Percentage representation of the discount"},"insurance_owed_amount_cents":{"type":"integer","format":"int32","description":"The amount that is owed by insurance"}},"required":["description","date_of_service","total_charge_amount_cents","covered_amount_cents","quantity"]}}},"required":["patient_id","practice_id","date_of_service","estimate","line_items_attributes"]},"payment":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"Patient id that this payment will be applied to"},"expected_amount_cents":{"type":"integer","format":"int32","description":"The expected amount of this payment"},"payment_method_type":{"type":"string","description":"The type of this payment","enum":["card","cash","check","insurance","one_time_payment","gift_card","ach"]},"patient_payment_info_id":{"type":"integer","format":"int32","description":"The id of the payment method"},"bank_number":{"type":"string","description":"Check number"},"gift_card_number":{"type":"string","description":"Gift card number"},"description":{"type":"string","description":"Description of the payment"},"stripe_one_time_token":{"type":"string","description":"Used for one time payments without creating payment method in database"},"apply_payment":{"type":"boolean","description":"Indicates whether Inbox Health should apply the payment to a patient's existing invoices","default":true},"practice_id":{"type":"integer","format":"int32","description":"Practice id that this payment will be attached to"},"doctor_id":{"type":"integer","format":"int32","description":"Doctor id that this payment will be attached to"},"tag":{"type":"string","description":"Tag/payment code for payment"},"deposit_account_id":{"type":"integer","format":"int32","description":"Deposit account id that this payment will be attached to"},"payment_reason_id":{"type":"integer","format":"int32","description":"Id of the payment reason to associate with the payment. This is only applicable when invoice payments are created alongside the payment"},"posting_status":{"type":"string","description":"Whether or not this payment has been posted to an external system","enum":["unposted","posting","posted","failed"]},"moto":{"type":"boolean","description":"Whether this card payment was taken via mail/telephone order, without CVC"}},"required":["patient_id","expected_amount_cents","payment_method_type"]}},"required":["payment"],"description":"Create a new payment/invoice (Quickpay)"},"QuickPayEntity":{"type":"object","properties":{"payment":{"$ref":"#/definitions/PaymentEntity"},"invoice":{"$ref":"#/definitions/InvoiceEntity"}},"description":"QuickPayEntity model"},"postPartnerV2Payments":{"type":"object","properties":{"invoice_id":{"type":"integer","format":"int32","description":"Invoice ID that payment will be applied to"},"appointment_id":{"type":"integer","format":"int32","description":"Appointment ID that payment will be applied to"},"payment":{"type":"object","properties":{"expected_amount_cents":{"type":"integer","format":"int32","description":"The expected amount of this payment"},"payment_method_type":{"type":"string","description":"The type of this payment","enum":["card","cash","check","insurance","one_time_payment","gift_card","external_card","ach"]},"patientless":{"type":"boolean","description":"Flag to indicate if payment deliberately omits patient"},"patient_id":{"type":"integer","format":"int32","description":"Patient ID that this payment will be applied to"},"patient_payment_info_id":{"type":"integer","format":"int32","description":"The ID of the payment method"},"bank_number":{"type":"string","description":"Check number"},"gift_card_number":{"type":"string","description":"Gift card number"},"description":{"type":"string","description":"Description of the payment"},"stripe_one_time_token":{"type":"string","description":"Used for one time payments without creating payment method in database"},"apply_payment":{"type":"boolean","description":"Indicates whether Inbox Health should apply the payment to a patient's existing invoices","default":true},"practice_id":{"type":"integer","format":"int32","description":"Practice id that this payment will be attached to"},"tag":{"type":"string","description":"Tag/payment code for payment"},"payment_reason_id":{"type":"integer","format":"int32","description":"Id of the payment reason to associate with the payment. This is only applicable when invoice payments are created alongside the payment"},"doctor_id":{"type":"integer","format":"int32","description":"Doctor id that this payment will be attached to"},"submitted_at":{"type":"string","format":"date-time","description":"Submitted at date for payment."},"custom_fields":{"type":"json","description":"JSON of any custom or meta data to associate with the payment"},"deposit_account_id":{"type":"integer","format":"int32","description":"Deposit account id that this payment will be attached to"},"posting_status":{"type":"string","description":"Whether or not this payment has been posted to an external system","enum":["unposted","posting","posted","failed"]}},"required":["expected_amount_cents","payment_method_type"]}},"required":["payment"],"description":"Create a payment"},"GetInvoicePaymentsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"invoice_payments":{"type":"array","items":{"$ref":"#/definitions/InvoicePaymentEntity"}}},"description":"GetInvoicePaymentsEntity model"},"InvoicePaymentEntity":{"type":"object","properties":{"payment_id":{"type":"string"},"invoice_id":{"type":"string"},"id":{"type":"string"},"paid_amount_cents":{"type":"string"},"reversal":{"type":"string"},"reversal_date":{"type":"string"},"payment_reasons_invoice_payments":{"$ref":"#/definitions/PaymentReasonsInvoicePaymentEntity"},"enterprise_id":{"type":"string"}}},"PaymentReasonsInvoicePaymentEntity":{"type":"object","properties":{"id":{"type":"string"},"payment_reason":{"$ref":"#/definitions/PaymentReasonEntity"},"invoice_payment_id":{"type":"string"},"amount_cents":{"type":"string"}}},"PaymentReasonEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"enterprise_id":{"type":"integer","format":"int32"}}},"GetPaymentAdjustmentsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"payment_adjustments":{"type":"array","items":{"$ref":"#/definitions/PaymentAdjustmentEntity"}}},"description":"GetPaymentAdjustmentsEntity model"},"PaymentAdjustmentEntity":{"type":"object","properties":{"id":{"type":"string"},"payment_id":{"type":"string"},"payment_processing_refund_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"transfer_id":{"type":"string"},"status":{"type":"string"},"created_by_user_id":{"type":"string"},"amount_cents":{"type":"string"}}},"putPartnerV2InvoicesId":{"type":"object","properties":{"email":{"type":"string","description":"Patient email"},"invoice":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"Id of the patient this invoice belongs to"},"practice_id":{"type":"integer","format":"int32","description":"Id of the practice this invoice belongs to"},"date_of_service":{"type":"string","description":"When this service took place"},"appointment_id":{"type":"integer","format":"int32","description":"The appointment Id to associate this invoice (usually for copay)"},"doctor_id":{"type":"integer","format":"int32","description":"Id of the doctor on this invoice"},"referring_doctor_id":{"type":"integer","format":"int32","description":"Id of the referring doctor associated with this invoice"},"notes":{"type":"string","description":"Invoice notes"},"estimate":{"type":"boolean","description":"Boolean indicating if this invoice is an estimate","default":false},"estimate_conversion":{"type":"boolean","description":"Boolean indicating if this invoice is an estimate conversion","default":false},"patient_facing_memo":{"type":"string","description":"Patient-facing memo on paper bill and patient portal"},"line_items_attributes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32","description":"Id of the line item"},"_destroy":{"type":"boolean","description":"Will this line item be deleted from the database"},"description":{"type":"string","description":"Description of this line item"},"date_of_service":{"type":"string","description":"Date of service for this line item"},"total_charge_amount_cents":{"type":"integer","format":"int32","description":"Total amount charged for this line item"},"covered_amount_cents":{"type":"integer","format":"int32","description":"The total amount covered for this line item"},"service_code":{"type":"string","description":"Line item service code"},"saved_line_item_id":{"type":"integer","format":"int32","description":"Line item template Id (if applicable)"},"tax_amount_cents":{"type":"integer","format":"int32","description":"The total tax amount for this line item"},"quantity":{"type":"integer","format":"int32","description":"Quantity for this line item","default":1},"discount_amount_cents":{"type":"integer","format":"int32","description":"Discount that is applied to this line item"},"discount_percent":{"type":"number","format":"double","description":"Percentage representation of the discount"},"tax_percent":{"type":"number","format":"double","description":"Percentage representation of the discount"},"insurance_owed_amount_cents":{"type":"integer","format":"int32","description":"The amount that is owed by insurance"}},"required":["description","date_of_service","total_charge_amount_cents","covered_amount_cents","quantity"]}}}}},"required":["invoice"],"description":"Update an invoice"},"postPartnerV2Invoices":{"type":"object","properties":{"email":{"type":"string","description":"Patient email"},"invoice":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"Id of the patient this invoice belongs to"},"practice_id":{"type":"integer","format":"int32","description":"Id of the practice this invoice belongs to"},"date_of_service":{"type":"string","description":"When this service took place"},"appointment_id":{"type":"integer","format":"int32","description":"The appointment Id to associate this invoice (usually for copay)"},"doctor_id":{"type":"integer","format":"int32","description":"Id of the doctor associated with this invoice"},"referring_doctor_id":{"type":"integer","format":"int32","description":"Id of the referring doctor associated with this invoice"},"notes":{"type":"string","description":"Invoice notes"},"estimate":{"type":"boolean","description":"If the invoice is an estimate","default":false},"patient_facing_memo":{"type":"string","description":"Patient-facing memo on paper bill and patient portal"},"line_items_attributes":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","description":"Description of this line item"},"date_of_service":{"type":"string","description":"Date of service for this line item"},"total_charge_amount_cents":{"type":"integer","format":"int32","description":"Total amount charged for this line item"},"covered_amount_cents":{"type":"integer","format":"int32","description":"The total amount covered for this line item"},"service_code":{"type":"string","description":"Line item service code"},"saved_line_item_id":{"type":"integer","format":"int32","description":"Line item template Id (if applicable)"},"tax_amount_cents":{"type":"integer","format":"int32","description":"The total tax amount for this line item"},"quantity":{"type":"integer","format":"int32","description":"Quantity for this line item","default":1},"discount_amount_cents":{"type":"integer","format":"int32","description":"Discount that is applied to this line item"},"discount_percent":{"type":"number","format":"double","description":"Percentage representation of the discount"},"tax_percent":{"type":"number","format":"double","description":"Percentage representation of the discount"},"insurance_owed_amount_cents":{"type":"integer","format":"int32","description":"The amount that is owed by insurance"}},"required":["description","date_of_service","total_charge_amount_cents","covered_amount_cents","quantity"]}}},"required":["patient_id","practice_id","date_of_service","estimate","line_items_attributes"]}},"required":["invoice"],"description":"Create a new invoice"},"GetLineItemsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"line_items":{"type":"array","items":{"$ref":"#/definitions/LineItemEntity"}}},"description":"GetLineItemsEntity model"},"postPartnerV2Enterprises":{"type":"object","properties":{"enterprise":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Enterprise"},"address_line_1":{"type":"string","description":"Street address of the enterprise"},"address_line_2":{"type":"string","description":"Street address of the enterprise"},"city":{"type":"string","description":"City of the enterprise"},"state":{"type":"string","description":"State (location) of the enterprise"},"zip":{"type":"string","description":"Zip code of the enterprise"},"sales_tax":{"type":"number","format":"double","description":"Sales tax","default":"0.0"},"time_zone":{"type":"string","description":"Time zone of the enterprise","enum":["America/Adak","Hawaii","Alaska","America/Anchorage","America/Metlakatla","America/Nome","America/Sitka","America/Yakutat","Pacific Time (US \u0026 Canada)","America/Boise","Arizona","Mountain Time (US \u0026 Canada)","America/Indiana/Knox","America/Indiana/Tell_City","America/Menominee","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","Central Time (US \u0026 Canada)","America/Detroit","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Kentucky/Louisville","America/Kentucky/Monticello","Eastern Time (US \u0026 Canada)","Indiana (East)"]},"practices_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the practice"},"address_line_1":{"type":"string","description":"Street address of the practice"},"city":{"type":"string","description":"City of the practice"},"state":{"type":"string","description":"State(location) of the practice"},"time_zone":{"type":"string","description":"Time zone of the practice"},"npi":{"type":"string","description":"NPI (National Provider Identifier)"},"address_line_2":{"type":"string","description":"Additional address parameters of the practice"},"zip":{"type":"string","description":"ZIP code of the practice"}},"required":["name","address_line_1","city","state","time_zone"]}},"minimum_bill_amount_cents":{"type":"integer","format":"int32","description":"Minimum amount for a bill to be valid","default":500},"ein":{"type":"string","description":"Employer Identification Number"},"support_phone_number":{"type":"string","description":"Support phone number for enterprise"},"use_support_phone_number":{"type":"boolean","description":"Boolean to determine if upport phone number for enterprise should be used on outgoing emails"},"default_service_code":{"type":"string","description":"Default service code for enterprise that will be used on verification of eligibility","default":"30"},"default_statement_memo":{"type":"string","description":"Statement memo for enterprise"},"days_before_patient_balance_reminder":{"type":"integer","format":"int32","description":"# of days before patient balance reminder is sent out to patient"},"days_before_patient_balance_reminder_with_paper_statements":{"type":"integer","format":"int32","description":"# of days before patient balance reminder is sent out to patient with existing paper bills"},"estimate_down_payment_rate":{"type":"number","format":"double","description":"Recommended estimate down payment percent"},"default_quick_pay_description":{"type":"string","description":"Default quick pay description","default":"Copay"},"enable_scheduled_eligible_requests":{"type":"boolean","description":"Toggles the availability of the scheduled eligibility request feature","default":"true"},"logo_background_color":{"type":"string","description":"Logo background color used in emails"},"statement_descriptor":{"type":"string","description":"Display name to show on bank statements when customers get charged (max 22 characters)"},"cancellation_fee_window":{"type":"integer","format":"int32","description":"The window in hours in which there will be an additional fee charged"},"cancellation_fee_cents":{"type":"integer","format":"int32","description":"The cancellation fee of an appointment"},"reschedule_window":{"type":"integer","format":"int32","description":"The window in hours in which there will be no rescheduling allowed","default":30},"soonest_bookable_time_window":{"type":"integer","format":"int32","description":"The window in hours in which they will be next allowed to book an appointment at","default":30},"apply_payment":{"type":"boolean","description":"Boolean to determine if quick pay payments will be created and applied with an invoice"},"checkin_card_on_file_required":{"type":"boolean","description":"Boolean to determine a card will be needed during check-in"},"patient_billing_active":{"type":"boolean","description":"Enables automatic batching of outstanding patient balance statements/charges","default":true},"auto_charge":{"type":"boolean","description":"Overrides patient-level auto_charge attribute to enable/disable automatically charging a patient their balance remainder"},"auto_charge_max_cents":{"type":"integer","format":"int32","description":"Specifies a default maximum amount to charge a patient automatically via the auto_charge action"},"past_due_balance_days":{"type":"integer","format":"int32","description":"# of days after which the patient account becomes past due","default":45},"collection_warning_balance_days":{"type":"integer","format":"int32","description":"# of days after which a patient is flagged for pre-collections","default":90},"enable_scheduled_appointment_reminders":{"type":"boolean","description":"Determines whether scheduled appointment reminders toggle and feature should be enabled or disabled","default":false},"max_paper_bills_per_billing_cycle_count":{"type":"integer","format":"int32","description":"Specifies a maximum paper bill amount to send out to patients during a billing cycle","default":3},"billing_contact_email":{"type":"string","description":"Email that will receive monthly bills/receipts from IH"},"billing_name":{"type":"string","description":"Overrides the name of the enterprise on outgoing patient paper statements"},"billing_business_name":{"type":"string","description":"Billing Business Name of the Enterprise"},"billing_address_line_1":{"type":"string","description":"Billing Street address of the enterprise"},"billing_address_line_2":{"type":"string","description":"Billing Street address of the enterprise"},"billing_city":{"type":"string","description":"Billing City of the enterprise"},"billing_state":{"type":"string","description":"Billing State (location) of the enterprise"},"billing_zip":{"type":"string","description":"Billing Zip code of the enterprise"},"send_initial_statement_sms":{"type":"boolean","description":"Toggle to turn on initial statement sms for patients"},"default_billing_cycle_template_id":{"type":"integer","format":"int32","description":"Default billing cycle template id for enterprise"},"default_past_due_billing_cycle_template_id":{"type":"integer","format":"int32","description":"Default past due billing cycle template id for enterprise"},"twenty_four_hours_appt_reminders":{"type":"boolean","description":"Toggle to turn on 24 hour appt reminders","default":true},"fourty_eight_hours_appt_reminders":{"type":"boolean","description":"Toggle to turn on 48 hour appt reminders","default":false},"one_week_appt_reminders":{"type":"boolean","description":"Toggle to turn on 1 week appt reminders","default":true},"self_pay_imported_payer_id":{"type":"integer","format":"int32","description":"Self pay imported payer id that this enterprise will be attached to"},"make_checks_payable_to":{"type":"string","description":"Name on paper statement to make checks payable to"},"custom_collection_copy":{"type":"string","description":"Text override the inner body of collection letters (will default to Inbox Health recommendations"},"enable_advanced_payment_routing":{"type":"boolean","description":"Toggles whether to allow/disallow use of multiple bank deposit accounts","default":false},"enable_unapplied_payment_only":{"type":"boolean","description":"Toggles whether to force all payments to be forced to be unapplied only","default":false},"enable_simplified_account_view":{"type":"boolean","description":"Toggles whether to be utilize an experimental simplified account view to users","default":false},"post_checkin_message":{"type":"string","description":"Text to show at the end of patient check-in"},"accepts_credit_card":{"type":"boolean","description":"Determines if paper statement shows credit card boxes","default":true},"color_statements":{"type":"boolean","description":"Determines if paper statement is sent in color","default":true},"first_class":{"type":"boolean","description":"Determines if paper statement is sent with USPS First Class","default":true},"return_envelope":{"type":"boolean","description":"Determines if paper statement is sent with return envelope","default":true},"perforation":{"type":"boolean","description":"Determines if paper statement is sent with perforation","default":true},"patient_support_email":{"type":"string","description":"Email address to use for patient support"},"admin_organization_id":{"type":"integer","format":"int32","description":"ID of Admin Organization for this enterprise "},"default_appointment_is_virtual_value":{"type":"boolean","description":"Default value for virtual appointments","default":false}},"required":["name","address_line_1","city","state","sales_tax","time_zone"]}},"required":["enterprise"],"description":"Create a new enterprise"},"EnterpriseEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"ein":{"type":"string"},"enterprise_payment_date_scheduled":{"type":"string"},"minimum_bill_amount_cents":{"type":"integer","format":"int32"},"support_phone_number":{"type":"string"},"use_support_phone_number":{"type":"string"},"payment_phone_number":{"type":"string"},"default_service_code":{"type":"string"},"sales_tax":{"type":"number","format":"double"},"time_zone":{"type":"string","enum":["America/Adak","Hawaii","Alaska","America/Anchorage","America/Metlakatla","America/Nome","America/Sitka","America/Yakutat","Pacific Time (US \u0026 Canada)","America/Boise","Arizona","Mountain Time (US \u0026 Canada)","America/Indiana/Knox","America/Indiana/Tell_City","America/Menominee","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","Central Time (US \u0026 Canada)","America/Detroit","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Kentucky/Louisville","America/Kentucky/Monticello","Eastern Time (US \u0026 Canada)","Indiana (East)"]},"default_service_location":{"type":"string"},"zip":{"type":"string"},"default_statement_memo":{"type":"string"},"days_before_patient_balance_reminder":{"type":"integer","format":"int32"},"days_before_patient_balance_reminder_with_paper_statements":{"type":"integer","format":"int32"},"practices":{"type":"array","items":{"$ref":"#/definitions/PracticeEntity"}},"enterprise_plan":{"$ref":"#/definitions/EnterprisePlanEntity"},"estimate_down_payment_rate":{"type":"number","format":"double"},"bcbs_payer_id":{"type":"string"},"default_quick_pay_description":{"type":"string"},"enable_scheduled_eligible_requests":{"type":"boolean"},"logo_background_color":{"type":"string"},"default_checkin_routes":{"type":"string"},"enable_giftcards":{"type":"string"},"statement_descriptor":{"type":"string"},"has_logo_base64":{"type":"string"},"cancellation_fee_window":{"type":"integer","format":"int32"},"cancellation_fee_cents":{"type":"integer","format":"int32"},"reschedule_window":{"type":"integer","format":"int32"},"soonest_bookable_time_window":{"type":"integer","format":"int32"},"patient_billing_active":{"type":"boolean"},"apply_payment":{"type":"boolean"},"default_eligible_npi":{"type":"string"},"checkin_card_on_file_required":{"type":"boolean"},"past_due_balance_days":{"type":"integer","format":"int32"},"collection_warning_balance_days":{"type":"integer","format":"int32"},"max_paper_bills_per_billing_cycle_count":{"type":"integer","format":"int32"},"twenty_four_hours_appt_reminders":{"type":"boolean"},"one_week_appt_reminders":{"type":"boolean"},"accepts_credit_card":{"type":"boolean"},"color_statements":{"type":"boolean"},"first_class":{"type":"boolean"},"return_envelope":{"type":"boolean"},"perforation":{"type":"boolean"},"external_ids":{"type":"array","items":{"$ref":"#/definitions/ExternalIdEntity"}},"account_manager_id":{"type":"integer","format":"int32"},"admin_organization_id":{"type":"integer","format":"int32"},"billing_business_name":{"type":"string"},"billing_address_line_1":{"type":"string"},"billing_address_line_2":{"type":"string"},"billing_city":{"type":"string"},"billing_state":{"type":"string"},"billing_zip":{"type":"string"},"patient_support_email":{"type":"string"},"payment_plan_minimums":{"type":"string"},"paper_bill_includes_payment_reasons":{"type":"string"},"enable_live_chat":{"type":"string"},"churned":{"type":"string"},"enable_unposted_payment_tab":{"type":"string"},"upfront_mode":{"type":"string"},"connect_onboarding_uuid":{"type":"string"},"use_custom_payment_reason_description":{"type":"string"},"stop_unapplied_payment_plans_when_patient_balance_is_zero":{"type":"string"},"default_appointment_is_virtual_value":{"type":"string"},"enable_merge_patient":{"type":"string"},"email_cta_button_color":{"type":"string"},"friendly_name":{"type":"string"},"links":{"type":"object","properties":{"practices":{"type":"string"},"patients":{"type":"string"},"enterprise_invoices":{"type":"string"},"enterprise_payment_infos":{"type":"string"},"enterprise_payments":{"type":"string"},"transfers":{"type":"string"}}}},"description":"EnterpriseEntity model"},"PracticeEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"enterprise_id":{"type":"integer","format":"int32"},"city":{"type":"string"},"state":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"practice_summary":{"type":"string"},"monday_open":{"type":"string"},"monday_close":{"type":"string"},"tuesday_open":{"type":"string"},"tuesday_close":{"type":"string"},"wednesday_open":{"type":"string"},"wednesday_close":{"type":"string"},"thursday_open":{"type":"string"},"thursday_close":{"type":"string"},"friday_open":{"type":"string"},"friday_close":{"type":"string"},"saturday_open":{"type":"string"},"saturday_close":{"type":"string"},"sunday_open":{"type":"string"},"sunday_close":{"type":"string"},"email":{"type":"string"},"website":{"type":"string"},"phone":{"type":"string"},"zip":{"type":"string"},"npi":{"type":"string"},"time_zone":{"type":"string"},"deposit_account_id":{"type":"integer","format":"int32"},"external_ids":{"type":"array","items":{"$ref":"#/definitions/ExternalIdEntity"}},"links":{"type":"object","properties":{"invoices":{"type":"string"},"users":{"type":"string"},"practice_users":{"type":"string"},"doctors":{"type":"string"}}}}},"EnterprisePlanEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"plan_name":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"per_email_rate_cents":{"type":"integer","format":"int32"},"per_outbound_sms_rate_cents":{"type":"integer","format":"int32"},"per_paper_rate_cents":{"type":"integer","format":"int32"},"per_paper_bill_suppression_rate_cents":{"type":"integer","format":"int32"},"per_outbound_call_minute_rate_cents":{"type":"integer","format":"int32"},"monthly_fee_cents":{"type":"integer","format":"int32"},"custom":{"type":"boolean"},"check_fee_cents":{"type":"integer","format":"int32"},"card_transaction_rate":{"type":"number","format":"double"},"amex_transaction_rate":{"type":"number","format":"double"},"amex_debit_transaction_rate":{"type":"number","format":"double"},"amex_prepaid_transaction_rate":{"type":"number","format":"double"},"amex_credit_transaction_rate":{"type":"number","format":"double"},"discover_debit_transaction_rate":{"type":"number","format":"double"},"discover_prepaid_transaction_rate":{"type":"number","format":"double"},"discover_credit_transaction_rate":{"type":"number","format":"double"},"mastercard_debit_transaction_rate":{"type":"number","format":"double"},"mastercard_prepaid_transaction_rate":{"type":"number","format":"double"},"mastercard_credit_transaction_rate":{"type":"number","format":"double"},"visa_debit_transaction_rate":{"type":"number","format":"double"},"visa_prepaid_transaction_rate":{"type":"number","format":"double"},"visa_credit_transaction_rate":{"type":"number","format":"double"},"terminal_amex_debit_transaction_rate":{"type":"number","format":"double"},"terminal_amex_prepaid_transaction_rate":{"type":"number","format":"double"},"terminal_amex_credit_transaction_rate":{"type":"number","format":"double"},"terminal_discover_debit_transaction_rate":{"type":"number","format":"double"},"terminal_discover_prepaid_transaction_rate":{"type":"number","format":"double"},"terminal_discover_credit_transaction_rate":{"type":"number","format":"double"},"terminal_mastercard_debit_transaction_rate":{"type":"number","format":"double"},"terminal_mastercard_prepaid_transaction_rate":{"type":"number","format":"double"},"terminal_mastercard_credit_transaction_rate":{"type":"number","format":"double"},"terminal_visa_debit_transaction_rate":{"type":"number","format":"double"},"terminal_visa_prepaid_transaction_rate":{"type":"number","format":"double"},"terminal_visa_credit_transaction_rate":{"type":"number","format":"double"},"amex_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"amex_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"amex_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"discover_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"discover_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"discover_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"mastercard_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"mastercard_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"mastercard_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"visa_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"visa_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"visa_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_amex_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_amex_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_amex_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_discover_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_discover_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_discover_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_mastercard_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_mastercard_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_mastercard_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_visa_debit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_visa_prepaid_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"terminal_visa_credit_transaction_flat_fee_cents":{"type":"integer","format":"int32"},"inbox_health_transaction_rate":{"type":"number","format":"double"},"transaction_flat_fee_cents":{"type":"integer","format":"int32"},"enable_preauth":{"type":"boolean"},"enable_estimates":{"type":"boolean"},"enable_billing":{"type":"boolean"},"enable_eligibility":{"type":"boolean"},"enable_checkin":{"type":"boolean"},"enable_full_service":{"type":"boolean"},"stripe_plan_id":{"type":"string"},"transfer_flat_fee_cents":{"type":"integer","format":"int32"},"card_reader_flat_fee_cents":{"type":"integer","format":"int32"},"postage_rate_cents":{"type":"integer","format":"int32"}}},"putPartnerV2EnterprisesId":{"type":"object","properties":{"enterprise":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Enterprise"},"address_line_1":{"type":"string","description":"Street address of the enterprise"},"address_line_2":{"type":"string","description":"Street address of the enterprise"},"city":{"type":"string","description":"City of the enterprise"},"state":{"type":"string","description":"State (location) of the enterprise"},"zip":{"type":"string","description":"Zip code of the enterprise"},"sales_tax":{"type":"number","format":"double","description":"Sales tax"},"time_zone":{"type":"string","description":"Time zone of the enterprise","enum":["America/Adak","Hawaii","Alaska","America/Anchorage","America/Metlakatla","America/Nome","America/Sitka","America/Yakutat","Pacific Time (US \u0026 Canada)","America/Boise","Arizona","Mountain Time (US \u0026 Canada)","America/Indiana/Knox","America/Indiana/Tell_City","America/Menominee","America/North_Dakota/Beulah","America/North_Dakota/Center","America/North_Dakota/New_Salem","Central Time (US \u0026 Canada)","America/Detroit","America/Indiana/Marengo","America/Indiana/Petersburg","America/Indiana/Vevay","America/Indiana/Vincennes","America/Indiana/Winamac","America/Kentucky/Louisville","America/Kentucky/Monticello","Eastern Time (US \u0026 Canada)","Indiana (East)"]},"practices_attributes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the practice"},"address_line_1":{"type":"string","description":"Street address of the practice"},"city":{"type":"string","description":"City of the practice"},"state":{"type":"string","description":"State(location) of the practice"},"time_zone":{"type":"string","description":"Time zone of the practice"},"npi":{"type":"string","description":"NPI (National Provider Identifier)"},"address_line_2":{"type":"string","description":"Additional address parameters of the practice"},"zip":{"type":"string","description":"ZIP code of the practice"},"id":{"type":"integer","format":"int32","description":"Id of the line item"}},"required":["name","address_line_1","city","state","time_zone"]}},"minimum_bill_amount_cents":{"type":"integer","format":"int32","description":"Minimum amount for a bill to be valid"},"ein":{"type":"string","description":"Employer Identification Number"},"support_phone_number":{"type":"string","description":"Support phone number for enterprise"},"use_support_phone_number":{"type":"boolean","description":"Boolean to determine if upport phone number for enterprise should be used on outgoing emails"},"default_service_code":{"type":"string","description":"Default service code for enterprise that will be used on verification of eligibility"},"default_statement_memo":{"type":"string","description":"Statement memo for enterprise"},"days_before_patient_balance_reminder":{"type":"integer","format":"int32","description":"# of days before patient balance reminder is sent out to patient"},"days_before_patient_balance_reminder_with_paper_statements":{"type":"integer","format":"int32","description":"# of days before patient balance reminder is sent out to patient with existing paper bills"},"estimate_down_payment_rate":{"type":"number","format":"double","description":"Recommended estimate down payment percent"},"default_quick_pay_description":{"type":"string","description":"Default quick pay description"},"enable_scheduled_eligible_requests":{"type":"boolean","description":"Toggles the availability of the scheduled eligibility request feature"},"logo_background_color":{"type":"string","description":"Logo background color used in emails"},"statement_descriptor":{"type":"string","description":"Display name to show on bank statements when customers get charged (max 22 characters)"},"cancellation_fee_window":{"type":"integer","format":"int32","description":"The window in hours in which there will be an additional fee charged"},"cancellation_fee_cents":{"type":"integer","format":"int32","description":"The cancellation fee of an appointment"},"reschedule_window":{"type":"integer","format":"int32","description":"The window in hours in which there will be no rescheduling allowed"},"soonest_bookable_time_window":{"type":"integer","format":"int32","description":"The window in hours in which they will be next allowed to book an appointment at"},"apply_payment":{"type":"boolean","description":"Boolean to determine if quick pay payments will be created and applied with an invoice"},"checkin_card_on_file_required":{"type":"boolean","description":"Boolean to determine a card will be needed during check-in"},"patient_billing_active":{"type":"boolean","description":"Enables automatic batching of outstanding patient balance statements/charges"},"auto_charge":{"type":"boolean","description":"Overrides patient-level auto_charge attribute to enable/disable automatically charging a patient their balance remainder"},"auto_charge_max_cents":{"type":"integer","format":"int32","description":"Specifies a default maximum amount to charge a patient automatically via the auto_charge action"},"past_due_balance_days":{"type":"integer","format":"int32","description":"# of days after which the patient account becomes past due"},"collection_warning_balance_days":{"type":"integer","format":"int32","description":"# of days after which a patient is flagged for pre-collections"},"enable_scheduled_appointment_reminders":{"type":"boolean","description":"Determines whether scheduled appointment reminders toggle and feature should be enabled or disabled"},"max_paper_bills_per_billing_cycle_count":{"type":"integer","format":"int32","description":"Specifies a maximum paper bill amount to send out to patients during a billing cycle"},"billing_contact_email":{"type":"string","description":"Email that will receive monthly bills/receipts from IH"},"billing_name":{"type":"string","description":"Overrides the name of the enterprise on outgoing patient paper statements"},"billing_business_name":{"type":"string","description":"Billing Business Name of the Enterprise"},"billing_address_line_1":{"type":"string","description":"Billing Street address of the enterprise"},"billing_address_line_2":{"type":"string","description":"Billing Street address of the enterprise"},"billing_city":{"type":"string","description":"Billing City of the enterprise"},"billing_state":{"type":"string","description":"Billing State (location) of the enterprise"},"billing_zip":{"type":"string","description":"Billing Zip code of the enterprise"},"send_initial_statement_sms":{"type":"boolean","description":"Toggle to turn on initial statement sms for patients"},"default_billing_cycle_template_id":{"type":"integer","format":"int32","description":"Default billing cycle template id for enterprise"},"default_past_due_billing_cycle_template_id":{"type":"integer","format":"int32","description":"Default past due billing cycle template id for enterprise"},"twenty_four_hours_appt_reminders":{"type":"boolean","description":"Toggle to turn on 24 hour appt reminders"},"fourty_eight_hours_appt_reminders":{"type":"boolean","description":"Toggle to turn on 48 hour appt reminders"},"one_week_appt_reminders":{"type":"boolean","description":"Toggle to turn on 1 week appt reminders"},"self_pay_imported_payer_id":{"type":"integer","format":"int32","description":"Self pay imported payer id that this enterprise will be attached to"},"make_checks_payable_to":{"type":"string","description":"Name on paper statement to make checks payable to"},"custom_collection_copy":{"type":"string","description":"Text override the inner body of collection letters (will default to Inbox Health recommendations"},"enable_advanced_payment_routing":{"type":"boolean","description":"Toggles whether to allow/disallow use of multiple bank deposit accounts"},"enable_unapplied_payment_only":{"type":"boolean","description":"Toggles whether to force all payments to be forced to be unapplied only"},"enable_simplified_account_view":{"type":"boolean","description":"Toggles whether to be utilize an experimental simplified account view to users"},"post_checkin_message":{"type":"string","description":"Text to show at the end of patient check-in"},"accepts_credit_card":{"type":"boolean","description":"Determines if paper statement shows credit card boxes"},"color_statements":{"type":"boolean","description":"Determines if paper statement is sent in color"},"first_class":{"type":"boolean","description":"Determines if paper statement is sent with USPS First Class"},"return_envelope":{"type":"boolean","description":"Determines if paper statement is sent with return envelope"},"perforation":{"type":"boolean","description":"Determines if paper statement is sent with perforation"},"patient_support_email":{"type":"string","description":"Email address to use for patient support"},"default_appointment_is_virtual_value":{"type":"boolean","description":"Default value for virtual appointments","default":false}},"required":["name","address_line_1","city","state","sales_tax","time_zone"]}},"required":["enterprise"],"description":"Update an existing enterprise"},"GetEnterprisesEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"enterprises":{"type":"array","items":{"$ref":"#/definitions/EnterpriseEntity"}}},"description":"GetEnterprisesEntity model"},"SavedLineItemEntity":{"type":"object","properties":{"id":{"type":"string"},"enterprise_id":{"type":"string"},"covered_amount_cents":{"type":"string"},"total_charge_amount_cents":{"type":"string"},"service_code":{"type":"string"},"created_by_user_id":{"type":"string"},"description":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"tax_amount_cents":{"type":"string"},"code_type":{"type":"string"},"category":{"type":"string"},"ignored_by_collections":{"type":"string"}},"description":"SavedLineItemEntity model"},"GetDepositAccountsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"deposit_accounts":{"type":"array","items":{"$ref":"#/definitions/DepositAccountEntity"}}},"description":"GetDepositAccountsEntity model"},"DepositAccountEntity":{"type":"object","properties":{"id":{"type":"string"},"nickname":{"type":"string"},"stripe_fields_needed":{"type":"string"},"enterprise_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"bank_name":{"type":"string"},"bank_last_4":{"type":"string"},"country":{"type":"string"},"name":{"type":"string"},"make_checks_payable_to":{"type":"string"},"custom_collection_copy":{"type":"string"},"has_logo_base64":{"type":"string"},"logo_base64":{"type":"string"},"logo_background_color":{"type":"string"},"email_cta_button_color":{"type":"string"},"address_line_1":{"type":"string"},"address_line_2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"support_phone_number":{"type":"string"},"support_phone_number_ext":{"type":"string"},"payment_phone_number":{"type":"string"},"patient_support_email":{"type":"string"},"billing_business_name":{"type":"string"},"billing_address_line_1":{"type":"string"},"billing_address_line_2":{"type":"string"},"billing_city":{"type":"string"},"billing_state":{"type":"string"},"billing_zip":{"type":"string"},"statement_descriptor":{"type":"string"},"statement_descriptor_prefix":{"type":"string"},"statement_descriptor_suffix":{"type":"string"},"connect_onboarding_uuid":{"type":"string"},"balance_cents":{"type":"string"},"practice_ids_sideloaded":{"type":"string"},"doctor_ids_sideloaded":{"type":"string"},"hide_provider_on_paper_statements":{"type":"string"},"links":{"type":"object","properties":{"practices":{"type":"string"},"doctors":{"type":"string"}}}}},"GetWriteOffCodesEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"write_off_codes":{"type":"array","items":{"$ref":"#/definitions/WriteOffCodeEntity"}}},"description":"GetWriteOffCodesEntity model"},"WriteOffCodeEntity":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"enterprise_id":{"type":"string"},"code":{"type":"string"},"description":{"type":"string"},"soft_delete":{"type":"string"}}},"GetBillingCycleTemplatesEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"billing_cycle_templates":{"type":"array","items":{"$ref":"#/definitions/BillingCycleTemplateEntity"}}},"description":"GetBillingCycleTemplatesEntity model"},"BillingCycleTemplateEntity":{"type":"object","properties":{"id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"enterprise_id":{"type":"string"},"partner_organization_id":{"type":"string"},"admin_organization_id":{"type":"string"},"enterprise_count":{"type":"string"},"nested_updated_at":{"type":"string"},"days_since_creation":{"type":"string"},"soft_delete":{"type":"string"},"links":{"type":"object","properties":{"billing_event_templates":{"type":"string"}}}}},"GetPaymentReasonsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"payment_reasons":{"type":"array","items":{"$ref":"#/definitions/PaymentReasonEntity"}}},"description":"GetPaymentReasonsEntity model"},"GetAdminOrganizationsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"admin_organizations":{"type":"array","items":{"$ref":"#/definitions/AdminOrganizationEntity"}}},"description":"GetAdminOrganizationsEntity model"},"AdminOrganizationEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"inbox_admin":{"type":"boolean"},"created_at":{"type":"string"},"base_fee_cents":{"type":"integer","format":"int32"},"contract_start_date":{"type":"string"},"contract_end_date":{"type":"string"},"auto_charge":{"type":"boolean"},"gross_payment_rate":{"type":"number","format":"double"},"email":{"type":"string"},"included_gross_payment_amount_cents":{"type":"integer","format":"int32"},"payment_date_scheduled":{"type":"string"},"enterprise_ids_sideloaded":{"type":"string"},"enterprise_plan_id":{"type":"integer","format":"int32"},"stripe_subscription_id":{"type":"string"},"days_until_due":{"type":"integer","format":"int32"},"enable_unposted_payment_tab":{"type":"string"},"display_billing_cycle_templates":{"type":"string"},"show_superset_analytics":{"type":"string"},"show_import_tab":{"type":"string"},"accounting_id":{"type":"string"},"mrr_tier":{"type":"string"},"force_user_mfa":{"type":"string"},"company_type":{"type":"string"},"use_for_auth":{"type":"string"},"activate_client_invoicing":{"type":"string"},"pending_admin_org_invoice":{"type":"string"},"rcm_customer_deposit_connect_onboarding_uuid":{"type":"string"},"billable?":{"type":"string"},"integration_credentials":{"$ref":"#/definitions/IntegrationCredentialEntity"},"links":{"type":"object","properties":{"enterprises":{"type":"string"},"users":{"type":"string"},"admin_organization_payment_infos":{"type":"string"}}}}},"IntegrationCredentialEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"admin_organization_id":{"type":"integer","format":"int32"},"pm_system_id":{"type":"integer","format":"int32"},"base_url":{"type":"string"},"auth_url":{"type":"string"},"username":{"type":"string"},"external_id":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"}}},"GetTransfersEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"transfers":{"type":"array","items":{"$ref":"#/definitions/TransferEntity"}},"deposit_accounts":{"type":"array","items":{"$ref":"#/definitions/DepositAccountEntity"}}},"description":"GetTransfersEntity model"},"TransferEntity":{"type":"object","properties":{"id":{"type":"string"},"submitted_at":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"payment_processing_transaction_id":{"type":"string"},"status":{"type":"string"},"enterprise_id":{"type":"string"},"deposit_account_id":{"type":"string"},"credit_or_debit":{"type":"string"},"amount_cents":{"type":"string"},"notes":{"type":"string"},"amount_collected_cents":{"type":"string"},"amount_adjusted_cents":{"type":"string"},"total_transaction_fees_cents":{"type":"string"},"amount_refunded_cents":{"type":"string"},"transfer_type":{"type":"string"},"payout_fee_cents":{"type":"string"},"links":{"type":"object","properties":{"payments":{"type":"string"},"payment_adjustments":{"type":"string"}}}}},"GetEnterprisePaymentsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"enterprise_payments":{"type":"array","items":{"$ref":"#/definitions/EnterprisePaymentEntity"}}},"description":"GetEnterprisePaymentsEntity model"},"EnterprisePaymentEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"payment_method_id":{"type":"integer","format":"int32"},"payment_processing_transaction_id":{"type":"string"},"submitted_at":{"type":"string"},"successful":{"type":"boolean"},"enterprise_id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"status":{"type":"string"},"amount_cents":{"type":"integer","format":"int32"},"tax_cents":{"type":"integer","format":"int32"}}},"GetEnterprisePaymentInfosEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"enterprise_payment_infos":{"type":"array","items":{"$ref":"#/definitions/EnterprisePaymentInfoEntity"}}},"description":"GetEnterprisePaymentInfosEntity model"},"EnterprisePaymentInfoEntity":{"type":"object","properties":{"id":{"type":"string"},"last_4_digits":{"type":"string"},"expiration_month":{"type":"string"},"expiration_year":{"type":"string"},"account_holder_name":{"type":"string"},"primary":{"type":"string"},"payment_processing_instrument_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"routing_number":{"type":"string"},"enterprise_id":{"type":"string"},"zip":{"type":"string"},"brand":{"type":"string"},"funding":{"type":"string"},"payment_method_expiration_email_status":{"type":"string"},"card_label":{"type":"string"},"links":{"type":"object","properties":{"enterprise_payments":{"type":"string"}}}}},"GetEnterpriseInvoicesEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"enterprise_invoices":{"type":"array","items":{"$ref":"#/definitions/EnterpriseInvoiceEntity"}}},"description":"GetEnterpriseInvoicesEntity model"},"EnterpriseInvoiceEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"enterprise_id":{"type":"integer","format":"int32"},"enterprise_name":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"start_date":{"type":"string"},"end_date":{"type":"string"},"total_monthly_fee_cents":{"type":"integer","format":"int32"}}},"AppointmentTemplateEntity":{"type":"object","properties":{"id":{"type":"string"},"appointment_type":{"type":"string"},"appointment_description":{"type":"string"},"exam_room":{"type":"string"},"duration":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"enterprise_id":{"type":"string"},"practice_id":{"type":"string"},"doctor_id":{"type":"string"},"created_by_user_id":{"type":"string"},"soft_delete":{"type":"string"},"checkin_routes":{"type":"string"},"service_code":{"type":"string"},"bookable":{"type":"string"},"skip_checkin":{"type":"string"},"copay_type":{"type":"string"},"suppress_reminders":{"type":"string"},"is_virtual":{"type":"string"}},"description":"AppointmentTemplateEntity model"},"GetDoctorsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"doctors":{"type":"array","items":{"$ref":"#/definitions/DoctorEntity"}}},"description":"GetDoctorsEntity model"},"DoctorEntity":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"enterprise_id":{"type":"integer","format":"int32"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"phone":{"type":"string"},"email":{"type":"string"},"specialty":{"type":"string"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"suffix":{"type":"string"},"certification":{"type":"string"},"message":{"type":"string"},"npi":{"type":"string"},"status":{"type":"string"},"provider_code":{"type":"string"},"profile_id":{"type":"integer","format":"int32"},"deposit_account_id":{"type":"integer","format":"int32"},"external_ids":{"type":"array","items":{"$ref":"#/definitions/ExternalIdEntity"}},"links":{"type":"object","properties":{"practices":{"type":"string"},"shifts":{"type":"string"},"profiles":{"type":"string"}}}},"description":"DoctorEntity model"},"GetPracticesEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"practices":{"type":"array","items":{"$ref":"#/definitions/PracticeEntity"}}},"description":"GetPracticesEntity model"},"putPartnerV2DoctorsId":{"type":"object","properties":{"doctor":{"type":"object","properties":{"first_name":{"type":"string","description":"First name of the doctor"},"middle_name":{"type":"string","description":"Middle name of the doctor"},"last_name":{"type":"string","description":"Last name of the doctor"},"phone":{"type":"string","description":"Phone number"},"specialty":{"type":"string","description":"Doctor's speciality"},"email":{"type":"string","description":"Doctor's email"},"certification":{"type":"string","description":"Certifications"},"suffix":{"type":"string","description":"Suffix"},"message":{"type":"string","description":"Message"},"npi":{"type":"string","description":"Doctor NPI"},"enterprise_id":{"type":"integer","format":"int32","description":"The Enterprise Id that the doctor will be associated with"},"status":{"type":"string","description":"The operating status of the doctor"},"provider_code":{"type":"string","description":"The provider code of the doctor"},"deposit_account_id":{"type":"integer","format":"int32","description":"Id of the doctor's deposit account"},"shifts_attributes":{"type":"array","items":{"type":"object","properties":{"practice_id":{"type":"integer","format":"int32","description":"Pracice id of the shift"},"start_time":{"type":"string","format":"date-time","description":"Start Date/Time of shift"},"end_time":{"type":"string","format":"date-time","description":"End Date/Time of shift"},"is_available":{"type":"boolean","description":"Is shift available"},"_destroy":{"type":"boolean","description":"Will this shift be deleted from the database"},"id":{"type":"integer","format":"int32","description":"Id of the shift"}},"required":["practice_id","start_time","end_time","is_available"]}}}}},"required":["doctor"],"description":"Update a doctor's information"},"postPartnerV2Doctors":{"type":"object","properties":{"doctor":{"type":"object","properties":{"first_name":{"type":"string","description":"First name of the doctor"},"middle_name":{"type":"string","description":"Middle name of the doctor"},"last_name":{"type":"string","description":"Last name of the doctor"},"phone":{"type":"string","description":"Phone number"},"specialty":{"type":"string","description":"Doctor's speciality"},"email":{"type":"string","description":"Doctor's email"},"certification":{"type":"string","description":"Certifications"},"suffix":{"type":"string","description":"Suffix"},"message":{"type":"string","description":"Message"},"npi":{"type":"string","description":"Doctor NPI"},"enterprise_id":{"type":"integer","format":"int32","description":"The Enterprise Id that the doctor will be associated with"},"status":{"type":"string","description":"The operating status of the doctor"},"provider_code":{"type":"string","description":"The provider code of the doctor"},"deposit_account_id":{"type":"integer","format":"int32","description":"Id of the doctor's deposit account"},"shifts_attributes":{"type":"array","items":{"type":"object","properties":{"practice_id":{"type":"integer","format":"int32","description":"Pracice id of the shift"},"start_time":{"type":"string","format":"date-time","description":"Start Date/Time of shift"},"end_time":{"type":"string","format":"date-time","description":"End Date/Time of shift"},"is_available":{"type":"boolean","description":"Is shift available"},"_destroy":{"type":"boolean","description":"Will this shift be deleted from the database"},"id":{"type":"integer","format":"int32","description":"Id of the shift"}},"required":["practice_id","start_time","end_time","is_available"]}}},"required":["first_name","last_name","enterprise_id"]}},"required":["doctor"],"description":"Create a new doctor"},"GetShiftsEntity":{"type":"object","properties":{"meta":{"$ref":"#/definitions/MetaEntity"},"shifts":{"type":"array","items":{"$ref":"#/definitions/ShiftEntity"}}},"description":"GetShiftsEntity model"},"ShiftEntity":{"type":"object","properties":{"id":{"type":"string"},"doctor_id":{"type":"string"},"practice_id":{"type":"string"},"is_available":{"type":"string"},"start_time":{"type":"string"},"end_time":{"type":"string"}}}}}