PUT /v1/:facility_id/ledgers/:ledger_id/update_autopay
Update autopay information for a ledger
Params
| Param name | Description |
|---|---|
|
ledger_id
required |
Validations:
|
|
autopay
optional |
Validations:
|
|
autopay[autopay_enabled]
optional |
Validations:
|
|
autopay[autopay_day]
optional |
Validations:
|
|
payment_method
required |
Can accept a paymentmethodid, or fields for CC or ACH payments Validations:
|
|
payment_method[payment_method_id]
optional |
If you want to use an existing payment method, pass in the id Validations:
|
|
payment_method[first_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[last_name]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[kind]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[reuseable]
optional |
Validations:
|
|
payment_method[magnetic_track]
optional |
Required if using a card swipe Validations:
|
|
payment_method[card_number]
optional |
Required if using a credit card Validations:
|
|
payment_method[card_type]
optional |
Required if using a credit card Validations:
|
|
payment_method[security_code]
optional |
Required if using a credit card Validations:
|
|
payment_method[expiration_date]
optional |
Required if using a credit card. Format: MM/YY Validations:
|
|
payment_method[account_number]
optional |
Required if using ACH Validations:
|
|
payment_method[account_number_confirmation]
optional |
Required if using ACH Validations:
|
|
payment_method[account_type]
optional |
Required if using ACH Validations:
|
|
payment_method[bank_name]
optional |
Required if using ACH Validations:
|
|
payment_method[routing_number]
optional |
Required if using ACH Validations:
|
|
payment_method[billing_address_attributes]
optional |
Required if not using an existing payment method Validations:
|
|
payment_method[billing_address_attributes][company]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address1]
optional |
Validations:
|
|
payment_method[billing_address_attributes][address2]
optional |
Validations:
|
|
payment_method[billing_address_attributes][city]
optional |
Validations:
|
|
payment_method[billing_address_attributes][postal]
optional |
Validations:
|
|
payment_method[billing_address_attributes][state]
optional |
Validations:
|
|
payment_method[check_number]
optional |
Required if using Check Validations:
|
|
payment_method[name_on_check]
optional |
Required if using Check Validations:
|
|
payment_method[check_amount]
optional |
Required if using Check Validations:
|
|
payment_method[reference_number]
optional |
Required if using Money Order Validations:
|
|
payment_method[money_order_amount]
optional |
Required if using Money Order Validations:
|
|
payment_method[amount_tendered]
optional |
Required if using Cash Validations:
|
Examples
PUT /v1/ee21ec72-af81-4063-9955-6fed098a3b28/ledgers/1cd4414e-2ddd-4cab-90bd-a0fda1acd63a/update_autopay
{
"autopay": {
"autopay_enabled": true,
"autopay_day": 6
},
"payment_method": {
"payment_method_id": "2f81857d-36e6-47cd-870c-3fb851594230"
},
"ledger": {}
}
200
{
"ledger": {
"id": "1cd4414e-2ddd-4cab-90bd-a0fda1acd63a",
"active": true,
"autopay_enabled": true,
"autopay_info": {
"autopay_enabled": true,
"day": 6,
"next_autopay_date": "2023-10-06",
"payment_method_id": "2f81857d-36e6-47cd-870c-3fb851594230",
"payment_type": "credit_card",
"account_or_card_number": "****1234"
},
"closed_on": null,
"current_account_balance": 72.95,
"current_insurance": {
"premium": 24.35,
"description": "Bader Program - $4,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": null,
"invoice_day_of_month": 13,
"lease_number": 1694788750,
"length_of_stay_in_months": 0,
"moved_in_at": "2023-09-15T04:38:39.990-10:00",
"next_charge_amount": 72.95,
"next_charge_amount_by_ledger": 72.95,
"next_charge_date": "2023-10-13",
"paid_through": "2023-09-12",
"rate_last_changed_on": "2023-09-15T04:38:39.990-10:00",
"rate_per_square_foot": 0.2,
"recent_open_charges": [
{
"id": "e639a0ad-021c-4d96-b7e0-db2bda8f9b78",
"description": "Rent Unit U100 - 10x6x4",
"code": null,
"internal_code": "4000",
"resolved": false,
"amount": 13.13,
"tax_amount": 1.13,
"amount_leftover": 13.13,
"effective_on": "2023-09-15T04:38:40.918-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "f1d2e99a-ac96-46fc-adca-8ba2a71fc70a"
},
{
"id": "24010f12-0ce3-4f38-8c04-6012dfea0ab3",
"description": "Bader Program - $4,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 24.35,
"tax_amount": 0.0,
"amount_leftover": 24.35,
"effective_on": "2023-09-15T04:38:40.918-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "3bedcad2-632f-4fa0-b384-738e6aa051d5"
},
{
"id": "916e71bf-c400-4c58-b079-97dcfd1d9266",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 35.47,
"tax_amount": 0.0,
"amount_leftover": 35.47,
"effective_on": "2023-09-15T04:38:40.918-10:00",
"service_start_date": "2023-09-13",
"service_end_date": "2023-10-12",
"accountable_id": "7fdd2846-6f31-4305-8a13-0fe7ba48ee17"
}
],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"storage_items": [],
"tenant": {
"id": "cce070b6-14f5-46e0-8f51-14ce7bf11d7d",
"account_number": 1000000,
"first_name": "Eric146",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"1cd4414e-2ddd-4cab-90bd-a0fda1acd63a"
],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": "username_146",
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2023-09-15T04:38:39.869-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "b5d94b8d-a0aa-4116-b040-1bab20ea9bb1",
"primary": true,
"source": null,
"number": "+16419060003",
"formatted_number": "(641) 906-0003 x 2637",
"extension": "2637",
"label": "Other",
"unformatted_number": "6419060003",
"sms_opt_in": false
},
{
"id": "859fcc6f-1635-4ffd-8821-d0207892f16f",
"primary": false,
"source": null,
"number": "+12523123913",
"formatted_number": "(252) 312-3913",
"extension": null,
"label": "Mobile",
"unformatted_number": "2523123913",
"sms_opt_in": false
},
{
"id": "1bd1a286-7718-474c-84c5-61d0533ddc18",
"primary": false,
"source": null,
"number": "+14798567941",
"formatted_number": "(479) 856-7941 x 1256",
"extension": "1256",
"label": "Other",
"unformatted_number": "4798567941",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "926991a9-1939-40ba-8352-2af2017c74a2",
"address1": "963700 Feest Key",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "963700 Feest Key, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "926991a9-1939-40ba-8352-2af2017c74a2",
"address1": "963700 Feest Key",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "963700 Feest Key, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "ee21ec72-af81-4063-9955-6fed098a3b28",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"eba4547a-7dbf-495c-8a12-754796fb8b80",
"f0aa5586-8663-4c6c-b57b-5cc7b6174f4f"
],
"password_recovery_question_ids": [
"94c4b1e1-a2d6-46e1-a41d-d8c97340b49c",
"1096fa72-ab14-4f16-9478-71f1f8af593f"
]
},
"unit": {
"id": "6059c32c-e245-43ad-b31d-07a8eea78c7b",
"price": 764.95,
"name": "U100",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 4.0,
"door_height": 10.0,
"door_width": 1.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x4",
"area": 60.0,
"standard_rate": 764.95,
"managed_rate": null,
"tiered_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "occupied",
"payment_status": "current",
"current_ledger_id": "1cd4414e-2ddd-4cab-90bd-a0fda1acd63a",
"current_tenant_id": "cce070b6-14f5-46e0-8f51-14ce7bf11d7d",
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": false,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "0c92705c-fac1-49b0-bdca-31fdefa24ff9",
"name": "Unit Type 129",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "552608f1-e78a-4449-9a69-d7bbf27eaf9d"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "ee21ec72-af81-4063-9955-6fed098a3b28"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"autopay": {
"autopay_enabled": true,
"autopay_day": 6
},
"payment_method": {
"payment_method_id": "2f81857d-36e6-47cd-870c-3fb851594230"
},
"facility_id": "ee21ec72-af81-4063-9955-6fed098a3b28",
"ledger_id": "1cd4414e-2ddd-4cab-90bd-a0fda1acd63a",
"ledger": {}
}
}
}