# Get StateInterest

Gets StateInterest

Endpoint: GET /state-interests/{stateInterestKey}
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Path parameters:

  - `stateInterestKey` (integer, required)
    StateInterest Key

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.stateInterest_Key` (integer, required)
    Kev value identifying a specific state interest rate Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.acH_Interest_Pct` (number,null)
    Value for interest to five decimal places, used in EDI/ACH interest calculations.

  - `data.acH_No_Interest_Within` (string,null)
    User selection to control a window for interest to be avoided in EDI/ACH calculations.

  - `data.calc_Interest_ACH_Business_Days` (boolean, required)
    Flag to control force only business days on the calendar to be used in EDI/ACH interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.calc_Interest_ACH_Prompt_Pay_Freq` (integer,null)
    Value for the (lower bound on StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.

  - `data.calc_Interest_ACH_Prompt_Pay_Freq_Thru` (integer,null)
    Value for the upper bound (StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.

  - `data.calc_Interest_ACH_Prompt_Pay_Type` (string,null)
    Defines the unit for the prompt pay range in EDI/ACH calculations. D = Days, M = Months, Y = Years.

  - `data.calc_Interest_Business_Days` (boolean, required)
    Flag to control force only business days on the calendar to be used in Manual/Default interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.calc_Interest_Prompt_Pay_Freq` (integer,null)
    Value for the (lower bound on StateInterest entries only) for Prompt Pay range in Manual/Default calculations.

  - `data.calc_Interest_Prompt_Pay_Freq_Thru` (integer,null)
    Value for the upper bound (StateInterest entries only) for Prompt Pay range in Manual/Default calculations.

  - `data.calc_Interest_Prompt_Pay_Type` (string,null)
    Defines the unit for the prompt pay range in Manual/Default calculations. D = Days, M = Months, Y = Years.

  - `data.compound_ACH_Interest` (boolean, required)
    Flag to control if/how interest is compounded in EDI/ACH interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.compound_Interest` (boolean, required)
    Flag to control if/how interest is compounded in Manual/Default interest calculations. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.effective_Date` (string,null)
    Date the interest rate becomes effective

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

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

  - `data.interest_Pct` (number,null)
    Interest rate that applies in the specified state

  - `data.no_Interest_Within` (string,null)
    Option to indicate no interest should be applied within the selected timeframe

  - `data.state` (string, required)
    Two letter abbeviation for the state

  - `data.term_Date` (string,null)
    Date the interest rate terminates

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

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

  - `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