amcintosh / freshbooks-php-sdk Goto Github PK

Workflow to run make generate-docs on merge to main and deploy the results to gh pages.

See https://www.freshbooks.com/api/parameters

Add retry plugin (https://docs.php-http.org/en/latest/plugins/retry.html), to client and allow disabling based on config.

Add optional included fields to the client model.

• outstanding_balance
• credit_balance
• draft_balance
• overdue_balance
• grand_total_balance
• last_activity
• late_reminders
• late_fee

See https://www.freshbooks.com/api/clients

You have the quantity type set to integer which only allows whole numbers

May want to make this a float to allow for partial quantities

The error response for the events API has changed. The events resource needs to be updated to handle the new error responses. Currently all errors are creating exceptions with "Unknwon error" as the message.

Resource and Identity response from the /me endpoint.

List, Get, Create, Update, Delete expenses

See https://www.freshbooks.com/api/expenses

When creating an invoice - it returns the following error

Write access denied. Tried to write None to field taxNumber1 of object line

Per Freshbooks Support - we aren't supposed to send/try to set taxNumber1 or taxNumber2

Hi,

Thank you for this great API.

I wonder if this API allows me to set the payment options on an invoice once created.

Thank you
Bill

See https://www.freshbooks.com/api/invoice_presentation_attachments

See https://www.freshbooks.com/api/parameters

I see that Freshbooks calls this a community library https://www.freshbooks.com/api/libraries , but note the ReadMe says 'FreshBooks users are uniquely identified by their email across our entire product.' The repo seems to have only a single contributor but to be very professional and actively under development/maintained.

I'd like to use it but don't want to get tied into an abandoned library. What is the status of @amcintosh 's or others' commitment to maintaining and developing this PHP SDK for Freshbooks?

Add support for the webhook callbacks resource including list, get, create, update, and delete.

See https://www.freshbooks.com/api/webhooks for API documentation.

Add support for the estimates resource including list and get. Prevent calls to create, update, and delete as those are not available.

See https://www.freshbooks.com/api/expense_categories for API documentation.

With list, get, create, update, and delete.

Expenses have an include option for receipt attachment details in a
sub-resource.

See https://www.freshbooks.com/api/expenses

See https://www.freshbooks.com/api/expenses

I needed a client field (username) which the default model doesn't include. It's a deprecated field, so I didn't think it warranted its own pull request.

So I overrode the FreshbBooksClient so I could override the public clients() method and insert a custom model (which extended the base and just added another public property).

The original method looks like this:

   public function clients(): AccountingResource
    {
        return new AccountingResource($this->httpClient, 'users/clients', Client::class, ClientList::class);
    }

$this->httpClient is a private property, so the extension didn't have access to it. I called $this->createHttpClient() in that place, and everything seems to be working perfectly. But it feels like that should maybe be a protected property to make it easier to reuse the same httpClient in my extension.

Anyway this is no big deal. I'm really enjoying the package and it's saving me a lot of time. If you're interested in this change, I could also submit a PR. If you're not interested, that's fine; just go ahead and close this issue.

Thanks so much for this package!

Add support for the estimates resource including list, get, create, update, and delete.

See https://www.freshbooks.com/api/estimates for API documentation.

Currently the client handles generating the auth url (getAuthRequestUrl), but doesn't allow for fetching the access token or refreshing a token.

• Handle the token calls
• Document in README
• Throw error if client not properly configured

Add address and phone number to the Business model.

Add support for the other_income resource including list, get, create, update, and delete.

See https://www.freshbooks.com/api/other_income for API documentation.

Add resource to handle /uploads requests.
See https://www.freshbooks.com/api/invoice_presentation_attachments and https://www.freshbooks.com/api/expense-attachments

Add documentation on how to use uploads.

Support sorting of list calls. See https://www.freshbooks.com/api/parameters

Hi @amcintosh

First of all, does this package support WebHooks? Is there a sample code that first verifies and then listens to WebHook events from FreshBooks?

Thanks
Bill

See https://www.freshbooks.com/api/tasks

See https://www.freshbooks.com/api/items