### RemOnline API Getting Started Guide Source: https://remonline.readme.io/reference/getting-started-with-api/get-directories-of-assets Provides an entry point for understanding how to begin using the RemOnline Public API, typically covering authentication and general API usage principles. ```APIDOC Getting Started ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-postings Provides initial guidance and a starting point for integrating with the RemOnline Public API. ```APIDOC Getting Started: /reference/getting-started-with-api ``` -------------------------------- ### RemOnline Public API Overview and Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-lead-custom-fields This snippet provides a high-level overview of the RemOnline Public API, listing the main resource categories and a direct link to the 'Getting Started' guide for initial setup and authentication. ```APIDOC RemOnline Public API: Getting Started: /reference/getting-started-with-api Available Resources: Tasks Inquiries Estimates Orders Sales Cashbox Invoices Inventory Assets Contacts Products Services ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-prices Provides initial guidance for integrating with the RemOnline Public API. ```APIDOC Getting Started: /reference/getting-started-with-api ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/create-comment-on-client Provides initial information and a starting point for integrating with the RemOnline Public API. ```APIDOC Getting Started: /reference/getting-started-with-api ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-bundles Provides an entry point for understanding how to begin using the RemOnline Public API. ```APIDOC Getting Started: /reference/getting-started-with-api ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/reopen-task Provides an entry point for understanding how to begin using the RemOnline Public API. ```APIDOC Getting Started: /reference/getting-started-with-api ``` -------------------------------- ### RemOnline API Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-cashboxes Provides an entry point for understanding how to begin using the RemOnline Public API. ```APIDOC Getting Started: /reference/getting-started-with-api ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-clients Provides initial information and guidance for integrating with the RemOnline Public API. ```APIDOC Getting Started: GET /reference/getting-started-with-api ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-company-taxes Provides an entry point for understanding how to begin using the RemOnline Public API. ```APIDOC Getting Started: - Getting Started ``` -------------------------------- ### RemOnline API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-order-statuses Provides initial information for developers to begin integrating with the RemOnline Public API. ```APIDOC Getting Started: - Getting Started (General) ``` -------------------------------- ### RemOnline API: Services Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Manages services, allowing retrieval of services by ID, categories, creation, and updates. ```APIDOC Services: - Get Services (GET /reference/get-service) - Get Service by ID (GET /reference/get-service-by-id) - Get Service Categories (GET /reference/get-service-categories) - Create Service (POST /reference/create-service) ``` -------------------------------- ### RemOnline API: Orders Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Provides endpoints for managing service orders, including retrieving statuses, orders by ID, creating, updating, managing items, updating status, adding comments, and getting public page URLs. ```APIDOC Orders: - Get Order Statuses (GET /reference/get-order-statuses) - Get Orders (GET /reference/get-orders) - Get Order by Id (GET /reference/get-order-by-id) - Create Order (POST /reference/create-order) - Update Order (PATCH /reference/update-order) - Get Order Items (GET /reference/get-order-items) - Add Order Item (POST /reference/create-order-item) - Update Order Item (PATCH /reference/update-order-item) - Update Order Status (POST /reference/update-order-status) - Create Order Comment (POST /reference/create-order-comment) - Get Order Public Page Url (GET /reference/get-order-public-page-url) ``` -------------------------------- ### RemOnline API: Sales Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Endpoint for retrieving sales records within the RemOnline system. ```APIDOC Sales: - Get Sales (GET /reference/get-sales) ``` -------------------------------- ### RemOnline Public API: Getting Started Source: https://remonline.readme.io/reference/getting-started-with-api/get-warehouses Provides initial guidance and general information for developers looking to integrate with the RemOnline Public API. ```APIDOC Getting Started ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Provides endpoints for managing products, including retrieving products by ID, categories, creating, and updating products. ```APIDOC Products: - Get Products (GET /reference/get-products) - Get Product by ID (GET /reference/get-product-by-id) - Get Product Categories (GET /reference/get-product-categories) - Create Product (POST /reference/create-product) - Update Product (PUT /reference/update-product) ``` -------------------------------- ### RemOnline API Endpoints Overview Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients A comprehensive list of available API endpoints for various RemOnline functionalities, including service updates, bundle management, and retrieving company settings. ```APIDOC - Update Service (PUT /reference/update-service) - Bundles - Get Bundles (GET /reference/get-bundles) - Get Bundle Entities (GET /reference/get-bundle-entities) - Settings - Get Company Settings (GET /reference/get-company-settings) - Get Locations (GET /reference/get-locations) - Get Location Resources (GET /reference/get-location-resources) - Get Employees (GET /reference/get-employees) - Get Company Taxes (GET /reference/get-company-taxes) - Get Order/Estimate Types (GET /reference/get-orderestimate-types) - Get Order/Estimate Custom Fields (GET /reference/get-ordersestimate-custom-fields) - Get Directories (GET /reference/get-directories) - Get Directory Items (GET /reference/get-directory-items) - Get Ad Campaigns (GET /reference/get-ad-campaigns) - Get Prices (GET /reference/get-prices) - Get Units of measurement (GET /reference/get-units-of-measurement) - Webhooks - Webhooks Guide (/reference/webhooks) ``` -------------------------------- ### RemOnline API: Sales Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for retrieving sales records within the RemOnline system. ```APIDOC Sales API Endpoints: GET /sales: Retrieve a list of sales. ``` -------------------------------- ### RemOnline API: Estimates Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing estimates, including operations to retrieve statuses, estimates by ID, create, update, manage items, change status, add comments, and get public page URLs. ```APIDOC Estimates API Endpoints: GET /estimate-statuses: Retrieve a list of estimate statuses. GET /estimates: Retrieve a list of estimates. GET /estimates/{id}: Retrieve a specific estimate by its ID. POST /estimates: Create a new estimate. PATCH /estimates/{id}: Update an existing estimate. GET /estimates/{id}/items: Retrieve items associated with an estimate. POST /estimates/{id}/items: Add an item to an estimate. PATCH /estimates/{id}/items/{item_id}: Update an item on an estimate. POST /estimates/{id}/status: Change the status of an estimate. POST /estimates/{id}/comments: Create a comment on an estimate. GET /estimates/{id}/public-page-url: Retrieve the public page URL for an estimate. ``` -------------------------------- ### RemOnline API: Tasks Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Provides a comprehensive set of endpoints for managing tasks within the RemOnline system, including creation, retrieval, updates, and status changes. ```APIDOC Tasks: - Get Tasks (GET /reference/get-tasks) - Get Task by ID (GET /reference/get-tasks-by-id) - Create Task (POST /reference/create-tasks) - Update Task (PUT /reference/update-task) - Close Task (POST /reference/close-task) - Reopen Task (POST /reference/reopen-task) - Create Comment on Task (POST /reference/comment-on-task) ``` -------------------------------- ### RemOnline API: Orders Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing orders, including operations to retrieve statuses, orders by ID, create, update, manage items, update status, add comments, and get public page URLs. ```APIDOC Orders API Endpoints: GET /order-statuses: Retrieve a list of order statuses. GET /orders: Retrieve a list of orders. GET /orders/{id}: Retrieve a specific order by its ID. POST /orders: Create a new order. PATCH /orders/{id}: Update an existing order. GET /orders/{id}/items: Retrieve items associated with an order. POST /orders/{id}/items: Add an item to an order. PATCH /orders/{id}/items/{item_id}: Update an item on an order. POST /orders/{id}/status: Update the status of an order. POST /orders/{id}/comments: Create a comment on an order. GET /orders/{id}/public-page-url: Retrieve the public page URL for an order. ``` -------------------------------- ### RemOnline API: Cashbox Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Manages cashbox operations, including retrieving cashboxes, transactions, cashflow items, and creating payments. ```APIDOC Cashbox: - Get Cashboxes (GET /reference/get-cashboxes) - Get Cashbox Transactions (GET /reference/get-cashbox-transactions) - Get Cashflow Items (GET /reference/get-cashflowitems) - Create Payment (POST /reference/create-payment) ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing products, including operations to retrieve products by ID, categories, create, and update products. ```APIDOC Products API Endpoints: GET /products: Retrieve a list of products. GET /products/{id}: Retrieve a specific product by its ID. GET /product-categories: Retrieve a list of product categories. POST /products: Create a new product. PUT /products/{id}: Update an existing product. ``` -------------------------------- ### RemOnline API Endpoints Reference Source: https://remonline.readme.io/reference/getting-started-with-api/create-write-off A comprehensive list of available API endpoints for various RemOnline functionalities, including service updates, bundle management, company settings, and webhooks. ```APIDOC API Endpoints: - Update Service (PUT /reference/update-service) - Bundles: - Get Bundles (GET /reference/get-bundles) - Get Bundle Entities (GET /reference/get-bundle-entities) - Settings: - Get Company Settings (GET /reference/get-company-settings) - Get Locations (GET /reference/get-locations) - Get Location Resources (GET /reference/get-location-resources) - Get Employees (GET /reference/get-employees) - Get Company Taxes (GET /reference/get-company-taxes) - Get Order/Estimate Types (GET /reference/get-orderestimate-types) - Get Order/Estimate Custom Fields (GET /reference/get-ordersestimate-custom-fields) - Get Directories (GET /reference/get-directories) - Get Directory Items (GET /reference/get-directory-items) - Get Ad Campaigns (GET /reference/get-ad-campaigns) - Get Prices (GET /reference/get-prices) - Get Units of measurement (GET /reference/get-units-of-measurement) - Webhooks: - Webhooks Guide (/reference/webhooks) ``` -------------------------------- ### RemOnline API: Cashbox Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing cashbox operations, including retrieving cashboxes, transactions, cashflow items, and creating payments. ```APIDOC Cashbox API Endpoints: GET /cashboxes: Retrieve a list of cashboxes. GET /cashbox-transactions: Retrieve a list of cashbox transactions. GET /cashflow-items: Retrieve a list of cashflow items. POST /payments: Create a new payment. ``` -------------------------------- ### RemOnline API: Services Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing services, including operations to retrieve services by ID, categories, create, and update services. ```APIDOC Services API Endpoints: GET /services: Retrieve a list of services. GET /services/{id}: Retrieve a specific service by its ID. GET /service-categories: Retrieve a list of service categories. POST /services: Create a new service. ``` -------------------------------- ### RemOnline API: Invoices Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Provides endpoints for managing invoices, including retrieving statuses, invoices by ID, and creating comments for invoices. ```APIDOC Invoices: - Get Invoice Statuses (GET /reference/get-invoice-statuses) - Get Invoices (GET /reference/get-invoices) - Get Invoice by ID (GET /reference/get-invoice-by-id) - Create Comment for Invoice (POST /reference/create-comment-for-invoice) ``` -------------------------------- ### RemOnline API: Assets Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Provides endpoints for managing assets, including retrieving assets by ID, creating, updating, moving assets, and retrieving custom fields and directories of assets. ```APIDOC Assets: - Get Assets (GET /reference/get-assets) - Get Asset by ID (GET /reference/get-asset-by-id) - Create Asset (POST /reference/create-asset) - Update Asset (PUT /reference/update-asset) - Move Asset (POST /reference/move-asset) - Get Asset Custom Fields (GET /reference/get-asset-custom-fields) - Get Directories of Assets (GET /reference/get-directories-of-assets) ``` -------------------------------- ### RemOnline API: Assets Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing assets, including operations to retrieve assets by ID, create, update, move, retrieve custom fields, and directories of assets. ```APIDOC Assets API Endpoints: GET /assets: Retrieve a list of assets. GET /assets/{id}: Retrieve a specific asset by its ID. POST /assets: Create a new asset. PUT /assets/{id}: Update an existing asset. POST /assets/{id}/move: Move an asset. GET /asset-custom-fields: Retrieve a list of asset custom fields. GET /asset-directories: Retrieve directories of assets. ``` -------------------------------- ### RemOnline API: Invoices Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing invoices, including operations to retrieve statuses, invoices by ID, and create comments for invoices. ```APIDOC Invoices API Endpoints: GET /invoice-statuses: Retrieve a list of invoice statuses. GET /invoices: Retrieve a list of invoices. GET /invoices/{id}: Retrieve a specific invoice by its ID. POST /invoices/{id}/comments: Create a comment for an invoice. ``` -------------------------------- ### RemOnline API: Tasks Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing tasks, including operations to retrieve, create, update, close, reopen, and add comments to tasks within the RemOnline system. ```APIDOC Tasks API Endpoints: GET /tasks: Retrieve a list of tasks. GET /tasks/{id}: Retrieve a specific task by its ID. POST /tasks: Create a new task. PUT /tasks/{id}: Update an existing task. POST /tasks/{id}/close: Close a task. POST /tasks/{id}/reopen: Reopen a task. POST /tasks/{id}/comments: Create a comment on a task. ``` -------------------------------- ### Create Write-off Transaction API Endpoint Source: https://remonline.readme.io/reference/getting-started-with-api/create-write-off Details for the API endpoint used to create a write-off transaction of products. This resource requires OAuth2 or Bearer token authentication. ```APIDOC Endpoint: POST https://api.remonline.app/warehouse/outcome-transactions/ Purpose: Create a write-off transaction of products. Authentication: - OAuth2 - Bearer ``` -------------------------------- ### RemOnline API: Inquiries Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing inquiries (leads), including operations to retrieve statuses, types, custom fields, create, update, change status, and add comments to inquiries. ```APIDOC Inquiries API Endpoints: GET /inquiry-statuses: Retrieve a list of inquiry statuses. GET /inquiry-types: Retrieve a list of inquiry types. GET /inquiry-custom-fields: Retrieve a list of inquiry custom fields. GET /inquiries: Retrieve a list of inquiries. POST /inquiries: Create a new inquiry. PUT /inquiries/{id}: Update an existing inquiry. POST /inquiries/{id}/status: Change the status of an inquiry. POST /inquiries/{id}/comments: Create a comment on an inquiry. ``` -------------------------------- ### RemOnline API: Inquiries Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Endpoints for managing customer inquiries (leads), including retrieving statuses, types, custom fields, creating, updating, changing status, and adding comments. ```APIDOC Inquiries: - Get Inquiry Statuses (GET /reference/get-lead-statuses) - Get Inquiry Types (GET /reference/get-lead-types) - Get Inquiry Custom Fields (GET /reference/get-lead-custom-fields) - Get Inquiries (GET /reference/get-leads) - Create Inquiry (POST /reference/create-lead) - Update Inquiry (PUT /reference/update-lead) - Change Inquiry Status (POST /reference/change-lead-status) - Create Inquiry Comment (POST /reference/create-comment-on-lead) ``` -------------------------------- ### RemOnline API: Inventory Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing inventory, including operations to retrieve warehouses, bins, stock, serial numbers, postings, transfers, write-offs, and create new postings, write-offs, or transfers. ```APIDOC Inventory API Endpoints: GET /warehouses: Retrieve a list of warehouses. GET /warehouse-bins: Retrieve a list of warehouse bins. GET /stock: Retrieve current stock levels. GET /product-serial-numbers: Retrieve product serial numbers. GET /postings: Retrieve a list of inventory postings. GET /transfers: Retrieve a list of inventory transfers. GET /write-offs: Retrieve a list of inventory write-offs. POST /postings: Create a new inventory posting. POST /write-offs: Create a new inventory write-off. POST /transfers: Create a new inventory transfer. ``` -------------------------------- ### RemOnline API: Estimates Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Manages estimates, allowing retrieval of statuses, estimates by ID, creation, updates, item management (add/update), status changes, comments, and public page URL retrieval. ```APIDOC Estimates: - Get Estimate Statuses (GET /reference/get-estimate-statuses) - Get Estimates (GET /reference/get-estimates) - Get Estimate by ID (GET /reference/get-estimate-by-id) - Create Estimate (POST /reference/create-estimate) - Update Estimate (PATCH /reference/update-estimate) - Get Estimate Items (GET /reference/get-estimate-items) - Add Estimate Item (POST /reference/create-estimate-item) - Update Estimate Item (PATCH /reference/update-estimate-item) - Change Estimate Status (POST /reference/change-estimate-status) - Create Estimate Comment (POST /reference/create-estimate-comment) - Get Estimate Public Page Url (GET /reference/get-estimate-public-page-url) ``` -------------------------------- ### RemOnline API: Contacts Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id Provides API endpoints for managing contacts (clients), including operations to retrieve contacts by ID, create, update, merge, add comments, and retrieve custom fields. ```APIDOC Contacts API Endpoints: GET /contacts: Retrieve a list of contacts. GET /contacts/{id}: Retrieve a specific contact by its ID. POST /contacts: Create a new contact. PUT /contacts/{id}: Update an existing contact. POST /contacts/merge: Merge multiple contacts. POST /contacts/{id}/comments: Create a comment on a contact. GET /contact-custom-fields: Retrieve a list of contact custom fields. ``` -------------------------------- ### RemOnline API: Contacts Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Manages customer contacts, allowing retrieval of contacts by ID, creation, updates, merging, adding comments, and retrieving custom fields. ```APIDOC Contacts: - Get Contacts (GET /reference/get-clients) - Get Contact by ID (GET /reference/get-clients-by-id) - Create Contact (POST /reference/create-client) - Update Contact (PUT /reference/update-client) - Merge Contacts (POST /reference/merge-clients) - Create Comment on Contact (POST /reference/create-comment-on-client) - Get Contact Custom Fields (GET /reference/get-client-custom-fields) ``` -------------------------------- ### RemOnline API: Inventory Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients Manages inventory operations, including retrieving warehouses, bins, stock, serial numbers, postings, transfers, write-offs, and creating new postings, write-offs, or transfers. ```APIDOC Inventory: - Get Warehouses (GET /reference/get-warehouses) - Get Warehouse Bins (GET /reference/get-warehouse-bins) - Get Stock (GET /reference/get-stock) - Get Product Serial Numbers (GET /reference/get-product-serial-numbers) - Get Postings (GET /reference/get-postings) - Get Transfers (GET /reference/get-transfers) - Get Write-Offs (GET /reference/get-write-offs) - Create Posting (POST /reference/create-posting) - Create Write-off (POST /reference/create-write-off) - Create Transfer (POST /reference/create-transfer) ``` -------------------------------- ### RemOnline Webhooks Guide Reference Source: https://remonline.readme.io/reference/getting-started-with-api/get-service-categories Reference to the dedicated Webhooks guide for integrating real-time notifications and events with the RemOnline API. ```APIDOC Webhooks Guide: - /reference/webhooks ``` -------------------------------- ### RemOnline Webhooks Guide Reference Source: https://remonline.readme.io/reference/getting-started-with-api/update-estimate-item Reference to the official Webhooks Guide for integrating real-time notifications and events with RemOnline. ```APIDOC Webhooks Guide: /reference/webhooks ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/create-order Enables management of products through API calls, covering operations like getting products by ID, categories, creating, and updating products. ```APIDOC Products: Get Products (GET) Get Product by ID (GET) Get Product Categories (GET) Create Product (POST) Update Product (PUT) ``` -------------------------------- ### Get Invoice by ID API Endpoint Source: https://remonline.readme.io/reference/getting-started-with-api/get-invoice-by-id This API method allows users to retrieve detailed information about a specific invoice using its unique identifier. Authentication is required via OAuth2 or Bearer token. ```APIDOC Endpoint: GET https://api.remonline.app/invoice/{invoice_id} Authentication: OAuth2, Bearer ``` -------------------------------- ### Get Postings API Endpoint Details Source: https://remonline.readme.io/reference/getting-started-with-api/get-postings Detailed documentation for the 'Get Postings' API endpoint, which retrieves a list of product postings from the warehouse. Includes method, URL, description, and authentication details. ```APIDOC Endpoint: Get Postings Method: GET URL: https://api.remonline.app/warehouse/postings/ Description: Returns list of products postings. Authentication: - OAuth2 - Bearer Client Libraries/Examples Available (no code provided): - Shell - Node - Ruby - PHP - Python ``` -------------------------------- ### Retrieve Tasks from RemOnline API Source: https://remonline.readme.io/reference/getting-started-with-api/getting-started-with-api Provides multi-language examples for making a GET request to the '/tasks' endpoint of the RemOnline API. Each example demonstrates how to set up the request, include the Bearer token for authentication, and handle the response, including checking the HTTP status and parsing the body. ```HTTP GET /tasks HTTP/1.1 Host: api.remonline.app Authorization: Bearer 946389976c464478beb0cf7a7b5b01bb ``` ```Python import requests API_KEY = "946389976c464478beb0cf7a7b5b01bb" url = "https://api.remonline.app/tasks" headers = { "Authorization": f"Bearer {API_KEY}" } response = requests.get(url, headers=headers) print(response.status_code) print(response.json()) ``` ```PHP "https://api.remonline.app/tasks", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer $apiKey" ] ]); $response = curl_exec($curl); $httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); echo "HTTP Status: $httpCode\n"; echo "Response: $response\n"; ?> ``` ```Kotlin import okhttp3.OkHttpClient import okhttp3.Request const val API_KEY = "946389976c464478beb0cf7a7b5b01bb" fun main() { val client = OkHttpClient() val request = Request.Builder() .url("https://api.remonline.app/tasks") .addHeader("Authorization", "Bearer $API_KEY") .build() val response = client.newCall(request).execute() println("HTTP Status: ${response.code}") println("Response: ${response.body?.string()}") } ``` ```Java import java.io.BufferedReader; import java.io.InputStreamReader; import java.net.HttpURLConnection; import java.net.URL; public class Main { private static final String API_KEY = "946389976c464478beb0cf7a7b5b01bb"; public static void main(String[] args) throws Exception { URL url = new URL("https://api.remonline.app/tasks"); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setRequestMethod("GET"); conn.setRequestProperty("Authorization", "Bearer " + API_KEY); int status = conn.getResponseCode(); BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream())); String inputLine; StringBuilder content = new StringBuilder(); while ((inputLine = in.readLine()) != null) { content.append(inputLine); } in.close(); conn.disconnect(); System.out.println("HTTP Status: " + status); System.out.println("Response: " + content.toString()); } } ``` -------------------------------- ### RemOnline API Endpoints Overview Source: https://remonline.readme.io/reference/getting-started-with-api/get-asset-custom-fields A comprehensive list of available API endpoints for various RemOnline functionalities, including service updates, bundles, and company settings, along with a reference to the Webhooks guide. ```APIDOC API Endpoints Overview: Service: - Update Service (PUT) /reference/update-service Bundles: - Get Bundles (GET) /reference/get-bundles - Get Bundle Entities (GET) /reference/get-bundle-entities Settings: - Get Company Settings (GET) /reference/get-company-settings - Get Locations (GET) /reference/get-locations - Get Location Resources (GET) /reference/get-location-resources - Get Employees (GET) /reference/get-employees - Get Company Taxes (GET) /reference/get-company-taxes - Get Order/Estimate Types (GET) /reference/get-orderestimate-types - Get Order/Estimate Custom Fields (GET) /reference/get-ordersestimate-custom-fields - Get Directories (GET) /reference/get-directories - Get Directory Items (GET) /reference/get-directory-items - Get Ad Campaigns (GET) /reference/get-ad-campaigns - Get Prices (GET) /reference/get-prices - Get Units of measurement (GET) /reference/get-units-of-measurement Webhooks: - Webhooks Guide /reference/webhooks ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/getting-started-with-api Endpoints for managing products, including retrieval, creation, updates, and product categories. ```APIDOC Products API Endpoints: Get Products: GET /reference/get-products Get Product by ID: GET /reference/get-product-by-id Get Product Categories: GET /reference/get-product-categories Create Product: POST /reference/create-product Update Product: PUT /reference/update-product ``` -------------------------------- ### Get Task by ID API Endpoint Documentation Source: https://remonline.readme.io/reference/getting-started-with-api/get-tasks-by-id Detailed documentation for the 'Get Task by ID' API endpoint. This endpoint allows retrieval of specific task details using a unique task identifier. It requires OAuth2 authentication with a Bearer token. While various languages are listed as supported for examples, no actual code snippets are provided in this documentation. ```APIDOC Endpoint: Get Task by ID Method: GET URL: https://api.remonline.app/tasks/{task_id} Authentication: - Type: OAuth2 - Scheme: Bearer Supported Languages for Examples (No Code Provided): - Shell - Node - Ruby - PHP - Python Response: - Note: Click 'Try It!' to see the response. ``` -------------------------------- ### Merge Contacts API Endpoint Source: https://remonline.readme.io/reference/getting-started-with-api/merge-clients API endpoint to merge existing client contacts in RemOnline. This operation uses a POST request and supports OAuth2 and Bearer token authentication. ```APIDOC Method: POST URL: https://api.remonline.app/clients/merge Description: Merge existed contacts. Authentication: - OAuth2 - Bearer Supported Languages for Request: Shell, Node, Ruby, PHP, Python ``` -------------------------------- ### RemOnline API Endpoints Overview Source: https://remonline.readme.io/reference/getting-started-with-api/get-directories-of-assets Provides a structured overview of the available API endpoints in RemOnline, categorized by functionality such as services, bundles, settings, and webhooks. ```APIDOC Service: - Update Service (PUT /reference/update-service) Bundles: - Get Bundles (GET /reference/get-bundles) - Get Bundle Entities (GET /reference/get-bundle-entities) Settings: - Get Company Settings (GET /reference/get-company-settings) - Get Locations (GET /reference/get-locations) - Get Location Resources (GET /reference/get-location-resources) - Get Employees (GET /reference/get-employees) - Get Company Taxes (GET /reference/get-company-taxes) - Get Order/Estimate Types (GET /reference/get-orderestimate-types) - Get Order/Estimate Custom Fields (GET /reference/get-ordersestimate-custom-fields) - Get Directories (GET /reference/get-directories) - Get Directory Items (GET /reference/get-directory-items) - Get Ad Campaigns (GET /reference/get-ad-campaigns) - Get Prices (GET /reference/get-prices) - Get Units of measurement (GET /reference/get-units-of-measurement) Webhooks: - Webhooks Guide (/reference/webhooks) ``` -------------------------------- ### RemOnline API Endpoints Overview Source: https://remonline.readme.io/reference/getting-started-with-api/get-leads A comprehensive list of available API endpoints for managing various aspects of RemOnline, including services, bundles, and company settings. This section outlines the path and method for each endpoint. ```APIDOC API Endpoints: - Update Service: PUT /reference/update-service - Bundles: - Get Bundles: GET /reference/get-bundles - Get Bundle Entities: GET /reference/get-bundle-entities - Settings: - Get Company Settings: GET /reference/get-company-settings - Get Locations: GET /reference/get-locations - Get Location Resources: GET /reference/get-location-resources - Get Employees: GET /reference/get-employees - Get Company Taxes: GET /reference/get-company-taxes - Get Order/Estimate Types: GET /reference/get-orderestimate-types - Get Order/Estimate Custom Fields: GET /reference/get-ordersestimate-custom-fields - Get Directories: GET /reference/get-directories - Get Directory Items: GET /reference/get-directory-items - Get Ad Campaigns: GET /reference/get-ad-campaigns - Get Prices: GET /reference/get-prices - Get Units of measurement: GET /reference/get-units-of-measurement - Webhooks: - Webhooks Guide: /reference/webhooks ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/reopen-task Endpoints for managing products, including retrieval, categories, creation, and updates. ```APIDOC Products: Get Products (GET) Get Product by ID (GET) Get Product Categories (GET) Create Product (POST) Update Product (PUT) ``` -------------------------------- ### RemOnline Public API Reference Source: https://remonline.readme.io/reference/getting-started-with-api/create-order-comment Detailed documentation of the RemOnline Public API, listing all available resource categories and their respective HTTP methods and endpoints for interaction. ```APIDOC RemOnline Public API: Tasks: Get Tasks (GET) Get Task by ID (GET) Create Task (POST) Update Task (PUT) Close Task (POST) Reopen Task (POST) Create Comment on Task (POST) Inquiries: Get Inquiry Statuses (GET) Get Inquiry Types (GET) Get Inquiry Custom Fields (GET) Get Inquiries (GET) Create Inquiry (POST) Update Inquiry (PUT) Change Inquiry Status (POST) Create Inquiry Comment (POST) Estimates: Get Estimate Statuses (GET) Get Estimates (GET) Get Estimate by ID (GET) Create Estimate (POST) Update Estimate (PATCH) Get Estimate Items (GET) Add Estimate Item (POST) Update Estimate Item (PATCH) Change Estimate Status (POST) Create Estimate Comment (POST) Get Estimate Public Page Url (GET) Orders: Get Order Statuses (GET) Get Orders (GET) Get Order by Id (GET) Create Order (POST) Update Order (PATCH) Get Order Items (GET) Add Order Item (POST) Update Order Item (PATCH) Update Order Status (POST) Create Order Comment (POST) Get Order Public Page Url (GET) Sales: Get Sales (GET) Cashbox: Get Cashboxes (GET) Get Cashbox Transactions (GET) Get Cashflow Items (GET) Create Payment (POST) Invoices: Get Invoice Statuses (GET) Get Invoices (GET) Get Invoice by ID (GET) Create Comment for Invoice (POST) Inventory: Get Warehouses (GET) Get Warehouse Bins (GET) Get Stock (GET) Get Product Serial Numbers (GET) Get Postings (GET) Get Transfers (GET) Get Write-Offs (GET) Create Posting (POST) Create Write-off (POST) Create Transfer (POST) Assets: Get Assets (GET) Get Asset by ID (GET) Create Asset (POST) Update Asset (PUT) Move Asset (POST) Get Asset Custom Fields (GET) Get Directories of Assets (GET) Contacts: Get Contacts (GET) Get Contact by ID (GET) Create Contact (POST) Update Contact (PUT) Merge Contacts (POST) Create Comment on Contact (POST) Get Contact Custom Fields (GET) Products: Get Products (GET) Get Product by ID (GET) Get Product Categories (GET) Create Product (POST) Update Product (PUT) Services: Get Services (GET) Get Service by ID (GET) Get Service Categories (GET) Create Service (POST) ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/create-posting Documentation for managing products in RemOnline, including retrieval, creation, updates, and category management. ```APIDOC Products: Get Products (GET) Get Product by ID (GET) Get Product Categories (GET) Create Product (POST) Update Product (PUT) ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/get-leads Offers API endpoints for managing products in RemOnline, including retrieval of products by ID, product categories, and creation and update of products. ```APIDOC Products Endpoints: - Get Products GET (/reference/get-products) - Get Product by ID GET (/reference/get-product-by-id) - Get Product Categories GET (/reference/get-product-categories) - Create Product POST (/reference/create-product) - Update Product PUT (/reference/update-product) ``` -------------------------------- ### Retrieve List of Tasks from RemOnline API Source: https://remonline.readme.io/reference/getting-started-with-api/index Demonstrates how to fetch a list of tasks from the RemOnline API using a GET request, including the necessary Bearer token authentication. Examples are provided for HTTP, Python, PHP, Kotlin, and Java. ```HTTP GET /tasks HTTP/1.1 Host: api.remonline.app Authorization: Bearer 946389976c464478beb0cf7a7b5b01bb ``` ```Python import requests API_KEY = "946389976c464478beb0cf7a7b5b01bb" url = "https://api.remonline.app/tasks" headers = { "Authorization": f"Bearer {API_KEY}" } response = requests.get(url, headers=headers) print(response.status_code) print(response.json()) ``` ```PHP "https://api.remonline.app/tasks", CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "Authorization: Bearer $apiKey" ] ]); $response = curl_exec($curl); $httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); echo "HTTP Status: $httpCode\n"; echo "Response: $response\n"; ?> ``` ```Kotlin import okhttp3.OkHttpClient import okhttp3.Request const val API_KEY = "946389976c464478beb0cf7a7b5b01bb" fun main() { val client = OkHttpClient() val request = Request.Builder() .url("https://api.remonline.app/tasks") .addHeader("Authorization", "Bearer $API_KEY") .build() val response = client.newCall(request).execute() println("HTTP Status: ${response.code}") println("Response: ${response.body?.string()}") } ``` ```Java import java.io.BufferedReader; import java.io.InputStreamReader; import java.net.HttpURLConnection; import java.net.URL; public class Main { private static final String API_KEY = "946389976c464478beb0cf7a7b5b01bb"; public static void main(String[] args) throws Exception { URL url = new URL("https://api.remonline.app/tasks"); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setRequestMethod("GET"); conn.setRequestProperty("Authorization", "Bearer " + API_KEY); int status = conn.getResponseCode(); BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream())); String inputLine; StringBuilder content = new StringBuilder(); while ((inputLine = in.readLine()) != null) { content.append(inputLine); } in.close(); conn.disconnect(); System.out.println("HTTP Status: " + status); System.out.println("Response: " + content.toString()); } } ``` -------------------------------- ### RemOnline API: Products Management Source: https://remonline.readme.io/reference/getting-started-with-api/get-clients Endpoints for managing products, including retrieval, creation, updates, and categories. ```APIDOC Products: Get Products: GET /reference/get-products Get Product by ID: GET /reference/get-product-by-id Get Product Categories: GET /reference/get-product-categories Create Product: POST /reference/create-product Update Product: PUT /reference/update-product ``` -------------------------------- ### RemOnline API Endpoints Reference Source: https://remonline.readme.io/reference/getting-started-with-api/update-order-status A comprehensive reference of available API endpoints for various RemOnline resources, including service updates, bundles, and company settings. This section outlines the available GET and PUT operations across different modules, along with a link to the Webhooks Guide. ```APIDOC Service: - Update Service (PUT) /reference/update-service Bundles: - Get Bundles (GET) /reference/get-bundles - Get Bundle Entities (GET) /reference/get-bundle-entities Settings: - Get Company Settings (GET) /reference/get-company-settings - Get Locations (GET) /reference/get-locations - Get Location Resources (GET) /reference/get-location-resources - Get Employees (GET) /reference/get-employees - Get Company Taxes (GET) /reference/get-company-taxes - Get Order/Estimate Types (GET) /reference/get-orderestimate-types - Get Order/Estimate Custom Fields (GET) /reference/get-ordersestimate-custom-fields - Get Directories (GET) /reference/get-directories - Get Directory Items (GET) /reference/get-directory-items - Get Ad Campaigns (GET) /reference/get-ad-campaigns - Get Prices (GET) /reference/get-prices - Get Units of measurement (GET) /reference/get-units-of-measurement Webhooks: - Webhooks Guide /reference/webhooks ``` -------------------------------- ### RemOnline API Endpoints Overview Source: https://remonline.readme.io/reference/getting-started-with-api/create-product A comprehensive list of available API endpoints for various RemOnline resources, including services, bundles, settings, and webhooks, providing quick access to different functionalities. ```APIDOC API Endpoints: - Update Service (PUT /reference/update-service) - Bundles: - Get Bundles (GET /reference/get-bundles) - Get Bundle Entities (GET /reference/get-bundle-entities) - Settings: - Get Company Settings (GET /reference/get-company-settings) - Get Locations (GET /reference/get-locations) - Get Location Resources (GET /reference/get-location-resources) - Get Employees (GET /reference/get-employees) - Get Company Taxes (GET /reference/get-company-taxes) - Get Order/Estimate Types (GET /reference/get-orderestimate-types) - Get Order/Estimate Custom Fields (GET /reference/get-ordersestimate-custom-fields) - Get Directories (GET /reference/get-directories) - Get Directory Items (GET /reference/get-directory-items) - Get Ad Campaigns (GET /reference/get-ad-campaigns) - Get Prices (GET /reference/get-prices) - Get Units of measurement (GET /reference/get-units-of-measurement) - Webhooks: - Webhooks Guide (/reference/webhooks) ``` -------------------------------- ### Get Order/Estimate Custom Fields API Endpoint Details Source: https://remonline.readme.io/reference/getting-started-with-api/get-ordersestimate-custom-fields Retrieves a list of custom fields associated with orders or estimates from the RemOnline API. This endpoint supports OAuth2 and Bearer token authentication. While no specific code examples are provided, client libraries are available for Shell, Node, Ruby, PHP, and Python. ```APIDOC Method: GET Endpoint: https://api.remonline.app/orders/custom-fields Authentication: - OAuth2 - Bearer Supported Client Languages: - Shell - Node - Ruby - PHP - Python Response: Click 'Try It!' to start a request and see the response here! ``` -------------------------------- ### RemOnline API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/move-asset Handles product management, including retrieval, categories, creation, and updates. ```APIDOC Products: Get Products: GET /reference/get-products Get Product by ID: GET /reference/get-product-by-id Get Product Categories: GET /reference/get-product-categories Create Product: POST /reference/create-product Update Product: PUT /reference/update-product ``` -------------------------------- ### RemOnline Products API Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/webhooks Documentation for managing products in RemOnline, covering retrieval, creation, update, and product categories. ```APIDOC Products API Endpoints: - Get Products (GET) - Get Product by ID (GET) - Get Product Categories (GET) - Create Product (POST) - Update Product (PUT) ``` -------------------------------- ### RemOnline API Endpoints for Products Management Source: https://remonline.readme.io/reference/getting-started-with-api/get-directories-of-assets Enables management of products, including retrieval of products by ID, product categories, creating new products, and updating existing ones. ```APIDOC Products: Get Products (GET) Get Product by ID (GET) Get Product Categories (GET) Create Product (POST) Update Product (PUT) ``` -------------------------------- ### Get Transfers API Endpoint Source: https://remonline.readme.io/reference/getting-started-with-api/get-transfers Retrieves a list of warehouse transfers. This endpoint uses the GET method and requires OAuth2 Bearer token authentication. ```APIDOC Method: GET Endpoint: https://api.remonline.app/warehouse/moves/ Description: Returns list of transfers. Authentication: OAuth2 Bearer ``` -------------------------------- ### RemOnline API Endpoints Overview Source: https://remonline.readme.io/reference/getting-started-with-api/getting-started-with-api A comprehensive list of available API endpoints for managing various aspects of RemOnline data, including services, bundles, settings, and more. This section provides a quick reference to the API's capabilities. ```APIDOC Update Service (PUT) - /reference/update-service Bundles (GET) - /reference/get-bundles Get Bundle Entities (GET) - /reference/get-bundle-entities Settings: Get Company Settings (GET) - /reference/get-company-settings Get Locations (GET) - /reference/get-locations Get Location Resources (GET) - /reference/get-location-resources Get Employees (GET) - /reference/get-employees Get Company Taxes (GET) - /reference/get-company-taxes Get Order/Estimate Types (GET) - /reference/get-orderestimate-types Get Order/Estimate Custom Fields (GET) - /reference/get-ordersestimate-custom-fields Get Directories (GET) - /reference/get-directories Get Directory Items (GET) - /reference/get-directory-items Get Ad Campaigns (GET) - /reference/get-ad-campaigns Get Prices (GET) - /reference/get-prices Get Units of measurement (GET) - /reference/get-units-of-measurement Webhooks Guide - /reference/webhooks ``` -------------------------------- ### RemOnline Public API: Products Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/update-client Covers API endpoints for managing products, including retrieval by ID, category retrieval, creation, and update. ```APIDOC Products: - Get Products (GET) - Get Product by ID (GET) - Get Product Categories (GET) - Create Product (POST) - Update Product (PUT) ``` -------------------------------- ### Get Tasks API Endpoint Source: https://remonline.readme.io/reference/getting-started-with-api/get-tasks Defines the HTTP GET endpoint for retrieving tasks from the RemOnline API, specifying the URL and supported authentication methods. ```APIDOC get https://api.remonline.app/tasks Credentials: OAuth2 Bearer ``` -------------------------------- ### Get Location Resources API Endpoint Source: https://remonline.readme.io/reference/getting-started-with-api/get-location-resources Documents the API endpoint for retrieving location-specific resources within the RemOnline system. This GET request requires OAuth2 or Bearer token authentication. ```APIDOC GET https://api.remonline.app/branches/resources/ Credentials: OAuth2 Bearer ``` -------------------------------- ### RemOnline API: Orders Endpoints Source: https://remonline.readme.io/reference/getting-started-with-api/getting-started-with-api API endpoints for managing customer orders, covering status, order creation, updates, item management, and public page URL retrieval. ```APIDOC Orders API Endpoints: Get Order Statuses: GET /reference/get-order-statuses Get Orders: GET /reference/get-orders Get Order by Id: GET /reference/get-order-by-id Create Order: POST /reference/create-order Update Order: PATCH /reference/update-order Get Order Items: GET /reference/get-order-items Add Order Item: POST /reference/create-order-item Update Order Item: PATCH /reference/update-order-item Update Order Status: POST /reference/update-order-status Create Order Comment: POST /reference/create-order-comment Get Order Public Page Url: GET /reference/get-order-public-page-url ``` -------------------------------- ### RemOnline Public API Reference Source: https://remonline.readme.io/reference/getting-started-with-api/get-product-categories This snippet provides a structured overview of the RemOnline Public API, detailing all available resources and their associated endpoints, including HTTP methods for each operation. ```APIDOC RemOnline Public API Overview: Getting Started Tasks: Get Tasks (GET) Get Task by ID (GET) Create Task (POST) Update Task (PUT) Close Task (POST) Reopen Task (POST) Create Comment on Task (POST) Inquiries: Get Inquiry Statuses (GET) Get Inquiry Types (GET) Get Inquiry Custom Fields (GET) Get Inquiries (GET) Create Inquiry (POST) Update Inquiry (PUT) Change Inquiry Status (POST) Create Inquiry Comment (POST) Estimates: Get Estimate Statuses (GET) Get Estimates (GET) Get Estimate by ID (GET) Create Estimate (POST) Update Estimate (PATCH) Get Estimate Items (GET) Add Estimate Item (POST) Update Estimate Item (PATCH) Change Estimate Status (POST) Create Estimate Comment (POST) Get Estimate Public Page Url (GET) Orders: Get Order Statuses (GET) Get Orders (GET) Get Order by Id (GET) Create Order (POST) Update Order (PATCH) Get Order Items (GET) Add Order Item (POST) Update Order Item (PATCH) Update Order Status (POST) Create Order Comment (POST) Get Order Public Page Url (GET) Sales: Get Sales (GET) Cashbox: Get Cashboxes (GET) Get Cashbox Transactions (GET) Get Cashflow Items (GET) Create Payment (POST) Invoices: Get Invoice Statuses (GET) Get Invoices (GET) Get Invoice by ID (GET) Create Comment for Invoice (POST) Inventory: Get Warehouses (GET) Get Warehouse Bins (GET) Get Stock (GET) Get Product Serial Numbers (GET) Get Postings (GET) Get Transfers (GET) Get Write-Offs (GET) Create Posting (POST) Create Write-off (POST) Create Transfer (POST) Assets: Get Assets (GET) Get Asset by ID (GET) Create Asset (POST) Update Asset (PUT) Move Asset (POST) Get Asset Custom Fields (GET) Get Directories of Assets (GET) Contacts: Get Contacts (GET) Get Contact by ID (GET) Create Contact (POST) Update Contact (PUT) Merge Contacts (POST) Create Comment on Contact (POST) Get Contact Custom Fields (GET) Products: Get Products (GET) Get Product by ID (GET) Get Product Categories (GET) Create Product (POST) Update Product (PUT) Services: Get Services (GET) Get Service by ID (GET) Get Service Categories (GET) Create Service (POST) ``` -------------------------------- ### Get Cashflow Items API Endpoint Details Source: https://remonline.readme.io/reference/getting-started-with-api/get-cashflowitems Detailed documentation for the 'Get Cashflow Items' API endpoint, including its method, URL, purpose, and specific field direction types. ```APIDOC Endpoint: Method: GET URL: https://api.remonline.app/cashflowitems Description: Get the list of cashbox payments. Field Direction Types: 0: Income 1: Expense Authentication: Type: OAuth2 Scheme: Bearer ``` -------------------------------- ### Get Bundles API Endpoint Definition Source: https://remonline.readme.io/reference/getting-started-with-api/get-bundles Defines the HTTP GET endpoint for retrieving a list of all existing bundles from the RemOnline application. This endpoint requires OAuth2 or Bearer token authentication. ```APIDOC GET https://api.remonline.app/bundles/ Description: Returns a list of existing bundles. Credentials: OAuth2 Bearer ```