# Create or Update Auth Batch

Creates or Updates Multiple Auths

Endpoint: PUT /auths
Version: v1
Security: apiKeyAuth, bearerAuth

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `bearerAuth` (unknown)
    http bearer JWT

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Request fields (application/json):

  - `auth_Number` (string)
    Unique identifier assigned to the authorization.

  - `actual_From` (string)
    Date when authorization usage begins/began.

  - `actual_Location` (string)
    Location where the authorization was used.

  - `actual_Thru` (string)
    Date when authorization usage ends/ended.

  - `additional_Visits` (number)
    No longer in use. This would track if an Auth had been adjusted to increase the number of approved visits. This is now done through the Auth Adjustment process where a new Auth is created referencing the original Auth.

  - `amount_Actual` (number)
    Total approved amount that has been used.

  - `amount_Approved` (number)
    Approved amount of the authorization.

  - `amount_Denied` (number)
    Denied amount of the authorization.

  - `amount_Requested` (number)
    Requested amount of the authorization.

  - `approved_By` (string)
    User that either approved, pended, or denied the authorization.

  - `approved_Date` (string)
    Date when the authorization was approved, denied, or pended as specified by the status field.

  - `approved_Frequency` (string)
    Authorization frequency that is/was approved.

  - `approved_From` (string)
    Date when the authorization approval starts/started.

  - `approved_Location` (string)
    Approved location of the authorization.

  - `approved_Thru` (string)
    Date when the authorization approval expires/expired.

  - `assigned_User` (string)
    User that the authorization was assigned to.

  - `audit_Flag` (string)
    Information field used in custom reporting.

  - `auth_Code` (string)
    Code that indicates the authorization status.

  - `auth_Type` (string)
    Indicates the type of authorization. Auth types can be configured within 'Auth Configuration'.

  - `auto_Accident` (string)
    Check this box to indicate that the authorization is related to an automotive accident.

  - `bodyCode_ID` (string)
    No longer in use.

  - `careManager_Key` (integer)
    ID of the Care Manager associated with the auth.

  - `case_Index_Actual` (string)
    Informational field used to identify the case index.

  - `case_Index_Approved` (string)
    Informational field used to identify the case index.

  - `case_Index_Denied` (string)
    Informational field used to identify the case index.

  - `case_Index_Requested` (string)
    Informational field used to identify the case index.

  - `case_Number` (string)
    Informational field used to house the case number.

  - `cityCode_ID` (string)
    No longer in use.

  - `closed` (boolean, required)
    Field no longer used. This is repalced by the Status field.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.

  - `drG_Category` (string)
    Identifies the category of the selected DRG Code.

  - `drG_Code` (string)
    Specifies a DRG code that is to be associated with the authorization.

  - `daily_Living` (integer)
    Identifies that the authoization is associated with a claim that is affecting the patient's daily living.

  - `denied_From` (string)
    Date when the authorization denial starts/started.

  - `denied_Thru` (string)
    Date when the authorization denial expires/expired.

  - `discharge_Date` (string)
    Date when the patient was discharged.

  - `entry_Date` (string)
    Date when the record was first added to the system.

  - `entry_User` (string)
    User that first added the record to the system.

  - `federal_ID` (string)
    VBA internal Federal_ID of the Provider associated with the Auth. Do not send NPI or another Provider alternate identifier.

  - `ivR_Flag` (string)
    Indicates that the Auth was Initiated via IVR.

  - `injury_Date` (string)
    Date when the injury occurred.

  - `member_Seq` (string)
    VBA internal Member_Seq of the Member associated with the Auth. Together with Subscriber_ID this is the Member composite key. Do not send a member alternate identifier.

  - `monthly_Amount` (number)
    Information field used in custom reporting.

  - `narrative` (string)
    Field no longer used. For Notes/Comments/Narrative information you would use the Note Services area.

  - `new_Or_Extended` (boolean, required)
    Indicates that the associated authorization is a new authorization or an extension of the original authorization.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.

  - `notes` (string)
    Field that allows the User to add any additional information to the authorization.

  - `ordered_By_ID` (string)
    ID of the Provider who ordered this auth.

  - `ordered_By_Name` (string)
    Name of the Provider who ordered this auth.

  - `other_Coverage_Primary` (string)
    Information field used in custom reporting.

  - `other_Insurance` (string)
    Check this box to indicate that the associated Member has other insurance.

  - `payee_ID` (string)
    ID of the Payee associated with the auth.

  - `plan_ID` (string)
    Unique identifier assigned to the plan.

  - `previous_Auth` (string)
    This field is no longer used as it has been replaced by the the Auth Adjustment process where an AuthReference record is created instead.

  - `previous_Treatment` (boolean, required)
    Check this box to indicate that previous treatment had been administered.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.

  - `prior_Auth` (string)
    References Prior Auth

  - `provider_ID` (string)
    VBA internal Provider_ID of the Provider associated with the Auth. Do not send NPI or another Provider alternate identifier; the Auth screen joins Provider data on this internal key.

  - `radiating_Pain` (integer)
    Identifies that the authoization is associated with a claim where the patient is experiencing radiating pain.

  - `range_Of_Motion` (integer)
    Identifies that the authoization is associated with a claim that is affecting the patient's range of motion.

  - `received_Date` (string)
    Date when the authorization was received.

  - `referred_By_ID` (string)
    Unique identifier assigned to the Provider who is referring. This field can be populated by right-clicking and selecting 'Lookup' from the context menu.

  - `referred_By_Name` (string)
    Name of the referring Provider. This field is automatically populated by the 'Referred By ID' field.

  - `region` (string)
    Information field used in custom reporting.

  - `reinsNotification_Date` (string)
    Date when the Reinsurance Notification report was run. Process automation will be prompted to send the auth reinsurance notification on this date.

  - `requested_Frequency` (string)
    Authorization frequency that is/was requested.

  - `requested_From` (string)
    Date when the authorization is/was requested to be effective.

  - `requested_Location` (string)
    Requested location of the authorization.

  - `requested_Thru` (string)
    Date when the authorization is/was requested to expire.

  - `service_Code` (string)
    Code used to identify the service type associated with the authorization.

  - `service_Type` (string)
    Type of service associated with the authorization.

  - `status` (string)
    Identifies the current status of the authorization.

  - `subscriber_ID` (string)
    VBA internal Subscriber_ID of the Member associated with the Auth. Together with Member_Seq this is the Member composite key. Do not send a member alternate identifier.

  - `tPlan_DownLoaded` (boolean, required)
    Indicates if the Treatment Plan was downloaded from the application.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.

  - `tPlan_DownLoaded_Date` (string)
    Indicates the date the Treatment Plan was downloaded from the application.

  - `tPlan_DownLoaded_User` (string)
    Indicates the user what downloaded the Treatment Plan from the application.

  - `tPlan_Printed` (string, required)
    Flag indicating if this Auth has been printed as a Treatment Plan.

  - `tPlan_Printed_Date` (string)
    The date this Auth has been printed as a Treatment Plan.

  - `total_Actual` (number)
    No longer in use.

  - `total_Approved` (number)
    No longer in use.

  - `total_Requested` (number)
    No longer in use.

  - `total_Unit_Type` (string)
    No longer in use.

  - `treatment_Type` (string)
    Indicates the type of treatment that is being authorized.

  - `type_Of_Service` (string)
    No longer in use.

  - `unit_Type` (string)
    Unit type that is used for the associated service. Unit types can be configured in 'Auth Configuration'.

  - `units_Actual` (number)
    Total number of approved units that have been used.

  - `units_Approved` (number)
    Number of units approved as part of the authorization.

  - `units_Denied` (number)
    Number of units denied as part of the authorization.

  - `units_Requested` (number)
    Number of units requested as part of the authorization.

  - `update_Date` (string)
    Date when the record was last updated in the system.

  - `update_User` (string)
    User that last updated the record in the system.

  - `urgent` (boolean, required)
    Check this box to indicate that the authorization request is urgent.  Note: The database will apply a default value of `False` for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of `False` to meet the API requirements and ensure that the functionality occurs as expected.

  - `visits_Actual` (number)
    Number of visits used as part of the authorization.

  - `visits_Approved` (number)
    Number of visits approved as part of the authorization.

  - `visits_Requested` (number)
    Number of visits requested as part of the authorization.

  - `visits_To_Date` (number)
    Number of visits that have been used up to the current date.

  - `work_Related` (string)
    Check this box to indicate that the authorization is related to work.

## Response 207:

  - `207` (unknown)
    Multicode response

## Response 207 fields (application/json):

  - `data` (array)

  - `data.id` (array, required)
    List of key/value pairs that represent the unique id for the entity operation.

  - `data.id.key` (string)

  - `data.id.value` (string)

  - `data.status` (integer, required)
    http status of the operation (eg, 200, 201, 500)

  - `data.body` (string, required)
    operation message (eg, Updated, Created, Error message)

  - `error` (object)

  - `error.detail` (string)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 403:

  - `403` (unknown)
    Forbidden. The x-api-key header is missing or not valid. The API gateway sends this response, not VBAPI, so the body is not the VBAPI envelope; see Errors and troubleshooting.

## Response 429:

  - `429` (unknown)
    Too many requests. The limit is 25 requests per second sustained, with bursts up to 50, per API key. Wait and retry with exponential backoff and jitter.