PUT /v1/:facility_id/ledgers/:ledger_id/update_autopay
Update autopay information for a ledger
Examples
PUT /v1/529128f5-e281-454a-8d78-8d3397bad8f9/ledgers/f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9/update_autopay
{
"autopay": {
"autopay_day": "6",
"autopay_enabled": "true"
},
"payment_method": {
"payment_method_id": "e7726789-0395-4a9a-8372-23cf36e8f1df"
}
}
200
{
"ledger": {
"id": "f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9",
"active": true,
"autopay_info": {
"autopay_enabled": true,
"day": 6,
"next_autopay_date": "2022-10-06",
"payment_method_id": "e7726789-0395-4a9a-8372-23cf36e8f1df",
"payment_type": "credit_card",
"account_or_card_number": "****1234"
},
"closed_on": null,
"current_account_balance": 63.67,
"current_insurance": {
"premium": 31.15,
"description": "Bader Program - $38,000.00"
},
"current_prepay_balance": 0.0,
"current_rate": 12.0,
"delinquent": false,
"gate_access_code": "672365",
"invoice_day_of_month": 10,
"lease_number": 1663058212,
"length_of_stay_in_months": 1,
"moved_in_at": "2022-09-12T22:36:36.287-10:00",
"next_charge_amount": 63.67,
"next_charge_amount_by_ledger": 63.67,
"next_charge_date": "2022-10-10",
"paid_through": "2022-09-09",
"rate_last_changed_on": "2022-09-12T22:36:36.288-10:00",
"rate_per_square_foot": 0.3,
"recent_open_charges": [
{
"id": "3a911cda-6dbc-4a4a-a0db-35e3ef6cbed5",
"description": "Rent Unit U27 - 8x5x7",
"code": null,
"internal_code": "4000",
"resolved": false,
"amount": 13.13,
"tax_amount": 1.13,
"amount_leftover": 13.13,
"effective_on": "2022-09-12T22:36:36.585-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "e98eb631-5b7d-404b-baae-a21aae9f8dd0"
},
{
"id": "a4dcf442-e00e-4c9d-89dc-d9a5e79694b8",
"description": "Bader Program - $38,000.00",
"code": null,
"internal_code": "4100",
"resolved": false,
"amount": 31.15,
"tax_amount": 0.0,
"amount_leftover": 31.15,
"effective_on": "2022-09-12T22:36:36.585-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "875ef720-9828-4971-b7cb-6e9a23b38998"
},
{
"id": "915e8454-9af7-4d4d-b6b4-2b0bdd6cac94",
"description": "Some service item",
"code": null,
"internal_code": "4150",
"resolved": false,
"amount": 19.39,
"tax_amount": 0.0,
"amount_leftover": 19.39,
"effective_on": "2022-09-12T22:36:36.585-10:00",
"service_start_date": "2022-09-10",
"service_end_date": "2022-10-09",
"accountable_id": "50a779eb-cf86-43dc-89b5-5453985ae19e"
}
],
"recent_payments": [],
"scheduled_move_out": null,
"scheduled_rate_change": null,
"scheduled_transfer": null,
"manage_revenue": "automatic",
"rate_increase_exempt": false,
"tenant": {
"id": "261589c3-85f9-47a4-8e62-55430f9d171d",
"account_number": 1000000,
"first_name": "Shannon34",
"last_name": "Wehner",
"middle_initial": null,
"email": "tamishabalistreri@krajcik.net34",
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [
"f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9"
],
"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_34",
"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": "2022-09-12T22:36:36.221-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "5c338681-bb3d-4928-86a1-ee8c80ee15e5",
"primary": true,
"source": null,
"number": "+18577634969",
"formatted_number": "(857) 763-4969 x 4825",
"extension": "4825",
"label": "Work",
"unformatted_number": "8577634969",
"sms_opt_in": false
},
{
"id": "136acec5-7bf7-450b-b473-2460e1e695e6",
"primary": false,
"source": null,
"number": "+18709016419",
"formatted_number": "(870) 901-6419 x 8422",
"extension": "8422",
"label": "Work",
"unformatted_number": "8709016419",
"sms_opt_in": false
},
{
"id": "532fc321-07b8-4180-855f-ce5c929fc93e",
"primary": false,
"source": null,
"number": "+18437272964",
"formatted_number": "(843) 727-2964 x 3301",
"extension": "3301",
"label": "Mobile",
"unformatted_number": "8437272964",
"sms_opt_in": false
}
],
"mailing_address": {
"id": "1f201c9f-b24a-47a0-9a3e-52751345ba8f",
"address1": "270707 Glenn Underpass",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "270707 Glenn Underpass, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "1f201c9f-b24a-47a0-9a3e-52751345ba8f",
"address1": "270707 Glenn Underpass",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "270707 Glenn Underpass, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "529128f5-e281-454a-8d78-8d3397bad8f9",
"previous_ledger_ids": [],
"lead_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"957d45c9-0c8d-4767-8991-59e13965f1e4",
"8d76430a-8286-4cbc-a68a-622306db7b0a"
],
"password_recovery_question_ids": [
"cfb616c0-26f7-48c4-8b76-f8176c5839d5",
"3c1ba298-3cfc-4fb2-86c5-1589cf8f78be"
]
},
"unit": {
"id": "7b1d79e8-3677-4677-a85a-f83d6d02c18a",
"price": 847.75,
"name": "U27",
"description": "",
"width": 8.0,
"length": 5.0,
"height": 7.0,
"door_height": 10.0,
"door_width": 2.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "8x5x7",
"area": 40.0,
"standard_rate": 847.75,
"managed_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "occupied",
"payment_status": "current",
"current_ledger_id": "f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9",
"current_tenant_id": "261589c3-85f9-47a4-8e62-55430f9d171d",
"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,
"tiering": {
"cross_sell_group_id": 1950,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "2f5d1494-22fd-4e00-b564-0daec26b533a",
"name": "Unit Type 27",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "f67e7317-0abe-4190-8a79-deb84a086830"
},
"alternate_contact_assignment_id": null,
"auction_id": null,
"facility_id": "529128f5-e281-454a-8d78-8d3397bad8f9"
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"autopay": {
"autopay_day": "6",
"autopay_enabled": "true"
},
"payment_method": {
"payment_method_id": "e7726789-0395-4a9a-8372-23cf36e8f1df"
},
"facility_id": "529128f5-e281-454a-8d78-8d3397bad8f9",
"ledger_id": "f3a5d3cb-6ed9-4426-9e75-34c9c771f5a9"
}
}
}
Params
| Param name | Description |
|---|---|
|
ledger_id required |
Value: Must be a String |
|
autopay optional |
Value: Must be a Hash |
|
autopay[autopay_enabled] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
autopay[autopay_day] optional |
Value: Must be a String |
|
payment_method required |
Can accept a paymentmethodid, or fields for CC or ACH payments Value: Must be a Hash |
|
payment_method[payment_method_id] optional |
If you want to use an existing payment method, pass in the id Value: Must be a String |
|
payment_method[first_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[last_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
payment_method[kind] optional |
Required if not using an existing payment method Value: Must be one of: <code>ach</code>, <code>credit_card</code>, <code>check</code>, <code>cash</code>, <code>card_swipe</code>. |
|
payment_method[reuseable] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
payment_method[magnetic_track] optional |
Required if using a card swipe Value: Must be a String |
|
payment_method[card_number] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[card_type] optional |
Required if using a credit card Value: Must be one of: <code>visa</code>, <code>mastercard</code>, <code>american_express</code>, <code>diners</code>, <code>discover</code>, <code>jcb</code>. |
|
payment_method[security_code] optional |
Required if using a credit card Value: Must be a String |
|
payment_method[expiration_date] optional |
Required if using a credit card. Format: MM/YY Value: Must be a String |
|
payment_method[account_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_number_confirmation] optional |
Required if using ACH Value: Must be a String |
|
payment_method[account_type] optional |
Required if using ACH Value: Must be a String |
|
payment_method[bank_name] optional |
Required if using ACH Value: Must be a String |
|
payment_method[routing_number] optional |
Required if using ACH Value: Must be a String |
|
payment_method[billing_address_attributes] optional |
Required if not using an existing payment method Value: Must be a Hash |
|
payment_method[billing_address_attributes][company] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address1] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][address2] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][city] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][postal] optional |
Value: Must be a String |
|
payment_method[billing_address_attributes][state] optional |
Value: Must be a String |
|
payment_method[check_number] optional |
Required if using Check Value: Must be a String |
|
payment_method[name_on_check] optional |
Required if using Check Value: Must be a String |
|
payment_method[check_amount] optional |
Required if using Check Value: Must be a String |
|
payment_method[reference_number] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[money_order_amount] optional |
Required if using Money Order Value: Must be a String |
|
payment_method[amount_tendered] optional |
Required if using Cash Value: Must be a String |