Delete Scheduled Transaction

{
  "amount": 1.1,
  "code": "code",
  "type": "PAYMENT",
  "createdAt": "2024-01-15T09:30:00Z",
  "customer": {
    "firstName": "firstName",
    "middleName": "middleName",
    "lastName": "lastName",
    "preferredName": "preferredName",
    "suffix": "suffix",
    "birthDate": "birthDate",
    "status": "APPLICANT",
    "email": "email",
    "phone": "phone",
    "gender": "gender",
    "headOfHousehold": true,
    "relationship": "PARTNER",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "householdId": "householdId",
    "propertyId": "propertyId",
    "organizationId": "organizationId"
  },
  "deletedAt": "2024-01-15T09:30:00Z",
  "description": "description",
  "endDate": "endDate",
  "frequency": "DAILY",
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "currentUnitId",
    "currentLeaseId": "currentLeaseId",
    "applicationId": "applicationId",
    "organizationId": "organizationId",
    "propertyId": "propertyId",
    "currentCertificationId": "currentCertificationId",
    "prospectId": "prospectId",
    "primaryCustomerId": "primaryCustomerId",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "unitId"
  },
  "householdId": "householdId",
  "id": "id",
  "idempotencyId": "idempotencyId",
  "lease": {
    "startDate": "startDate",
    "endDate": "endDate",
    "moveInDate": "moveInDate",
    "moveOutDate": "moveOutDate",
    "rentAmount": 1.1,
    "leasedRent": 1.1,
    "securityDepositAmount": 1.1,
    "makeReadyDate": "makeReadyDate",
    "turnMoveOutDays": 1,
    "documentId": "documentId",
    "moveOutId": "moveOutId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "propertyId": "propertyId",
    "unitId": "unitId",
    "householdId": "householdId",
    "organizationId": "organizationId"
  },
  "leaseId": "leaseId",
  "ledger": "OPERATING",
  "note": "note",
  "notes": "notes",
  "organizationId": "organizationId",
  "property": {
    "name": "name",
    "shortName": "shortName",
    "email": "email",
    "phone": "phone",
    "physicalStreetAddress1": "physicalStreetAddress1",
    "physicalStreetAddress2": "physicalStreetAddress2",
    "physicalCity": "physicalCity",
    "physicalState": "physicalState",
    "physicalZip": "physicalZip",
    "physicalCountry": "physicalCountry",
    "mailingStreetAddress1": "mailingStreetAddress1",
    "mailingStreetAddress2": "mailingStreetAddress2",
    "mailingCity": "mailingCity",
    "mailingState": "mailingState",
    "mailingZip": "mailingZip",
    "mailingCountry": "mailingCountry",
    "phoneNumber": "phoneNumber",
    "faxNumber": "faxNumber",
    "timezone": "timezone",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "organizationId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "countyName",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "propertyId": "propertyId",
  "startDate": "startDate",
  "subledger": "RESIDENT",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Available by Request

Cancel a scheduled transaction, preventing it from being automatically processed. This is useful when recurring charges need to be stopped or one-time scheduled payments are no longer needed.

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

<Badge>Available by Request</Badge> Cancel a scheduled transaction, preventing it from being automatically processed. This is useful when recurring charges need to be stopped or one-time scheduled payments are no longer needed. <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

scheduledTransactionIdstringRequired

The id of the scheduled transaction

Response

Expected response to a valid request

amountdouble

codestring

typeenum

createdAtdatetimeOptional

customerobjectOptional

deletedAtdatetimeOptional

descriptionstringOptional

endDatestringOptionalformat: "date"

frequencyenumOptional

The frequency of the scheduled transaction

householdobjectOptional

householdIdstringOptionalformat: "uuid"

idstringOptionalformat: "uuid"

idempotencyIdstringOptionalformat: "uuid"

leaseobjectOptional

leaseIdstringOptionalformat: "uuid"

ledgerenumOptionalDefaults to OPERATING

notestringOptional

Note on the scheduled transaction

notesstringOptional

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

propertyIdstringOptionalformat: "uuid"

startDatestringOptionalformat: "date"

subledgerenumOptionalDefaults to RESIDENT

updatedAtdatetimeOptional