Slade Advantage API Collection
stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
stringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
stringstringstringstringstringstring · colorintegerstringintegerstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
string · requiredstringstringstringstringstring · date-timestring · colorstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
string · requiredstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
integerstringstring[]string · date-timestringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
string · requiredstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstringstring
List visits
GET
https://accounts.multitenant.slade360.co.ke
/api/visits/visits
Get objects from the DB/cache.
query Parameters
appointmentbilling_classMultiple values may be separated by commas.
branch_idcluster_idcreatedcreated_bycurrent_queuecustomer_iddepartment_idendepisode_of_care_idformatguarantor_ididorderingWhich field to use when ordering the results.
organisationpageA page number within the paginated result set.
page_sizeNumber of results to return per page.
patientpatient_coverpost_visit_survey_tokenpriorityMultiple values may be separated by commas.
searchA search term.
startstatusMultiple values may be separated by commas.
updatedupdated_byvisit_numbervisit_typeMultiple values may be separated by commas.
workstation_idList visits › Responses
200
Untitled Response
countobject[]
nextpreviousCreate visit
POST
https://accounts.multitenant.slade360.co.ke
/api/visits/visits
Create and persist single or multiple records.
Headers
X-WorkstationX-clusterX-BranchX-DepartmentCreate visit › Request Body
visit_typestatuspatientbilling_classappointmentcurrent_queueCreate visit › Responses
Untitled Response
billing_classcreatedcreated_bycreated_by_namecustomer_ididorganisationpatientpatient_namephone_numberobject[]
statusupdatedupdated_byupdated_by_nameobject
visit_typeworkstation_iddepartment_idbranch_idcluster_idactivevisit_numberstartendpriorityguarantor_idpatient_coverepisode_of_care_idpost_visit_survey_tokenappointmentcurrent_queueList billing invoices
GET
https://accounts.multitenant.slade360.co.ke
/api/billing/invoices
Get objects from the DB/cache.
query Parameters
branch_idcluster_idcreatedcreated_bydepartment_idformatidinvoice_numberorderingWhich field to use when ordering the results.
organisationpageA page number within the paginated result set.
page_sizeNumber of results to return per page.
sales_invoice_idsearchA search term.
service_requestupdatedupdated_byworkflow_stateMultiple values may be separated by commas.
workstation_idList billing invoices › Responses
200
Untitled Response
countobject[]
nextpreviousList billable items
GET
https://accounts.multitenant.slade360.co.ke
/api/billing/billable_items
Get objects from the DB/cache.
query Parameters
branch_idclinical_ordercluster_idcreatedcreated_bydepartment_idformatidinvoicenameorderingWhich field to use when ordering the results.
organisationoriginal_pricepageA page number within the paginated result set.
page_sizeNumber of results to return per page.
pricepricelist_product_idproduct_idquantitysales_invoice_line_idsales_order_line_idsearchA search term.
tax_rateupdatedupdated_byworkstation_idList billable items › Responses
200
Untitled Response
countobject[]
nextpreviousCreate billable item
POST
https://accounts.multitenant.slade360.co.ke
/api/billing/billable_items
Create and persist single or multiple records.
Headers
X-WorkstationX-clusterX-BranchX-DepartmentCreate billable item › Request Body
invoicepricequantityproduct_idoriginal_pricepricelist_product_idnameCreate billable item › Responses
Untitled Response
createdcreated_bycreated_by_nameidnameorganisationoriginal_pricepricepricelist_product_idproduct_idquantitysales_invoice_line_idsales_order_line_idupdatedupdated_byupdated_by_nameworkstation_iddepartment_idbranch_idcluster_idactivetax_rateclinical_orderinvoiceRecord billing payment
POST
https://accounts.multitenant.slade360.co.ke
/api/billing/invoices/{id}/record_payment
Record a payment on the ERP.
Recording payments on the ERP is a two-step process: 1. We add a payment receipt 2. We link the receipt to a sales invoice.
This endpoint does both actions instead of the frontend having to call the ERP twice.
path Parameters
id(Required) A UUID string identifying this invoice.
Headers
X-WorkstationX-clusterX-BranchX-DepartmentRecord billing payment › Request Body
payment_dateamountsource_organisation_unitcurrencyinvoicepayment_method_namepayment_methodRecord billing payment › Responses
200
Untitled Response
amount_dueamount_paidcreatedcreated_bycreated_by_nameidobject[]
invoice_numberorganisationobject[]
refund_statusobject[]
sales_invoice_idservice_requestupdatedupdated_byupdated_by_nameworkflow_stateworkstation_iddepartment_idbranch_idcluster_idactivePrint visit receipt
GET
https://accounts.multitenant.slade360.co.ke
/api/visits/visits/{id}/consolidated_invoice
Generate an invoice that consolidates lines from all invoices.
path Parameters
id(Required) A UUID string identifying this visit.
Print visit receipt › Responses
200
Untitled Response
billing_classcreatedcreated_bycreated_by_namecustomer_ididorganisationpatientpatient_namephone_numberobject[]
statusupdatedupdated_byupdated_by_nameobject
visit_typeworkstation_iddepartment_idbranch_idcluster_idactivevisit_numberstartendpriorityguarantor_idpatient_coverepisode_of_care_idpost_visit_survey_tokenappointmentcurrent_queueRecord multiple payments
POST
https://accounts.multitenant.slade360.co.ke
/api/billing/invoices/record_multiple_payments
Record payments for multiple invoices.
Record multiple payments › Request Body
amountcurrencyinvoice_idspayment_datepayment_methodpayment_method_nameRecord multiple payments › Responses
200
Untitled Response
amount_dueamount_paidcreatedcreated_bycreated_by_nameidobject[]
invoice_numberorganisationobject[]
refund_statusobject[]
sales_invoice_idservice_requestupdatedupdated_byupdated_by_nameworkflow_stateworkstation_iddepartment_idbranch_idcluster_idactiveClose visit
POST
https://accounts.multitenant.slade360.co.ke
/api/visits/visits/{id}/close
Complete/Close the visit.
path Parameters
id(Required) A UUID string identifying this visit.
Close visit › Responses
200
Untitled Response
billing_classcreatedcreated_bycreated_by_namecustomer_ididorganisationpatientpatient_namephone_numberobject[]
statusupdatedupdated_byupdated_by_nameobject
visit_typeworkstation_iddepartment_idbranch_idcluster_idactivevisit_numberstartendpriorityguarantor_idpatient_coverepisode_of_care_idpost_visit_survey_tokenappointmentcurrent_queue