An Elixir client for the FreshBooks API.
This is a work in progress. This means that there are a limited set of features available (i.e: the ones I need right now :)) so pull requests to add new features are highly appreciated :)
To use it in your Mix projects, first add it as a dependency:
def deps do
[{:elixir_freshbooks, "~> 0.0.7"}]
endThen run mix deps.get to install it.
In your config.exs, setup the following section:
config :elixir_freshbooks,
url: "https://sample.freshbooks.com/api/2.1/xml-in",
token: "token"In your freshbooks account you should find both values.
Clients are used via the Client module.
alias ElixirFreshbooks.Client, as: C > C.create(
"first_name", "last_name", "organization", "[email protected]",
"username", "password"
)
%ElixirFreshbooks.Client{
email: "[email protected]",
first_name: "first_name",
id: 4422,
last_name: "last_name",
organization: "organization",
username: "username",
password: "password"
}Both username and password are optional arguments.
> C.update %ElixirFreshbooks.Client{id: 4422, password: "new_password"}
:okInvoices are used via the Invoice module.
alias ElixirFreshbooks.Invoice, as: I
alias ElixirFreshbooks.InvoiceLine, as: L # Create a new invoice for the client_id 4422, add one line with the given
# name, description, unit_cost, and quantity.
> I.create 4422, "sent", ["note1", "note2", "note3"], [
L.new("Line Name", "Line Description", 2, 4)
]
%ElixirFreshbooks.Invoice{
client_id: 4422,
id: 9932,
lines: [
%ElixirFreshbooks.InvoiceLine{
description: "Line Description",
name: "Line Name",
quantity: 4,
type: "item",
unit_cost: 2
}
],
notes: ["note1", "note2", "note3"],
status: "sent"
} # Taxes are in percent only, not absolute values.
> item = L.new("Line Name", "Line Description", 2, 4) |>
L.tax("tax name", 7) |>
L.tax("another tax", 3)
> I.create 4422, "sent", ["note1", "note2", "note3"], [item]Payments are used via the Payment module.
alias ElixirFreshbooks.Payment, as: P > P.create 889, 10.50, "Credit Card", ["note1", "note2", "note3"]
%ElixirFreshbooks.Payment{
invoice_id: 889,
amount: 10.50,
id: 778,
notes: ["note1", "note2", "note3"],
type: "Credit Card"
}Expenses are used via the Expense module.
alias ElixirFreshbooks.Expense, as: E > E.create 1, 1994955, 1.23, "test vendor", ["note1", "note2"]
%ElixirFreshbooks.Expense{
amount: 1.23,
category_id: 1994955,
client_id: nil,
date: "2015-12-06",
id: 320343,
notes: ["note1", "note2"],
project_id: nil,
staff_id: 1,
vendor: "test vendor"
}The source code is released under Apache 2 License.
Check LICENSE file for more information.