api-docs v5.116.0

API Docs

Table of contents

Inventory_Stock_Configuration

Stock Configuration - Find

Back to top

Get array of inventory stock configurations

GET /inventory-stock-configurations

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>"
}

Examples

Example usage:

curl "https://yourdomain.com/inventory-stock-configurations" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
inventoryStockConfigurations Object[]

array of inventory stock configuration
inventoryStockConfigurations.id string
inventoryStockConfigurations.organization string
inventoryStockConfigurations.warehouse string
inventoryStockConfigurations.product string
inventoryStockConfigurations.productType string
inventoryStockConfigurations.variant string
inventoryStockConfigurations.stockRoom string
inventoryStockConfigurations.variantName string
inventoryStockConfigurations.variantBarcode string
inventoryStockConfigurations.variantUnitCost number
inventoryStockConfigurations.variantUnitPrice number
inventoryStockConfigurations.variantExternalId string
inventoryStockConfigurations.variantSellable boolean
inventoryStockConfigurations.variantMedicine string
inventoryStockConfigurations.variantIsMedicineDangerous boolean
inventoryStockConfigurations.coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
inventoryStockConfigurations.commissions Object[]

applied as commission in billing
inventoryStockConfigurations.commissions.id string
inventoryStockConfigurations.commissions.type string
inventoryStockConfigurations.commissions.subtype string

for insured commission
inventoryStockConfigurations.commissions.providerType string
inventoryStockConfigurations.commissions.provider string

doctor uid or facility id
inventoryStockConfigurations.commissions.percentage number
inventoryStockConfigurations.commissions.amount number
inventoryStockConfigurations.commissions.forCoveragePaymentType string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "service-id",
    "organization": "some organization",
    "coverages": ["coverage 1", "coverage 2"]
  },
  {
    "id": "service-id",
    "organization": "some organization",
    "coverages": ["coverage 1", "coverage 2"]
  }
]

Stock Configuration - Get

Back to top

Get an inventory stock configuration's details

GET /inventory-stock-configurations/: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 inventory-stock-configuration

Examples

Example usage:

curl "https://yourdomain.com/inventory-stock-configurations/<inventory-stock-configuration-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
organization string
warehouse string
product string
productType string
variant string
stockRoom string
variantName string
variantBarcode string
variantUnitCost number
variantUnitPrice number
variantExternalId string
variantSellable boolean
variantMedicine string
variantIsMedicineDangerous boolean
coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions Object[]

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string

for insured commission
commissions.providerType string
commissions.provider string

doctor uid or facility id
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "organization": "some organization",
  "coverages": ["coverage 1", "coverage 2"]
}

Stock Configuration - Patch

Back to top

Update an inventory stock configuration

PATCH /inventory-stock-configurations/: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 inventory-stock-configuration
coverages string[] optional

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions Object[] optional

applied as commission in billing
commissions.id string
commissions.type string Allowed values: "private","insured","company"
commissions.subtype string

for insured commission

Allowed values: "hmo","government"
commissions.providerType string Allowed values: "doctor","facility"
commissions.provider string

doctor uid or facility id
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string Allowed values: "prepaid","postpaid"

Examples

Example usage:

curl "https://yourdomain.com/inventory-stock-configurations/<inventory-stock-configuration-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "coverages": ["updated", "coverages"]
  }'

Parameters examples

json - Request-Example

{
  "coverages": ["updated", "coverages"]
}

Success response

Success response - Success 200

Name Type Description
id string
organization string
warehouse string
product string
productType string
variant string
stockRoom string
variantName string
variantBarcode string
variantUnitCost number
variantUnitPrice number
variantExternalId string
variantSellable boolean
variantMedicine string
variantIsMedicineDangerous boolean
coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions Object[]

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string

for insured commission
commissions.providerType string
commissions.provider string

doctor uid or facility id
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "organization": "some organization",
  "coverages": ["coverage 1", "coverage 2"]
}

Stock Configuration - Post

Back to top

Create an inventory product

POST /inventory-stock-configurations

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
coverages string[] optional

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions Object[] optional

applied as commission in billing
commissions.id string
commissions.type string Allowed values: "private","insured","company"
commissions.subtype string

for insured commission

Allowed values: "hmo","government"
commissions.providerType string Allowed values: "doctor","facility"
commissions.provider string

doctor uid or facility id
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string Allowed values: "prepaid","postpaid"

Examples

Example usage:

curl "https://yourdomain.com/inventory-stock-configurations" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "id": "inventory stock configuration id",
    "coverages": ["cov 1", "cov 2"]
  }'

Parameters examples

json - Request-Example

{
  "id": "inventory stock configuration id",
  "coverages": ["cov 1", "cov 2"]
}

Success response

Success response - Success 200

Name Type Description
id string
organization string
warehouse string
product string
productType string
variant string
stockRoom string
variantName string
variantBarcode string
variantUnitCost number
variantUnitPrice number
variantExternalId string
variantSellable boolean
variantMedicine string
variantIsMedicineDangerous boolean
coverages string[]

saved to db only as insurance coverage ids applicable to this service. applied as payment in billing
commissions Object[]

applied as commission in billing
commissions.id string
commissions.type string
commissions.subtype string

for insured commission
commissions.providerType string
commissions.provider string

doctor uid or facility id
commissions.percentage number
commissions.amount number
commissions.forCoveragePaymentType string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "organization": "some organization",
  "coverages": ["coverage 1", "coverage 2"]
}

results matching ""

    No results matching ""