api-docs v5.116.0

API Docs

Table of contents

Billing_Item

Billing Item - Delete

Back to top

Delete a specific billing item. Can only delete non-finalized items.

DELETE /billing-items/: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>"
}

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
facility string
invoice string
invoiceType string
invoiceSubject string
invoiceCreatedAt string
refType string
refSubtype string
paid number
balance number
finalizedAt number

timestamp
finalizedBy string

account uid
confirmedAt number

timestamp
confirmedBy string

account uid
voidedAt number

timestamp
voidedBy string

account uid
voidReason string
returnedAt number

timestamp
returnedBy string

account uid
returnReason string
parent string
type string
forConfirmation boolean
ref string
providers string[]
name string
description string
quantity number
priceCurrency string
price number
commissions object[]
commissions.id string
commissions.commission string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.withholdingTax number
commissions.forCoveragePaymentType string
coverages object[]
coverages.contract string
coverages.insurer string
coverages.insurerType string
coverages.insurerSubtype string
coverages.name string
coverages.id string
coverages.paymentMethod string
coverages.type string
coverages.amount number
coverages.percentage number
coverages.approvalCode string
discounts object[]
discounts.id string
discounts.promo string

applied promo
discounts.code string

action-code code
discounts.name string
discounts.amount number

use either percentage or amount
discounts.percentage number

use either percentage or amount
amendment boolean
tax number
taxCode string
taxComplication string
taxExemption boolean
tags string[]
items object[]
items.ref string
items.name string
items.description string
items.quantity number
items.priceCurrency string
items.price number
payments object[]
actionCode string
stockRoom string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Billing Item - Find

Back to top

Get list of billing items

GET /billing-items

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/billing-items" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
billingItems object[]

array of billing item
billingItems.id string
billingItems.createdAt number

timestamp
billingItems.createdBy string

account uid
billingItems.facility string
billingItems.invoice string
billingItems.invoiceType string
billingItems.invoiceSubject string
billingItems.invoiceCreatedAt string
billingItems.refType string
billingItems.refSubtype string
billingItems.paid number
billingItems.balance number
billingItems.finalizedAt number

timestamp
billingItems.finalizedBy string

account uid
billingItems.confirmedAt number

timestamp
billingItems.confirmedBy string

account uid
billingItems.voidedAt number

timestamp
billingItems.voidedBy string

account uid
billingItems.voidReason string
billingItems.returnedAt number

timestamp
billingItems.returnedBy string

account uid
billingItems.returnReason string
billingItems.parent string
billingItems.type string
billingItems.forConfirmation boolean
billingItems.ref string
billingItems.providers string[]
billingItems.name string
billingItems.description string
billingItems.quantity number
billingItems.priceCurrency string
billingItems.price number
billingItems.commissions object[]
billingItems.commissions.id string

auto-generated id
billingItems.commissions.commission string
billingItems.commissions.type string
billingItems.commissions.subtype string
billingItems.commissions.providerType string
billingItems.commissions.provider string
billingItems.commissions.percentage number
billingItems.commissions.amount number
billingItems.commissions.withholdingTax number
billingItems.commissions.forCoveragePaymentType string
billingItems.coverages object[]
billingItems.coverages.contract string
billingItems.coverages.insurer string
billingItems.coverages.insurerType string
billingItems.coverages.insurerSubtype string
billingItems.coverages.name string
billingItems.coverages.id string

auto-generated id
billingItems.coverages.paymentMethod string
billingItems.coverages.type string
billingItems.coverages.amount number
billingItems.coverages.percentage number
billingItems.coverages.approvalCode string
billingItems.discounts object[]
billingItems.discounts.id string

auto-generated id
billingItems.discounts.promo string

applied promo
billingItems.discounts.code string

action-code code
billingItems.discounts.name string
billingItems.discounts.amount number

use either percentage or amount
billingItems.discounts.percentage number

use either percentage or amount
billingItems.amendment boolean
billingItems.tax number
billingItems.taxCode string
billingItems.taxComplication string
billingItems.taxExemption boolean
billingItems.tags string[]
billingItems.items object[]
billingItems.items.ref string
billingItems.items.name string
billingItems.items.description string
billingItems.items.quantity number
billingItems.items.priceCurrency string
billingItems.items.price number
billingItems.payments object[]
billingItems.actionCode string
billingItems.stockRoom string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "id-1",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "id-2",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Billing Item - Get

Back to top

Get a specific billing item

GET /billing-items/: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>"
}

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
facility string
invoice string
invoiceType string
invoiceSubject string
invoiceCreatedAt string
refType string
refSubtype string
paid number
balance number
finalizedAt number

timestamp
finalizedBy string

account uid
confirmedAt number

timestamp
confirmedBy string

account uid
voidedAt number

timestamp
voidedBy string

account uid
voidReason string
returnedAt number

timestamp
returnedBy string

account uid
returnReason string
parent string
type string
forConfirmation boolean
ref string
providers string[]
name string
description string
quantity number
priceCurrency string
price number
commissions object[]
commissions.id string
commissions.commission string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.withholdingTax number
commissions.forCoveragePaymentType string
coverages object[]
coverages.contract string
coverages.insurer string
coverages.insurerType string
coverages.insurerSubtype string
coverages.name string
coverages.id string
coverages.paymentMethod string
coverages.type string
coverages.amount number
coverages.percentage number
coverages.approvalCode string
discounts object[]
discounts.id string
discounts.promo string

applied promo
discounts.code string

action-code code
discounts.name string
discounts.amount number

use either percentage or amount
discounts.percentage number

use either percentage or amount
amendment boolean
tax number
taxCode string
taxComplication string
taxExemption boolean
tags string[]
items object[]
items.ref string
items.name string
items.description string
items.quantity number
items.priceCurrency string
items.price number
payments object[]
actionCode string
stockRoom string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Billing Item - Patch

Back to top

Update billing item

PATCH /billing-items/: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
createdAt number optional

timestamp

Default value: currentTime
refType string optional
refSubtype string optional
voidReason string optional
returnReason string optional
type string optional Allowed values: inventory-variant,service,action-code
forConfirmation boolean optional
ref string optional
providers string[] optional
name string optional
description string optional
quantity number optional
priceCurrency string optional
price number optional
commissions object[] optional
commissions.id string Default value: auto-generated-id
commissions.commission string
commissions.type string Allowed values: private,insured,company
commissions.subtype string Allowed values: hmo,government
commissions.providerType string Allowed values: doctor,facility
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.withholdingTax number
commissions.forCoveragePaymentType string Allowed values: prepaid,postpaid
coverages object[] optional
coverages.contract string
coverages.insurer string
coverages.insurerType string
coverages.insurerSubtype string
coverages.name string
coverages.id string Default value: auto-generated-id
coverages.paymentMethod string Allowed values: prepaid,postpaid
coverages.type string Allowed values: deduction,override,unknown
coverages.amount number
coverages.percentage number
coverages.approvalCode string
discounts object[] optional
discounts.id string Default value: auto-generated-id
discounts.promo string

applied promo
discounts.code string

action-code code
discounts.name string
discounts.amount number

use either percentage or amount
discounts.percentage number

use either percentage or amount
amendment boolean optional
tax number optional
taxCode string optional
taxComplication string optional
taxExemption boolean optional
tags string[] optional
items object[] optional
items.ref string
items.name string
items.description string
items.quantity number Default value: 1
items.priceCurrency string
items.price number Default value: 0
payments object[] optional
actionCode string optional
void boolean/number/string optional

operators
return boolean/number/string optional

operators
confirm boolean optional

operators
stockRoom string

Examples

Example usage:

curl "https://yourdomain.com/billing-items/<billing-item-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "void": true
  }'

Parameters examples

json - Request-Example

{
  "void": true
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
facility string
invoice string
invoiceType string
invoiceSubject string
invoiceCreatedAt string
refType string
refSubtype string
paid number
balance number
finalizedAt number

timestamp
finalizedBy string

account uid
confirmedAt number

timestamp
confirmedBy string

account uid
voidedAt number

timestamp
voidedBy string

account uid
voidReason string
returnedAt number

timestamp
returnedBy string

account uid
returnReason string
parent string
type string
forConfirmation boolean
ref string
providers string[]
name string
description string
quantity number
priceCurrency string
price number
commissions object[]
commissions.id string
commissions.commission string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.withholdingTax number
commissions.forCoveragePaymentType string
coverages object[]
coverages.contract string
coverages.insurer string
coverages.insurerType string
coverages.insurerSubtype string
coverages.name string
coverages.id string
coverages.paymentMethod string
coverages.type string
coverages.amount number
coverages.percentage number
coverages.approvalCode string
discounts object[]
discounts.id string
discounts.promo string

applied promo
discounts.code string

action-code code
discounts.name string
discounts.amount number

use either percentage or amount
discounts.percentage number

use either percentage or amount
amendment boolean
tax number
taxCode string
taxComplication string
taxExemption boolean
tags string[]
items object[]
items.ref string
items.name string
items.description string
items.quantity number
items.priceCurrency string
items.price number
payments object[]
actionCode string
stockRoom string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Billing Item - Post

Back to top

Create billing item

POST /billing-items

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
createdAt number optional

timestamp

Default value: currentTime
invoice string
refType string optional
refSubtype string optional
parent string optional
type string optional Allowed values: inventory-variant,service,action-code
forConfirmation boolean optional
ref string optional
providers string[] optional
name string optional
description string optional
quantity number optional
priceCurrency string optional
price number optional
commissions object[] optional
commissions.id string Default value: auto-generated-id
commissions.commission string
commissions.type string Allowed values: private,insured,company
commissions.subtype string Allowed values: hmo,government
commissions.providerType string Allowed values: doctor,facility
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.withholdingTax number
commissions.forCoveragePaymentType string Allowed values: prepaid,postpaid
coverages object[] optional
coverages.contract string
coverages.insurer string
coverages.insurerType string
coverages.insurerSubtype string
coverages.name string
coverages.id string Default value: auto-generated-id
coverages.paymentMethod string Allowed values: prepaid,postpaid
coverages.type string Allowed values: deduction,override,unknown
coverages.amount number
coverages.percentage number
coverages.approvalCode string
discounts object[] optional
discounts.id string Default value: auto-generated-id
discounts.promo string

applied promo
discounts.code string

action-code code
discounts.name string
discounts.amount number

use either percentage or amount
discounts.percentage number

use either percentage or amount
amendment boolean optional
tax number optional
taxCode string optional
taxComplication string optional
taxExemption boolean optional
tags string[] optional
items object[] optional
items.ref string
items.name string
items.description string
items.quantity number Default value: 1
items.priceCurrency string
items.price number Default value: 0
payments object[] optional
actionCode string optional
stockRoom string

Examples

Example usage:

curl "https://yourdomain.com/billing-items" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "invoice": "invoice-id",
    "createdAt": 1234567890
  }'

Parameters examples

json - Request-Example

{
  "invoice": "invoice-id",
  "createdAt": 1234567890
}

Success response

Success response - Success 200

Name Type Description
id string
createdAt number

timestamp
createdBy string

account uid
facility string
invoice string
invoiceType string
invoiceSubject string
invoiceCreatedAt string
refType string
refSubtype string
paid number
balance number
finalizedAt number

timestamp
finalizedBy string

account uid
confirmedAt number

timestamp
confirmedBy string

account uid
voidedAt number

timestamp
voidedBy string

account uid
voidReason string
returnedAt number

timestamp
returnedBy string

account uid
returnReason string
parent string
type string
forConfirmation boolean
ref string
providers string[]
name string
description string
quantity number
priceCurrency string
price number
commissions object[]
commissions.id string
commissions.commission string
commissions.type string
commissions.subtype string
commissions.providerType string
commissions.provider string
commissions.percentage number
commissions.amount number
commissions.withholdingTax number
commissions.forCoveragePaymentType string
coverages object[]
coverages.contract string
coverages.insurer string
coverages.insurerType string
coverages.insurerSubtype string
coverages.name string
coverages.id string
coverages.paymentMethod string
coverages.type string
coverages.amount number
coverages.percentage number
coverages.approvalCode string
discounts object[]
discounts.id string
discounts.promo string

applied promo
discounts.code string

action-code code
discounts.name string
discounts.amount number

use either percentage or amount
discounts.percentage number

use either percentage or amount
amendment boolean
tax number
taxCode string
taxComplication string
taxExemption boolean
tags string[]
items object[]
items.ref string
items.name string
items.description string
items.quantity number
items.priceCurrency string
items.price number
payments object[]
actionCode string
stockRoom string

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "id-1",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""