Payor Accounts

Create PayorAccount

Creates a new PayorAccount

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
payor_Account_Key
required
integer <int32>

Unique identifier for each Payor and Account combination. Note: This field is marked as NOT NULL in the database and therefore required by the API.

account_Key
required
integer <int32>

References the FundingAccount.Account_Key associated with this Payor/Account. Note: This field is marked as NOT NULL in the database and therefore required by the API.

check_Stock
integer or null <int32>

When a check is printed, the check will default to the selected check stock.

currency_ID
string or null <= 16 characters

Identifies the currency that is used by the Payor.

default_Contact_Method
string or null <= 32 characters

Identifies the desired default contact method of the Payor.

default_Funding_Format
string or null <= 32 characters

Identifies the desired default funding format of the Payor.

effective_Date
string or null <date-time>

Date when the Payor account becomes/became effective.

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.

funding_Threshold
integer or null <int32>

This option is informational only.

logo_File
string or null <= 256 characters

Displays the currently used logo file for the Payor. This logo can be applied to custom check stock.

payor_ID
required
string [ 1 .. 20 ] characters

References the Payor.Payor_ID associated with this Payor/Account.

signatures_Required
integer or null <int32>

This option is informational only.

single_Check_Per_Claim
required
boolean

Requires that this Payor's claims be paid for with a single check. Note: This field is marked as NOT NULL in the database and therefore required by the API.

term_Date
string or null <date-time>

Date when the Payor account becomes/became terminated.

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.

Responses
200

Success

401

Unauthorized

post/payor-accounts
Request samples
{
  • "payor_Account_Key": 0,
  • "account_Key": 0,
  • "check_Stock": 0,
  • "currency_ID": "string",
  • "default_Contact_Method": "string",
  • "default_Funding_Format": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "funding_Threshold": 0,
  • "logo_File": "string",
  • "payor_ID": "string",
  • "signatures_Required": 0,
  • "single_Check_Per_Claim": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PayorAccount

Lists PayorAccounts with optional Payor_ID filter.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
payorID
string

Payor ID

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/payor-accounts
Request samples 
Response samples 
No sample
Get PayorAccount
Gets PayorAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountKey
required
integer <int32> 
Payor Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payor-accounts/{payorAccountKey}
Request samples 
Response samples 
No sample
Update PayorAccount
Updates a specific PayorAccount.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountKey
required
integer <int32> 
Payor Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
payor_Account_Key
required
integer <int32> 
Unique identifier for each Payor and Account combination. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
required
integer <int32> 
References the FundingAccount.Account_Key associated with this Payor/Account. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_Stock
integer or null <int32> 
When a check is printed, the check will default to the selected check stock.


 
currency_ID
string or null  <= 16 characters 
Identifies the currency that is used by the Payor.


 
default_Contact_Method
string or null  <= 32 characters 
Identifies the desired default contact method of the Payor.


 
default_Funding_Format
string or null  <= 32 characters 
Identifies the desired default funding format of the Payor.


 
effective_Date
string or null <date-time> 
Date when the Payor account becomes/became effective.


 
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.


 
funding_Threshold
integer or null <int32> 
This option is informational only.


 
logo_File
string or null  <= 256 characters 
Displays the currently used logo file for the Payor. This logo can be applied to custom check stock.


 
payor_ID
required
string  [ 1 .. 20 ] characters 
References the Payor.Payor_ID associated with this Payor/Account.


 
signatures_Required
integer or null <int32> 
This option is informational only.


 
single_Check_Per_Claim
required
boolean
Requires that this Payor's claims be paid for with a single check. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
Date when the Payor account becomes/became terminated.


 
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.


 
Responses 
200
Success


401
Unauthorized


put/payor-accounts/{payorAccountKey}
Request samples 
{
  • "payor_Account_Key": 0,
  • "account_Key": 0,
  • "check_Stock": 0,
  • "currency_ID": "string",
  • "default_Contact_Method": "string",
  • "default_Funding_Format": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "funding_Threshold": 0,
  • "logo_File": "string",
  • "payor_ID": "string",
  • "signatures_Required": 0,
  • "single_Check_Per_Claim": true,
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PayorAccount
Deletes an PayorAccount


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountKey
required
integer <int32> 
Payor Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payor-accounts/{payorAccountKey}
Request samples 
Get PayorAccount Balance Advanced API 
Gets PayorAccount Balance details


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorAccountKey
required
integer <int32> 
Payor Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payor-accounts/{payorAccountKey}/account-balance
Request samples 
Response samples 
No sample
Create or Update Batch PayorAccount
Create or Update multiple PayorAccount 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_Account_Key
required
integer <int32> 
Unique identifier for each Payor and Account combination. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
account_Key
required
integer <int32> 
References the FundingAccount.Account_Key associated with this Payor/Account. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_Stock
integer or null <int32> 
When a check is printed, the check will default to the selected check stock.


 
currency_ID
string or null  <= 16 characters 
Identifies the currency that is used by the Payor.


 
default_Contact_Method
string or null  <= 32 characters 
Identifies the desired default contact method of the Payor.


 
default_Funding_Format
string or null  <= 32 characters 
Identifies the desired default funding format of the Payor.


 
effective_Date
string or null <date-time> 
Date when the Payor account becomes/became effective.


 
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.


 
funding_Threshold
integer or null <int32> 
This option is informational only.


 
logo_File
string or null  <= 256 characters 
Displays the currently used logo file for the Payor. This logo can be applied to custom check stock.


 
payor_ID
required
string  [ 1 .. 20 ] characters 
References the Payor.Payor_ID associated with this Payor/Account.


 
signatures_Required
integer or null <int32> 
This option is informational only.


 
single_Check_Per_Claim
required
boolean
Requires that this Payor's claims be paid for with a single check. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
term_Date
string or null <date-time> 
Date when the Payor account becomes/became terminated.


 
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.


 
Responses 
207
Success


401
Unauthorized


put/payor-accounts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
List Claims Information from a Payor's Funding Account
List Claims Information from a Payor's Funding Account


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorId
required
string
Payor ID


 
accountKey
required
integer <int32> 
Payor's Funding Account Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payor/{payorId}/funding-accounts/{accountKey}/claims-info
Request samples 
Response samples 
No sample
List Payor Accounts for Check Processing
Gets a list of Payor Accounts for Check Processing


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


 
Responses 
200
Success


401
Unauthorized


get/payor-accounts/check-processing
Request samples 
Response samples 
No sample