Skip to content

Create ProviderWithhold

Request

Creates a new ProviderWithhold

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
providerWithhold_Keyinteger, (int32)required

Unique identifier for each Withhold setting.

account_Keyinteger or null, (int32)

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

benefit_Codestring or null, <= 10 characters

Benefit code required for adjudication matching.

effective_Datestring, (date-time)required

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

entry_Datestring, (date-time)

Date when the record was first added to the system.

entry_Userstring or null, <= 20 characters

User that first added the record to the system.

ex_Codestring or null, <= 6 characters

Ex code associated with the price line.

federal_IDstring or null, <= 20 characters

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

network_IDstring or null, <= 10 characters

Identifies the required Network for adjudication matching.

payor_IDstring or null, <= 20 characters

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

provider_IDstring or null, <= 20 characters

The Provider ID this Withhold setting is being applied.

term_Datestring or null, (date-time)

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

update_Datestring, (date-time)

Date when the record was last updated in the system.

update_Userstring or null, <= 20 characters

User that last updated the record in the system.

withholdnumber or null, (double)

Shows the withheld percentage.

withhold_Maxnumber or null, (double)

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

withhold_Pctbooleanrequired

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

curl -i -X POST \
  https://vbapi.vbasoftware.com/vbasoftware/provider-withholds \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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
  }'

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}