Organizze PHP SDK [BETA]
Organizze é na minha opinião o melhor sistema de controle financeiro pessoal e empresarial.
Essa biblioteca serve para facilitar automação/interação com a plataforma facilitando assim ainda mais sua utilização da plataforma., (*1)
Instalação
Esta biblioteca pode ser encontrada no Packagist.
Recomendamos sua instalação com o composer., (*2)
Para instalar a biblioteca basta executar o seguinte comando no seu terminal, (*3)
$ composer require skaisser/organizze:~0.1
Ou você pode editar seu arquivo composer.json, (*4)
{
"require": {
"skaisser/organizze": "~0.1"
}
}
Então voce deve instalar APENAS UM dos seguintes adaptadores:, (*5)
{
"require": {
"kriswallsmith/buzz": "~0.10",
"guzzle/guzzle": "~3.7",
"guzzlehttp/guzzle": "~5.0",
"guzzlehttp/guzzle": "~6.0"
}
}
Exemplo de utilização
<?php
require 'vendor/autoload.php';
use Skaisser\Organizze\Adapter\GuzzleHttpAdapter;
use Skaisser\Organizze\Organizze;
// Você precisará do seu e-mail e Chave Api para consumir esta api
$adaptador = new GuzzleHttpAdapter('seuemail@provedor.com', 'chave_api_gerada_pelo_organizze');
// Vamos criar o objeto Organizze com o Adaptador selecionado.
$organizze = new Organizze($adaptador);
// ...
Transações (Lançamentos)
// Pegar uma transação especifica por id
$transaction = $organizze->transaction()->getById(:id);
// Criar uma nova Transação | Veja Skaisser/Organizze/Entity/Transaction para parametros disponiveis.
$transaction = $organizze->transaction()->create(array);
// Modificar uma Transação | Veja Skaisser/Organizze/Entity/Transaction para parametros disponiveis.
$account = $organizze->account()->update(:id, array);
Contas [ORGANIZZE MAIS OU EMPRESARIAL]
// Pegar todas as Contas
$accounts = $organizze->account()->getAll();
// Pegar uma Conta por id
$account = $organizze->account()->getById(690486);
// Criar uma nova Conta | tipo disponivel -> Conta Corrente: checking, Conta Poupança: savings, Outros: other
$account = $organizze->account()->create(['name' => 'Banco Itau', 'description' => 'Ag 0123', 'type' => 'checking']);
// Modificar uma Conta | tipo disponivel -> Conta Corrente: checking, Conta Poupança: savings, Outros: other
$account = $organizze->account()->update(:id, array);
Categoria
```php
// ...
// retorna todas as categorias
$category = $organizze->category()->getAll();, (*6)
// Pegar uma categoria por id
$category = $organizze->category()->getById(:id);, (*7)
// Excluir uma Categoria
$category = $organizze->category()->deleteById(:id);, (*8)
// Criar uma nova Categoria
$category = $organizze->category()->create(['name' => 'Nome Categoria']);, (*9)
// Criar uma nova SubCategoria [REQUER ORGANIZZE MAIS OU EMPRESARIAL]
$category = $organizze->category()->create(['name' => 'Nome Subcategoria', 'parent_id' => 'idCategoriaPai']);, (*10)
// Atualize uma Categoria
$category = $organizze->category()->update(:idCategoria, ['name' => 'Novo Nome']);, (*11)
// Atualize uma Subcategoria (alterando a categoria pai)
$category = $organizze->category()->update(:idCategoria, ['parent_id' => 'idCategoriaPai']);, (*12)
````, (*13)
Créditos