Capitation Transactions

Create CapitationTransaction

Creates a new CapitationTransaction

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
capitationTransaction_Key
required
integer <int32>

ID for the capitation transaction. Note: This field is marked as NOT NULL in the database and therefore required by the API.

check_Batch
integer or null <int32>

Identifies the batch to which the transaction's check belongs.

description
string or null <= 64 characters

Description of the capitation transaction.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

payee_ID
string or null <= 20 characters

ID of the Payee associated with the capitation transaction.

transaction_Date
string or null <date-time>

Date when the capitation transaction occurred.

update_Date
string <date-time>

Date 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/capitation-transactions
Request samples
{
  • "capitationTransaction_Key": 0,
  • "check_Batch": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CapitationTransaction

Lists all CapitationTransaction

SecurityapiKeyAuth and bearerAuth
Request
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/capitation-transactions
Request samples 
Response samples 
No sample
Get CapitationTransaction
Gets CapitationTransaction


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationTransactionKey
required
integer <int32> 
CapitationTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/capitation-transactions/{capitationTransactionKey}
Request samples 
Response samples 
No sample
Update CapitationTransaction
Updates a specific CapitationTransaction.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationTransactionKey
required
integer <int32> 
CapitationTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
capitationTransaction_Key
required
integer <int32> 
ID for the capitation transaction. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_Batch
integer or null <int32> 
Identifies the batch to which the transaction's check belongs.


 
description
string or null  <= 64 characters 
Description of the capitation transaction.


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


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


 
payee_ID
string or null  <= 20 characters 
ID of the Payee associated with the capitation transaction.


 
transaction_Date
string or null <date-time> 
Date when the capitation transaction occurred.


 
update_Date
string <date-time> 
Date 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/capitation-transactions/{capitationTransactionKey}
Request samples 
{
  • "capitationTransaction_Key": 0,
  • "check_Batch": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "payee_ID": "string",
  • "transaction_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CapitationTransaction
Deletes an CapitationTransaction


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
capitationTransactionKey
required
integer <int32> 
CapitationTransaction Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/capitation-transactions/{capitationTransactionKey}
Request samples 
Create or Update Batch CapitationTransaction
Create or Update multiple CapitationTransaction 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 
capitationTransaction_Key
required
integer <int32> 
ID for the capitation transaction. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
check_Batch
integer or null <int32> 
Identifies the batch to which the transaction's check belongs.


 
description
string or null  <= 64 characters 
Description of the capitation transaction.


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


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


 
payee_ID
string or null  <= 20 characters 
ID of the Payee associated with the capitation transaction.


 
transaction_Date
string or null <date-time> 
Date when the capitation transaction occurred.


 
update_Date
string <date-time> 
Date 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/capitation-transactions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}