Payor

Create Payor

Creates a new Payor

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payor_ID
required
string [ 1 .. 20 ] characters

Unique identifier assigned to the Payor.

address
string or null <= 255 characters

Address of the Payor.

address2
string or null <= 128 characters

Address line 2 of the Payor.

admin_Fee
number or null <double>

Specifies the 'Admin Fee' amount that will be applied to the associated check.

admin_Pct
string or null <= 1 characters

Identifies whether the associated 'Admin Fee' is a percentage.

city
string or null <= 25 characters

City of the Payor's address.

contact
string or null <= 50 characters

Name of the intended contact person for the Payor.

country_ID
string or null <= 8 characters

Identifier of the country where the Payor resides.

county_Code
string or null <= 8 characters

Indentifier of the county where the Payor resides.

default_Pay_Date_Range
integer or null <int32>

This option allows the User to post-date 'Check Paid Date' field at the Payor level by the designated number of days.

edI_ID
string or null <= 9 characters

EDI ID associated with the Payor.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code
string or null <= 6 characters

Allows the User to select an Ex Code that will be applied to any claims associated with the Payor whenever the 'Apply Ex Code' option is selected.

fax_Country_Code
string or null <= 8 characters

Country code of the Payor's fax number.

fax_Number
string or null <= 20 characters

Fax number of the Payor.

federal_ID
string or null <= 32 characters

Identifier assigned to the Payor that is used for federal tax purposes.

force_Filter
required
boolean

This option will limit filters available from the Claim Funding screen to the filters that have been built on the Funds Filter tab. Note: This field is marked as NOT NULL in the database and therefore required by the API.

last_Wire_Check
integer or null <int32>

Displays the check number of the Payor's last wire transfer.

name
string or null <= 100 characters

Name of the Payor individual or institution.

phone_Country_Code
string or null <= 8 characters

Country code of the Payor's phone number.

phone_Number
string or null <= 20 characters

Phone number of the Payor.

state
string or null <= 2 characters

State of the Payor's address.

update_Date
string <date-time>

Date when 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 Payor's address.

Responses
200

Success

401

Unauthorized

post/payors
Request samples
{
  • "payor_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "admin_Fee": 0.1,
  • "admin_Pct": "s",
  • "city": "string",
  • "contact": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "default_Pay_Date_Range": 0,
  • "edI_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "federal_ID": "string",
  • "force_Filter": true,
  • "last_Wire_Check": 0,
  • "name": "string",
  • "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 Payor

Lists all Payor

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/payors
Request samples 
Response samples 
No sample
Get Payor
Gets Payor


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorId
required
string
Payor ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payors/{payorId}
Request samples 
Response samples 
No sample
Update Payor
Updates a specific Payor.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorId
required
string
Payor ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payor_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the Payor.


 
address
string or null  <= 255 characters 
Address of the Payor.


 
address2
string or null  <= 128 characters 
Address line 2 of the Payor.


 
admin_Fee
number or null <double> 
Specifies the 'Admin Fee' amount that will be applied to the associated check.


 
admin_Pct
string or null  <= 1 characters 
Identifies whether the associated 'Admin Fee' is a percentage.


 
city
string or null  <= 25 characters 
City of the Payor's address.


 
contact
string or null  <= 50 characters 
Name of the intended contact person for the Payor.


 
country_ID
string or null  <= 8 characters 
Identifier of the country where the Payor resides.


 
county_Code
string or null  <= 8 characters 
Indentifier of the county where the Payor resides.


 
default_Pay_Date_Range
integer or null <int32> 
This option allows the User to post-date 'Check Paid Date' field at the Payor level by the designated number of days.


 
edI_ID
string or null  <= 9 characters 
EDI ID associated with the Payor.


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


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


 
ex_Code
string or null  <= 6 characters 
Allows the User to select an Ex Code that will be applied to any claims associated with the Payor whenever the 'Apply Ex Code' option is selected.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the Payor's fax number.


 
fax_Number
string or null  <= 20 characters 
Fax number of the Payor.


 
federal_ID
string or null  <= 32 characters 
Identifier assigned to the Payor that is used for federal tax purposes.


 
force_Filter
required
boolean
This option will limit filters available from the Claim Funding screen to the filters that have been built on the Funds Filter tab. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
last_Wire_Check
integer or null <int32> 
Displays the check number of the Payor's last wire transfer.


 
name
string or null  <= 100 characters 
Name of the Payor individual or institution.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Payor's phone number.


 
phone_Number
string or null  <= 20 characters 
Phone number of the Payor.


 
state
string or null  <= 2 characters 
State of the Payor's address.


 
update_Date
string <date-time> 
Date when 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 Payor's address.


 
Responses 
200
Success


401
Unauthorized


put/payors/{payorId}
Request samples 
{
  • "payor_ID": "string",
  • "address": "string",
  • "address2": "string",
  • "admin_Fee": 0.1,
  • "admin_Pct": "s",
  • "city": "string",
  • "contact": "string",
  • "country_ID": "string",
  • "county_Code": "string",
  • "default_Pay_Date_Range": 0,
  • "edI_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "fax_Country_Code": "string",
  • "fax_Number": "string",
  • "federal_ID": "string",
  • "force_Filter": true,
  • "last_Wire_Check": 0,
  • "name": "string",
  • "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 Payor
Deletes an Payor


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorId
required
string
Payor ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payors/{payorId}
Request samples 
Create or Update Batch Payor
Create or Update multiple Payor 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 
payor_ID
required
string  [ 1 .. 20 ] characters 
Unique identifier assigned to the Payor.


 
address
string or null  <= 255 characters 
Address of the Payor.


 
address2
string or null  <= 128 characters 
Address line 2 of the Payor.


 
admin_Fee
number or null <double> 
Specifies the 'Admin Fee' amount that will be applied to the associated check.


 
admin_Pct
string or null  <= 1 characters 
Identifies whether the associated 'Admin Fee' is a percentage.


 
city
string or null  <= 25 characters 
City of the Payor's address.


 
contact
string or null  <= 50 characters 
Name of the intended contact person for the Payor.


 
country_ID
string or null  <= 8 characters 
Identifier of the country where the Payor resides.


 
county_Code
string or null  <= 8 characters 
Indentifier of the county where the Payor resides.


 
default_Pay_Date_Range
integer or null <int32> 
This option allows the User to post-date 'Check Paid Date' field at the Payor level by the designated number of days.


 
edI_ID
string or null  <= 9 characters 
EDI ID associated with the Payor.


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


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


 
ex_Code
string or null  <= 6 characters 
Allows the User to select an Ex Code that will be applied to any claims associated with the Payor whenever the 'Apply Ex Code' option is selected.


 
fax_Country_Code
string or null  <= 8 characters 
Country code of the Payor's fax number.


 
fax_Number
string or null  <= 20 characters 
Fax number of the Payor.


 
federal_ID
string or null  <= 32 characters 
Identifier assigned to the Payor that is used for federal tax purposes.


 
force_Filter
required
boolean
This option will limit filters available from the Claim Funding screen to the filters that have been built on the Funds Filter tab. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
last_Wire_Check
integer or null <int32> 
Displays the check number of the Payor's last wire transfer.


 
name
string or null  <= 100 characters 
Name of the Payor individual or institution.


 
phone_Country_Code
string or null  <= 8 characters 
Country code of the Payor's phone number.


 
phone_Number
string or null  <= 20 characters 
Phone number of the Payor.


 
state
string or null  <= 2 characters 
State of the Payor's address.


 
update_Date
string <date-time> 
Date when 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 Payor's address.


 
Responses 
207
Success


401
Unauthorized


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