README.md

invoiced-php

This repository contains the PHP client library for the Invoiced API.

Installing

The Invoiced package can be installed with composer:

composer require invoiced/invoiced

Requirements

• PHP 5.5+, PHP 7+, or PHP 8+
• Composer

Usage

First, you must instantiate a new client

$invoiced = new Invoiced\Client('{API_KEY}');

Then, API calls can be made like this:

// retrieve invoice
$invoice = $invoiced->Invoice->retrieve('{INVOICE_ID}');

// mark as paid
$payment = $invoiced->Payment->create([
    'amount' => $invoice->balance,
    'method' => 'check',
    'applied_to' => [
        [
            'type' => 'invoice',
            'invoice' => $invoice->id,
            'amount' => $invoice->balance,
        ],
    ]
]);

If you want to use the sandbox API instead then you must set the second argument on the client to true like this:

$invoiced = new Invoiced\Client("{SANDBOX_API_KEY}", true);

Developing

The test suite can be ran with phpunit

Deploying

In order to deploy a new version to Packagist, a new release must be created in GitHub.