Invoiceable items include fees, retail items, insurance and services.
*A facility has the option to disable tenants from making payments, in the event this has been applied and the tenant has been provided in the parameters, a tenant will not be able to make a payment via the API calls listed here.
GET /v1/729da653-1650-4207-a990-623b48e47e6c/invoiceable_items 200 { "invoiceable_items": [ { "id": "b2a56988-9e4c-46f4-a922-3f3b02f6c710", "product_code": "ADMIN_FEE", "kind": "fee", "description": "Administrative Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "b4b75a21-f48e-441b-aeb5-15bfa53112a6", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "a78ea097-80d4-4197-8e21-952d4884333c", "product_code": "CALIFORNIA_FEE_SCHEDULE", "kind": "fee", "description": "California Fee Schedule", "required_at_move_in": false, "required_at_transfer": false, "amount": "Variable", "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "5a609ee4-8d1d-48ea-ac49-801abe58eb9b", "amount": 10.0, "kind": "amount", "limit": 60.0 }, { "id": "bfa4b48d-e1d6-4caa-a5bf-7b5b9510a59f", "amount": 15.0, "kind": "amount", "limit": 99.99 }, { "id": "3f39a276-f018-442b-a43b-30928b91cf06", "amount": 20.0, "kind": "amount", "limit": 133.0 }, { "id": "67df2d04-c0af-4af7-9eb2-383b7ebfebda", "amount": 15.0, "kind": "percent", "limit": null } ] }, { "id": "4cfb4999-a0ac-494c-9ff8-f98cf94855e9", "product_code": "EARLY_TERMINATION_FEE", "kind": "fee", "description": "Early Termination Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "c9e8df3b-06df-4662-8db1-a7b8687104bc", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "bd9b0774-828c-4495-9e81-8bf1d031fa47", "product_code": "FEE_CHARGEBACK", "kind": "fee", "description": "Chargeback Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 20.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 20.0, "invoiceable_amounts": [ { "id": "581353f5-1bfc-4915-88e1-59d981b1a949", "amount": 20.0, "kind": "amount", "limit": null } ] }, { "id": "2513566d-40da-4a83-b622-9bc48ccc50fb", "product_code": "FEE_NSF", "kind": "fee", "description": "NSF Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 30.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 30.0, "invoiceable_amounts": [ { "id": "19c60f19-b3df-43f5-b296-e97e5647f868", "amount": 30.0, "kind": "amount", "limit": null } ] }, { "id": "eea6981f-c1e7-44d0-9c9c-f9617ecd7bc4", "product_code": "INVOICE_FEE", "kind": "fee", "description": "Invoice Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "df9f4571-df23-45d2-816f-c4a557b8270f", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "4a6ff8d2-7884-40b3-89a8-81111d39d0f9", "product_code": "MOVE_OUT", "kind": "fee", "description": "Move Out Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "fd9bf617-4e11-4722-b56d-25c2075ae0ac", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "72e20d38-455c-414c-b4fc-dfde6ce8b1ab", "product_code": "ONLINE_PAYMENT", "kind": "fee", "description": "Online Payment Convenience Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "53d53630-d0dd-4441-b1ed-2977b05a46fb", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "4980f226-4f16-4a74-87e8-8a56eb4a2edd", "product_code": "SECURITY_DEPOSIT", "kind": "fee", "description": "Security Deposit", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "6077d017-93a9-4f43-94c6-7e94ae86be68", "amount": 0.0, "kind": "amount", "limit": null } ] } ], "meta": { "pagination": { "current_page": 1, "total_pages": 1, "per_page": 100, "total_entries": 9, "previous_page": null, "next_page": null }, "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "GET", "request_id": null, "parameters": { "facility_id": "729da653-1650-4207-a990-623b48e47e6c" } } }
GET /v1/f25b935b-8190-45b0-80ce-d5ce1fac2235/invoiceable_items/insurance 200 { "invoiceable_items": [ { "id": "c3e802e8-c67a-47b5-8e01-8c651ab2bb78", "product_code": "MINICO-1", "kind": "insurance", "description": "MiniCo Insurance Agency, LLC - $130.50", "required_at_move_in": false, "required_at_transfer": false, "amount": 15.76, "short_description": null, "show_in_sales_center": true, "tax_total": 0.0, "total": 15.76, "coverage_amount": 130.5, "coverage_percentage": 70, "provider_name": "MiniCo Insurance Agency, LLC", "provider_key": "minico", "invoiceable_amounts": [ { "id": "fb252244-37fa-44e3-9e86-4fd3932b3a35", "amount": 15.76, "kind": "amount", "limit": null } ] } ], "meta": { "pagination": { "current_page": 1, "total_pages": 1, "per_page": 100, "total_entries": 1, "previous_page": null, "next_page": null }, "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "GET", "request_id": null, "parameters": { "facility_id": "f25b935b-8190-45b0-80ce-d5ce1fac2235" } } }
GET /v1/054929b6-68f1-4145-8311-4d0927c1690b/invoiceable_items/services 200 { "invoiceable_items": [ { "id": "458ee28a-db18-4afb-ab11-29ae951afe8b", "product_code": "S-10", "kind": "service", "description": "Some service item", "required_at_move_in": false, "required_at_transfer": false, "amount": 38.17, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 38.17, "invoiceable_amounts": [ { "id": "d0eecf00-9aaf-4a1d-9595-6a821dae27d2", "amount": 38.17, "kind": "amount", "limit": null } ] }, { "id": "eef851d1-aa7d-49b7-80de-d3d29b2346b6", "product_code": "S-11", "kind": "service", "description": "Some other service item", "required_at_move_in": false, "required_at_transfer": false, "amount": 8.25, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 8.25, "invoiceable_amounts": [ { "id": "7a7ee8c8-6fc8-44e1-9752-c630a417c091", "amount": 8.25, "kind": "amount", "limit": null } ] } ], "meta": { "pagination": { "current_page": 1, "total_pages": 1, "per_page": 100, "total_entries": 2, "previous_page": null, "next_page": null }, "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "GET", "request_id": null, "parameters": { "facility_id": "054929b6-68f1-4145-8311-4d0927c1690b" } } }
GET /v1/6e37f722-da39-4846-842d-63c3f551ecae/invoiceable_items/retail 200 { "invoiceable_items": [ { "id": "21ffd543-476e-4a85-a91b-347e4fb3d173", "product_code": "BOX-1", "kind": "retail", "description": "A box of indeterminate size", "required_at_move_in": false, "required_at_transfer": false, "amount": 45.69, "short_description": null, "show_in_sales_center": true, "tax_total": 4.569, "total": 50.259, "quantity": 0, "is_rental_center_lock": false, "invoiceable_amounts": [ { "id": "2528f65e-1057-400a-a932-d6a577833f58", "amount": 45.69, "kind": "amount", "limit": null } ] }, { "id": "d6690486-58f7-4eae-8253-4b1355e6e1b6", "product_code": "BOX-2", "kind": "retail", "description": "A box of indeterminate size", "required_at_move_in": false, "required_at_transfer": false, "amount": 4.7, "short_description": null, "show_in_sales_center": true, "tax_total": 0.47, "total": 5.17, "quantity": 0, "is_rental_center_lock": false, "invoiceable_amounts": [ { "id": "3415039d-3c99-4cdb-a6eb-ebfc98f72e24", "amount": 4.7, "kind": "amount", "limit": null } ] } ], "meta": { "pagination": { "current_page": 1, "total_pages": 1, "per_page": 100, "total_entries": 2, "previous_page": null, "next_page": null }, "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "GET", "request_id": null, "parameters": { "facility_id": "6e37f722-da39-4846-842d-63c3f551ecae" } } }
POST /v1/23585444-8520-43c1-957e-848b71056ea3/invoiceable_items/retail_payment { "payment_method": { "billing_postal": "12345", "card_number": "00000000", "card_type": "visa", "expiration_date": "10/24", "first_name": "John", "kind": "credit_card", "last_name": "Doe", "security_code": "123" }, "retail_payment": { "invoiceable_items": [ { "invoiceable_item_id": "00575d8b-1ef0-458a-b2d4-ed2569ab5038", "quantity": "1" }, { "invoiceable_item_id": "30f70bc6-d09d-4a84-a521-8e4d80a182f5", "quantity": "1" } ] } } 200 { "successful_payment_event": { "id": "6ddf63fb-8ffd-443b-a794-42c60e26b119", "amount": 48.76, "success": true, "date": "2022-09-12T22:37:19.574-10:00", "payment_method": { "id": "4ba5cf1a-1ee1-4f80-8945-12d9b97527cc", "kind": "credit_card", "first_name": "John", "last_name": "Doe", "reuseable": false, "card_number": "****0000", "card_type": "visa", "expiration_date": "10/24", "billing_address": null } }, "meta": { "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "POST", "request_id": null, "parameters": { "payment_method": { "billing_postal": "12345", "card_number": "[FILTERED]", "card_type": "visa", "expiration_date": "10/24", "first_name": "John", "kind": "credit_card", "last_name": "Doe", "security_code": "[FILTERED]" }, "retail_payment": { "invoiceable_items": [ { "invoiceable_item_id": "00575d8b-1ef0-458a-b2d4-ed2569ab5038", "quantity": "1" }, { "invoiceable_item_id": "30f70bc6-d09d-4a84-a521-8e4d80a182f5", "quantity": "1" } ] }, "facility_id": "23585444-8520-43c1-957e-848b71056ea3" } } }
Param name | Description |
---|---|
retail_payment required |
Value: Must be a Hash |
retail_payment[tenant_id] optional |
A tenant record to associate retail invoice with (optional) Value: Must be a String |
retail_payment[invoiceable_items] optional |
A collection of retail invoiceable item ids Value: Must be an Array of nested elements |
retail_payment[invoiceable_items][invoiceable_item_id] optional |
The retail invoiceable item id attempting to purchase Value: Must be a String |
retail_payment[invoiceable_items][quantity] optional |
Quantity of retail invoiceable item 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 |
GET /v1/459fff37-ea3b-4429-bddf-64d23e0c9617/invoiceable_items/fees 200 { "fees": { "security_deposit": { "id": "2f22d976-c9da-4c28-b5c8-284d425af933", "product_code": "SECURITY_DEPOSIT", "kind": "fee", "description": "Security Deposit", "required_at_move_in": false, "required_at_transfer": false, "amount": 150.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 150.0, "invoiceable_amounts": [ { "id": "aa2757fc-bee9-4970-b160-39f13a09a62e", "amount": 150.0, "kind": "amount", "limit": null } ] }, "online_payment": { "id": "085e98d8-ec4f-4c58-8046-129befd0192d", "product_code": "ONLINE_PAYMENT", "kind": "fee", "description": "Online Payment Convenience Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 1.95, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 1.95, "invoiceable_amounts": [ { "id": "d8825a9f-f540-4608-8580-968e971c8fbb", "amount": 1.95, "kind": "amount", "limit": null } ] }, "reservation": { "id": "0773d4ed-f62a-43b0-a28c-23a1c30bb6df", "product_code": "FEE-5", "kind": "fee", "description": "Reservation Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 5.99, "short_description": null, "show_in_sales_center": false, "tax_total": 0.599, "total": 6.589, "invoiceable_amounts": [ { "id": "ed1c8269-ce79-4c37-9eb2-218ba3b739da", "amount": 5.99, "kind": "amount", "limit": null } ] }, "move_in_fees": [ { "id": "cc72a55a-081a-4b69-be60-856c81e65de5", "product_code": "FEE-3", "kind": "fee", "description": "admin fee", "required_at_move_in": true, "required_at_transfer": false, "amount": "Variable", "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 8.0, "invoiceable_amounts": [ { "id": "3d69fa8b-b88e-4e13-805d-3553bea88abd", "amount": 4.0, "kind": "amount", "limit": 60.0 }, { "id": "4b35a782-662a-426a-8751-3a98eff3fa4b", "amount": 8.0, "kind": "amount", "limit": null } ] } ], "transfer_fees": [ { "id": "cb169312-53f9-4aee-a1e4-52891494939f", "product_code": "FEE-4", "kind": "fee", "description": "transfer fee", "required_at_move_in": false, "required_at_transfer": true, "amount": "Variable", "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "4087c14a-1b55-4811-8465-2f609f9db29f", "amount": 10.0, "kind": "percent", "limit": null } ] } ], "other": [ { "id": "427b81e3-93fb-419d-89c3-d92baa4c13ea", "product_code": "ADMIN_FEE", "kind": "fee", "description": "Administrative Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "63143b94-e45c-4066-96c6-afc08a8949e6", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "ee481d4f-0060-40a2-a313-bb73f414a1b0", "product_code": "CALIFORNIA_FEE_SCHEDULE", "kind": "fee", "description": "California Fee Schedule", "required_at_move_in": false, "required_at_transfer": false, "amount": "Variable", "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "6a244832-51dd-49ff-a8af-5a576f525e36", "amount": 10.0, "kind": "amount", "limit": 60.0 }, { "id": "771a723e-d0c8-4269-a0ff-6fc49446b768", "amount": 15.0, "kind": "amount", "limit": 99.99 }, { "id": "5402ed32-db6b-4a27-8cfd-875cc280d10a", "amount": 20.0, "kind": "amount", "limit": 133.0 }, { "id": "e2477d59-6004-40ca-8245-290dd0916ec1", "amount": 15.0, "kind": "percent", "limit": null } ] }, { "id": "e2fd1940-c8b8-489a-a3ea-dfe1373e4b1c", "product_code": "EARLY_TERMINATION_FEE", "kind": "fee", "description": "Early Termination Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "369f989a-fd70-42d7-979a-01a3f382fd34", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "442b571d-cc6e-40c8-ade2-47982573bb9a", "product_code": "FEE-6", "kind": "fee", "description": "some fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 5.98, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 5.98, "invoiceable_amounts": [ { "id": "c713f50e-3835-4cab-9adf-95cfb54d44de", "amount": 5.98, "kind": "amount", "limit": null } ] }, { "id": "159f36f7-8194-471e-a4c4-7badfe5031b8", "product_code": "FEE_CHARGEBACK", "kind": "fee", "description": "Chargeback Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 20.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 20.0, "invoiceable_amounts": [ { "id": "9373d2df-7a06-4625-8d83-4c227f241c28", "amount": 20.0, "kind": "amount", "limit": null } ] }, { "id": "12e7f6cf-f5f6-4f39-ac8c-76b4c575fff2", "product_code": "FEE_NSF", "kind": "fee", "description": "NSF Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 30.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 30.0, "invoiceable_amounts": [ { "id": "33fdb6c1-c58b-4eac-936b-bd4f41047572", "amount": 30.0, "kind": "amount", "limit": null } ] }, { "id": "b5f264b4-c222-4391-885e-578525645b4a", "product_code": "INVOICE_FEE", "kind": "fee", "description": "Invoice Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "078a5fb7-b862-493b-8e2a-4de1f70f1c46", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "3a2b3639-58b4-40a5-b663-cce16c5e6cf1", "product_code": "MOVE_OUT", "kind": "fee", "description": "Move Out Fee", "required_at_move_in": false, "required_at_transfer": false, "amount": 0.0, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 0.0, "invoiceable_amounts": [ { "id": "b7865cf9-ceeb-451c-8573-de67e73c1aa8", "amount": 0.0, "kind": "amount", "limit": null } ] } ] }, "meta": { "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "GET", "request_id": null, "parameters": { "facility_id": "459fff37-ea3b-4429-bddf-64d23e0c9617" } } }