State Interest

Create StateInterest

Creates a new StateInterest

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
stateInterest_Key
required
integer <int32>

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.

acH_Interest_Pct
number or null <double>

Value for interest to five decimal places, used in EDI/ACH interest calculations.

acH_No_Interest_Within
string or null <= 20 characters

User selection to control a window for interest to be avoided in EDI/ACH calculations.

calc_Interest_ACH_Business_Days
required
boolean

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.

calc_Interest_ACH_Prompt_Pay_Freq
integer or null <int32>

Value for the (lower bound on StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.

calc_Interest_ACH_Prompt_Pay_Freq_Thru
integer or null <int32>

Value for the upper bound (StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.

calc_Interest_ACH_Prompt_Pay_Type
string or null <= 1 characters

Defines the unit for the prompt pay range in EDI/ACH calculations. D = Days, M = Months, Y = Years.

calc_Interest_Business_Days
required
boolean

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.

calc_Interest_Prompt_Pay_Freq
integer or null <int32>

Value for the (lower bound on StateInterest entries only) for Prompt Pay range in Manual/Default calculations.

calc_Interest_Prompt_Pay_Freq_Thru
integer or null <int32>

Value for the upper bound (StateInterest entries only) for Prompt Pay range in Manual/Default calculations.

calc_Interest_Prompt_Pay_Type
string or null <= 1 characters

Defines the unit for the prompt pay range in Manual/Default calculations. D = Days, M = Months, Y = Years.

compound_ACH_Interest
required
boolean

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.

compound_Interest
required
boolean

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.

effective_Date
string or null <date-time>

Date the interest rate becomes effective

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

interest_Pct
number or null <double>

Interest rate that applies in the specified state

no_Interest_Within
string or null <= 20 characters

Option to indicate no interest should be applied within the selected timeframe

state
required
string [ 1 .. 2 ] characters

Two letter abbeviation for the state

term_Date
string or null <date-time>

Date the interest rate terminates

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/state-interests
Request samples
{
  • "stateInterest_Key": 0,
  • "acH_Interest_Pct": 0.1,
  • "acH_No_Interest_Within": "string",
  • "calc_Interest_ACH_Business_Days": true,
  • "calc_Interest_ACH_Prompt_Pay_Freq": 0,
  • "calc_Interest_ACH_Prompt_Pay_Freq_Thru": 0,
  • "calc_Interest_ACH_Prompt_Pay_Type": "s",
  • "calc_Interest_Business_Days": true,
  • "calc_Interest_Prompt_Pay_Freq": 0,
  • "calc_Interest_Prompt_Pay_Freq_Thru": 0,
  • "calc_Interest_Prompt_Pay_Type": "s",
  • "compound_ACH_Interest": true,
  • "compound_Interest": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "interest_Pct": 0.1,
  • "no_Interest_Within": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List StateInterest

Lists all StateInterest

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

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.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/state-interests
Request samples 
Response samples 
No sample
Get StateInterest
Gets StateInterest


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
stateInterestKey
required
integer <int32> 
StateInterest Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/state-interests/{stateInterestKey}
Request samples 
Response samples 
No sample
Update StateInterest
Updates a specific StateInterest.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
stateInterestKey
required
integer <int32> 
StateInterest Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
stateInterest_Key
required
integer <int32> 
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.


 
acH_Interest_Pct
number or null <double> 
Value for interest to five decimal places, used in EDI/ACH interest calculations.


 
acH_No_Interest_Within
string or null  <= 20 characters 
User selection to control a window for interest to be avoided in EDI/ACH calculations.


 
calc_Interest_ACH_Business_Days
required
boolean
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.


 
calc_Interest_ACH_Prompt_Pay_Freq
integer or null <int32> 
Value for the (lower bound on StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.


 
calc_Interest_ACH_Prompt_Pay_Freq_Thru
integer or null <int32> 
Value for the upper bound (StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.


 
calc_Interest_ACH_Prompt_Pay_Type
string or null  <= 1 characters 
Defines the unit for the prompt pay range in EDI/ACH calculations. D = Days, M = Months, Y = Years.


 
calc_Interest_Business_Days
required
boolean
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.


 
calc_Interest_Prompt_Pay_Freq
integer or null <int32> 
Value for the (lower bound on StateInterest entries only) for Prompt Pay range in Manual/Default calculations.


 
calc_Interest_Prompt_Pay_Freq_Thru
integer or null <int32> 
Value for the upper bound (StateInterest entries only) for Prompt Pay range in Manual/Default calculations.


 
calc_Interest_Prompt_Pay_Type
string or null  <= 1 characters 
Defines the unit for the prompt pay range in Manual/Default calculations. D = Days, M = Months, Y = Years.


 
compound_ACH_Interest
required
boolean
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.


 
compound_Interest
required
boolean
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.


 
effective_Date
string or null <date-time> 
Date the interest rate becomes effective


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
interest_Pct
number or null <double> 
Interest rate that applies in the specified state


 
no_Interest_Within
string or null  <= 20 characters 
Option to indicate no interest should be applied within the selected timeframe


 
state
required
string  [ 1 .. 2 ] characters 
Two letter abbeviation for the state


 
term_Date
string or null <date-time> 
Date the interest rate terminates


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/state-interests/{stateInterestKey}
Request samples 
{
  • "stateInterest_Key": 0,
  • "acH_Interest_Pct": 0.1,
  • "acH_No_Interest_Within": "string",
  • "calc_Interest_ACH_Business_Days": true,
  • "calc_Interest_ACH_Prompt_Pay_Freq": 0,
  • "calc_Interest_ACH_Prompt_Pay_Freq_Thru": 0,
  • "calc_Interest_ACH_Prompt_Pay_Type": "s",
  • "calc_Interest_Business_Days": true,
  • "calc_Interest_Prompt_Pay_Freq": 0,
  • "calc_Interest_Prompt_Pay_Freq_Thru": 0,
  • "calc_Interest_Prompt_Pay_Type": "s",
  • "compound_ACH_Interest": true,
  • "compound_Interest": true,
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "interest_Pct": 0.1,
  • "no_Interest_Within": "string",
  • "state": "st",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete StateInterest
Deletes an StateInterest


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
stateInterestKey
required
integer <int32> 
StateInterest Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/state-interests/{stateInterestKey}
Request samples 
Create or Update Batch StateInterest
Create or Update multiple StateInterest at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
stateInterest_Key
required
integer <int32> 
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.


 
acH_Interest_Pct
number or null <double> 
Value for interest to five decimal places, used in EDI/ACH interest calculations.


 
acH_No_Interest_Within
string or null  <= 20 characters 
User selection to control a window for interest to be avoided in EDI/ACH calculations.


 
calc_Interest_ACH_Business_Days
required
boolean
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.


 
calc_Interest_ACH_Prompt_Pay_Freq
integer or null <int32> 
Value for the (lower bound on StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.


 
calc_Interest_ACH_Prompt_Pay_Freq_Thru
integer or null <int32> 
Value for the upper bound (StateInterest entries only) for Prompt Pay range in EDI/ACH calculations.


 
calc_Interest_ACH_Prompt_Pay_Type
string or null  <= 1 characters 
Defines the unit for the prompt pay range in EDI/ACH calculations. D = Days, M = Months, Y = Years.


 
calc_Interest_Business_Days
required
boolean
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.


 
calc_Interest_Prompt_Pay_Freq
integer or null <int32> 
Value for the (lower bound on StateInterest entries only) for Prompt Pay range in Manual/Default calculations.


 
calc_Interest_Prompt_Pay_Freq_Thru
integer or null <int32> 
Value for the upper bound (StateInterest entries only) for Prompt Pay range in Manual/Default calculations.


 
calc_Interest_Prompt_Pay_Type
string or null  <= 1 characters 
Defines the unit for the prompt pay range in Manual/Default calculations. D = Days, M = Months, Y = Years.


 
compound_ACH_Interest
required
boolean
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.


 
compound_Interest
required
boolean
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.


 
effective_Date
string or null <date-time> 
Date the interest rate becomes effective


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
interest_Pct
number or null <double> 
Interest rate that applies in the specified state


 
no_Interest_Within
string or null  <= 20 characters 
Option to indicate no interest should be applied within the selected timeframe


 
state
required
string  [ 1 .. 2 ] characters 
Two letter abbeviation for the state


 
term_Date
string or null <date-time> 
Date the interest rate terminates


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


put/state-interests-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}