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/27e2ae43-a03c-49d2-a942-6a3bad7806e1/invoiceable_items 200 { "invoiceable_items": [ { "id": "aab7f88c-231f-4da2-aa2c-e9f4f52437c9", "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": "a598278f-9fb7-4124-b03f-760126c38f35", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "84bf3373-a254-402e-b412-8d46ca335cef", "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": "aa009682-356b-4c7d-b8cb-a238c7450e83", "amount": 10.0, "kind": "amount", "limit": 60.0 }, { "id": "681826fc-65c7-46ad-9e55-936c61cdc940", "amount": 15.0, "kind": "amount", "limit": 99.99 }, { "id": "fe547f6f-8f88-4b86-b57b-927547e42606", "amount": 20.0, "kind": "amount", "limit": 133.0 }, { "id": "1fdf46b8-431b-4d6d-9d4b-dab0f1b507fc", "amount": 15.0, "kind": "percent", "limit": null } ] }, { "id": "fe8074e0-4286-4969-800f-4fbd72c24ed3", "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": "788d503e-b12c-4612-bfdf-eb72072ead69", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "1c4bcaef-b8bd-408c-bb27-695c60cf962c", "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": "25753b1b-d4c8-4af9-bc35-2d697057fec6", "amount": 20.0, "kind": "amount", "limit": null } ] }, { "id": "1c343140-1ea1-43ad-bf53-7d96f8d76198", "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": "3cd2505a-ac60-47f9-8c05-282ea617d974", "amount": 30.0, "kind": "amount", "limit": null } ] }, { "id": "795c3950-3af5-4a12-aff9-e6a1897637c4", "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": "9fd6fe83-6658-477a-b6c4-0bf011f5e85a", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "e496fd48-289d-4ef9-b878-627526af8591", "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": "ac685a62-a3ce-4126-9589-1567f6ac44c4", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "1bc65080-49fe-4057-b4e2-1fd64dcde2db", "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": "a4d4eaeb-3f1a-4d3b-b4fb-6c8063a2c2fe", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "5b097afa-223b-424c-9017-90d99823918b", "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": "ef78c415-faac-471f-a904-73f81276381a", "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": "27e2ae43-a03c-49d2-a942-6a3bad7806e1", "invoiceable_item": {} } } }
GET /v1/a0bfab46-0e89-4059-b0c8-cd6c314b1fb1/invoiceable_items/insurance 200 { "invoiceable_items": [ { "id": "6306b183-f158-4129-b764-a6b510ccb6ab", "product_code": "MINICO-1", "kind": "insurance", "description": "MiniCo Insurance Agency, LLC - $130.50", "required_at_move_in": false, "required_at_transfer": false, "amount": 36.31, "short_description": null, "show_in_sales_center": true, "tax_total": 0.0, "total": 36.31, "coverage_amount": 130.5, "coverage_percentage": 70, "provider_name": "MiniCo Insurance Agency, LLC", "provider_key": "minico", "invoiceable_amounts": [ { "id": "9ce6da35-b81e-49ef-a1c3-53213b067ab7", "amount": 36.31, "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": "a0bfab46-0e89-4059-b0c8-cd6c314b1fb1", "invoiceable_item": {} } } }
GET /v1/f7d52585-d5f2-441c-a306-18207537b258/invoiceable_items/services 200 { "invoiceable_items": [ { "id": "9b928392-8c74-47ac-a380-a46331f09b18", "product_code": "S-5", "kind": "service", "description": "Some service item", "required_at_move_in": false, "required_at_transfer": false, "amount": 11.4, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 11.4, "invoiceable_amounts": [ { "id": "dc1fc6d5-bf57-4e89-b6ae-52d7cb1e0e75", "amount": 11.4, "kind": "amount", "limit": null } ] }, { "id": "30248ba9-65a0-42e6-a4db-8c61d0dd6939", "product_code": "S-6", "kind": "service", "description": "Some other service item", "required_at_move_in": false, "required_at_transfer": false, "amount": 32.88, "short_description": null, "show_in_sales_center": false, "tax_total": 0.0, "total": 32.88, "invoiceable_amounts": [ { "id": "64e02601-826f-4db9-8407-fa64e4920e2a", "amount": 32.88, "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": "f7d52585-d5f2-441c-a306-18207537b258", "invoiceable_item": {} } } }
GET /v1/2193d693-b26e-4f98-834e-8310923db5b1/invoiceable_items/retail 200 { "invoiceable_items": [ { "id": "5ef4c74f-2286-4abb-8b8e-99e080bbeee3", "product_code": "BOX-20", "kind": "retail", "description": "A box of indeterminate size", "required_at_move_in": false, "required_at_transfer": false, "amount": 26.83, "short_description": null, "show_in_sales_center": true, "tax_total": 2.683, "total": 29.513, "quantity": 0, "is_rental_center_lock": false, "invoiceable_amounts": [ { "id": "33a39b6e-fe86-40f3-8d2c-b24004114e28", "amount": 26.83, "kind": "amount", "limit": null } ] }, { "id": "67bb66c4-46b5-45e4-b24c-0c2741c5b6ef", "product_code": "BOX-21", "kind": "retail", "description": "A box of indeterminate size", "required_at_move_in": false, "required_at_transfer": false, "amount": 23.35, "short_description": null, "show_in_sales_center": true, "tax_total": 2.335, "total": 25.685, "quantity": 0, "is_rental_center_lock": false, "invoiceable_amounts": [ { "id": "11bdd36b-267c-4a6c-9981-a4fb13b2b721", "amount": 23.35, "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": "2193d693-b26e-4f98-834e-8310923db5b1", "invoiceable_item": {} } } }
Param name | Description |
---|---|
retail_payment
required |
Validations:
|
retail_payment[tenant_id]
optional |
A tenant record to associate retail invoice with (optional) Validations:
|
retail_payment[invoiceable_items]
optional |
A collection of retail invoiceable item ids Validations:
|
retail_payment[invoiceable_items][invoiceable_item_id]
optional |
The retail invoiceable item id attempting to purchase Validations:
|
retail_payment[invoiceable_items][quantity]
optional |
Quantity of retail invoiceable item 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:
|
POST /v1/89516dd8-55e9-47eb-a5e7-06c6ffb6ecfb/invoiceable_items/retail_payment { "payment_method": { "kind": "credit_card", "first_name": "John", "last_name": "Doe", "card_type": "visa", "card_number": "00000000", "security_code": "123", "expiration_date": "10/24", "billing_postal": "12345" }, "retail_payment": { "invoiceable_items": [ { "invoiceable_item_id": "0584bce9-dcfb-4403-8a24-1405fb92c915", "quantity": 1 }, { "invoiceable_item_id": "3fa9c871-8756-4cbf-aac7-42816b797723", "quantity": 1 } ] }, "invoiceable_item": {} } 200 { "successful_payment_event": { "id": "380cd10e-c2a1-4546-a66e-a505527a00ab", "amount": 78.05, "success": true, "date": "2023-09-15T04:38:22.790-10:00", "payment_method": { "id": "7f5e3cd4-20c8-4aa8-9d52-f25b01338b81", "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": { "kind": "credit_card", "first_name": "John", "last_name": "Doe", "card_type": "visa", "card_number": "[FILTERED]", "security_code": "[FILTERED]", "expiration_date": "10/24", "billing_postal": "12345" }, "retail_payment": { "invoiceable_items": [ { "invoiceable_item_id": "0584bce9-dcfb-4403-8a24-1405fb92c915", "quantity": 1 }, { "invoiceable_item_id": "3fa9c871-8756-4cbf-aac7-42816b797723", "quantity": 1 } ] }, "facility_id": "89516dd8-55e9-47eb-a5e7-06c6ffb6ecfb", "invoiceable_item": {} } } }
GET /v1/28540dc9-1c4f-4107-a902-0fb98e193b74/invoiceable_items/fees 200 { "fees": { "security_deposit": { "id": "4a0556bf-b6a9-4781-9175-9f2c2a2737ea", "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": "548e638b-ad9f-480c-9e56-24a88ae38d17", "amount": 150.0, "kind": "amount", "limit": null } ] }, "online_payment": { "id": "fdd93b35-6de2-4897-9f63-58da5f97e687", "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": "4b34c6f7-3f31-45f9-8ab8-584a8a0fa5af", "amount": 1.95, "kind": "amount", "limit": null } ] }, "reservation": { "id": "4c9b7cc7-e582-4f3e-8c2b-fa8c9291aba0", "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": "64f922f9-b854-4056-ae3b-415822a27dbe", "amount": 5.99, "kind": "amount", "limit": null } ] }, "move_in_fees": [ { "id": "49a3d403-6878-4fc6-a7b5-9068a59154ef", "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": "e754d59a-7900-497a-a700-bfae9eebd594", "amount": 4.0, "kind": "amount", "limit": 60.0 }, { "id": "91413d86-b79e-438d-90c0-6b93151245bf", "amount": 8.0, "kind": "amount", "limit": null } ] } ], "transfer_fees": [ { "id": "711e97c8-db2e-4ed6-8ae0-775b3e6579fa", "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": "b9d99b99-ffc9-4fc4-a904-5aaa753503dc", "amount": 10.0, "kind": "percent", "limit": null } ] } ], "other": [ { "id": "dd29d495-edb4-43d9-94d0-1c78a10d8cb7", "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": "78e92b52-46fc-4b4b-9135-49ae21678685", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "4f668553-411f-41de-bf4e-3f1b75269074", "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": "a7bfedfb-a8c9-4c28-aa0b-082ed0ae2809", "amount": 10.0, "kind": "amount", "limit": 60.0 }, { "id": "708b4278-c846-4e21-bce6-fa70ccdc6004", "amount": 15.0, "kind": "amount", "limit": 99.99 }, { "id": "d4d29ce6-4007-4d4a-8334-4af117eeb735", "amount": 20.0, "kind": "amount", "limit": 133.0 }, { "id": "0b98d8c1-c0e8-425c-a9b9-75da90e3b068", "amount": 15.0, "kind": "percent", "limit": null } ] }, { "id": "92299f17-50ad-4e8b-8d2b-08cbc9dc15b2", "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": "c28271dc-560e-4533-a0f5-c5a7ffd2f2e0", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "30c9098c-f3bd-4e9e-90e6-be7688e5eefd", "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": "f94795e2-dc7d-4c55-93c1-2d906afd9dc5", "amount": 20.0, "kind": "amount", "limit": null } ] }, { "id": "072ef6b7-0a18-4dfa-9bd7-d7b197532565", "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": "2dd9c462-328d-4385-b989-c8043d94d5a7", "amount": 30.0, "kind": "amount", "limit": null } ] }, { "id": "23890d88-0362-4649-ae90-113be2557e30", "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": "9621e951-c616-4d08-9e5f-cfefa9cad8e4", "amount": 5.98, "kind": "amount", "limit": null } ] }, { "id": "620a0438-3e46-4c52-9cf4-7539b8d51ae4", "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": "76beae00-1682-4594-bfe4-b13f892c5bf4", "amount": 0.0, "kind": "amount", "limit": null } ] }, { "id": "66a1bdbe-c9a0-4e2c-aafc-816c5403176d", "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": "9a4f44a9-8aa9-48eb-947c-275f8174cd1a", "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": "28540dc9-1c4f-4107-a902-0fb98e193b74", "invoiceable_item": {} } } }