Paymo

The Paymo modules allow you to watch, create, update, list, delete, and retrieve the task, tasklist, projects, invoices, clients, and time entries in your Paymo account.

Getting Started with Paymo

Prerequisites

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting Paymo to Integromat

To connect your Paymo account to Integromat you need to obtain the API Key from your Paymo account and insert it in the Create a connection dialog in the Integromat module.

1. Login to your Paymo account.

2. Click Your Profile Icon > My Settings > API Keys > Generate New API button.

V8KL4EwelK.gif

3. Enter a name for the API Key, click Generate, and copy the API key to your clipboard.

paymo1.png

4. Go to Integromat and open the Paymo module's Create a connection dialog.

JRZEJCvPpR.gif

5. In the Connection name field, enter a name for the connection.

6. In the API Key field, enter the API key copied in step 3.

7. In the Password field, enter your account password, and click Continue.

The connection has been established.

Task

Watch New Tasks

Triggers when a new task hs been created.

You do not have to add the webhooks in the Paymo as it is automatically done for you once you add and save an instant trigger module to your scenario.

WebhookEnter a name for the webhook.
ConnectionEstablish a connection to your Paymo account.

List Tasks

Returns a list of tasks.

ConnectionEstablish a connection to your Paymo account.
Project IDSelect the Project ID whose tasks you want to list.
Tasklist IDSelect the TaskList ID of the project whose tasks you want to list.
User IDSelect the User ID to list only those tasks related to the user.
CompletedSelect whether you want to list the completed tasks:
  • Yes
  • No
  • Not defined
Assigned toSelect the assignee to list only those tasks assigned to the specified user.
IncludeSelect the options whose details you want to include in the task.
LimitSet the maximum number of tasks Integromat should return during one scenario execution cycle.

Get a Task

Returns information about a specified task.

ConnectionEstablish a connection to your Paymo account.
Task IDSelect the Task ID whose details you want to retrieve.
IncludeSelect the options you want to include in the details.

Create a Task

Creates a task.

ConnectionEstablish a connection to your Paymo account.
Task NameEnter the name of the task.
Tasklist IDSelect the Tasklist ID for the task.
User IDSelect the User ID to whom you want to assign the task.
CompleteSelect whether this is completed:
  • Yes
  • No
  • Not defined
Status IDSelect the status of the task:
  • Backlog
  • To Do
  • In Progress
  • Complete
BillableSelect whether the task is billable:
  • Yes
  • No
  • Not defined
Flat BillingSelect whether this task is flat billable:
  • Yes
  • No
  • Not defined

This option applies only for the Time & Materials projects.

Position of the TaskEnter the position of the task in the Tasklist.
DescriptionEnter the details of the project. 
Due DateEnter the date by when the task must be completed.
Budget HoursEnter the hours allocated for the task.
UsersSelect the users whom you want to notify about the task.
PrioritySelect the priority of the task. If no priority is selected, the task priority is set as normal.
  • Low
  • Normal
  • High
  • Critical

Update a Task

Updates the information of a specified task.

ConnectionEstablish a connection to your Paymo account.
Task IDSelect the Task ID whose details you want to update.
Task NameEnter the name of the task.
Tasklist IDSelect the Tasklist ID for the task.
User IDSelect the User ID to whom you want to assign the task.
CompleteSelect whether this is completed:
  • Yes
  • No
  • Not defined
Status IDSelect the status of the task:
  • Backlog
  • To Do
  • In Progress
  • Complete
BillableSelect whether the task is billable:
  • Yes
  • No
  • Not defined
Flat BillingSelect whether this task is flat billable:
  • Yes
  • No
  • Not defined
This option applies only for the Time & Materials projects.
Position of the TaskEnter the position of the task in the Tasklist.
DescriptionEnter the details of the project. 
Due DateEnter the date by when the task must be completed.
Budget HoursEnter the hours allocated for the task.
UsersSelect the users whom you want to notify about the task.
PrioritySelect the priority of the task. If no priority is selected, the task priority is set as normal.
  • Low
  • Normal
  • High
  • Critical

Delete a Task

Deletes a specified task.

ConnectionEstablish a connection to your Paymo account.
Task IDSelect the Task ID you want to delete.

Task List

Watch New Task Lists

Triggers when a new task list has been created.

You do not have to add the webhooks in the Paymo as it is automatically done for you once you add and save an instant trigger module to your scenario.

ConnectionEstablish a connection to your Paymo account.
Task IDSelect the Task ID whose details you want to update.

List Task Lists

Returns a list of task lists.

ConnectionEstablish a connection to your Paymo account.
Search BySelect the option to search the task lists:
  • Project 
  • Milestone
Project IDSelect the Project ID whose task lists you want to list.
Milestone IDSelect the Milestone ID whose task lists you want to list.
IncludeSelect the options whose details you want to include in the task list.
LimitSet the maximum number of task lists Integromat should return during one scenario execution cycle.

Get a Task List

Returns information about a specified task list.

ConnectionEstablish a connection to your Paymo account.
Task List IDSelect the Task List ID whose details you want to retrieve.
IncludeSelect the options whose details you want to include in the task list details.

Create a Task List

Create a new task list.

ConnectionEstablish a connection to your Paymo account.
Task List NameEnter the task list name.
Project IDSelect the Project ID associated with the task list.
Position of the Task ListEnter the task list position in the project.
Milestone IDSelect the Milestone ID for the task list. If you are linking a task list with a milestone, all tasks from the task list should be completed by the milestone due date.

Update a Task List

Updates the information of a specified task list.

ConnectionEstablish a connection to your Paymo account.
Tasklist IDSelect the Tasklist ID whose details you want to update.
Task List NameEnter the task list name.
Project IDSelect the Project ID associated with the task list.
Position of the Task ListEnter the task list position in the project.
Milestone IDSelect the Milestone ID for the task list. If you are linking a task list with a milestone, all tasks from the task list should be completed by the milestone due date.

Delete a Task List

Deletes a specified task list.

ConnectionEstablish a connection to your Paymo account.
Task List IDSelect the Task List ID you want to delete.

Invoice 

Watch New Invoices

Triggers when a new invoice has been created.

You do not have to add the webhooks in the Paymo as it is automatically done for you once you add and save an instant trigger module to your scenario.

WebhookEnter a name for the webhook.
ConnectionEstablish a connection to your Paymo account.

List Invoices

Returns a list of invoices.

ConnectionEstablish a connection to your Paymo account.
Client IDSelect the Client ID whose invoices you want to list.
StatusSelect the status of the invoices:
  • Draft
  • Sent
  • Viewed
  • Paid
  • Void
TotalEnter the invoice amount to list invoices with the specified amount. For example, >100.
IncludeSelect the options whose details you want to include in the invoice.
LimitSet the maximum number of invoices Integromat should return during one scenario execution cycle.

Get an Invoice

Returns information about a specified invoice.

ConnectionEstablish a connection to your Paymo account.
Invoice IDSelect the Invoice ID whose details you want to retrieve.
IncludeSelect the options whose details you want to include in the invoice.

Create an Invoice

Creates a new invoice. 

ConnectionEstablish a connection to your Paymo account.
Client IDSelect the Client ID whose invoice you want to create.
CurrencySelect the applicable currency for the invoice.
Date Enter the date when the invoice is created.
Due DateEnter the date when the invoice is due.
Template IDSelect the Template ID for the invoice.
TaxEnter the tax on the invoice amount in percentage.
Second TaxEnter the tax on the invoice amount in percentage.
NumberEnter the invoice number.
TitleEnter the invoice name.
Delivery DateEnter the date when the items in the invoice must be delivered.
FooterEnter the text that should appear at the footer of the invoice.
DiscountEnter the discount applied to the invoice in percentage.
Discount TextEnter the discount details.
Tax on TaxSelect whether tax is applicable on the tax amount mentioned in the invoice:
  • Yes
  • No
  • Not defined
Bill ToEnter the customer information that should appear in the invoice.
Company InfoEnter the company information that should appear in the invoice.
NotesEnter any additional information about the invoice which you want to mention.
Items

Add the items in the invoice:

ItemEnter the name of the item.
DescriptionEnter the details of the item.
Price UnitEnter the price of the item.
QuantityEnter the number of items in the invoice.
Expense IDSelect the Expense ID applicable for the item.
Apply TaxSelect whether the tax is applicable on the item:
  • Yes
  • No
  • Not defined
Position on Invoice ItemSelect the item position in the invoice.

Update an Invoice

Updates the information of a specified invoice.

ConnectionEstablish a connection to your Paymo account.
Invoice IDSelect the Invoice ID whose details you want to update.
Client IDSelect the Client ID whose invoice you want to create.
CurrencySelect the applicable currency for the invoice.
Date Enter the date when the invoice is created.
Due DateEnter the date when the invoice is due.
Template IDSelect the Template ID for the invoice.
TaxEnter the tax on the invoice amount in percentage.
Second TaxEnter the tax on the invoice amount in percentage.
NumberEnter the invoice number.
TitleEnter the invoice name.
Delivery DateEnter the date when the items in the invoice must be delivered.
FooterEnter the text that should appear at the footer of the invoice.
DiscountEnter the discount applied to the invoice in percentage.
Discount TextEnter the discount details.
Tax on TaxSelect whether tax is applicable on the tax amount mentioned in the invoice:
  • Yes
  • No
  • Not defined
Bill ToEnter the customer information that should appear in the invoice.
Company InfoEnter the company information that should appear in the invoice.
NotesEnter any additional information about the invoice which you want to mention.
Items

Add the items in the invoice:

ItemEnter the name of the item.
DescriptionEnter the details of the item.
Price UnitEnter the price of the item.
QuantityEnter the number of items in the invoice.
Expense IDSelect the Expense ID applicable for the item.
Apply TaxSelect whether the tax is applicable on the item:
  • Yes
  • No
  • Not defined
Position on Invoice ItemSelect the item position in the invoice.

Delete an Invoice

Deletes a specified invoice.

ConnectionEstablish a connection to your Paymo account.
Invoice IDSelect the Invoice ID you want to delete.

Project

Watch New Projects

Triggers when a new project has been created.

You do not have to add the webhooks in the Paymo as it is automatically done for you once you add and save an instant trigger module to your scenario.

WebhookEnter a name for the webhook.
ConnectionEstablish a connection to your Paymo account.

List Projects

Returns all projects.

ConnectionEstablish a connection to your Paymo account.
Client IDSelect the Client ID whose projects you want to list.
Manager IDSelect the Manager ID(s) whose associated projects you want to list.
User IDSelect the User ID (s) whose assigned projects you want to list.
ActiveSelect whether you want to list the active projects:
  • Yes
  • No
  • Not defined
IncludeSelect the options whose details you want to include in the projects.
LimitSet the maximum number of projects Integromat should return during one scenario execution cycle.

Get a Project

Returns information about a specified project.

ConnectionEstablish a connection to your Paymo account.
Project IDSelect the Project ID whose details you want to retrieve.
IncludeSelect the options whose details you want to include in the project.

Create a Project

Creates a new project.

ConnectionEstablish a connection to your Paymo account.
Project NameEnter the project name.
CodeEnter the project code which is used as a prefix in the task code. The project code can only contain alphanumeric (A-Z, numbers 0-9). 
DescriptionEnter the details of the project.
Client IDSelect the Client ID for whom you are creating the project.
Workflow IDSelect the Workflow ID applicable for the project.
Status IDSelect the Status ID of the project:
  • On-hold
  • Canceled
  • Completed
  • Archived
  • Active
  • Proposal
ActiveSelect whether the project is active:
  • Yes
  • No
  • Not defined
Adjustable HoursSelect whether the project hours are adjustable:
  • Yes
  • No
  • Not defined
UsersAdd the users to whom you want to assign the project.
ManagersAdd the managers for the project.
BillableSelect whether the project is billable:
  • Yes
  • No
  • Not defined
Budget HoursEnter the number of hours you want to allocate for the project. If no hours mentioned then the project will have unlimited budget hours.
Price Per HourEnter the project's hourly price details. Applicable only for time & materials project.

Update a Project

Updates the information of a specified project.

ConnectionEstablish a connection to your Paymo account.
Project IDSelect the Project ID whose details you want to update.
Project NameEnter the project name.
CodeEnter the project code which is used as a prefix in the task code. The project code can only contain alphanumeric (A-Z, numbers 0-9). 
DescriptionEnter the details of the project.
Client IDSelect the Client ID for whom you are creating the project.
Workflow IDSelect the Workflow ID applicable for the project.
Status IDSelect the Status ID of the project:
  • On-hold
  • Canceled
  • Completed
  • Archived
  • Active
  • Proposal
ActiveSelect whether the project is active:
  • Yes
  • No
  • Not defined
Adjustable HoursSelect whether the project hours are adjustable:
  • Yes
  • No
  • Not defined
UsersAdd the users to whom you want to assign the project.
ManagersAdd the managers for the project.
BillableSelect whether the project is billable:
  • Yes
  • No
  • Not defined
Budget HoursEnter the number of hours you want to allocate for the project. If no hours mentioned then the project will have unlimited budget hours.
Price Per HourEnter the project's hourly price details. Applicable only for time & materials project.

Delete a Project

Deletes a specified project.

ConnectionEstablish a connection to your Paymo account.
Project IDSelect the Project ID you want to delete.

Client

Watch New Clients

Triggers when a new client has been created.

You do not have to add the webhooks in the Paymo as it is automatically done for you once you add and save an instant trigger module to your scenario.

WebhookEnter a name for the webhook.
ConnectionEstablish a connection to your Paymo account.

List Clients

Returns a list of clients.

ConnectionEstablish a connection to your Paymo account.
ActiveSelect whether to list active clients:
  • Yes
  • No
  • Not defined
IncludeSelect the options whose details you want to include in the clients.
LimitSet the maximum number of clients Integromat should return during one scenario execution cycle.

Get a Client

Returns information about a specified client.

ConnectionEstablish a connection to your Paymo account.
Client IDSelect the Client ID whose details you want to retrieve.
IncludeSelect the options whose details you want to include in the clients.

Create a Client

Creates a new client.

ConnectionEstablish a connection to your Paymo account.
NameEnter the name of the client.
Street AddressEnter the street address of the client.
City NameEnter the city name.
State or RegionEnter the client's state or region name.
Postal CodeEnter the client's area postal code.
CountryEnter the country name.
Phone NumberEnter the phone number of the client.
Fax NumberEnter the fax number of the client.
Email AddressEnter the email address of the client.
Website AddressEnter the client's website URL address.
Fiscal InformationEnter the Fiscal information of the client which is used in the client's invoice.
Client Logo Image URLEnter the client's logo image URL address.

Update a Client

Updates the information of a specified client.

ConnectionEstablish a connection to your Paymo account.
Client IDSelect the Client ID whose details you want to update.
NameEnter the name of the client.
Street AddressEnter the street address of the client.
City NameEnter the client's city name.
State or RegionEnter the client's state or region name.
Postal CodeEnter the client's area postal code.
CountryEnter the country name.
Phone NumberEnter the phone number of the client.
Fax NumberEnter the fax number of the client.
Email AddressEnter the email address of the client.
Website AddressEnter the client's website URL address.
Fiscal InformationEnter the Fiscal information of the client which is used in the client's invoice.
Client Logo Image URLEnter the client's logo image URL address.

Delete a Client

Deletes a specified client.

ConnectionEstablish a connection to your Paymo account.
Client IDSelect the Client ID you want to delete.

Time Entry

Watch New time Entries

Triggers when a new time entry has been created.

You do not have to add the webhooks in the Paymo as it is automatically done for you once you add and save an instant trigger module to your scenario.

WebhookEnter a name for the webhook.
ConnectionEstablish a connection to your Paymo account.

List Time Entries

Returns a list of time entries.

ConnectionEstablish a connection to your Paymo account.
Search BySelect the option to search the time entries:
  • Project
  • Task
  • Client
  • User
  • Time Interval
Project IDSelect the Project ID whose time entries you want to search.
Client IDSelect the Client ID whose time entries you want to search.
User IDSelect the User ID whose time entries you want to search.
Task IDSelect the Task ID whose time entries you want to search.
FromEnter the date to search time entries created on or after the specified date.
ToEnter the date to search time entries created on or before the specified date.
IncludeSelect the options whose details you want to include in the time entries.
LimitSet the maximum number of clients Integromat should return during one scenario execution cycle.

Get a Time Entry

Returns information about a specified time entry.

ConnectionEstablish a connection to your Paymo account.
Time Entry IDSelect the Time Entry ID whose details you want to retrieve.
IncludeSelect the options you want to include in the details.

Create a Time Entry

Creates a new time entry.

ConnectionEstablish a connection to your Paymo account.
Task IDSelect a Task ID whose time entry you want to create.
Choose TimingSelect an option for entering the time:
  • Date and Duration
  • Start and End Time
FromEnter the date to search time entries created on or after the specified date.
ToEnter the date to search time entries created on or before the specified date.
Start TimeEnter the start time.
End TimeEnter the end time
User IDSelect the User ID whose time entry you are creating.
DescriptionEnter the details of the time entry.
Invoice IDSelect the Invoice ID related to the time entry.
BilledSelect whether the time entry is billed:
  • Yes
  • No
  • Not defined

Update a Time Entry

Updates the information of a specified time entry.

ConnectionEstablish a connection to your Paymo account.
Time Entry IDSelect the Time Entry ID whose details you want to update.
Task IDSelect a Task ID whose time entry you want to create.
Choose TimingSelect an option for entering the time:
  • Date and Duration
  • Start and End Time
FromEnter the date to search time entries created on or after the specified date.
ToEnter the date to search time entries created on or before the specified date.
Start TimeEnter the start time.
End TimeEnter the end time
User IDSelect the User ID whose time entry you are creating.
DescriptionEnter the details of the time entry.
Invoice IDSelect the Invoice ID related to the time entry.
BilledSelect whether the time entry is billed:
  • Yes
  • No
  • Not defined

Delete a Time Entry

Deletes a time entry.

ConnectionEstablish a connection to your Paymo account.
Time Entry IDSelect the Time Entry ID you want to delete.

Others

Make an API Call

Performs an arbitrary authorized API call.

ConnectionEstablish a connection to your Paymo account.
URL

Enter a path relative to https://api.paymoapp.com/. For example: /clients

For the list of available endpoints, refer to the Paymo 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.

HeadersEnter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query StringEnter the request query string.
BodyEnter the body content for your API call.

Example of Use - List Projects

The following API call returns all the projects from your Paymo account:

URL:
/projects

Method:
GET

paymo3.png

Matches of the search can be found in the module's Output under BundleBody > projects
In our example, 3 projects were returned:

paymo2.png

 

Popular use cases from our blog

trello2

How to Automatically Turn Tweets Into Inspiring Images [Tutorial]

part4

How to Automate Procurement in Your Shopify Store - Part 4

part3

How to Automate Procurement in Your Shopify Store - Part 3

shopify

How to Automate Procurement in Your Shopify Store - Part 2

crm

8 Powerful and Free CRM Integrations to Boost Your Work

procur

How to Automate Procurement in Your Shopify Store - Part 1

Didn’t find what you were looking for?

Ticket

Create a ticket

Contact our world-class support team and tell us what’s happening.

Create a ticket
Expert

Find an expert

We feature a network of 450+ certified partners across the globe who are ready to help

Find an expert

Automate any workflow in your business

Sign up for a free account today. No credit card required, no time limits on free plan.