Home

This module is a small wrapper around the Paymo API.

What is this Paymo thing, anyway?

Paymo is cloud based application for tracking your time and invoice your clients. Before I started using it, I was often forgetting to bill some customer for some of my time, so it rocks my universe. I would recommend it for any freelancer or small consulting business.

If you want to check Paymo, use my referral link:

• http://www.paymo.biz/

If you are using Google Apps, it integrates very nicely.

Install

It is in the cheese shop, so just easy_install or pip it.

pip install paymo

Example usage

Just initialize the API with your credentials and call the API methods as standard python methods feeding parameters by name.

Method and parameter names are the same documented at:

• http://api.paymo.biz/docs/

Examples:

>>> from paymoapi import PaymoAPI
>>> paymo = PaymoAPI('my-paymo-api-key', 'my-username', 'my-password')
>>> # Now you can call apy methods like native python methods
>>> paymo.users.getList()
{u'status': u'ok',
 u'users': {u'user': [{u'active': 1,
                       u'id': u'65535',
                       u'realname': u'Enoch Root',
                       u'username': u'[email protected]'},
                      {u'active': 1,
                       u'id': u'65534',
                       u'realname': u'Thomas A. Anderson',
                       u'username': u'[email protected]'}]}}

>>> # you can even call help
>>> help(paymo.users.getList)
Help on paymo.users.getList in paymo.users object:

class paymo.users.getList(DynamicApi)
 |  ## paymo.users.getList
 |  
 |  Get a list of users from the same company as the authenticated user's
 |  company.
 |  
 |  
 |  ### Authentication
 |  
 |  This method requires authentication .
 |  
 |  
 |  ### Arguments
 |  
 |      api_key (Required):
 |          Your application key. See here for more details.
 |      auth_token (Required):
 |          Authentication token received upon login.
 |  
 |  ### Example Response
 |  
 |  <?xml version="1.0" encoding="UTF-8"?>
 |  <response status="ok">
 |          <users>
 |                  <user id="1279" username="johndoe" realname="John Doe" active="1" />
 |                  <user id="1283" username="marydoe" realname="Mary Doe" active="0" />
 |          </users>
 |  </response>
 |  
 |  
 |  ### Error Codes
 |  
 |      101: Unknown API method:
 |          The requested method was not found.
 |      102: Unknown response format:
 |          The requested response format was not found.
 |      103: Invalid API Key:
 |          The API key passed was not valid.
 |      104: Invalid auth token / Login failed:
 |          The login details or auth token passed were invalid.
 |      105: Insufficient permissions:
 |          The user making the method call did not have the required permissions.
 |      106: Service currently unavailable:
 |          The service is temporarily unavailable.
 |      107: Too many requests for this API key:
 |          The application has reached the limit for number of API calls during a specific time period. Wait a bit and try again.
 |
>>> paymo.auth.logout()

Caveats

• The help strings are automatically scraped from the docs URL. If the HTML format changes, most likely this will stop working.
• English is not my native idiom, sometimes I may sound like Tarzan.