Download the PHP package quaderno/quaderno without Composer

PHP Wrapper for Quaderno API

This library is a PHP wrapper to connect and handle the Quaderno API in a nicer way.

A Quaderno account is needed for using it. You can sign up for a free trial or use our sandbox environment to test your integration before going live.

Requirements

• PHP 5 or higher
• cURL (included by default in recent PHP versions)

Installation

Install via Composer, or just copy all the files into a single folder in your project.

Usage

A rule of thumb to take into account when using the wrapper is that calls to the API are actually only made with the methods: 'find()', 'save()', 'delete()', 'deliver()' and 'ping()'.

To obtain correct tax calculations, it's key to set your account defaults correctly. Tax calculation API calls infer any parameter not explicitly set in the call from your account configuration. Check https://developers.quaderno.io/guides/tax-calculations to learn more.

Load

Setup

Testing connection

Pagination

⚠️ There's a known limitation on the current version of the PHP wrapper which does not allow to easily inspect response headers, like the ones used to facilitate pagination from version 20210316 (X-Pages-NextPage and X-Pages-HasMore). For now, you can workaround that either by playing with more requests with smaller data ranges and higher limit to fetch more docs (max 100); or fetch your first find data with any query and then perform another paginated request with the created_before parameter and the ID of the last returned document, until the response is empty.

Taxes

Quaderno allows you to calculate tax rates and validate tax IDs.

Calculating taxes

Check our API docs to know all valid parameters.

Validate tax ID

Check our API docs to know the supported tax jurisdictions.

Contacts

A contact is any customer or vendor who appears on your invoices, credit notes, and expenses.

Find contacts

Returns false if request fails.

Creating and updating a contact

Retrieve a contact by payment processor ID

Products

Products are those goods or services that you sell to your customers.

Find products

Returns false if request fails.

Creating and updating a product

Transactions

Create a Transaction object to easily send sales & refunds from your app to Quaderno. We'll use them to issue invoices & credit notes, as well as update tax reports automatically.

Create a transaction

Billing documents

A billing document is either an invoice, an expense, a credit or an estimate.

Find documents

Note: In order to looking up for number, contact name or P.O. number fields, you must set the 'q' param in the params array.

Retrieve a document by payment processor ID

Create and update a document

Deliver a document

Only possible in invoices, credit notes, and estimates. The contact must have an email address defined.

Payments

Payments in Quaderno-lingo represent the recording of a successful payment.

Add a payment to a document

You can add a payment only to invoices and expenses. Input should be a QuadernoPayment object.

Get payments

Remove a payment

Evidence

Location evidence are proofs of the customer's location that should be stored in order to be compliant with tax rules in some tax jurisdictions (e.g. EU VAT).

Creating a location evidence

Webhooks

Webhooks refers to a combination of elements that collectively create a notification and reaction system within a larger integration.

Find webhooks

Returns false if request fails.

Sessions

A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through Quaderno Checkout.

Creating and updating a Checkout Session

More information

Remember this is only a PHP wrapper for the original API. If you want more information about the API itself, head to the original API documentation.

License

(The MIT License)

Copyright © 2013-2023 Quaderno

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.