x QBOS REST API documentation for PAYERSETTINGS

QBOS REST API documentation (PAYERSETTINGS)

(return to Main Document)

Introduction

The PAYERSETTINGS API allows client applications to maintain PAYERSETTINGS 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

See details in Authentication Documentation.

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}/...

PAYERSETTINGS 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 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 5783 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.
Payer_Type nvarchar 50 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
Payer_Type_Code nvarchar 50 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
Payer_Name nvarchar 50 Yes NULL
Hospice_Provider_ID nvarchar 35 Yes NULL
Benefit_Type nvarchar 20 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
Allow_Faxed_Claims 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.
Allow_Immediate_Claim_Cycle 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.
Signature_Required 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.
Signature nvarchar 50 Yes NULL
Payment_Method nvarchar 20 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
Billing_Frequency nvarchar 20 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
Recertification_Interval nvarchar 20 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
Bill_Day_Death 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.
Bill_Day_Discharge 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.
Recertification_Required 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.
Physician_Order_Required 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.
Continuous_Care_Billing_Increments nvarchar 20 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
Invoice_Breakdown nvarchar 20 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.
Claim_Form nvarchar 20 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.
Claim_Submission_Format nvarchar 20 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.
Print_Paper 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.
Claim_Print_Format nvarchar 20 Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
EDI_Payer_Code nvarchar 30 Yes NULL
EDI_Payer_Name nvarchar 30 Yes NULL
EDI_Provider_Code nvarchar 30 Yes NULL
ERA_ID nvarchar 30 Yes NULL
Claim_Non_Billable_Required 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.
Claim_Other_Payers_Required 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.
Signature_Box_Checked 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.
Active_Payer 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.
Codes integer Yes Yes NULL This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.
G_Codes 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.
CPT_Codes 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.
Initial_FF_Period integer Yes Yes NULL
NOE_Required 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.
NOTR_Required 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.
Face_Required 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.
Bill_Meds 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.
Bill_Visits 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.
Signature_Date datetime Yes NULL
Payer_Complete 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.
RB_Revenue_Code nvarchar 10 Yes NULL
RB_Bill_Rate integer 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.
To_Provider_Name nvarchar 70 Yes NULL
To_Provider_Address1 nvarchar 70 Yes NULL
To_Provider_Address2 nvarchar 70 Yes NULL
To_Provider_City nvarchar 70 Yes NULL
To_Provider_State nvarchar 2 Yes NULL
To_Provider_Zip nvarchar 10 Yes NULL
To_Provider_Service_Location_ID nvarchar 14 Yes NULL
To_Provider_Phone_Number nvarchar 20 Yes NULL
To_Provider_EIN nvarchar 20 Yes NULL
Care_Type nvarchar 20 Yes Hospice This property is populated by a Type 2 Value List.
Click here for the appropriate API and sample of value options for this column.

PAYERSETTINGS Relationships

Parent and Child relations to PAYERSETTINGS.

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_3175" : 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_3172 1-1 Yes Contact
Parent Relations

PAYERSETTINGS

Child Relations
Relation Id Cardinality
(Parent-to-Child)
Required
**on POST of child
Links Down To  
REL_3175 1-1 Yes** Medicare_Payer_Settings  
REL_3176 1-1 Yes** Medicaid_Payer_Settings  
REL_3177 1-1 Yes** Commercial_Payer_Settings  
REL_3178 1-1 Yes** Room_and_Board_Settings  
REL_3174 1-Many Yes** Payer_Contact  
REL_3189 1-Many Yes** Service_Rates  
REL_3226 1-1 Yes** Self_and_Unfunded_Payer_Settings  
REL_3192 1-1 Yes** Self_and_Unfunded_Payer_Settings  
REL_3197 1-1 Yes** CMS_Settings  
REL_3198 1-1 Yes** UB_Settings  
REL_3200 1-Many Yes** General_Ledger_Location_Codes  
REL_3201 1-Many Yes** General_Ledger_Visit_Codes  
REL_3202 1-Many Yes** General_Ledger_Service_Codes  
REL_3203 1-Many Yes** Visit_Rates  
REL_3224 1-Many Yes** Medicaid_Rates  
REL_3173 1-Many Billing_Runs  
 



Read PAYERSETTINGS by id:

GET https:/.../v1/517090/PAYERSETTINGS/{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/PAYERSETTINGS/2
Unauthorized request.

Read PAYERSETTINGS by parent id:

GET https:/.../v1/517090/{parent_relation_id}/{parent_id}/links/PAYERSETTINGS[?{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/3172/530944/links/PAYERSETTINGS
Unauthorized request.

Read PAYERSETTINGS by filter:

GET https:/.../v1/517090/PAYERSETTINGS[?{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/PAYERSETTINGS?id=2
Unauthorized request.

Create PAYERSETTINGS:

POST https:/.../v1/517090/PAYERSETTINGS

Request data [See properties]:

Response codes:

Update PAYERSETTINGS:

PUT https:/.../v1/517090/PAYERSETTINGS/{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 PAYERSETTINGS:

DELETE https:/.../v1/517090/PAYERSETTINGS/{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 PAYERSETTINGS:

POST https:/.../v1/517090/{relation_id}/{link_to_id}/links/PAYERSETTINGS/{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 PAYERSETTINGS:

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


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

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

Response codes:

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