Payor Reports

Create PayorReport

Creates a new PayorReport

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
reportDefinition_Key
required
integer <int32>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
report_Type
required
string [ 1 .. 16 ] characters
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/payors/{payorID}/reports
Request samples
{
  • "payor_ID": "string",
  • "reportDefinition_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "report_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PayorReport

Lists all PayorReport for the given payorID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
payorID
required
string

Payor 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/payors/{payorID}/reports
Request samples 
Response samples 
No sample
Get PayorReport
Gets PayorReport


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorID
required
string
Payor ID


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/payors/{payorID}/reports/{reportDefinitionKey}
Request samples 
Response samples 
No sample
Delete PayorReport
Deletes an PayorReport


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
payorID
required
string
Payor ID


 
reportDefinitionKey
required
integer <int32> 
ReportDefinition Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/payors/{payorID}/reports/{reportDefinitionKey}
Request samples 
Create or Update Batch PayorReport
Create or Update multiple PayorReport 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
payorID
required
string
Payor ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
payor_ID
required
string  [ 1 .. 20 ] characters 
 
reportDefinition_Key
required
integer <int32> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
report_Type
required
string  [ 1 .. 16 ] characters 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


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