Read Reversal

1 curl -G https://api.fortresstech.io/v1/transactions/transactionId/reversal \ 2 --data-urlencode fields=id,name,property.*,documents.type

1 { 2 "amount": 1.1, 3 "customerId": "customerId", 4 "householdId": "householdId", 5 "method": "method", 6 "createdAt": "2024-01-15T09:30:00Z", 7 "customer": { 8 "firstName": "firstName", 9 "middleName": "middleName", 10 "lastName": "lastName", 11 "preferredName": "preferredName", 12 "suffix": "suffix", 13 "birthDate": "birthDate", 14 "status": "APPLICANT", 15 "email": "email", 16 "phone": "phone", 17 "gender": "gender", 18 "headOfHousehold": true, 19 "relationship": "PARTNER", 20 "id": "id", 21 "readableId": "readableId", 22 "idempotencyId": "idempotencyId", 23 "createdAt": "2024-01-15T09:30:00Z", 24 "updatedAt": "2024-01-15T09:30:00Z", 25 "deletedAt": "2024-01-15T09:30:00Z", 26 "householdId": "householdId", 27 "propertyId": "propertyId", 28 "organizationId": "organizationId" 29 }, 30 "date": "2024-01-15T09:30:00Z", 31 "deletedAt": "2024-01-15T09:30:00Z", 32 "household": { 33 "status": "APPLICANT", 34 "isUnderEviction": true, 35 "id": "id", 36 "readableId": "readableId", 37 "idempotencyId": "idempotencyId", 38 "createdAt": "2024-01-15T09:30:00Z", 39 "updatedAt": "2024-01-15T09:30:00Z", 40 "deletedAt": "2024-01-15T09:30:00Z", 41 "currentUnitId": "currentUnitId", 42 "currentLeaseId": "currentLeaseId", 43 "applicationId": "applicationId", 44 "organizationId": "organizationId", 45 "propertyId": "propertyId", 46 "currentCertificationId": "currentCertificationId", 47 "prospectId": "prospectId", 48 "primaryCustomerId": "primaryCustomerId", 49 "totalActiveRentAmount": 1.1, 50 "totalActiveSubsidyAmount": 1.1, 51 "totalActiveFeesAmount": 1.1, 52 "unitId": "unitId" 53 }, 54 "id": "id", 55 "idempotencyId": "idempotencyId", 56 "note": "note", 57 "organizationId": "organizationId", 58 "readableId": "readableId", 59 "transaction": { 60 "id": "id", 61 "readableId": "readableId", 62 "customerId": "customerId", 63 "householdId": "householdId", 64 "propertyId": "propertyId", 65 "organizationId": "organizationId", 66 "depositId": "depositId", 67 "date": "2024-01-15T09:30:00Z", 68 "amount": 1.1, 69 "note": "note", 70 "code": "code", 71 "subjournal": "RESIDENT", 72 "ledger": "RESIDENT", 73 "fiscalPeriod": "fiscalPeriod", 74 "isPaid": true, 75 "type": "CREDIT", 76 "reversedTransactionId": "reversedTransactionId", 77 "runningBalanceAmount": 1.1, 78 "paymentDate": "2024-01-15T09:30:00Z", 79 "createdAt": "2024-01-15T09:30:00Z", 80 "updatedAt": "2024-01-15T09:30:00Z", 81 "deletedAt": "2024-01-15T09:30:00Z" 82 }, 83 "transactionId": "transactionId", 84 "updatedAt": "2024-01-15T09:30:00Z" 85 }

Info for a specific reversal

Path parameters

transactionIdstringRequired

The id of the property

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"

Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request

amountdouble

customerIdstringformat: "uuid"

householdIdstringformat: "uuid"

methodstring

createdAtdatetime or null

customerobject or null

datedatetime or null

deletedAtdatetime or null

householdobject or null

idstring or nullformat: "uuid"

idempotencyIdstring or nullformat: "uuid"

notestring or null

organizationIdstring or nullformat: "uuid"

readableIdstring or null

transactionobject or null

transactionIdstring or nullformat: "uuid"

updatedAtdatetime or null