# Get Disability Date and Exhaust Date

Based on information submitted in the Disability Advisor, calcualte the current Disability Date and Exhaust Date and return the advisor object.

Endpoint: POST /disability-advisor-get-dates
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Request fields (application/json):

  - `description` (string,null)
    Used to give a description for this episode of care.

  - `sickTime` (boolean)
    This flag identifies that there is sick time during this disability.

  - `sickTimeFrom` (string,null)
    This is the begin date of the sick time payment.

  - `sickTimeThru` (string,null)
    This is the end date of the sick time payment.

  - `sickTimeExCode` (string,null)
    This is the explanation code that will be applied to the sick time payments during this disability.

  - `vacation` (boolean)
    This flag identifies that there is vacation during this disability.

  - `vacationFrom` (string,null)
    This is the begin date of the vacation payment.

  - `vacationThru` (string,null)
    This is the end date of the vacation payment.

  - `vacationExCode` (string,null)
    This is the explanation code that will be applied to the vacation payments during this disability.

  - `salaryContinuation` (boolean)
    This flag identifies that salary continuation is part of the payment during this disability.

  - `salaryContinuationFrom` (string,null)
    This is the begin date of the salary continuation payment.

  - `salaryContinuationThru` (string,null)
    This is the end date of the salary continuation payment.

  - `salaryContinuationExCode` (string,null)
    This is the explanation code that will be applied to the salary continuation payments during this disability.

  - `partialDisability` (boolean)
    This will identify if this is a partial disability payment.  Partial Disability payments have additional tax and payment rules applied during adjudication.

  - `partialDisabilityHours` (boolean)
    This flag will identify if there is partial disability hours involved during the claim.

  - `imageNumber` (string,null)

  - `imageNumber2` (string,null)

  - `imageNumber3` (string,null)

  - `imageNumber4` (string,null)

  - `receivedDate` (string,null)

  - `lastDayWorked` (string,null)

  - `diagnosis1` (string,null)
    This identifies the primary diagnosis for this disability.

  - `diagnosis2` (string,null)
    This identifies additional diagnosis for this disability.

  - `dateOfSurgery` (string,null)
    This identifies the date of surgery for disability due to surgery.

  - `waitingPeriod` (integer,null)
    This is the number of waiting period days that will be assigned to the waiting period payment on this disability.

  - `rollupWaitingPeriod` (boolean)
    This flag if set will create the Waiting Period in one claim.

  - `admitDate` (string,null)
    This identifies the date the member was admitted to the Hospital if hospitalized as part of this disability.

  - `applyExtension` (boolean)
    This will let the Disability Payment Creator know that the created payments need to have a reminder Ex Code applied to the final two payments.

  - `applyExtensionExCode` (string,null)
    This is the Ex Code that is applied to the final two payments created by the Disability Payment Creator if the Apply Extension option is selected.

  - `closureEffectiveDate` (string,null)
    This is an information only field that allows the tracking of the Closure Effective Date.

  - `dateFirstAttended` (string,null)
    This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.

  - `disabledByPhysician` (string,null)
    This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.

  - `dob` (string,null)
    This is the Members Birth Date.

  - `duringEmployment` (boolean)
    Flag to identify if this disability happened while member was at work.

  - `surgery` (integer,null)
    Used to identify if surgery is involved in this disability.

  - `typeOfSurgery` (string,null)
    This is the procedure code of the surgery being performed for this disability.

  - `disabilityType` (string,null)
    This identifies the type of disability (Injury or Illness).

  - `typeOfDelivery` (string,null)
    This will identify the type of delivery that is performed as a result of pregnancy.

  - `numberOfPayments` (integer,null)
    This will identify the number of payments that will be involved during this claim.

  - `waiveWaitingPeriod` (boolean)
    This will identify whether the Waive Waiting Period option was selected.

  - `stateTax` (number,null)
    This will identify the state withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

  - `federalWithheld` (number,null)
    This will hold the amount for the Federal tax withheld from each payment.

  - `fica` (number,null)
    This will hold the FICA tax deduction for each payment.

  - `subscriberID` (string,null)
    This is the member’s unique system ID.

  - `memberSeq` (string,null)
    This is the member's sequence number.

  - `firstName` (string,null)
    This is the Members First Name.

  - `lastName` (string,null)
    This is the Members Last Name.

  - `groupID` (string,null)
    This is the Members Last Name.

  - `planID` (string,null)
    This will identify the plan under which this disability falls.

  - `planType` (string,null)
    This is the Plan Type associated with the Plan ID.

  - `planTypeLTD` (boolean)
    This is the Plan Type identifier for Long Term Disability.

  - `exceedReturnToWork` (boolean)
    This will be the Exceed Return To Work flag associated with the case.

  - `exceedMax` (boolean)
    This will indicate if max exceeded in disability payment creation.

  - `followupDate` (string,null)
    This will be the date the case is being followed up on.

  - `followupExCode` (string,null)
    This will identify the follow-up ExCode to be used.

  - `includeReturnToWork` (boolean)
    This will identify if the claim should include return to work.

  - `scd` (boolean)
    This is an SCD Payment identifier.

  - `paymentInterval` (integer,null)
    This identifies the payment interval for the disability claim (e.g., 5-day, 7-day, Monthly).

  - `surgeryExCode` (string,null)
    This is the explanation code attached to the surgery payments during this disability claim.

  - `jobType` (string,null)
    This will indicate the type of job associated with the disability (e.g., Sedentary, Light, Medium, Heavy).

  - `waitingPeriodExCode` (string,null)
    This is the explanation code applied to the waiting period payment for this disability.

  - `includeWaitingPeriod` (boolean)
    This will identify if the claim includes waiting period coverage.

  - `maxDisability` (integer,null)
    This will identify the maximum amount of disability payments for this claim.

  - `includeInMax` (boolean)
    This flag indicates if the waiting period is included in the maximum disability calculation.

  - `firstDayHospital` (boolean)
    This flag identifies if the first day in the hospital is included in the disability coverage.

  - `liabilityInjury` (boolean)
    This flag identifies if the injury was due to liability.

  - `pay_To` (string,null)

  - `mail_To` (string,null)

  - `exCode` (string,null)

  - `hospitalized` (boolean)

  - `pregnancy` (boolean)
    This flag identifies if the disability is related to pregnancy.

  - `dischargeDate` (string,null)
    This identifies the date of discharge from the hospital.

  - `expectedTypicalDuration` (integer,null)
    This identifies the expected typical duration of the disability.

  - `dateOfDelivery` (string,null)
    This identifies the date of the delivery for pregnancy-related disability.

  - `returnToWork` (string,null)
    This identifies the date the employee returned to work after the disability.

  - `ltdEffectiveDate` (string,null)
    This identifies the date the long-term disability becomes effective.

  - `ltdPacketDate` (string,null)
    This identifies the date the long-term disability packet was sent.

  - `depSSDIEndDate` (string,null)
    This identifies the end date for dependent SSDI coverage.

  - `lastPhysicianWarrantDate` (string,null)
    This identifies the last warrant date for the physician for this claim.

  - `exhaustDate` (string,null)
    This identifies the exhaustion date for the disability claim.

  - `physicianReturnToWork` (string,null)
    This is the Return to Work date identified by the Physician at the start of disability.This may or may not be the actual date the member returns to work.

  - `disabilityPayThroughDay` (integer,null)
    This identifies the disability pay-through day for this claim.

  - `overpaymentTotal` (number,null)
    This will track the total overpayment amount for the disability claim.

  - `overpaymentDeduction` (number,null)
    This will track the deduction amount for overpayments.

  - `overpaymentExCode` (string,null)
    This is the explanation code for the overpayment during the disability.

  - `paymentDuration` (integer,null)
    This will identify the duration of payments for the disability (e.g., Weekly, Monthly).

  - `processByDisabilityDate` (boolean)
    This will identify if the claim needs to be processed based on the disability date.

  - `disability_Date` (string,null)
    This identifies the actual disability date for this claim.

  - `diagnosticCodeType` (string,null)
    This identifies the diagnostic code type for this claim.

  - `preview` (boolean)
    This flag indicates if the options being sent will only product a list of payments in memory and not create them in the database.  Allows front-end to review their options before actually creating the payments.

  - `deductions` (array,null)
    This is the list of any deductions that will be applied to each payment.

  - `deductions.deductionType` (string,null)
    This is the deduction to be applied, this must be a valid value from the DeductionType table.

  - `deductions.deductionPct` (boolean)
    This indicates if the value in DeductionAmount is a Pct deduction.

  - `deductions.deductionAmount` (number,null)
    This is the amount of the Deduction.  If DeductionPct is true, then this value must be between 0 - 100.

  - `deductions.caseNumber` (string,null)
    This is the Case Number for the deduction.  Information only.

  - `deductions.thirdPartyPayment` (boolean)
    This indicates if the deduction should spawn a 3rd party payment which is a separate Professional claim for the deduction.

  - `deductions.providerID` (string,null)
    When ThirdPartyPayment is true, this is the ProviderID for the 3rd party payment.

  - `deductions.preTax` (boolean)
    This indicates if the deduction should be applied before taxes are calculated.

  - `deductions.preGross` (boolean)
    This indicates if the deduction should be applied before the gross amount is calculated.

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.description` (string,null)
    Used to give a description for this episode of care.

  - `data.sickTime` (boolean)
    This flag identifies that there is sick time during this disability.

  - `data.sickTimeFrom` (string,null)
    This is the begin date of the sick time payment.

  - `data.sickTimeThru` (string,null)
    This is the end date of the sick time payment.

  - `data.sickTimeExCode` (string,null)
    This is the explanation code that will be applied to the sick time payments during this disability.

  - `data.vacation` (boolean)
    This flag identifies that there is vacation during this disability.

  - `data.vacationFrom` (string,null)
    This is the begin date of the vacation payment.

  - `data.vacationThru` (string,null)
    This is the end date of the vacation payment.

  - `data.vacationExCode` (string,null)
    This is the explanation code that will be applied to the vacation payments during this disability.

  - `data.salaryContinuation` (boolean)
    This flag identifies that salary continuation is part of the payment during this disability.

  - `data.salaryContinuationFrom` (string,null)
    This is the begin date of the salary continuation payment.

  - `data.salaryContinuationThru` (string,null)
    This is the end date of the salary continuation payment.

  - `data.salaryContinuationExCode` (string,null)
    This is the explanation code that will be applied to the salary continuation payments during this disability.

  - `data.partialDisability` (boolean)
    This will identify if this is a partial disability payment.  Partial Disability payments have additional tax and payment rules applied during adjudication.

  - `data.partialDisabilityHours` (boolean)
    This flag will identify if there is partial disability hours involved during the claim.

  - `data.imageNumber` (string,null)

  - `data.imageNumber2` (string,null)

  - `data.imageNumber3` (string,null)

  - `data.imageNumber4` (string,null)

  - `data.receivedDate` (string,null)

  - `data.lastDayWorked` (string,null)

  - `data.diagnosis1` (string,null)
    This identifies the primary diagnosis for this disability.

  - `data.diagnosis2` (string,null)
    This identifies additional diagnosis for this disability.

  - `data.dateOfSurgery` (string,null)
    This identifies the date of surgery for disability due to surgery.

  - `data.waitingPeriod` (integer,null)
    This is the number of waiting period days that will be assigned to the waiting period payment on this disability.

  - `data.rollupWaitingPeriod` (boolean)
    This flag if set will create the Waiting Period in one claim.

  - `data.admitDate` (string,null)
    This identifies the date the member was admitted to the Hospital if hospitalized as part of this disability.

  - `data.applyExtension` (boolean)
    This will let the Disability Payment Creator know that the created payments need to have a reminder Ex Code applied to the final two payments.

  - `data.applyExtensionExCode` (string,null)
    This is the Ex Code that is applied to the final two payments created by the Disability Payment Creator if the Apply Extension option is selected.

  - `data.closureEffectiveDate` (string,null)
    This is an information only field that allows the tracking of the Closure Effective Date.

  - `data.dateFirstAttended` (string,null)
    This identifies the date the member first visited the Physician. This field, in combination with Disabled by Physician Date and Last Day Worked, create the Disability Date for the Member.

  - `data.disabledByPhysician` (string,null)
    This identifies the date the member was disabled by the Physician. This field, in combination with First Attended Physician Date and Last Day Worked, create the Disability Date for the Member.

  - `data.dob` (string,null)
    This is the Members Birth Date.

  - `data.duringEmployment` (boolean)
    Flag to identify if this disability happened while member was at work.

  - `data.surgery` (integer,null)
    Used to identify if surgery is involved in this disability.

  - `data.typeOfSurgery` (string,null)
    This is the procedure code of the surgery being performed for this disability.

  - `data.disabilityType` (string,null)
    This identifies the type of disability (Injury or Illness).

  - `data.typeOfDelivery` (string,null)
    This will identify the type of delivery that is performed as a result of pregnancy.

  - `data.numberOfPayments` (integer,null)
    This will identify the number of payments that will be involved during this claim.

  - `data.waiveWaitingPeriod` (boolean)
    This will identify whether the Waive Waiting Period option was selected.

  - `data.stateTax` (number,null)
    This will identify the state withhold amount for each payment. If tax calculation module is enabled, this option will be ignored.

  - `data.federalWithheld` (number,null)
    This will hold the amount for the Federal tax withheld from each payment.

  - `data.fica` (number,null)
    This will hold the FICA tax deduction for each payment.

  - `data.subscriberID` (string,null)
    This is the member’s unique system ID.

  - `data.memberSeq` (string,null)
    This is the member's sequence number.

  - `data.firstName` (string,null)
    This is the Members First Name.

  - `data.lastName` (string,null)
    This is the Members Last Name.

  - `data.groupID` (string,null)
    This is the Members Last Name.

  - `data.planID` (string,null)
    This will identify the plan under which this disability falls.

  - `data.planType` (string,null)
    This is the Plan Type associated with the Plan ID.

  - `data.planTypeLTD` (boolean)
    This is the Plan Type identifier for Long Term Disability.

  - `data.exceedReturnToWork` (boolean)
    This will be the Exceed Return To Work flag associated with the case.

  - `data.exceedMax` (boolean)
    This will indicate if max exceeded in disability payment creation.

  - `data.followupDate` (string,null)
    This will be the date the case is being followed up on.

  - `data.followupExCode` (string,null)
    This will identify the follow-up ExCode to be used.

  - `data.includeReturnToWork` (boolean)
    This will identify if the claim should include return to work.

  - `data.scd` (boolean)
    This is an SCD Payment identifier.

  - `data.paymentInterval` (integer,null)
    This identifies the payment interval for the disability claim (e.g., 5-day, 7-day, Monthly).

  - `data.surgeryExCode` (string,null)
    This is the explanation code attached to the surgery payments during this disability claim.

  - `data.jobType` (string,null)
    This will indicate the type of job associated with the disability (e.g., Sedentary, Light, Medium, Heavy).

  - `data.waitingPeriodExCode` (string,null)
    This is the explanation code applied to the waiting period payment for this disability.

  - `data.includeWaitingPeriod` (boolean)
    This will identify if the claim includes waiting period coverage.

  - `data.maxDisability` (integer,null)
    This will identify the maximum amount of disability payments for this claim.

  - `data.includeInMax` (boolean)
    This flag indicates if the waiting period is included in the maximum disability calculation.

  - `data.firstDayHospital` (boolean)
    This flag identifies if the first day in the hospital is included in the disability coverage.

  - `data.liabilityInjury` (boolean)
    This flag identifies if the injury was due to liability.

  - `data.pay_To` (string,null)

  - `data.mail_To` (string,null)

  - `data.exCode` (string,null)

  - `data.hospitalized` (boolean)

  - `data.pregnancy` (boolean)
    This flag identifies if the disability is related to pregnancy.

  - `data.dischargeDate` (string,null)
    This identifies the date of discharge from the hospital.

  - `data.expectedTypicalDuration` (integer,null)
    This identifies the expected typical duration of the disability.

  - `data.dateOfDelivery` (string,null)
    This identifies the date of the delivery for pregnancy-related disability.

  - `data.returnToWork` (string,null)
    This identifies the date the employee returned to work after the disability.

  - `data.ltdEffectiveDate` (string,null)
    This identifies the date the long-term disability becomes effective.

  - `data.ltdPacketDate` (string,null)
    This identifies the date the long-term disability packet was sent.

  - `data.depSSDIEndDate` (string,null)
    This identifies the end date for dependent SSDI coverage.

  - `data.lastPhysicianWarrantDate` (string,null)
    This identifies the last warrant date for the physician for this claim.

  - `data.exhaustDate` (string,null)
    This identifies the exhaustion date for the disability claim.

  - `data.physicianReturnToWork` (string,null)
    This is the Return to Work date identified by the Physician at the start of disability.This may or may not be the actual date the member returns to work.

  - `data.disabilityPayThroughDay` (integer,null)
    This identifies the disability pay-through day for this claim.

  - `data.overpaymentTotal` (number,null)
    This will track the total overpayment amount for the disability claim.

  - `data.overpaymentDeduction` (number,null)
    This will track the deduction amount for overpayments.

  - `data.overpaymentExCode` (string,null)
    This is the explanation code for the overpayment during the disability.

  - `data.paymentDuration` (integer,null)
    This will identify the duration of payments for the disability (e.g., Weekly, Monthly).

  - `data.processByDisabilityDate` (boolean)
    This will identify if the claim needs to be processed based on the disability date.

  - `data.disability_Date` (string,null)
    This identifies the actual disability date for this claim.

  - `data.diagnosticCodeType` (string,null)
    This identifies the diagnostic code type for this claim.

  - `data.preview` (boolean)
    This flag indicates if the options being sent will only product a list of payments in memory and not create them in the database.  Allows front-end to review their options before actually creating the payments.

  - `data.deductions` (array,null)
    This is the list of any deductions that will be applied to each payment.

  - `data.deductions.deductionType` (string,null)
    This is the deduction to be applied, this must be a valid value from the DeductionType table.

  - `data.deductions.deductionPct` (boolean)
    This indicates if the value in DeductionAmount is a Pct deduction.

  - `data.deductions.deductionAmount` (number,null)
    This is the amount of the Deduction.  If DeductionPct is true, then this value must be between 0 - 100.

  - `data.deductions.caseNumber` (string,null)
    This is the Case Number for the deduction.  Information only.

  - `data.deductions.thirdPartyPayment` (boolean)
    This indicates if the deduction should spawn a 3rd party payment which is a separate Professional claim for the deduction.

  - `data.deductions.providerID` (string,null)
    When ThirdPartyPayment is true, this is the ProviderID for the 3rd party payment.

  - `data.deductions.preTax` (boolean)
    This indicates if the deduction should be applied before taxes are calculated.

  - `data.deductions.preGross` (boolean)
    This indicates if the deduction should be applied before the gross amount is calculated.

  - `error` (object)

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

  - `error.instance` (string,null)
    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,null)
    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,null)
    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 fields