EZRentOut MCP by usefulapi

List all rental orders (25 per page) with status, customer and dates. Paged: add 1 to page for the next one. GET /baskets.api.

One order by its order number: customer, status, dates, line items (order_line_items), sub-rent items, totals and payments. GET /baskets/<ORDER#>.api.

The check-out / check-in history of one order. GET /baskets/<ORDER#>/history.api.

The payment options (cash, check, ...) that ezrentout_record_order_payment accepts. GET /payment_options.api.

無需輸入參數。

All pricing coupons of the company. GET /pricing_coupons.api.

無需輸入參數。

List customers (25 per page). Optional filter: email, category, taxed, non_taxed, inactive_customers, subscribed_emails, not_subscribed_emails, checked_out_orders, completed_orders, account_name. email, category, account_name and completed_orders (for example "> 50") need filter_val. GET /customers.api.

One customer by id: name, email, phone, addresses, status, custom fields. GET /customers/<CUSTOMER_ID>.api.

Look up the customer, business contact or business that has an email address. GET /api/members/search_by_email.api.

List business customers (20 per page). Optional filter: all, active_businesses, inactive_businesses, checked_out_orders, active_customers, completed_orders (completed_orders needs filter_val, for example "> 50"). GET /businesses.api.

One business customer by id. GET /businesses/<BUSINESS#>.api.

List the contact persons of business customers (25 per page). GET /contacts.api.

One business contact by id. GET /contacts/<CONTACT_ID>.api.

The shipping/billing addresses of one customer. GET /customers/<CUSTOMER_ID>/shipping_addresses.api.

The shipping/billing addresses of one business. GET /businesses/<BUSINESS#>/shipping_addresses.api.

List fixed assets (the individually tracked rental items, 25 per page) with group, location and status. GET /assets.api.

Assets by a status filter. status: available, assets_being_serviced, availability_range, checked_out (= currently rented out), group, location, overdue, possessions_of, possessions_of_email, reserved, product_model_number, items_in_order, reservation_starting_today, retired, update_time. Most filters need filter_param_val (a group or location id, a user id, an email, a model number, an order number; for availability_range two dates joined by ~). Not needed for available, checked_out, overdue, reserved, retired. GET /assets/filter.api.

Search by asset name (3+ characters), or # followed by the item number, or @ followed by the identification number. GET /search.api (facet FixedAsset).

One fixed asset by its asset number: details, group, location, status, rental prices, optionally service details and custom fields. GET /assets/<ASSET#>.api.

The check-in/check-out and change history of one asset (5 entries per page). GET /assets/<ASSET#>/history_paginate.api.

The dates on which an asset, inventory item or asset stock is booked or reserved. GET /assets/<ASSET#>/booked_dates.api.

The comments on one item (25 per page), optionally by one user. GET /assets/<ASSET#>/comments.api.

Assets currently in maintenance (25 per page), optionally only one service type or state. GET /assets/filter.api?for_service=true&status=assets_being_serviced.

List inventory (consumable items tracked by quantity, 25 per page). GET /inventory.api.

One inventory item by item number, with its stock. GET /inventory/<ASSET#>.api.

Search inventory items by name, #<item number> or @<identification number>. GET /search.api (facet VolatileAsset).

The stock movements (added, sold, transferred) of one inventory item. GET /inventory/<ASSET#>/history.api.

The stock of an inventory or asset-stock item at one location. GET /locations/get_quantity_by_location.api.

List asset stock (bulk items tracked by quantity per location, 25 per page). GET /stock_assets.api.

One asset stock item by number. GET /stock_assets/<AssetStock#>.api.

The company's users (staff/admins, 25 per page). Filter by email, employee_identification_number or status (filter_val: active, inactive, login, non_login, all). GET /members.api.

One user by id. GET /members/<USER_ID>.api.

The assets currently checked out to one user (a read; the vendor API uses PUT for this lookup). PUT /members/<USER_ID>/checked_out_items.api?page=N with item_type in the form body.

The company's locations (25 per page); status all, active or inactive. GET /locations/get_line_item_locations.api.

One location by id. GET /locations/<LOCATION#>.api.

The quantity of every asset, asset-stock and inventory item at one location. GET /locations/<LOCATION#>/quantities_by_asset_ids.api.

The asset groups (categories, 25 per page) with their items. GET /assets/classification_view.api.

All subgroups, or those of one group. GET /groups/get_sub_groups.api.

Bundles (items rented together, 25 per page). GET /bundles.api.

One bundle by id, with its items. GET /bundles/<BUNDLE#>.api.

The company's vendors/suppliers (25 per page). GET /assets/vendors.api.

The custom fields defined for items (names and ids). GET /assets/custom_attributes.api.

無需輸入參數。

All purchase orders. GET /purchase_orders.api.

無需輸入參數。

One purchase order with its items. GET /purchase_orders/<PO#>.api.

Maintenance work orders (25 per page), optionally by status filter (open, in_progess [sic, as the vendor spells it], review_pending, complete) or by work order type. GET /tasks.api.

One work order by number. GET /tasks/<Work_Order#>.api.

The work order types of the company. GET /task_types.api.

無需輸入參數。

The saved custom reports (id, name, description). GET /reports/list_custom_reports.api.

無需輸入參數。

Create a customer (a person who rents). First and last name are required. Does not create an order. POST /customers.api.

Create a new rental order (a draft until it is booked or rented out) for a customer, optionally with assets and dates. If the customer belongs to several businesses, pass business_id. Does not rent anything out and does not charge. POST /baskets.api.

Add assets (or bundles as <id>-b) to an existing order. PATCH /baskets/<ORDER#>/update_basket_from_show.api.

Reserve an order's assets for a period (books the order). EZRentOut may notify the customer according to the account's settings. PATCH /baskets/<ORDER#>/reservation.api.

Add a custom line (a named amount, for example a delivery fee) to an order; it raises the order total. Not possible on sold, void, completed or cancelled orders. POST /baskets/<ORDER#>/custom_entries.api.

Record a payment received for an order (a prepayment). It records the amount in EZRentOut; it does not charge a card (credit card payments are not supported by the API). Use a payment_method_name from ezrentout_list_payment_options. PATCH /baskets/<ORDER#>/charge_pre_payment.api.

Check an order out: its assets go to the customer and the rental clock and billing start. EZRentOut may email the customer according to the account's settings. Give rentout_date and return_date, or use_current_datetime. PATCH /baskets/<ORDER#>/checkout.api.

Check an order in: the customer returned the assets, rental billing ends and the assets become available again. Give return_date (and return_time), or use_current_datetime to return now. Returns the whole order (no partial returns, late fees or payment here; use ezrentout_record_order_payment). EZRentOut may email the customer according to the account's settings. PATCH /baskets/<ORDER#>/checkin.api.

Add a comment to an asset, asset stock or inventory item. POST /assets/<ASSET#>/comments.api.

Create a work order with a title, type and due date, optionally for assets. By default the linked assets are marked unavailable (mark_items_unavailable). POST /tasks.api.

Mark a work order in progress. PATCH /tasks/<Work_Order#>/mark_in_progress.api.

Mark a work order complete; its assets may become available again. PATCH /tasks/<Work_Order#>/mark_complete.api.