States

Create State

Creates a new State

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
state_Abbrev
required
string [ 1 .. 2 ] characters

Two letter abbeviation for the state

all_States
string or null <= 1 characters

Flag indicating the identifier refers to all states

apply_State_Tax
required
boolean

Flag indicating if state tax should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.

calc_Interest_ACH_Business_Days
required
boolean

Flag indicating if ACH/EDI prompt pay frequency is based on business days 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>

Number of units used for ACH/EDI prompt pay frequency

calc_Interest_ACH_Prompt_Pay_Type
string or null <= 1 characters

Units used for ACH/EDI prompt pay frequency, either days, months or years

calc_Interest_Business_Days
required
boolean

Flag indicating if manual prompt pay frequency is based on business days 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>

Number of units used for manual prompt pay frequency

calc_Interest_Prompt_Pay_Type
string or null <= 1 characters

Units used for manual prompt pay frequency, either days, months or years

default_Percentage_Election
required
number <double>

Amount of the default percentage election that should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

state_Name
string or null <= 25 characters

Full name of the state

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

use_Percentage_Election
required
boolean

Flag indicating if the default percentage election should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.

use_StateInterest_Settings
required
boolean

Flag to control whether to use the State Interest entries for a specific state instead of State Details. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/states
Request samples
{
  • "state_Abbrev": "st",
  • "all_States": "s",
  • "apply_State_Tax": true,
  • "calc_Interest_ACH_Business_Days": true,
  • "calc_Interest_ACH_Prompt_Pay_Freq": 0,
  • "calc_Interest_ACH_Prompt_Pay_Type": "s",
  • "calc_Interest_Business_Days": true,
  • "calc_Interest_Prompt_Pay_Freq": 0,
  • "calc_Interest_Prompt_Pay_Type": "s",
  • "default_Percentage_Election": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "state_Name": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Percentage_Election": true,
  • "use_StateInterest_Settings": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List State

Lists all State given a specific

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/states
Request samples 
Response samples 
No sample
Get State
Gets State


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
stateAbbrev
required
string
State Abbreviation


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/states/{stateAbbrev}
Request samples 
Response samples 
No sample
Update State
Updates a specific State.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
stateAbbrev
required
string
State Abbreviation


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
state_Abbrev
required
string  [ 1 .. 2 ] characters 
Two letter abbeviation for the state


 
all_States
string or null  <= 1 characters 
Flag indicating the identifier refers to all states


 
apply_State_Tax
required
boolean
Flag indicating if state tax should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH_Business_Days
required
boolean
Flag indicating if ACH/EDI prompt pay frequency is based on business days 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> 
Number of units used for ACH/EDI prompt pay frequency


 
calc_Interest_ACH_Prompt_Pay_Type
string or null  <= 1 characters 
Units used for ACH/EDI prompt pay frequency, either days, months or years


 
calc_Interest_Business_Days
required
boolean
Flag indicating if manual prompt pay frequency is based on business days 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> 
Number of units used for manual prompt pay frequency


 
calc_Interest_Prompt_Pay_Type
string or null  <= 1 characters 
Units used for manual prompt pay frequency, either days, months or years


 
default_Percentage_Election
required
number <double> 
Amount of the default percentage election that should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
state_Name
string or null  <= 25 characters 
Full name of the state


 
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


 
use_Percentage_Election
required
boolean
Flag indicating if the default percentage election should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
use_StateInterest_Settings
required
boolean
Flag to control whether to use the State Interest entries for a specific state instead of State Details. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/states/{stateAbbrev}
Request samples 
{
  • "state_Abbrev": "st",
  • "all_States": "s",
  • "apply_State_Tax": true,
  • "calc_Interest_ACH_Business_Days": true,
  • "calc_Interest_ACH_Prompt_Pay_Freq": 0,
  • "calc_Interest_ACH_Prompt_Pay_Type": "s",
  • "calc_Interest_Business_Days": true,
  • "calc_Interest_Prompt_Pay_Freq": 0,
  • "calc_Interest_Prompt_Pay_Type": "s",
  • "default_Percentage_Election": 0.1,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "state_Name": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Percentage_Election": true,
  • "use_StateInterest_Settings": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete State
Deletes an State


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
stateAbbrev
required
string
State Abbreviation


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/states/{stateAbbrev}
Request samples 
Create or Update Batch State
Create or Update multiple State 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 
state_Abbrev
required
string  [ 1 .. 2 ] characters 
Two letter abbeviation for the state


 
all_States
string or null  <= 1 characters 
Flag indicating the identifier refers to all states


 
apply_State_Tax
required
boolean
Flag indicating if state tax should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
calc_Interest_ACH_Business_Days
required
boolean
Flag indicating if ACH/EDI prompt pay frequency is based on business days 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> 
Number of units used for ACH/EDI prompt pay frequency


 
calc_Interest_ACH_Prompt_Pay_Type
string or null  <= 1 characters 
Units used for ACH/EDI prompt pay frequency, either days, months or years


 
calc_Interest_Business_Days
required
boolean
Flag indicating if manual prompt pay frequency is based on business days 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> 
Number of units used for manual prompt pay frequency


 
calc_Interest_Prompt_Pay_Type
string or null  <= 1 characters 
Units used for manual prompt pay frequency, either days, months or years


 
default_Percentage_Election
required
number <double> 
Amount of the default percentage election that should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
state_Name
string or null  <= 25 characters 
Full name of the state


 
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


 
use_Percentage_Election
required
boolean
Flag indicating if the default percentage election should be applied to calculations Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
use_StateInterest_Settings
required
boolean
Flag to control whether to use the State Interest entries for a specific state instead of State Details. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


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