QBOS REST API documentation for BILLRUN

The BILLRUN API allows client applications to maintain BILLRUN data record sets.

Audience

This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.

Additional resources, information about this guide

Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us at: pkajaani@qbos.com. We appreciate your help.

Getting Started

To place any request in a QBOS API application from a third party application you need to first authenticate your user account and set/calculate values for the following request headers: x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth

Custom resource vs. standard resource URI format

Custom resource (a.k.a applet) URI contains the resource vendor id in place of "/o/" in the standard object URI. Compare: .../v1/o/...with .../v1/{vendor_id}/...

BILLRUN properties

Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.

Name	Type	Max Length	Numeric	Required For POST	Filterable	Computed Column	Default	Description
_client_Id	bigint		Yes				NULL	This is the Data Org Id.
_owner_Id	bigint		Yes		Yes		NULL	This is the user id of the record owner. Defaults to the creatorOpid.
_creator_Opid	bigint		Yes		Yes		NULL	This is the user id of the original record submitter.
_create_Date	datetime		No	{timestamp}				Not enterable upon Insert. System sets this date upon record creation.
status_id	int		Yes		Yes		2812	The status id of the record. Taken from the Life Cycle statuses in ADS.
_status_Change_Date	datetime		No				NULL	Not enterable. System sets this date whenever the statusid is changed.
Billing_Run_Description	nvarchar	1000		Yes	Yes		Immediate Cycle
Bill_Period_Start_Date	datetime			Yes	Yes
Bill_Period_End_Date	datetime			Yes	Yes
Include_Patients	integer		Yes	Yes	Yes		5	This property is populated by a Type 2 Value List. Click here for the appropriate API and sample of value options for this column.
Patient_Chart_Id	integer		Yes		Yes		NULL
_Submitted_by	nvarchar	20			Yes	Yes	=SubmitterOpId
Notes	nvarchar(MAX)				Yes		NULL
Run_Billing	bit		Yes		Yes		0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Prepare_Billing_Data	bit		Yes		Yes		0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Delete_All_Claim_Items	bit		Yes		Yes		0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
ISA_Segment_ID	bigint		Yes		Yes		NULL
Release_Patients_onto_regular_Bill_status	bit		Yes		Yes		NULL	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Log_Message	nvarchar	120			Yes		NULL
Benefit_SW	integer		Yes		Yes		0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Generate_RNB_Approval	bit		Yes		Yes		0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Generate_AP	bit		Yes		Yes		0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
uiShowBillCycle	bit		Yes		Yes		1	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Last_process_start_date	datetime				Yes		NULL
Last_process_end_date	datetime				Yes		NULL
Run_Status	integer		Yes		Yes		2	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Bill_Run_Type	nvarchar	1			Yes		I	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Close_SW	bit		Yes		Yes		0	This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column.
Batch_Bill_Run_Id	bigint		Yes		Yes		NULL
Patient_Chart_Id_List	nvarchar(MAX)				Yes		NULL
Pri_Sec_Ter_Ind	integer		Yes	Yes	Yes		1	This property is populated by a Type 2 Value List. Click here for the appropriate API and sample of value options for this column.
PB_Number_of_Patients	integer		Yes		Yes		NULL
PB_Number_of_Claims	integer		Yes		Yes		NULL
PB_Revenue	money		Yes		Yes		NULL
B_Number_of_Patients	integer		Yes		Yes		NULL
B_Number_of_Claims	integer		Yes		Yes		NULL
B_Billed_Revenue	money		Yes		Yes		NULL
EPS_Post_AR_Job_Batch_Id	bigint		Yes		No		NULL
Post_AR_Date	datetime				Yes		NULL

BILLRUN Relationships

Parent and Child relations to BILLRUN.

Note that the only Required status on relationships that affect a POST of an object are on the parent relations. A Required status on a child relation is only meaningful when POSTing the child object.

Linking during POST: a custom object record can be linked to a parent or child record (custom or standard) during POST by including (in the payload) the realtion id paired with the parent or child object record being linked to. For example: { "REl_2064" : 1832 } Multiple links may be created in the same POST.

Relation Id	Cardinality (Parent-to-Child)	Required For POST	Links Up To	Is Unary?^*
REL_2172	1-Many	Yes	Billing_Management_Panel	Yes
REL_3173	1-Many		Payer_Settings
REL_2174	1-Many		Payor_Settings
Parent Relations ↑ BILLRUN ↓ Child Relations
Relation Id	Cardinality (Parent-to-Child)	Required **on POST of child	Links Down To
REL_2064	1-Many		Invoice
REL_1969	1-Many	Yes**	Claim_Cycle
REL_2053	1-Many	Yes**	Nursing_Home_R&B_Payable_Approval
REL_1782	1-Many	Yes**	Claim_Items

SHORTCUT TIP! (read Is Unary?...)
* Is Unary? == means that there will only be one record per corporation. When POSTing a BILLRUN record under a unary record, you do not need to retrieve the unary record id, first. Use a -1 to indicate the unary record id as in "REL_2172":"-1" and the POST will determine the appropriate parent record id to link the BILLRUN to.

Read BILLRUN by id:

GET https:/.../v1/517090/BILLRUN/{id}

Response codes:

200 - OK
404 - Not found or user does not have permission to access resources of this type.
400 - Client error
500 - Server error

Response data: GET https:/.../v1/517090/BILLRUN/1

Unauthorized request.

Read BILLRUN by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/BILLRUN[?{filter}]

Response codes:

400 - Client error
500 - Server error
404 - Not found or user does not have permission to access resources of this type.
200 - OK

Response data: GET https:/.../v1/517090/2172/1/links/BILLRUN

Unauthorized request.

Read BILLRUN by filter:

GET https:/.../v1/517090/BILLRUN[?{filter}]

Response codes:

200 - OK
400 - Client error
404 - Not found or user does not have permission to access resources of this type.
500 - Server error

Response data: GET https:/.../v1/517090/BILLRUN?id=1

Unauthorized request.

Create BILLRUN:

POST https:/.../v1/517090/BILLRUN

Request data [See properties]:

Response codes:

201 - OK [See response data]
400 - Client error
500 - Server error

Update BILLRUN:

PUT https:/.../v1/517090/BILLRUN/{id}

Request data [See properties]:

Response codes:

200 - OK Content returned [See response data]
204 - OK No content
400 - Client error
404 - Not found
500 - Server error

Delete BILLRUN:

DELETE https:/.../v1/517090/BILLRUN/{id}

The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

Create Link for BILLRUN:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/BILLRUN/{id}

{relation_id} can indicate either a parent or a child relation.

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

Delete Link for BILLRUN:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/BILLRUN/{id}

Deleting a link from BILLRUN down to a child object must be explicitly indicated by negating the relation id:

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/BILLRUN/{id}

Response codes:

204 - OK
400 - Client error
404 - Not found
500 - Server error

QBOS REST API documentation (BILLRUN)

Introduction

Audience

Additional resources, information about this guide

Getting Started

Custom resource vs. standard resource URI format

BILLRUN properties

BILLRUN Relationships

Read BILLRUN by id:

GET https:/.../v1/517090/BILLRUN/{id}

Read BILLRUN by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/BILLRUN[?{filter}]

Read BILLRUN by filter:

GET https:/.../v1/517090/BILLRUN[?{filter}]

Create BILLRUN:

POST https:/.../v1/517090/BILLRUN

Update BILLRUN:

PUT https:/.../v1/517090/BILLRUN/{id}

Delete BILLRUN:

DELETE https:/.../v1/517090/BILLRUN/{id}

Create Link for BILLRUN:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/BILLRUN/{id}

Delete Link for BILLRUN:

DELETE https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/BILLRUN/{id}

DELETE https:/.../v1/517090/{-child_relation_id}/{child_id}/links/BILLRUN/{id}