Create Reversal

POST

https://api.fortresstech.io/v1/transactions/:transactionId/reversal

POST

/v1/transactions/:transactionId/reversal

curl -X POST https://api.fortresstech.io/v1/transactions/transactionId/reversal \
     -H "x-api-key: <apiKey>"

200Successful

{
  "amount": 1.1,
  "method": "string",
  "householdId": "string",
  "customerId": "string",
  "date": "2024-01-15T09:30:00Z",
  "note": "string",
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "transactionId": "string",
  "organizationId": "string",
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "string",
    "currentLeaseId": "string",
    "applicationId": "string",
    "organizationId": "string",
    "propertyId": "string",
    "currentCertificationId": "string",
    "prospectId": "string",
    "primaryCustomerId": "string",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "string"
  },
  "customer": {
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "preferredName": "string",
    "suffix": "string",
    "birthDate": "2023-01-15",
    "status": "APPLICANT",
    "email": "string",
    "phone": "string",
    "gender": "string",
    "headOfHousehold": true,
    "relationship": "PARTNER",
    "passportNumberLastFour": "string",
    "passportCountry": "string",
    "alienRegistrationNumberLastFour": "string",
    "citizenshipStatus": "string",
    "maritalStatus": "string",
    "spouseName": "string",
    "studentType": "string",
    "currentAddressStreet": "string",
    "currentAddressStreet2": "string",
    "currentAddressCity": "string",
    "currentAddressState": "string",
    "currentAddressZipCode": "string",
    "lenderName": "string",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "householdId": "string",
    "propertyId": "string",
    "organizationId": "string"
  },
  "transaction": {
    "id": "string",
    "readableId": "string",
    "customerId": "string",
    "householdId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "depositId": "string",
    "date": "2024-01-15T09:30:00Z",
    "amount": 1.1,
    "note": "string",
    "code": "string",
    "subjournal": "RESIDENT",
    "ledger": "RESIDENT",
    "fiscalPeriod": "string",
    "isPaid": true,
    "type": "CREDIT",
    "reversedTransactionId": "string",
    "runningBalanceAmount": 1.1,
    "paymentDate": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z"
  }
}

Create a reversal

Authentication

x-api-keystring

API Key authentication via header

Path parameters

transactionIdstringRequired

The id of the transaction you want to reverse

Response

The created reversal

amountdouble

methodstring

householdIdstringformat: "uuid"

customerIdstringformat: "uuid"

datedatetimeOptional

notestringOptional

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

transactionIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

householdobjectOptional

customerobjectOptional

transactionobjectOptional