Commission Agencies

Create CommissionAgency

Creates a new CommissionAgency

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
commissionAgency_Key
required
integer <int32>

Unique identifier for the Commission Agency table Note: This field is marked as NOT NULL in the database and therefore required by the API.

address1
string or null <= 128 characters

Address1 of the Agency

address2
string or null <= 128 characters

Address2 of the Agency

agency_Type
string or null <= 32 characters

Type of the Agency

city
string or null <= 32 characters

City of the Agency

cluster_Hierarchy
string or null <= 32 characters
country_ID
string or null <= 8 characters

Country ID of the Agency

county_Code
string or null <= 8 characters

County Code of the Agency

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

fax_Country_Code
string or null <= 8 characters

Fax Country Code of the Agency

fax_Number
string or null <= 32 characters

Fax Number of the Agency

name
string or null <= 128 characters

Name of the Agency

payee_ID
string or null <= 20 characters

Payee ID of the Agency

payment_Distribution_Interval
string or null <= 1 characters

Payment Distribution Interval of the Agency

phone_Country_Code
string or null <= 8 characters

Phone Country Code of the Agency

phone_Number
string or null <= 32 characters

Phone Number of the Agency

state
string or null <= 2 characters

State of the Agency

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

zip_Code
string or null <= 32 characters

Zip Code of the Agency

Responses
200

Success

401

Unauthorized

post/commission-agencies
Request samples
{
  • "commissionAgency_Key": 0,
  • "address1": "string",
  • "address2": "string",
  • "agency_Type": "string",
  • "city": "string",
  • "cluster_Hierarchy": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "name": "string",
  • "payee_ID": "string",
  • "payment_Distribution_Interval": "s",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CommissionAgency

Lists all CommissionAgency

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/commission-agencies
Request samples 
Response samples 
No sample
Get CommissionAgency
Gets CommissionAgency


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAgencyKey
required
integer <int32> 
CommissionAgency Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/commission-agencies/{commAgencyKey}
Request samples 
Response samples 
No sample
Update CommissionAgency
Updates a specific CommissionAgency.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAgencyKey
required
integer <int32> 
CommissionAgency Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
commissionAgency_Key
required
integer <int32> 
Unique identifier for the Commission Agency table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
address1
string or null  <= 128 characters 
Address1 of the Agency


 
address2
string or null  <= 128 characters 
Address2 of the Agency


 
agency_Type
string or null  <= 32 characters 
Type of the Agency


 
city
string or null  <= 32 characters 
City of the Agency


 
cluster_Hierarchy
string or null  <= 32 characters 
 
country_ID
string or null  <= 8 characters 
Country ID of the Agency


 
county_Code
string or null  <= 8 characters 
County Code of the Agency


 
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


 
fax_Country_Code
string or null  <= 8 characters 
Fax Country Code of the Agency


 
fax_Number
string or null  <= 32 characters 
Fax Number of the Agency


 
name
string or null  <= 128 characters 
Name of the Agency


 
payee_ID
string or null  <= 20 characters 
Payee ID of the Agency


 
payment_Distribution_Interval
string or null  <= 1 characters 
Payment Distribution Interval of the Agency


 
phone_Country_Code
string or null  <= 8 characters 
Phone Country Code of the Agency


 
phone_Number
string or null  <= 32 characters 
Phone Number of the Agency


 
state
string or null  <= 2 characters 
State of the Agency


 
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


 
zip_Code
string or null  <= 32 characters 
Zip Code of the Agency


 
Responses 
200
Success


401
Unauthorized


put/commission-agencies/{commAgencyKey}
Request samples 
{
  • "commissionAgency_Key": 0,
  • "address1": "string",
  • "address2": "string",
  • "agency_Type": "string",
  • "city": "string",
  • "cluster_Hierarchy": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "name": "string",
  • "payee_ID": "string",
  • "payment_Distribution_Interval": "s",
  • "phone_Country_Code": "string",
  • "phone_Number": "string",
  • "state": "st",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "zip_Code": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CommissionAgency
Deletes an CommissionAgency


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
commAgencyKey
required
integer <int32> 
CommissionAgency Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/commission-agencies/{commAgencyKey}
Request samples 
Create or Update Batch CommissionAgency
Create or Update multiple CommissionAgency 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 
commissionAgency_Key
required
integer <int32> 
Unique identifier for the Commission Agency table Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
address1
string or null  <= 128 characters 
Address1 of the Agency


 
address2
string or null  <= 128 characters 
Address2 of the Agency


 
agency_Type
string or null  <= 32 characters 
Type of the Agency


 
city
string or null  <= 32 characters 
City of the Agency


 
cluster_Hierarchy
string or null  <= 32 characters 
 
country_ID
string or null  <= 8 characters 
Country ID of the Agency


 
county_Code
string or null  <= 8 characters 
County Code of the Agency


 
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


 
fax_Country_Code
string or null  <= 8 characters 
Fax Country Code of the Agency


 
fax_Number
string or null  <= 32 characters 
Fax Number of the Agency


 
name
string or null  <= 128 characters 
Name of the Agency


 
payee_ID
string or null  <= 20 characters 
Payee ID of the Agency


 
payment_Distribution_Interval
string or null  <= 1 characters 
Payment Distribution Interval of the Agency


 
phone_Country_Code
string or null  <= 8 characters 
Phone Country Code of the Agency


 
phone_Number
string or null  <= 32 characters 
Phone Number of the Agency


 
state
string or null  <= 2 characters 
State of the Agency


 
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


 
zip_Code
string or null  <= 32 characters 
Zip Code of the Agency


 
Responses 
207
Success


401
Unauthorized


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