Group Payor Account Provider Federal IDs

Create GroupPayorAccountProviderFederal

Creates a new GroupPayorAccountProviderFederal

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

settingID
required
string

Setting ID

header Parameters
vbasoftware-database
required
string

Target database

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

References GroupPayorAccount.Group_ID on the parent record.

setting_ID
required
string [ 1 .. 32 ] characters

References GroupPayorAccount.Setting_ID on the parent record.

federal_ID
required
string [ 1 .. 20 ] characters

If the setting is Tax ID specific, you would include that Tax ID here.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/payor-account-settings/{settingID}/federal-ids
Request samples
{
  • "group_ID": "string",
  • "setting_ID": "string",
  • "federal_ID": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupPayorAccountProviderFederal

Lists all GroupPayorAccountProviderFederal for the given groupID and settingID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

settingID
required
string

Setting 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/groups/{groupID}/payor-account-settings/{settingID}/federal-ids
Request samples 
Response samples 
No sample
Get GroupPayorAccountProviderFederal
Gets GroupPayorAccountProviderFederal


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
federalID
required
string
Federal ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/payor-account-settings/{settingID}/federal-ids/{federalID}
Request samples 
Response samples 
No sample
Delete GroupPayorAccountProviderFederal
Deletes an GroupPayorAccountProviderFederal


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
federalID
required
string
Federal ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/payor-account-settings/{settingID}/federal-ids/{federalID}
Request samples 
Create or Update Batch GroupPayorAccountProviderFederal
Create or Update multiple GroupPayorAccountProviderFederal 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
groupID
required
string
Group ID


 
settingID
required
string
Setting ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
group_ID
required
string  [ 1 .. 20 ] characters 
References GroupPayorAccount.Group_ID on the parent record.


 
setting_ID
required
string  [ 1 .. 32 ] characters 
References GroupPayorAccount.Setting_ID on the parent record.


 
federal_ID
required
string  [ 1 .. 20 ] characters 
If the setting is Tax ID specific, you would include that Tax ID here.


 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/payor-account-settings/{settingID}/federal-ids-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}