Provider Credentialing Amounts

Create ProviderCredAmount

Creates a new ProviderCredAmount

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerCredKey
required
integer <int32>

ProviderCred Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

Associates these custom amount values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.

credAmount_Key
required
integer <int32>

The type associated with the credentialing amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

amount
number or null <double>

The dollar amount or percentage associated with the credential.

amount_Pct
required
boolean

This indicates that the associated amount represents a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

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/provider-credentialing/{providerCredKey}/amounts
Request samples
{
  • "providerCred_Key": 0,
  • "credAmount_Key": 0,
  • "amount": 0.1,
  • "amount_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderCredAmount

Lists all ProviderCredAmount for the given providerCredKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerCredKey
required
integer <int32>

ProviderCred Key

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/provider-credentialing/{providerCredKey}/amounts
Request samples
Response samples
No sample

Get ProviderCredAmount

Gets ProviderCredAmount

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerCredKey
required
integer <int32>

ProviderCred Key

credAmountKey
required
integer <int32>

CredAmount Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/provider-credentialing/{providerCredKey}/amounts/{credAmountKey}
Request samples
Response samples
No sample

Update ProviderCredAmount

Updates a specific ProviderCredAmount.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerCredKey
required
integer <int32>

ProviderCred Key

credAmountKey
required
integer <int32>

CredAmount Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerCred_Key
required
integer <int32>

Associates these custom amount values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.

credAmount_Key
required
integer <int32>

The type associated with the credentialing amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

amount
number or null <double>

The dollar amount or percentage associated with the credential.

amount_Pct
required
boolean

This indicates that the associated amount represents a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

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/provider-credentialing/{providerCredKey}/amounts/{credAmountKey}
Request samples
{
  • "providerCred_Key": 0,
  • "credAmount_Key": 0,
  • "amount": 0.1,
  • "amount_Pct": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Delete ProviderCredAmount

Deletes an ProviderCredAmount

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
providerCredKey
required
integer <int32>

ProviderCred Key

credAmountKey
required
integer <int32>

CredAmount Key

header Parameters
vbasoftware-database
required
string

Target database

Responses
204

Success

401

Unauthorized

delete/provider-credentialing/{providerCredKey}/amounts/{credAmountKey}
Request samples

Create or Update Batch ProviderCredAmount

Create or Update multiple ProviderCredAmount 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
providerCredKey
required
integer <int32>

ProviderCred Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
Array
providerCred_Key
required
integer <int32>

Associates these custom amount values with the credentialing process (ProviderCred.ProviderCred_Key) Note: This field is marked as NOT NULL in the database and therefore required by the API.

credAmount_Key
required
integer <int32>

The type associated with the credentialing amount. Note: This field is marked as NOT NULL in the database and therefore required by the API.

amount
number or null <double>

The dollar amount or percentage associated with the credential.

amount_Pct
required
boolean

This indicates that the associated amount represents a percentage. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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.

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/provider-credentialing/{providerCredKey}/amounts-batch
Request samples
[
  • {
    }
]
Response samples
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}