api-docs v5.116.0

API Docs

Table of contents

Organization

Organization - Delete

Back to top

Delete an organization's details

DELETE /organizations/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of organization

Examples

Example usage:

curl "https://yourdomain.com/organizations/<organization-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
externalId string
createdAt number

timestamp
createdBy string
type string Allowed values: cms,his,personal-clinic,group-clinic,pharmacy,health-group,company,product-page,warehouse,insurance,diagnostic-center
subtype string
parent string
overlords string[]

controlling organization's ids
name string
description string
address object
address.street1 string
address.street2 string
address.city string
address.municipality string
address.province string
address.country string
address.lat number
address.lng number
website string
email string
emails string[]
phone string
phones string[]
tags string[]
logoURL string
picURL string
picDataURI string
coverURL string
metadata object
publicFields string[]
configQueueing object
configQueueing.balancingModel string Allowed values: routing,dynamic
configQueueing.lastNumber number
configQueueing.askPrivacySignature boolean
configQueueing.requireDeferReason boolean
configQueueing.requireCancelReason boolean
configQueueing.requireRequeueReason boolean
configQueueing.cashierPoolServiceTypes string[]
configQueueing.endOfEncounterServiceTypes string[]
configActionCodes object
configActionCodes.logoURL string
configActionCodes.backgroundURL string
configActionCodes.signatureURL string
configBilling object
configBilling.discountTypes object[]
configBilling.paymentMethods object[]
configBilling.paymentMethodDefault string
configBilling.taxTypes object[]
configBilling.taxTypeServiceSalesDefault string
configBilling.taxTypeProductSalesDefault string
configBilling.taxTypePurchaseDefault string
configBilling.priceLists object[]
configBilling.priceListSalesDefault string
configBilling.priceListPurchaseDefault string
configBilling.enablePrePostpaid boolean
configBilling.requireInvoicePaymentOrCoverage boolean
configBilling.disallowPriceEditing boolean
configBilling.requireCoverageApprovalCode.hmo boolean
configBilling.requireCoverageApprovalCode.government boolean
configBilling.requireCoverageApprovalCode.company.default boolean
configBilling.requireCoverageApprovalCode.company.prepaid boolean
configBilling.requireCoverageApprovalCode.company.postpaid boolean
configSMS object
configSMS.providers object[]
configSMS.providers.appid string
configSMS.providers.shortcode string
configSMS.providers.appsecret string
configSMS.providers.passphrase string
configLIS object
configLIS.enabled boolean
configLIS.useSI boolean
configLIS.printLayout string Allowed values: tabular,compact
configLIS.showIndicatorsOnPrint boolean
configLIS.showRemarksOnPrint boolean
configLIS.orderTestsReportTargets string[]
configLIS.useSectionFixtures boolean
configLIS.customControlIdEnabled boolean
configLIS.customControlIdFormat string
configLIS.customControlIdDateFormat string
configLIS.customControlIdLength number
configLIS.customControlIdPaddingPosition string Allowed values: before,after
configLIS.customControlIdPaddingCharacter string
configRIS object
configRIS.enabled boolean
configRIS.useSectionFixtures boolean
configRIS.customControlIdEnabled boolean
configRIS.customControlIdFormat string
configRIS.customControlIdDateFormat string
configRIS.customControlIdLength number
configRIS.customControlIdPaddingPosition string Allowed values: before,after
configRIS.customControlIdPaddingCharacter string
configInventory object
configInventory.enabled boolean
configInventory.productCategories string[]
configInventory.productTypes string[]
configInventory.productBrands string[]
configInventory.stockAdjustmentReasons string[]
configInventory.stockRooms string[]
configInventory.unfulfilledSalesOrderExpiration number
configKiosk object
configKiosk.enabled boolean
configKiosk.enableQueueNoPrinting boolean
configKiosk.backgroundURL string
configKiosk.fields object
configKiosk.fieldsFollowUp object
configKiosk.marquee object
configKiosk.tags string[]
configKiosk.messages object[]
configKiosk.messages.id string
configKiosk.messages.language string
configKiosk.messages.text string
configKiosk.messages.title string
configKiosk.messages.acceptButtonText string
configKiosk.insuranceWorkflow boolean
configEMR object
configEMR.fieldsPatient object
configEMR.requiredRecords object[]
configEMR.requiredRecords.id string
configEMR.requiredRecords.type string
configEMR.requiredRecords.subtype string
configEMR.showOwnRecords boolean
configEMR.useAccountOwnedFormTemplates boolean
configFacility object
configFacility.dashboardDisplays object
configFacility.schedule object[]
configFacility.schedule.id string
configFacility.schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
configFacility.schedule.opening number

timestamp
configFacility.schedule.closing number

timestamp
configFacility.insuranceARTemplateDefault string
configFacility.printHeaderTemplate object
configFacility.cutoffTime number

timestamp hour format
configFacility.currency string
configFacility.currencySymbol string
configFacility.languages object
configInsurer object
configInsurer.insurer string
configInsurer.insurerName string
cutoffTime number

timestamp
warehouseEnabled boolean
queue_printNo boolean
queue_balancingModel string Allowed values: routing,dynamic
bl_discountTypes object
bl_discountTypes.code string
bl_discountTypes.name string
bl_discountTypes.application string Allowed values: billing-item,billing-invoice
bl_discountTypes.applicationSubtype string Allowed values: inventory-variant,service
bl_discountTypes.applicationRefs string[]
bl_discountTypes.amount number
bl_discountTypes.percentage number
bl_paymentMethods object
bl_paymentMethods.code string
bl_paymentMethods.type string
bl_paymentMethods.name string
bl_paymentMethods.description string
bl_defaultPaymentMethod string
bl_taxTypes object[]
bl_taxTypes.code string
bl_taxTypes.name string
bl_taxTypes.description string
bl_taxTypes.value number
bl_defaultSalesTax string
bl_defaultPurchaseTax string
bl_priceLists object[]
bl_priceLists.code string
bl_priceLists.name string
bl_priceLists.currency string Default value: PHP
bl_priceLists.sales boolean Default value: false
bl_defaultSalesPriceList string
bl_defaultPurchasePriceList string
wh_productCategories string[]
wh_productTypes stirng[]
wh_brands string[]
wh_stockAdjustmentReasons string[]
wh_unfulfilledSalesOrderExpiration number
mf_dashboardDisplays object
mf_patientFields object
mf_kioskBackgroundURL string
mf_kioskFields object
mf_kioskFollowUpFields object
mf_kioskMarquee object
mf_kioskTags string[]
mf_kioskMessages object[]
mf_kioskMessages.id string
mf_kioskMessages.language string
mf_kioskMessages.text string
mf_kioskMessages.title string
mf_kioskMessages.acceptButtonText string
mf_schedule object
mf_schedule.id string
mf_schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
mf_schedule.opening number

timestamp
mf_schedule.closing number

timestamp
mf_defaultTemplate_insuranceAR string
mf_printHeaderTemplate object
sms_configs object[]
sms_configs.appid stirng
sms_configs.shortcode stirng
sms_configs.appsecret stirng
sms_configs.passphrase stirng
ac_logoURL string
ac_backgroundURL string
ac_signatureURL string
diagnostic_useSI boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "organization-id",
  "externalId": "hmo-custom-id",
  "type": "company",
  "name": "Medicard Partner Company",
  "overlords": [ "hmo-hq-random-id" ]
}

Organization - Get

Back to top

Get an organization's details

GET /organizations/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of organization

Examples

Example usage:

curl "https://yourdomain.com/organizations/<organization-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
externalId string
createdAt number

timestamp
createdBy string
type string Allowed values: cms,his,personal-clinic,group-clinic,pharmacy,health-group,company,product-page,warehouse,insurance,diagnostic-center
subtype string
parent string
overlords string[]

controlling organization's ids
name string
description string
address object
address.street1 string
address.street2 string
address.city string
address.municipality string
address.province string
address.country string
address.lat number
address.lng number
website string
email string
emails string[]
phone string
phones string[]
tags string[]
logoURL string
picURL string
picDataURI string
coverURL string
metadata object
publicFields string[]
configQueueing object
configQueueing.balancingModel string Allowed values: routing,dynamic
configQueueing.lastNumber number
configQueueing.askPrivacySignature boolean
configQueueing.requireDeferReason boolean
configQueueing.requireCancelReason boolean
configQueueing.requireRequeueReason boolean
configQueueing.cashierPoolServiceTypes string[]
configQueueing.endOfEncounterServiceTypes string[]
configActionCodes object
configActionCodes.logoURL string
configActionCodes.backgroundURL string
configActionCodes.signatureURL string
configBilling object
configBilling.discountTypes object[]
configBilling.paymentMethods object[]
configBilling.paymentMethodDefault string
configBilling.taxTypes object[]
configBilling.taxTypeServiceSalesDefault string
configBilling.taxTypeProductSalesDefault string
configBilling.taxTypePurchaseDefault string
configBilling.priceLists object[]
configBilling.priceListSalesDefault string
configBilling.priceListPurchaseDefault string
configBilling.enablePrePostpaid boolean
configBilling.requireInvoicePaymentOrCoverage boolean
configBilling.disallowPriceEditing boolean
configBilling.requireCoverageApprovalCode.hmo boolean
configBilling.requireCoverageApprovalCode.government boolean
configBilling.requireCoverageApprovalCode.company.default boolean
configBilling.requireCoverageApprovalCode.company.prepaid boolean
configBilling.requireCoverageApprovalCode.company.postpaid boolean
configSMS object
configSMS.providers object[]
configSMS.providers.appid string
configSMS.providers.shortcode string
configSMS.providers.appsecret string
configSMS.providers.passphrase string
configLIS object
configLIS.enabled boolean
configLIS.useSI boolean
configLIS.printLayout string Allowed values: tabular,compact
configLIS.showIndicatorsOnPrint boolean
configLIS.showRemarksOnPrint boolean
configLIS.orderTestsReportTargets string[]
configLIS.useSectionFixtures boolean
configLIS.customControlIdEnabled boolean
configLIS.customControlIdFormat string
configLIS.customControlIdDateFormat string
configLIS.customControlIdLength number
configLIS.customControlIdPaddingPosition string Allowed values: before,after
configLIS.customControlIdPaddingCharacter string
configRIS object
configRIS.enabled boolean
configRIS.useSectionFixtures boolean
configRIS.customControlIdEnabled boolean
configRIS.customControlIdFormat string
configRIS.customControlIdDateFormat string
configRIS.customControlIdLength number
configRIS.customControlIdPaddingPosition string Allowed values: before,after
configRIS.customControlIdPaddingCharacter string
configInventory object
configInventory.enabled boolean
configInventory.productCategories string[]
configInventory.productTypes string[]
configInventory.productBrands string[]
configInventory.stockAdjustmentReasons string[]
configInventory.stockRooms string[]
configInventory.unfulfilledSalesOrderExpiration number
configKiosk object
configKiosk.enabled boolean
configKiosk.enableQueueNoPrinting boolean
configKiosk.backgroundURL string
configKiosk.fields object
configKiosk.fieldsFollowUp object
configKiosk.marquee object
configKiosk.tags string[]
configKiosk.messages object[]
configKiosk.messages.id string
configKiosk.messages.language string
configKiosk.messages.text string
configKiosk.messages.title string
configKiosk.messages.acceptButtonText string
configKiosk.insuranceWorkflow boolean
configEMR object
configEMR.fieldsPatient object
configEMR.requiredRecords object[]
configEMR.requiredRecords.id string
configEMR.requiredRecords.type string
configEMR.requiredRecords.subtype string
configEMR.showOwnRecords boolean
configEMR.useAccountOwnedFormTemplates boolean
configFacility object
configFacility.dashboardDisplays object
configFacility.schedule object[]
configFacility.schedule.id string
configFacility.schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
configFacility.schedule.opening number

timestamp
configFacility.schedule.closing number

timestamp
configFacility.insuranceARTemplateDefault string
configFacility.printHeaderTemplate object
configFacility.cutoffTime number

timestamp hour format
configFacility.currency string
configFacility.currencySymbol string
configFacility.languages object
configInsurer object
configInsurer.insurer string
configInsurer.insurerName string
cutoffTime number

timestamp
warehouseEnabled boolean
queue_printNo boolean
queue_balancingModel string Allowed values: routing,dynamic
bl_discountTypes object
bl_discountTypes.code string
bl_discountTypes.name string
bl_discountTypes.application string Allowed values: billing-item,billing-invoice
bl_discountTypes.applicationSubtype string Allowed values: inventory-variant,service
bl_discountTypes.applicationRefs string[]
bl_discountTypes.amount number
bl_discountTypes.percentage number
bl_paymentMethods object
bl_paymentMethods.code string
bl_paymentMethods.type string
bl_paymentMethods.name string
bl_paymentMethods.description string
bl_defaultPaymentMethod string
bl_taxTypes object[]
bl_taxTypes.code string
bl_taxTypes.name string
bl_taxTypes.description string
bl_taxTypes.value number
bl_defaultSalesTax string
bl_defaultPurchaseTax string
bl_priceLists object[]
bl_priceLists.code string
bl_priceLists.name string
bl_priceLists.currency string Default value: PHP
bl_priceLists.sales boolean Default value: false
bl_defaultSalesPriceList string
bl_defaultPurchasePriceList string
wh_productCategories string[]
wh_productTypes stirng[]
wh_brands string[]
wh_stockAdjustmentReasons string[]
wh_unfulfilledSalesOrderExpiration number
mf_dashboardDisplays object
mf_patientFields object
mf_kioskBackgroundURL string
mf_kioskFields object
mf_kioskFollowUpFields object
mf_kioskMarquee object
mf_kioskTags string[]
mf_kioskMessages object[]
mf_kioskMessages.id string
mf_kioskMessages.language string
mf_kioskMessages.text string
mf_kioskMessages.title string
mf_kioskMessages.acceptButtonText string
mf_schedule object
mf_schedule.id string
mf_schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
mf_schedule.opening number

timestamp
mf_schedule.closing number

timestamp
mf_defaultTemplate_insuranceAR string
mf_printHeaderTemplate object
sms_configs object[]
sms_configs.appid stirng
sms_configs.shortcode stirng
sms_configs.appsecret stirng
sms_configs.passphrase stirng
ac_logoURL string
ac_backgroundURL string
ac_signatureURL string
diagnostic_useSI boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "organization-id",
  "externalId": "hmo-custom-id",
  "type": "company",
  "name": "Medicard Partner Company",
  "overlords": [ "hmo-hq-random-id" ]
}

Organization - Patch

Back to top

Update an organization

PATCH /organizations/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
externalId string optional
createdAt number optional

timestamp
type string Allowed values: cms,his,personal-clinic,group-clinic,pharmacy,health-group,company,product-page,warehouse,insurance,diagnostic-center
subtype string optional
parent string optional
overlords string[] optional

controlling organization's ids
name string
description string optional
address object optional
address.street1 string
address.street2 string
address.city string
address.municipality string
address.province string
address.country string
address.lat number
address.lng number
website string optional
email string optional
emails string[] optional
phone string optional
phones string[] optional
tags string[] optional
logoURL string optional
picURL string optional
picDataURI string optional
coverURL string optional
metadata object optional
publicFields string[] optional
configQueueing object optional
configQueueing.balancingModel string Allowed values: routing,dynamic
configQueueing.lastNumber number
configQueueing.askPrivacySignature boolean
configQueueing.requireDeferReason boolean
configQueueing.requireCancelReason boolean
configQueueing.requireRequeueReason boolean
configQueueing.cashierPoolServiceTypes string[]
configQueueing.endOfEncounterServiceTypes string[]
configActionCodes object optional
configActionCodes.logoURL string
configActionCodes.backgroundURL string
configActionCodes.signatureURL string
configBilling object optional
configBilling.discountTypes object[]
configBilling.paymentMethods object[]
configBilling.paymentMethodDefault string
configBilling.taxTypes object[]
configBilling.taxTypeServiceSalesDefault string
configBilling.taxTypeProductSalesDefault string
configBilling.taxTypePurchaseDefault string
configBilling.priceLists object[]
configBilling.priceListSalesDefault string
configBilling.priceListPurchaseDefault string
configBilling.enablePrePostpaid boolean
configBilling.requireInvoicePaymentOrCoverage boolean
configBilling.disallowPriceEditing boolean
configBilling.requireCoverageApprovalCode.hmo boolean
configBilling.requireCoverageApprovalCode.government boolean
configBilling.requireCoverageApprovalCode.company.default boolean
configBilling.requireCoverageApprovalCode.company.prepaid boolean
configBilling.requireCoverageApprovalCode.company.postpaid boolean
configSMS object optional
configSMS.providers object[]
configSMS.providers.appid string
configSMS.providers.shortcode string
configSMS.providers.appsecret string
configSMS.providers.passphrase string
configLIS object optional
configLIS.enabled boolean
configLIS.useSI boolean
configLIS.printLayout string Allowed values: tabular,compact
configLIS.showIndicatorsOnPrint boolean
configLIS.showRemarksOnPrint boolean
configLIS.orderTestsReportTargets string[]
configLIS.useSectionFixtures boolean
configLIS.customControlIdEnabled boolean
configLIS.customControlIdFormat string
configLIS.customControlIdDateFormat string
configLIS.customControlIdLength number
configLIS.customControlIdPaddingPosition string Allowed values: before,after
configLIS.customControlIdPaddingCharacter string
configRIS object optional
configRIS.enabled boolean
configRIS.useSectionFixtures boolean
configRIS.customControlIdEnabled boolean
configRIS.customControlIdFormat string
configRIS.customControlIdDateFormat string
configRIS.customControlIdLength number
configRIS.customControlIdPaddingPosition string Allowed values: before,after
configRIS.customControlIdPaddingCharacter string
configInventory object optional
configInventory.enabled boolean
configInventory.productCategories string[]
configInventory.productTypes string[]
configInventory.productBrands string[]
configInventory.stockAdjustmentReasons string[]
configInventory.stockRooms string[]
configInventory.unfulfilledSalesOrderExpiration number
configKiosk object optional
configKiosk.enabled boolean
configKiosk.enableQueueNoPrinting boolean
configKiosk.backgroundURL string
configKiosk.fields object
configKiosk.fieldsFollowUp object
configKiosk.marquee object
configKiosk.tags string[]
configKiosk.messages object[]
configKiosk.messages.id string
configKiosk.messages.language string
configKiosk.messages.text string
configKiosk.messages.title string
configKiosk.messages.acceptButtonText string
configKiosk.insuranceWorkflow boolean
configEMR object optional
configEMR.fieldsPatient object
configEMR.requiredRecords object[]
configEMR.requiredRecords.id string
configEMR.requiredRecords.type string
configEMR.requiredRecords.subtype string
configEMR.showOwnRecords boolean
configEMR.useAccountOwnedFormTemplates boolean
configFacility object optional
configFacility.dashboardDisplays object
configFacility.schedule object[]
configFacility.schedule.id string
configFacility.schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
configFacility.schedule.opening number

timestamp
configFacility.schedule.closing number

timestamp
configFacility.insuranceARTemplateDefault string
configFacility.printHeaderTemplate object
configFacility.cutoffTime number

timestamp hour format
configFacility.currency string
configFacility.currencySymbol string
configFacility.languages object
configInsurer object optional
configInsurer.insurer string
configInsurer.insurerName string
cutoffTime number optional

timestamp
warehouseEnabled boolean optional
queue_printNo boolean optional
queue_balancingModel string optional Allowed values: routing,dynamic
bl_discountTypes object optional
bl_discountTypes.code string
bl_discountTypes.name string
bl_discountTypes.application string Allowed values: billing-item,billing-invoice
bl_discountTypes.applicationSubtype string Allowed values: inventory-variant,service
bl_discountTypes.applicationRefs string[]
bl_discountTypes.amount number
bl_discountTypes.percentage number
bl_paymentMethods object optional
bl_paymentMethods.code string
bl_paymentMethods.type string
bl_paymentMethods.name string
bl_paymentMethods.description string
bl_defaultPaymentMethod string optional
bl_taxTypes object[] optional
bl_taxTypes.code string
bl_taxTypes.name string
bl_taxTypes.description string
bl_taxTypes.value number
bl_defaultSalesTax string optional
bl_defaultPurchaseTax string optional
bl_priceLists object[] optional
bl_priceLists.code string
bl_priceLists.name string
bl_priceLists.currency string Default value: PHP
bl_priceLists.sales boolean Default value: false
bl_defaultSalesPriceList string optional
bl_defaultPurchasePriceList string optional
wh_productCategories string[] optional
wh_productTypes stirng[] optional
wh_brands string[] optional
wh_stockAdjustmentReasons string[] optional
wh_unfulfilledSalesOrderExpiration number optional
mf_dashboardDisplays object optional
mf_patientFields object optional
mf_kioskBackgroundURL string optional
mf_kioskFields object optional
mf_kioskFollowUpFields object optional
mf_kioskMarquee object optional
mf_kioskTags string[] optional
mf_kioskMessages object[] optional
mf_kioskMessages.id string
mf_kioskMessages.language string
mf_kioskMessages.text string
mf_kioskMessages.title string
mf_kioskMessages.acceptButtonText string
mf_schedule object optional
mf_schedule.id string
mf_schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
mf_schedule.opening number

timestamp
mf_schedule.closing number

timestamp
mf_defaultTemplate_insuranceAR string optional
mf_printHeaderTemplate object optional
sms_configs object[] optional
sms_configs.appid stirng
sms_configs.shortcode stirng
sms_configs.appsecret stirng
sms_configs.passphrase stirng
ac_logoURL string optional
ac_backgroundURL string optional
ac_signatureURL string optional
diagnostic_useSI boolean optional
superadmin boolean/string optional

operator

Examples

Example usage:

curl "https://yourdomain.com/organizations/<organization-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "name": "Updated Name"
  }'

Parameters examples

json - Request-Example

{
  "name": "Updated Name"
}

Success response

Success response - Success 200

Name Type Description
id string
externalId string
createdAt number

timestamp
createdBy string
type string Allowed values: cms,his,personal-clinic,group-clinic,pharmacy,health-group,company,product-page,warehouse,insurance,diagnostic-center
subtype string
parent string
overlords string[]

controlling organization's ids
name string
description string
address object
address.street1 string
address.street2 string
address.city string
address.municipality string
address.province string
address.country string
address.lat number
address.lng number
website string
email string
emails string[]
phone string
phones string[]
tags string[]
logoURL string
picURL string
picDataURI string
coverURL string
metadata object
publicFields string[]
configQueueing object
configQueueing.balancingModel string Allowed values: routing,dynamic
configQueueing.lastNumber number
configQueueing.askPrivacySignature boolean
configQueueing.requireDeferReason boolean
configQueueing.requireCancelReason boolean
configQueueing.requireRequeueReason boolean
configQueueing.cashierPoolServiceTypes string[]
configQueueing.endOfEncounterServiceTypes string[]
configActionCodes object
configActionCodes.logoURL string
configActionCodes.backgroundURL string
configActionCodes.signatureURL string
configBilling object
configBilling.discountTypes object[]
configBilling.paymentMethods object[]
configBilling.paymentMethodDefault string
configBilling.taxTypes object[]
configBilling.taxTypeServiceSalesDefault string
configBilling.taxTypeProductSalesDefault string
configBilling.taxTypePurchaseDefault string
configBilling.priceLists object[]
configBilling.priceListSalesDefault string
configBilling.priceListPurchaseDefault string
configBilling.enablePrePostpaid boolean
configBilling.requireInvoicePaymentOrCoverage boolean
configBilling.disallowPriceEditing boolean
configBilling.requireCoverageApprovalCode.hmo boolean
configBilling.requireCoverageApprovalCode.government boolean
configBilling.requireCoverageApprovalCode.company.default boolean
configBilling.requireCoverageApprovalCode.company.prepaid boolean
configBilling.requireCoverageApprovalCode.company.postpaid boolean
configSMS object
configSMS.providers object[]
configSMS.providers.appid string
configSMS.providers.shortcode string
configSMS.providers.appsecret string
configSMS.providers.passphrase string
configLIS object
configLIS.enabled boolean
configLIS.useSI boolean
configLIS.printLayout string Allowed values: tabular,compact
configLIS.showIndicatorsOnPrint boolean
configLIS.showRemarksOnPrint boolean
configLIS.orderTestsReportTargets string[]
configLIS.useSectionFixtures boolean
configLIS.customControlIdEnabled boolean
configLIS.customControlIdFormat string
configLIS.customControlIdDateFormat string
configLIS.customControlIdLength number
configLIS.customControlIdPaddingPosition string Allowed values: before,after
configLIS.customControlIdPaddingCharacter string
configRIS object
configRIS.enabled boolean
configRIS.useSectionFixtures boolean
configRIS.customControlIdEnabled boolean
configRIS.customControlIdFormat string
configRIS.customControlIdDateFormat string
configRIS.customControlIdLength number
configRIS.customControlIdPaddingPosition string Allowed values: before,after
configRIS.customControlIdPaddingCharacter string
configInventory object
configInventory.enabled boolean
configInventory.productCategories string[]
configInventory.productTypes string[]
configInventory.productBrands string[]
configInventory.stockAdjustmentReasons string[]
configInventory.stockRooms string[]
configInventory.unfulfilledSalesOrderExpiration number
configKiosk object
configKiosk.enabled boolean
configKiosk.enableQueueNoPrinting boolean
configKiosk.backgroundURL string
configKiosk.fields object
configKiosk.fieldsFollowUp object
configKiosk.marquee object
configKiosk.tags string[]
configKiosk.messages object[]
configKiosk.messages.id string
configKiosk.messages.language string
configKiosk.messages.text string
configKiosk.messages.title string
configKiosk.messages.acceptButtonText string
configKiosk.insuranceWorkflow boolean
configEMR object
configEMR.fieldsPatient object
configEMR.requiredRecords object[]
configEMR.requiredRecords.id string
configEMR.requiredRecords.type string
configEMR.requiredRecords.subtype string
configEMR.showOwnRecords boolean
configEMR.useAccountOwnedFormTemplates boolean
configFacility object
configFacility.dashboardDisplays object
configFacility.schedule object[]
configFacility.schedule.id string
configFacility.schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
configFacility.schedule.opening number

timestamp
configFacility.schedule.closing number

timestamp
configFacility.insuranceARTemplateDefault string
configFacility.printHeaderTemplate object
configFacility.cutoffTime number

timestamp hour format
configFacility.currency string
configFacility.currencySymbol string
configFacility.languages object
configInsurer object
configInsurer.insurer string
configInsurer.insurerName string
cutoffTime number

timestamp
warehouseEnabled boolean
queue_printNo boolean
queue_balancingModel string Allowed values: routing,dynamic
bl_discountTypes object
bl_discountTypes.code string
bl_discountTypes.name string
bl_discountTypes.application string Allowed values: billing-item,billing-invoice
bl_discountTypes.applicationSubtype string Allowed values: inventory-variant,service
bl_discountTypes.applicationRefs string[]
bl_discountTypes.amount number
bl_discountTypes.percentage number
bl_paymentMethods object
bl_paymentMethods.code string
bl_paymentMethods.type string
bl_paymentMethods.name string
bl_paymentMethods.description string
bl_defaultPaymentMethod string
bl_taxTypes object[]
bl_taxTypes.code string
bl_taxTypes.name string
bl_taxTypes.description string
bl_taxTypes.value number
bl_defaultSalesTax string
bl_defaultPurchaseTax string
bl_priceLists object[]
bl_priceLists.code string
bl_priceLists.name string
bl_priceLists.currency string Default value: PHP
bl_priceLists.sales boolean Default value: false
bl_defaultSalesPriceList string
bl_defaultPurchasePriceList string
wh_productCategories string[]
wh_productTypes stirng[]
wh_brands string[]
wh_stockAdjustmentReasons string[]
wh_unfulfilledSalesOrderExpiration number
mf_dashboardDisplays object
mf_patientFields object
mf_kioskBackgroundURL string
mf_kioskFields object
mf_kioskFollowUpFields object
mf_kioskMarquee object
mf_kioskTags string[]
mf_kioskMessages object[]
mf_kioskMessages.id string
mf_kioskMessages.language string
mf_kioskMessages.text string
mf_kioskMessages.title string
mf_kioskMessages.acceptButtonText string
mf_schedule object
mf_schedule.id string
mf_schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
mf_schedule.opening number

timestamp
mf_schedule.closing number

timestamp
mf_defaultTemplate_insuranceAR string
mf_printHeaderTemplate object
sms_configs object[]
sms_configs.appid stirng
sms_configs.shortcode stirng
sms_configs.appsecret stirng
sms_configs.passphrase stirng
ac_logoURL string
ac_backgroundURL string
ac_signatureURL string
diagnostic_useSI boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "organization-id",
  "externalId": "hmo-custom-id",
  "type": "company",
  "name": "Medicard Partner Company",
  "overlords": [ "hmo-hq-random-id" ]
}

Organization - Post

Back to top

Create an organization

POST /organizations

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
externalId string optional
createdAt number optional

timestamp
type string Allowed values: cms,his,personal-clinic,group-clinic,pharmacy,health-group,company,product-page,warehouse,insurance,diagnostic-center
subtype string optional
parent string optional
overlords string[] optional

controlling organization's ids
name string
description string optional
address object optional
address.street1 string
address.street2 string
address.city string
address.municipality string
address.province string
address.country string
address.lat number
address.lng number
website string optional
email string optional
emails string[] optional
phone string optional
phones string[] optional
tags string[] optional
logoURL string optional
picURL string optional
picDataURI string optional
coverURL string optional
metadata object optional
publicFields string[] optional
configQueueing object optional
configQueueing.balancingModel string Allowed values: routing,dynamic
configQueueing.lastNumber number
configQueueing.askPrivacySignature boolean
configQueueing.requireDeferReason boolean
configQueueing.requireCancelReason boolean
configQueueing.requireRequeueReason boolean
configQueueing.cashierPoolServiceTypes string[]
configQueueing.endOfEncounterServiceTypes string[]
configActionCodes object optional
configActionCodes.logoURL string
configActionCodes.backgroundURL string
configActionCodes.signatureURL string
configBilling object optional
configBilling.discountTypes object[]
configBilling.paymentMethods object[]
configBilling.paymentMethodDefault string
configBilling.taxTypes object[]
configBilling.taxTypeServiceSalesDefault string
configBilling.taxTypeProductSalesDefault string
configBilling.taxTypePurchaseDefault string
configBilling.priceLists object[]
configBilling.priceListSalesDefault string
configBilling.priceListPurchaseDefault string
configBilling.enablePrePostpaid boolean
configBilling.requireInvoicePaymentOrCoverage boolean
configBilling.disallowPriceEditing boolean
configBilling.requireCoverageApprovalCode.hmo boolean
configBilling.requireCoverageApprovalCode.government boolean
configBilling.requireCoverageApprovalCode.company.default boolean
configBilling.requireCoverageApprovalCode.company.prepaid boolean
configBilling.requireCoverageApprovalCode.company.postpaid boolean
configSMS object optional
configSMS.providers object[]
configSMS.providers.appid string
configSMS.providers.shortcode string
configSMS.providers.appsecret string
configSMS.providers.passphrase string
configLIS object optional
configLIS.enabled boolean
configLIS.useSI boolean
configLIS.printLayout string Allowed values: tabular,compact
configLIS.showIndicatorsOnPrint boolean
configLIS.showRemarksOnPrint boolean
configLIS.orderTestsReportTargets string[]
configLIS.useSectionFixtures boolean
configLIS.customControlIdEnabled boolean
configLIS.customControlIdFormat string
configLIS.customControlIdDateFormat string
configLIS.customControlIdLength number
configLIS.customControlIdPaddingPosition string Allowed values: before,after
configLIS.customControlIdPaddingCharacter string
configRIS object optional
configRIS.enabled boolean
configRIS.useSectionFixtures boolean
configRIS.customControlIdEnabled boolean
configRIS.customControlIdFormat string
configRIS.customControlIdDateFormat string
configRIS.customControlIdLength number
configRIS.customControlIdPaddingPosition string Allowed values: before,after
configRIS.customControlIdPaddingCharacter string
configInventory object optional
configInventory.enabled boolean
configInventory.productCategories string[]
configInventory.productTypes string[]
configInventory.productBrands string[]
configInventory.stockAdjustmentReasons string[]
configInventory.stockRooms string[]
configInventory.unfulfilledSalesOrderExpiration number
configKiosk object optional
configKiosk.enabled boolean
configKiosk.enableQueueNoPrinting boolean
configKiosk.backgroundURL string
configKiosk.fields object
configKiosk.fieldsFollowUp object
configKiosk.marquee object
configKiosk.tags string[]
configKiosk.messages object[]
configKiosk.messages.id string
configKiosk.messages.language string
configKiosk.messages.text string
configKiosk.messages.title string
configKiosk.messages.acceptButtonText string
configKiosk.insuranceWorkflow boolean
configEMR object optional
configEMR.fieldsPatient object
configEMR.requiredRecords object[]
configEMR.requiredRecords.id string
configEMR.requiredRecords.type string
configEMR.requiredRecords.subtype string
configEMR.showOwnRecords boolean
configEMR.useAccountOwnedFormTemplates boolean
configFacility object optional
configFacility.dashboardDisplays object
configFacility.schedule object[]
configFacility.schedule.id string
configFacility.schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
configFacility.schedule.opening number

timestamp
configFacility.schedule.closing number

timestamp
configFacility.insuranceARTemplateDefault string
configFacility.printHeaderTemplate object
configFacility.cutoffTime number

timestamp hour format
configFacility.currency string
configFacility.currencySymbol string
configFacility.languages object
configInsurer object optional
configInsurer.insurer string
configInsurer.insurerName string
cutoffTime number optional

timestamp
warehouseEnabled boolean optional
queue_printNo boolean optional
queue_balancingModel string optional Allowed values: routing,dynamic
bl_discountTypes object optional
bl_discountTypes.code string
bl_discountTypes.name string
bl_discountTypes.application string Allowed values: billing-item,billing-invoice
bl_discountTypes.applicationSubtype string Allowed values: inventory-variant,service
bl_discountTypes.applicationRefs string[]
bl_discountTypes.amount number
bl_discountTypes.percentage number
bl_paymentMethods object optional
bl_paymentMethods.code string
bl_paymentMethods.type string
bl_paymentMethods.name string
bl_paymentMethods.description string
bl_defaultPaymentMethod string optional
bl_taxTypes object[] optional
bl_taxTypes.code string
bl_taxTypes.name string
bl_taxTypes.description string
bl_taxTypes.value number
bl_defaultSalesTax string optional
bl_defaultPurchaseTax string optional
bl_priceLists object[] optional
bl_priceLists.code string
bl_priceLists.name string
bl_priceLists.currency string Default value: PHP
bl_priceLists.sales boolean Default value: false
bl_defaultSalesPriceList string optional
bl_defaultPurchasePriceList string optional
wh_productCategories string[] optional
wh_productTypes stirng[] optional
wh_brands string[] optional
wh_stockAdjustmentReasons string[] optional
wh_unfulfilledSalesOrderExpiration number optional
mf_dashboardDisplays object optional
mf_patientFields object optional
mf_kioskBackgroundURL string optional
mf_kioskFields object optional
mf_kioskFollowUpFields object optional
mf_kioskMarquee object optional
mf_kioskTags string[] optional
mf_kioskMessages object[] optional
mf_kioskMessages.id string
mf_kioskMessages.language string
mf_kioskMessages.text string
mf_kioskMessages.title string
mf_kioskMessages.acceptButtonText string
mf_schedule object optional
mf_schedule.id string
mf_schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
mf_schedule.opening number

timestamp
mf_schedule.closing number

timestamp
mf_defaultTemplate_insuranceAR string optional
mf_printHeaderTemplate object optional
sms_configs object[] optional
sms_configs.appid stirng
sms_configs.shortcode stirng
sms_configs.appsecret stirng
sms_configs.passphrase stirng
ac_logoURL string optional
ac_backgroundURL string optional
ac_signatureURL string optional
diagnostic_useSI boolean optional
superadmin boolean/string optional

operator
subscription object optional

operator
subscription.id string
subscription.organization string
subscription.trainingDaysOnSite number
subscription.trainingDaysRemote number
subscription.consultation string
subscription.storage number
subscription.transactions number
subscription.doctorSeats number
subscription.support boolean
subscription.syncbase boolean
subscription.pharmacy boolean
subscription.inventory boolean
subscription.lis boolean
subscription.ris boolean
subscription.pme boolean
subscription.dental boolean

Examples

Example usage:

curl "https://yourdomain.com/organizations" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "externalId": "hmo-custom-id",
    "type": "company",
    "name": "Medicard Partner Company",
    "overlords": [ "hmo-hq-random-id" ]
  }'

Parameters examples

json - Request-Example

{
  "externalId": "hmo-custom-id",
  "type": "company",
  "name": "Medicard Partner Company",
  "overlords": [ "hmo-hq-random-id" ]
}

Success response

Success response - Success 200

Name Type Description
id string
externalId string
createdAt number

timestamp
createdBy string
type string Allowed values: cms,his,personal-clinic,group-clinic,pharmacy,health-group,company,product-page,warehouse,insurance,diagnostic-center
subtype string
parent string
overlords string[]

controlling organization's ids
name string
description string
address object
address.street1 string
address.street2 string
address.city string
address.municipality string
address.province string
address.country string
address.lat number
address.lng number
website string
email string
emails string[]
phone string
phones string[]
tags string[]
logoURL string
picURL string
picDataURI string
coverURL string
metadata object
publicFields string[]
configQueueing object
configQueueing.balancingModel string Allowed values: routing,dynamic
configQueueing.lastNumber number
configQueueing.askPrivacySignature boolean
configQueueing.requireDeferReason boolean
configQueueing.requireCancelReason boolean
configQueueing.requireRequeueReason boolean
configQueueing.cashierPoolServiceTypes string[]
configQueueing.endOfEncounterServiceTypes string[]
configActionCodes object
configActionCodes.logoURL string
configActionCodes.backgroundURL string
configActionCodes.signatureURL string
configBilling object
configBilling.discountTypes object[]
configBilling.paymentMethods object[]
configBilling.paymentMethodDefault string
configBilling.taxTypes object[]
configBilling.taxTypeServiceSalesDefault string
configBilling.taxTypeProductSalesDefault string
configBilling.taxTypePurchaseDefault string
configBilling.priceLists object[]
configBilling.priceListSalesDefault string
configBilling.priceListPurchaseDefault string
configBilling.enablePrePostpaid boolean
configBilling.requireInvoicePaymentOrCoverage boolean
configBilling.disallowPriceEditing boolean
configBilling.requireCoverageApprovalCode.hmo boolean
configBilling.requireCoverageApprovalCode.government boolean
configBilling.requireCoverageApprovalCode.company.default boolean
configBilling.requireCoverageApprovalCode.company.prepaid boolean
configBilling.requireCoverageApprovalCode.company.postpaid boolean
configSMS object
configSMS.providers object[]
configSMS.providers.appid string
configSMS.providers.shortcode string
configSMS.providers.appsecret string
configSMS.providers.passphrase string
configLIS object
configLIS.enabled boolean
configLIS.useSI boolean
configLIS.printLayout string Allowed values: tabular,compact
configLIS.showIndicatorsOnPrint boolean
configLIS.showRemarksOnPrint boolean
configLIS.orderTestsReportTargets string[]
configLIS.useSectionFixtures boolean
configLIS.customControlIdEnabled boolean
configLIS.customControlIdFormat string
configLIS.customControlIdDateFormat string
configLIS.customControlIdLength number
configLIS.customControlIdPaddingPosition string Allowed values: before,after
configLIS.customControlIdPaddingCharacter string
configRIS object
configRIS.enabled boolean
configRIS.useSectionFixtures boolean
configRIS.customControlIdEnabled boolean
configRIS.customControlIdFormat string
configRIS.customControlIdDateFormat string
configRIS.customControlIdLength number
configRIS.customControlIdPaddingPosition string Allowed values: before,after
configRIS.customControlIdPaddingCharacter string
configInventory object
configInventory.enabled boolean
configInventory.productCategories string[]
configInventory.productTypes string[]
configInventory.productBrands string[]
configInventory.stockAdjustmentReasons string[]
configInventory.stockRooms string[]
configInventory.unfulfilledSalesOrderExpiration number
configKiosk object
configKiosk.enabled boolean
configKiosk.enableQueueNoPrinting boolean
configKiosk.backgroundURL string
configKiosk.fields object
configKiosk.fieldsFollowUp object
configKiosk.marquee object
configKiosk.tags string[]
configKiosk.messages object[]
configKiosk.messages.id string
configKiosk.messages.language string
configKiosk.messages.text string
configKiosk.messages.title string
configKiosk.messages.acceptButtonText string
configKiosk.insuranceWorkflow boolean
configEMR object
configEMR.fieldsPatient object
configEMR.requiredRecords object[]
configEMR.requiredRecords.id string
configEMR.requiredRecords.type string
configEMR.requiredRecords.subtype string
configEMR.showOwnRecords boolean
configEMR.useAccountOwnedFormTemplates boolean
configFacility object
configFacility.dashboardDisplays object
configFacility.schedule object[]
configFacility.schedule.id string
configFacility.schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
configFacility.schedule.opening number

timestamp
configFacility.schedule.closing number

timestamp
configFacility.insuranceARTemplateDefault string
configFacility.printHeaderTemplate object
configFacility.cutoffTime number

timestamp hour format
configFacility.currency string
configFacility.currencySymbol string
configFacility.languages object
configInsurer object
configInsurer.insurer string
configInsurer.insurerName string
cutoffTime number

timestamp
warehouseEnabled boolean
queue_printNo boolean
queue_balancingModel string Allowed values: routing,dynamic
bl_discountTypes object
bl_discountTypes.code string
bl_discountTypes.name string
bl_discountTypes.application string Allowed values: billing-item,billing-invoice
bl_discountTypes.applicationSubtype string Allowed values: inventory-variant,service
bl_discountTypes.applicationRefs string[]
bl_discountTypes.amount number
bl_discountTypes.percentage number
bl_paymentMethods object
bl_paymentMethods.code string
bl_paymentMethods.type string
bl_paymentMethods.name string
bl_paymentMethods.description string
bl_defaultPaymentMethod string
bl_taxTypes object[]
bl_taxTypes.code string
bl_taxTypes.name string
bl_taxTypes.description string
bl_taxTypes.value number
bl_defaultSalesTax string
bl_defaultPurchaseTax string
bl_priceLists object[]
bl_priceLists.code string
bl_priceLists.name string
bl_priceLists.currency string Default value: PHP
bl_priceLists.sales boolean Default value: false
bl_defaultSalesPriceList string
bl_defaultPurchasePriceList string
wh_productCategories string[]
wh_productTypes stirng[]
wh_brands string[]
wh_stockAdjustmentReasons string[]
wh_unfulfilledSalesOrderExpiration number
mf_dashboardDisplays object
mf_patientFields object
mf_kioskBackgroundURL string
mf_kioskFields object
mf_kioskFollowUpFields object
mf_kioskMarquee object
mf_kioskTags string[]
mf_kioskMessages object[]
mf_kioskMessages.id string
mf_kioskMessages.language string
mf_kioskMessages.text string
mf_kioskMessages.title string
mf_kioskMessages.acceptButtonText string
mf_schedule object
mf_schedule.id string
mf_schedule.day string Allowed values: mon,tue,wed,thu,fri,sat,sun
mf_schedule.opening number

timestamp
mf_schedule.closing number

timestamp
mf_defaultTemplate_insuranceAR string
mf_printHeaderTemplate object
sms_configs object[]
sms_configs.appid stirng
sms_configs.shortcode stirng
sms_configs.appsecret stirng
sms_configs.passphrase stirng
ac_logoURL string
ac_backgroundURL string
ac_signatureURL string
diagnostic_useSI boolean

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "organization-id",
  "externalId": "hmo-custom-id",
  "type": "company",
  "name": "Medicard Partner Company",
  "overlords": [ "hmo-hq-random-id" ]
}

results matching ""

    No results matching ""