Provider Withholds

Create ProviderWithhold

Creates a new ProviderWithhold

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
providerWithhold_Key
required
integer <int32>

Unique identifier for each Withhold setting.

account_Key
integer or null <int32>

This field indicates the funding account criteria by which the withhold is applied to a claim.

benefit_Code
string or null <= 10 characters

Benefit code required for adjudication matching.

effective_Date
required
string <date-time>

Start of the range of acceptable service dates for the admin fee.

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.

ex_Code
string or null <= 6 characters

Ex code associated with the price line.

federal_ID
string or null <= 20 characters

Allows setting the Tax ID that this withhold will apply when applying a withhold across multiple Providers.

network_ID
string or null <= 10 characters

Identifies the required Network for adjudication matching.

payor_ID
string or null <= 20 characters

This field indicates the payor criteria by which the withhold is applied to a claim.

provider_ID
string or null <= 20 characters

The Provider ID this Withhold setting is being applied.

term_Date
string or null <date-time>

End of the range of acceptable service dates for the admin fee.

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.

withhold
number or null <double>

Shows the withheld percentage.

withhold_Max
number or null <double>

Indicates the max Withhold that can be taken for this withhold configuration.

withhold_Pct
required
boolean

Indicates if the Withhold value on this table is a Percentage or a Flat amount.

Responses
200

Success

401

Unauthorized

post/provider-withholds
Request samples
{
  • "providerWithhold_Key": 0,
  • "account_Key": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "federal_ID": "string",
  • "network_ID": "string",
  • "payor_ID": "string",
  • "provider_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "withhold": 0.1,
  • "withhold_Max": 0.1,
  • "withhold_Pct": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ProviderWithhold

Lists all ProviderWithhold. Supply optional ProviderID and/or FederalID parameters to filter results.

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
providerId
string

ProviderID

federalId
string

FederalID

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-withholds
Request samples 
Response samples 
No sample
Get ProviderWithhold
Gets ProviderWithhold


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerWithholdKey
required
integer <int32> 
ProviderWithhold Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/provider-withholds/{providerWithholdKey}
Request samples 
Response samples 
No sample
Update ProviderWithhold
Updates a specific ProviderWithhold.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerWithholdKey
required
integer <int32> 
ProviderWithhold Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
providerWithhold_Key
required
integer <int32> 
Unique identifier for each Withhold setting.


 
account_Key
integer or null <int32> 
This field indicates the funding account criteria by which the withhold is applied to a claim.


 
benefit_Code
string or null  <= 10 characters 
Benefit code required for adjudication matching.


 
effective_Date
required
string <date-time> 
Start of the range of acceptable service dates for the admin fee.


 
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.


 
ex_Code
string or null  <= 6 characters 
Ex code associated with the price line.


 
federal_ID
string or null  <= 20 characters 
Allows setting the Tax ID that this withhold will apply when applying a withhold across multiple Providers.


 
network_ID
string or null  <= 10 characters 
Identifies the required Network for adjudication matching.


 
payor_ID
string or null  <= 20 characters 
This field indicates the payor criteria by which the withhold is applied to a claim.


 
provider_ID
string or null  <= 20 characters 
The Provider ID this Withhold setting is being applied.


 
term_Date
string or null <date-time> 
End of the range of acceptable service dates for the admin fee.


 
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.


 
withhold
number or null <double> 
Shows the withheld percentage.


 
withhold_Max
number or null <double> 
Indicates the max Withhold that can be taken for this withhold configuration.


 
withhold_Pct
required
boolean
Indicates if the Withhold value on this table is a Percentage or a Flat amount.


 
Responses 
200
Success


401
Unauthorized


put/provider-withholds/{providerWithholdKey}
Request samples 
{
  • "providerWithhold_Key": 0,
  • "account_Key": 0,
  • "benefit_Code": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "federal_ID": "string",
  • "network_ID": "string",
  • "payor_ID": "string",
  • "provider_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "withhold": 0.1,
  • "withhold_Max": 0.1,
  • "withhold_Pct": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ProviderWithhold
Deletes an ProviderWithhold


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
providerWithholdKey
required
integer <int32> 
ProviderWithhold Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/provider-withholds/{providerWithholdKey}
Request samples 
Create or Update Batch ProviderWithhold
Create or Update multiple ProviderWithhold 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 
providerWithhold_Key
required
integer <int32> 
Unique identifier for each Withhold setting.


 
account_Key
integer or null <int32> 
This field indicates the funding account criteria by which the withhold is applied to a claim.


 
benefit_Code
string or null  <= 10 characters 
Benefit code required for adjudication matching.


 
effective_Date
required
string <date-time> 
Start of the range of acceptable service dates for the admin fee.


 
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.


 
ex_Code
string or null  <= 6 characters 
Ex code associated with the price line.


 
federal_ID
string or null  <= 20 characters 
Allows setting the Tax ID that this withhold will apply when applying a withhold across multiple Providers.


 
network_ID
string or null  <= 10 characters 
Identifies the required Network for adjudication matching.


 
payor_ID
string or null  <= 20 characters 
This field indicates the payor criteria by which the withhold is applied to a claim.


 
provider_ID
string or null  <= 20 characters 
The Provider ID this Withhold setting is being applied.


 
term_Date
string or null <date-time> 
End of the range of acceptable service dates for the admin fee.


 
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.


 
withhold
number or null <double> 
Shows the withheld percentage.


 
withhold_Max
number or null <double> 
Indicates the max Withhold that can be taken for this withhold configuration.


 
withhold_Pct
required
boolean
Indicates if the Withhold value on this table is a Percentage or a Flat amount.


 
Responses 
207
Success


401
Unauthorized


put/provider-withholds-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}