Skip to navigation
API ReferenceDeductions

Read Deduction

Info for a specific deduction

Authentication

x-api-keystring
API Key authentication via header

Path parameters

deductionIdstringRequired
The id of the deduction

Response

Expected response to a valid request
typeenumOptional

The deduction category. CHILDCARE_FOR_WORK: childcare that lets a household member work. CHILDCARE_FOR_SCHOOL: childcare that lets a household member attend school or look for work. MEDICAL: out-of-pocket medical expenses. DISABILITY: out-of-pocket disability assistance expenses.

Allowed values:
annualAmountdoubleOptional
Annual amount of the expense, in USD
idstringOptionalformat: "uuid"

Fortress replaces a certification’s deduction records each time they are saved, so this id changes on every edit and no field identifies one entry across edits (a member can have several entries of the same type). Do not store it: re-read a certification’s deductions by certificationId and add up annualAmount per applicantId and type.

readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
applicantIdstringOptionalformat: "uuid"

The household member the deduction belongs to: the id of the member’s applicant record on the application, set for adults and minors alike. This is not the same value as applicantId on applications, which holds the head of household’s customer id.

customerIdstringOptionalformat: "uuid"

The customer id of the household member. Set for adults only; null for minors, who have no customer record.

householdIdstringOptionalformat: "uuid"
applicationIdstringOptionalformat: "uuid"
certificationIdstringOptionalformat: "uuid"
The certification the deduction was recorded on
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
customerobjectOptional
householdobjectOptional
applicationobjectOptional
certificationobjectOptional
propertyobjectOptional