Group Advice to Pay

Create GroupATP

Creates a new GroupATP

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupATP_Key
required
integer <int32>
claim_Type
string or null <= 20 characters
division_ID
string or null <= 20 characters
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
federal_ID
string or null <= 20 characters
group_ID
required
string [ 1 .. 20 ] characters
place_Of_Service_From
string or null <= 5 characters
place_Of_Service_Thru
string or null <= 5 characters
provider_NPI
string or null <= 20 characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/groups/{groupID}/avdvice-to-pay
Request samples
{
  • "groupATP_Key": 0,
  • "claim_Type": "string",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "federal_ID": "string",
  • "group_ID": "string",
  • "place_Of_Service_From": "strin",
  • "place_Of_Service_Thru": "strin",
  • "provider_NPI": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupATP

Lists all GroupATP for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group 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}/avdvice-to-pay
Request samples 
Response samples 
No sample
Get GroupATP
Gets GroupATP


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupATPKey
required
integer <int32> 
GroupATP Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/avdvice-to-pay/{groupATPKey}
Request samples 
Response samples 
No sample
Update GroupATP
Updates a specific GroupATP.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupATPKey
required
integer <int32> 
GroupATP Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupATP_Key
required
integer <int32> 
 
claim_Type
string or null  <= 20 characters 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
federal_ID
string or null  <= 20 characters 
 
group_ID
required
string  [ 1 .. 20 ] characters 
 
place_Of_Service_From
string or null  <= 5 characters 
 
place_Of_Service_Thru
string or null  <= 5 characters 
 
provider_NPI
string or null  <= 20 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/avdvice-to-pay/{groupATPKey}
Request samples 
{
  • "groupATP_Key": 0,
  • "claim_Type": "string",
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "federal_ID": "string",
  • "group_ID": "string",
  • "place_Of_Service_From": "strin",
  • "place_Of_Service_Thru": "strin",
  • "provider_NPI": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupATP
Deletes an GroupATP


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupATPKey
required
integer <int32> 
GroupATP Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/avdvice-to-pay/{groupATPKey}
Request samples 
Create or Update Batch GroupATP
Create or Update multiple GroupATP 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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupATP_Key
required
integer <int32> 
 
claim_Type
string or null  <= 20 characters 
 
division_ID
string or null  <= 20 characters 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
federal_ID
string or null  <= 20 characters 
 
group_ID
required
string  [ 1 .. 20 ] characters 
 
place_Of_Service_From
string or null  <= 5 characters 
 
place_Of_Service_Thru
string or null  <= 5 characters 
 
provider_NPI
string or null  <= 20 characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/groups/{groupID}/avdvice-to-pay-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}