api-docs v5.116.0

API Docs

Table of contents

Billing_Invoice

Billing Invoice - Delete

Back to top

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

DELETE /billing-invoices/: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-invoices/<billing-invoice-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string

encounter id for medical billing
createdAt number

timestamp
createdBy string

account uid
facility string
type string
subject string
subjectType string
subjectTags string[]
or string
taxComplication string

inclusive, exclusive
finalizedAt number

timestamp
finalizedBy string

account uid
notes string
coverageTypes string[]
discounts object[]
paid number

[VIRTUAL]
balance number

[VIRTUAL]
status string

[VIRTUAL] paid, unpaid
tags string[]

Success response example

Success response example - Success-Response:

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

Billing Invoice - Find

Back to top

Get list of billing invoices

GET /billing-invoices

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

Success response

Success response - Success 200

Name Type Description
billingInvoices[] object[]

array of billingInvoice
billingInvoices.id string

encounter id for medical billing
billingInvoices.createdAt number

timestamp
billingInvoices.createdBy string

account uid
billingInvoices.facility string
billingInvoices.type string

types
billingInvoices.subject string
billingInvoices.subjectType string
billingInvoices.subjectTags string[]
billingInvoices.or string
billingInvoices.taxComplication string

inclusive, exclusive
billingInvoices.finalizedAt number

timestamp
billingInvoices.finalizedBy string

account uid
billingInvoices.notes string
billingInvoices.coverageTypes string[]
billingInvoices.discounts object[]
billingInvoices.paid number

[VIRTUAL]
billingInvoices.balance number

[VIRTUAL]
billingInvoices.status string

[VIRTUAL] paid, unpaid
billingInvoices.tags 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 Invoice - Get

Back to top

Get a specific billing invoice

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

Success response

Success response - Success 200

Name Type Description
id string

encounter id for medical billing
createdAt number

timestamp
createdBy string

account uid
facility string
type string
subject string
subjectType string
subjectTags string[]
or string
taxComplication string

inclusive, exclusive
finalizedAt number

timestamp
finalizedBy string

account uid
notes string
coverageTypes string[]
discounts object[]
paid number

[VIRTUAL]
balance number

[VIRTUAL]
status string

[VIRTUAL] paid, unpaid
tags string[]

Success response example

Success response example - Success-Response:

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

Billing Invoice - Patch

Back to top

Update billing invoice

PATCH /billing-invoices/: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
subject string optional
subjectType string optional
subjectTags string[] optional
or string optional
taxComplication string optional Allowed values: inclusive,exclusive
notes string optional
discounts object[] optional Default value: emptyArray
discounts.id string Default value: auto-generated-id
discounts.promo string

applied promo code
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
finalizedAt number optional

timestamp
finalizedBy string optional

account uid
createdAt number optional

timestamp
tags string[] optional
actionCode string optional
finalize number/boolean optional

timestamp if number

Examples

Example usage:

curl "https://yourdomain.com/billing-invoices/<billing-invoice-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "subject": "some subject"
  }'

Parameters examples

json - Request-Example

{
  "subject": "some subject"
}

Success response

Success response - Success 200

Name Type Description
id string

encounter id for medical billing
createdAt number

timestamp
createdBy string

account uid
facility string
type string
subject string
subjectType string
subjectTags string[]
or string
taxComplication string

inclusive, exclusive
finalizedAt number

timestamp
finalizedBy string

account uid
notes string
coverageTypes string[]
discounts object[]
paid number

[VIRTUAL]
balance number

[VIRTUAL]
status string

[VIRTUAL] paid, unpaid
tags string[]

Success response example

Success response example - Success-Response:

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

Billing Invoice - Post

Back to top

Create billing invoice

POST /billing-invoices

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 optional

encounter id for medical billing
facility string
type string optional Allowed values: medical-encounter,inventory-transaction
subject string optional
subjectType string optional
subjectTags string[] optional
or string optional
taxComplication string optional Allowed values: inclusive,exclusive
notes string optional
discounts object[] optional Default value: emptyArray
discounts.id string Default value: auto-generated-id
discounts.promo string

applied promo code
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
finalizedAt number optional

timestamp
finalizedBy string optional

account uid
createdAt number optional

timestamp

Default value: currentTime
tags string[] optional
items object[] optional

BillingItem object
actionCode string optional

Examples

Example usage:

curl "https://yourdomain.com/billing-invoices" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "facility": "facility-id",
    "type": "medical-encounter"
  }'

Parameters examples

json - Request-Example

{
  "facility": "facility-id",
  "type": "medical-encounter"
}

Success response

Success response - Success 200

Name Type Description
id string

encounter id for medical billing
createdAt number

timestamp
createdBy string

account uid
facility string
type string
subject string
subjectType string
subjectTags string[]
or string
taxComplication string

inclusive, exclusive
finalizedAt number

timestamp
finalizedBy string

account uid
notes string
coverageTypes string[]
discounts object[]
paid number

[VIRTUAL]
balance number

[VIRTUAL]
status string

[VIRTUAL] paid, unpaid
tags 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 ""