Ronin
The Ronin modules allow you to watch, create, update, list, retrieve, and delete the clients, tasks, contacts, invoices, expenses, payments, projects, and estimates in your Ronin account.
Getting Started with Ronin
Prerequisites
A Ronin account
In order to use Ronin with Make, it is necessary to have a Ronin account. If you do not have one, you can create a Ronin account at roninapp.com.
Note
The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!
Connecting Ronin to Make
To connect your Ronin account to Make you need to obtain the API Token from your Ronin account and insert it in the Create a connection dialog in the Make module.
1. Log in to your Ronin account.
2. Click Your Account Name > Request API Token.
3. Copy the API Token to your clipboard.
4. Go to Make and open the Ronin module's Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the Domain field, enter your Ronin account's domain name. For example, if your account's URL address is www.xyz.ronin.com then your domain name is xyz.
7. In the API Token field, enter the token details copied in step 3, and click Continue.
The connection has been established.
Clients
Triggers when a new client has been created.
Connection | |
Limit | Set the maximum number of clients Make should return during one scenario execution cycle. |
Searches clients.
Connection | |
Updated Since | Enter the date to list the clients created on or after the specified date. |
Sort By | Select the option to sort the clients:
|
Limit | Set the maximum number of clients Make should return during one scenario execution cycle. |
Retrieves a client specified by ID.
Connection | |
Client ID | Select the Client ID whose details you want to retrieve. |
Creates a new client.
Connection | |
Name | Select the Client ID whose details you want to retrieve. |
Number | Enter the client's contact number. |
Description | Enter the client's details. |
Website | Enter the client's website. |
Country | Enter the client's country name. |
Address | Enter the client's address. |
Address 2 | Enter the client's alternative address. |
City | Enter the client's city name. |
State | Enter the client's state name. |
Zip | Enter the area postal code. |
Updates a client object.
Connection | |
Client ID | Select the Client ID whose details you want to update. |
Name | Select the Client ID whose details you want to retrieve. |
Number | Enter the client's contact number. |
Description | Enter the client's details. |
Website | Enter the client's website. |
Country | Enter the client's country name. |
Address | Enter the client's address. |
Address 2 | Enter the client's alternative address. |
City | Enter the client's city name. |
State | Enter the client's state name. |
Zip | Enter the area postal code. |
Deletes a client specified by ID.
Connection | |
Client ID | Select the Client ID you want to delete. |
Contacts
Triggers when a new contact has been created.
Connection | |
Limit | Set the maximum number of contacts Make should return during one scenario execution cycle. |
Retrieves a list of contacts.
Connection | |
Client ID | Select the Client ID whose contacts you want to list. |
Limit | Set the maximum number of contacts Make should return during one scenario execution cycle. |
Retrieves a contact specified by ID.
Connection | |
Contact ID | Select the Contact ID whose details you want to retrieve. |
Creates a new contact.
Connection | |
Name | Enter the contact's name. |
Client ID | Select the Client ID to which the contact belongs to. |
Email address | Enter the contact's email address. |
Title | Enter the position of the contact in the client's company. |
Extension | Enter the contact's extension number. |
Phone | Enter the contact's phone number. |
Mobile | Enter the contact's mobile number. |
Updates a contact object.
Connection | |
Contact ID | Select the Contact ID whose details you want to update. |
Name | Enter the contact's name. |
Client ID | Select the Client ID to which the contact belongs to. |
Email address | Enter the contact's email address. |
Title | Enter the position of the contact in the client's company. |
Extension | Enter the contact's extension number. |
Phone | Enter the contact's phone number. |
Mobile | Enter the contact's mobile number. |
Deletes a contact specified by ID.
Connection | |
Contact ID | Select the Contact ID you want to delete. |
Estimates
Triggers when a new estimate has been created.
Connection | |
Limit | Set the maximum number of estimates Make should return during one scenario execution cycle. |
Retrieves a list of estimates.
Connection | |
Expense Nested In | Select the option to choose the estimates you want to list:
|
Project ID | Select the Project ID whose estimates you want to list. |
Client ID | Select the Client ID whose estimates you want to list. |
Limit | Set the maximum number of estimates Make should return during one scenario execution cycle. |
Creates an estimate.
Connection | |||||||||||
Date | Enter the date when the estimate is being created. See the list of supported date and time formats. | ||||||||||
Currency Code | Select the three-character currency code applicable for the estimate. For example, | ||||||||||
Title | Enter a name for the estimate. | ||||||||||
Note | Enter the details of the estimate. | ||||||||||
Number | Enter the estimation number. If no value is provided, then this value will be autoincremented from previous invoice numbers. | ||||||||||
Client ID | Select the Client ID for whom you are preparing the estimate. | ||||||||||
Total Cost | Enter the estimated cost. | ||||||||||
Subtotal | Enter the subtotal amount of the estimation. | ||||||||||
Tax | Enter the tax amount included in the estimation. | ||||||||||
Tax Label | Enter the tax name. For example, | ||||||||||
Tax 2 | Enter the tax amount included in the estimation. | ||||||||||
Tax 2 Label | Enter the tax name. For example, | ||||||||||
Tax 3 | Enter the tax amount included in the estimation. | ||||||||||
Tax 3 Label | Enter the tax name. For example, | ||||||||||
Compound Tax | Select whether the compound tax applicable for the estimation. | ||||||||||
Estimate Items | Add the items which were estimated:
|
Retrieves an estimate specified by ID.
Connection | |
Estimate ID | Select the Estimate ID whose details you want to retrieve. |
Updates an estimate specified by ID.
Connection | |||||||||||
Estimate ID | Select the Estimate ID whose details you want to update. | ||||||||||
Date | Enter the date when the estimate is being created. See the list of supported date and time formats. | ||||||||||
Currency Code | Select the three-character currency code applicable for the estimate. For example, | ||||||||||
Title | Enter a name for the estimate. | ||||||||||
Note | Enter the details of the estimate. | ||||||||||
Number | Enter the estimation number. This value will be autoincremented from previous invoice numbers if not provided. | ||||||||||
Client ID | Select the Client ID for whom you are preparing the estimate. | ||||||||||
Total Cost | Enter the estimated cost. | ||||||||||
Subtotal | Enter the subtotal amount of the estimation. | ||||||||||
Tax | Enter the tax amount included in the estimation. | ||||||||||
Tax Label | Enter the tax name. For example, | ||||||||||
Tax 2 | Enter the tax amount included in the estimation. | ||||||||||
Tax 2 Label | Enter the tax name. For example, | ||||||||||
Tax 3 | Enter the tax amount included in the estimation. | ||||||||||
Tax 3 Label | Enter the tax name. For example, | ||||||||||
Compound Tax | Select whether the compound tax applicable for the estimation. | ||||||||||
Estimate Items | Add the items which were estimated:
|
Deletes an estimate specified by ID.
Connection | |
Estimate ID | Select the Estimate ID you want to delete. |
Expenses
Triggers when a new expense has been created.
Connection | |
Limit | Set the maximum number of expenses Make should return during one scenario execution cycle. |
Searches expenses.
Connection | |
From Date | Enter the date from which you search the expenses. See the list of supported date and time formats. |
To Date | Enter the date until which you search the expenses. See the list of supported date and time formats. |
Expense Nested In | Select the option whose expenses you want to search:
|
Limit | Set the maximum number of expenses Make should return during one scenario execution cycle. |
Creates a new response.
Connection | |
Amount | Enter the expense amount. |
Description | Enter the details of the expense. |
Invoice ID | Select the Invoice ID to which you want to associate the expense. |
Incurred On | Enter the date and time of the occurrence of the expense. See the list of supported date and time formats. |
Refers To | Select the option to which the expense belongs to. For example, |
Retrieves an expense specified by ID.
Connection | |
Expense ID | Select the Expense ID whose details you want to retrieve. |
Updates an expense specified by ID.
Connection | |
Expense ID | Select the Expense ID whose details you want to update. |
Amount | Enter the expense amount. |
Description | Enter the details of the expense. |
Invoice ID | Select the Invoice ID to which you want to associate the expense. |
Incurred On | Enter the date and time of the occurrence of the expense. See the list of supported date and time formats. |
Refers To | Select the option to which the expense belongs to. For example, |
Deletes an expense specified by ID.
Connection | |
Expense ID | Select the Expense ID you want to delete. |
Invoices
Triggers when a new invoice has been created.
Connection | |
Limit | Set the maximum number of invoices Make should return during one scenario execution cycle. |
Searches invoices.
Connection | |
To Date | Enter the date until which you want to search the invoices. |
Expense Nested In | Select the option in which you want to search the invoices. |
Client ID | Select the Client ID whose invoices you want to search. |
Project ID | Select the Project ID whose invoices you want to search. |
Limit | Set the maximum number of invoices Make should return during one scenario execution cycle. |
Creates an invoice.
Connection | |||||||
Date | Enter the date when the invoice is being created. See the list of supported date and time formats. | ||||||
Due Date | Enter the date when the invoice is due for the payment. See the list of supported date and time formats. | ||||||
Currency Code | Select the three-character currency code applicable to the invoice. | ||||||
Title | Enter the invoice name. | ||||||
Note | Enter the information about the invoice. | ||||||
Client ID | Select the Client ID to whom the invoice belongs to. | ||||||
Number | Enter the invoice number. | ||||||
Total Cost | Enter the total amount of the invoice. | ||||||
Balance | Enter the balance amount payable for the invoice. | ||||||
Subtotal | Enter the subtotal amount of the invoice. | ||||||
Tax | Enter the tax amount applicable to the invoice. | ||||||
Tax Label | Enter the tax name. For example, | ||||||
Tax 2 | Enter the tax amount applicable to the invoice. | ||||||
Tax Label | Enter the tax name. For example, | ||||||
Tax 3 | Enter the tax amount applicable to the invoice. | ||||||
Tax Label | Enter the tax name. For example, | ||||||
Compound Tax | Select whether the compound tax is applicable to the invoice. | ||||||
Summary | Enter the summary details of the invoice. | ||||||
Invoice Items | Add the invoice items:
|
Retrieves invoice details specified by ID.
Connection | |
Invoice ID | Select the Invoice ID whose details you want to retrieve. |
Updates an invoice specified by ID.
Connection | |||||||
Invoice ID | Select the Invoice ID whose details you want to update. | ||||||
Date | Enter the date when the invoice is being created. See the list of supported date and time formats. | ||||||
Due Date | Enter the date when the invoice is due for the payment. See the list of supported date and time formats. | ||||||
Currency Code | Select the three-character currency code applicable to the invoice. | ||||||
Title | Enter the invoice name. | ||||||
Note | Enter the information about the invoice. | ||||||
Client ID | Select the Client ID to whom the invoice belongs to. | ||||||
Number | Enter the invoice number. | ||||||
Total Cost | Enter the total amount of the invoice. | ||||||
Balance | Enter the balance amount payable for the invoice. | ||||||
Subtotal | Enter the subtotal amount of the invoice. | ||||||
Tax | Enter the tax amount applicable to the invoice. | ||||||
Tax Label | Enter the tax name. For example, | ||||||
Tax 2 | Enter the tax amount applicable to the invoice. | ||||||
Tax Label | Enter the tax name. For example, | ||||||
Tax 3 | Enter the tax amount applicable to the invoice. | ||||||
Tax Label | Enter the tax name. For example, | ||||||
Compound Tax | Select whether the compound tax is applicable to the invoice. | ||||||
Summary | Enter the summary details of the invoice. | ||||||
Invoice Items | Add the invoice items:
|
Deletes an invoice specified by ID.
Connection | |
Invoice ID | Select the Invoice ID whose details you want to retrieve. |
Tasks
Triggers when a new task has been created.
Connection | |
Limit | Set the maximum number of tasks Make should return during one scenario execution cycle. |
Retrieves a list of tasks.
Connection | |
Project ID | Select the Project ID whose tasks you want to list. |
Limit | Set the maximum number of tasks Make should return during one scenario execution cycle. |
Creates a new task.
Connection | |
Title | Enter the task name. |
Description | Enter the task details. |
Assignee ID | Select the Assignee ID to whom you want to assign the task. |
Refers To | Select the option to which this task belongs to:
|
Due Date | Enter the date by when this task must be completed. See the list of supported date and time formats. |
Complete | Select whether the task is completed. |
Complete At | Enter the date when the task is completed. See the list of supported date and time formats. |
Retrieves a task specified by ID.
Connection | |
Task ID | Select the Task ID whose details you want to retrieve. |
Updates a task specified by ID.
Connection | |
Task ID | Select the Task ID whose details you want to update. |
Title | Enter the task name. |
Description | Enter the task details. |
Assignee ID | Select the Assignee ID to whom you want to assign the task. |
Refers To | Select the option to which this task belongs to:
|
Due Date | Enter the date by when this task must be completed. See the list of supported date and time formats. |
Complete | Select whether the task is completed. |
Complete At | Enter the date when the task is completed. See the list of supported date and time formats. |
Deletes a task specified by ID.
Connection | |
Task ID | Select the Task ID you want to delete. |
Other
Performs an arbitrary API call.
Connection | |
URL | Enter a path relative to NoteFor the list of available endpoints, refer to the Ronin API Documentation. |
Method | Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
Headers | Enter the desired request headers. You don't have to add authorization headers; we already did that for you. |
Query String | Enter the request query string. |
Body | Enter the body content for your API call. |
The following API call returns all the projects from your Ronin account:
URL: /projects
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body > projects. In our example, 2 projects were returned:
Triggers when a new payment has been created.
Connection | |
Limit | Set the maximum number of payments Make should return during one scenario execution cycle. |
Triggers when a new project has been created.
Connection | |
Limit | Set the maximum number of new projects Make should return during one scenario execution cycle. |
Triggers when a new staff member has been added.
Connection | |
Limit | Set the maximum number of new staff members Make should return during one scenario execution cycle. |
Retrieves a list of projects.
Connection | |
Client ID | Select the Client ID whose projects you want to list. |
Limit | Set the maximum number of projects Make should return during one scenario execution cycle. |