# List ClaimCustomExCodeRule

Lists all ClaimCustomExCodeRule

Endpoint: GET /claim-custom-ex-code-rules
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Query parameters:

  - `page` (integer)
    Page

  - `pageSize` (integer)
    Page Size

  - `sortBy` (string)
    Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.claimCustomExCodeRule_Key` (integer, required)
    Unique identifier for each custom Ex Code rule. This takes the combination of fields on this table and, if a claim fits in the configuration, assigns an ex code. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.benefit_Code` (string,null)
    Benefit code associated with the selected custom ExCode rule.

  - `data.claim_Type` (string,null)
    The Claim Type for this Custom Ex Code rule.

  - `data.date_Type` (string,null)
    The Date Type (service date, received date, etc.) to use in combination with effective dates to deterine if this rule applies.

  - `data.detail_Amount` (number,null)
    The amount you want this edit to compare against.  For example, if you wanted to apply a custom ex code for any claim with a Co Insurance greater than $50, you would set Detail_Amount_Field = "co_ins_amt", set the Detail_Amount_Field_Operator to ">", then set the Detail_Amount field to 50.00.

  - `data.detail_Amount_Field` (string,null)
    The detail amount field drives the logic for what the Field Operator and Amount are compared against on the Service line:            payable_amount: The amount payable based on rules applied (Allowed - (copay, coins, deductible, not covered, etc.).            billed_price: The amount billed, represented by the Billed_Price field.            plan_price: The price associated with the plan, represented by the Plan_Price field.            deductible_amt: The deductible amount, represented by the Deductible_Amt field.            co_pay_amt: The co-payment amount, represented by the Co_Pay_Amt field.            co_ins_amt: The co-insurance amount, represented by the Co_Ins_Amt field.            cob_amt: The coordination of benefits amount, represented by the COB_Amt field.            cob_hold: The coordination of benefits hold amount, represented by the COB_Hold field.            cob_mem_resp: The coordination of benefits member responsibility, represented by the COB_Mem_Resp field.            mem_resp: The total member responsibility, calculated as the sum of Co_Ins_Amt, Co_Pay_Amt, and Deductible_Amt.

  - `data.detail_Amount_Field_Operator` (string,null)
    Simple operator (Greater than, less than, or equal).  This compares the value identified in Detail_Amount_Field against the value in the Detail_Amount field based on this opeator.

  - `data.division_ID` (string,null)
    The Division ID for this Custom Ex Code rule.

  - `data.effective_Date` (string,null)
    Effective Date for this Custom Ex Code rule.

  - `data.entry_Date` (string)
    Date when the record was first added to the system.

  - `data.entry_User` (string,null)
    User that first added the record to the system.

  - `data.ex_Code` (string,null)
    The Ex Code that is applied if the identified criteria matched a claim during adjudication.

  - `data.federal_ID` (string,null)
    The Tax ID for this Custom Ex Code rule.

  - `data.from_Diag_Code` (string,null)
    The Diagnosis Range for this Custom Ex Code rule.

  - `data.from_Procedure` (string,null)
    The Procedure Range for this Custom Ex Code rule.

  - `data.group_ID` (string,null)
    The Group ID for this Custom Ex Code rule.

  - `data.member_Seq` (string,null)
    The Member Sequence for this Custom Ex Code rule.

  - `data.network_Option` (string,null)
    Option that allows custom claim rules to be applied in network, out of network or in all cases

  - `data.plan_ID` (string,null)
    The Plan ID for this Custom Ex Code rule.

  - `data.provider_ID` (string,null)
    The Provider ID for this Custom Ex Code rule.

  - `data.subscriber_ID` (string,null)
    The Subscriber ID for this Custom Ex Code rule.

  - `data.term_Date` (string,null)
    Term Date for this Custom Ex Code rule.

  - `data.thru_Diag_Code` (string,null)
    The Diagnosis Range for this Custom Ex Code rule.

  - `data.thru_Procedure` (string,null)
    The Procedure Range for this Custom Ex Code rule.

  - `data.update_Date` (string)
    Date when the record was last updated in the system.

  - `data.update_User` (string,null)
    User that last updated the record in the system.

  - `data.use_Detail_Ex_Code` (boolean, required)
    Indicates that this Custom Ex Code rule is going to apply the resulting Ex Code to the Service Line rather than the header.  This assumes the use of Benefit_Code and the Detail_Amount fields. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields