Provider Payees

Create ProviderPayee

Creates a new ProviderPayee

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

header Parameters
vbasoftware-database
required
string

Target database

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

Identifier of Proivider record.

payee_ID
required
string [ 1 .. 20 ] characters

Idenfifier of the Provider Payee.

effective_Date
required
string <date-time>

Date when the Payee becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.

blid
string or null <= 64 characters

BaseLoad Key for this Service/Billing Provider location combination.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

term_Date
string or null <date-time>

Date when the Payee expires/expired.

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/providers/{providerID}/payees
Request samples
{
  • "provider_ID": "string",
  • "payee_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "blid": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderPayee

Lists all ProviderPayee for the given providerID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerID
required
string

Provider ID

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/providers/{providerID}/payees
Request samples 
Response samples 
No sample
Get ProviderPayee
Gets ProviderPayee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
payeeID
required
string
Payee ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/providers/{providerID}/payees/{payeeID}/{effectiveDate}
Request samples 
Response samples 
No sample
Update ProviderPayee
Updates a specific ProviderPayee.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
payeeID
required
string
Payee ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
provider_ID
required
string  [ 1 .. 20 ] characters 
Identifier of Proivider record.


 
payee_ID
required
string  [ 1 .. 20 ] characters 
Idenfifier of the Provider Payee.


 
effective_Date
required
string <date-time> 
Date when the Payee becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
blid
string or null  <= 64 characters 
BaseLoad Key for this Service/Billing Provider location combination.


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


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


 
term_Date
string or null <date-time> 
Date when the Payee expires/expired.


 
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/providers/{providerID}/payees/{payeeID}/{effectiveDate}
Request samples 
{
  • "provider_ID": "string",
  • "payee_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "blid": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderPayee
Deletes an ProviderPayee


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
payeeID
required
string
Payee ID


 
effectiveDate
required
string <date-time> 
Effective Date


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/providers/{providerID}/payees/{payeeID}/{effectiveDate}
Request samples 
Create or Update Batch ProviderPayee
Create or Update multiple ProviderPayee at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerID
required
string
Provider ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
provider_ID
required
string  [ 1 .. 20 ] characters 
Identifier of Proivider record.


 
payee_ID
required
string  [ 1 .. 20 ] characters 
Idenfifier of the Provider Payee.


 
effective_Date
required
string <date-time> 
Date when the Payee becomes/became effective. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
blid
string or null  <= 64 characters 
BaseLoad Key for this Service/Billing Provider location combination.


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


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


 
term_Date
string or null <date-time> 
Date when the Payee expires/expired.


 
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/providers/{providerID}/payees-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}