Skip to content

bislewl/clearcheckbook_api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ClearCheckbook.com API - PHP Class

This has been tested using PHP 7 and appears to work well. However use at your own risk.

There are several items that still need to be completed but this is just a basic start.

  1. First thing you will need is developer credentials. You can obtain these at at: https://www.clearcheckbook.com/developer It may be helpful to also have the API Documentation
  2. Next thing is to put these files on a server (local or remote)
  3. Add the API credentials to the includes/configure.php file along with your username & password for ClearCheckbook.com
  4. Create your file you wish to use the class in
  5. Add a require() for both the 'includes/configure.php' and 'includes/classes/clearcheckbook_api.php' see example.php if needed
  6. Now you can use it as a typical class.

Example Usages:

Creating Instance:

$ccb_api = new clearcheckbook_api();

Get User Information:

$user_details = $ccb_api->getUser();
echo var_dump($user_details);

Get 50 Most Recent Transactions:

$transaction = array('limit' => 50);
echo var_dump($ccb_api->getTransactions());

@TODO List

  • Create gitHub Repo
  • Provide Instructions
  • Create Class
  • Add Functions
    • _construct
    • apiRequest
    • getUser
    • insertUser
    • getAccounts
    • getAccount
    • insertAccount
    • editAccount
    • deleteAccount
    • getCategories
    • insertCategory
    • editCategory
    • deleteCategory
    • getTransactions
    • getTransaction
    • editTransaction *Need to add support for file attachments and split functionality
    • insertTransaction *Need to add support for file attachments and split functionality
    • deleteTransaction
    • editJive
    • getHistory
    • getAutocomplete
    • Reports Functions
    • Budgets Functions
    • Reminders Functions
    • Bill Tracker Functions
    • Premium Status Functions
    • Currency Codes

Any issues? Create an Issue

Have suggestions/Improvements please fork and perform a pull request.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages