GET
/
v2
/
invoice
curl --request GET \
  --url https://api.sonderplan.com/v2/invoice \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 1,
      "prefix": "INV-",
      "number": 892,
      "date": 1547501100,
      "date_time_iso": "2022-02-22T09:00:00+11:00",
      "due_date": 1547501100,
      "due_date_time_iso": "2022-02-22T09:00:00+11:00",
      "items": [
        {
          "id": 982342,
          "item_text": "Edit Suite 1 Grading",
          "item_uuid": "r2394",
          "ratescheme_id": 989234,
          "description": "Session booked between 10th Jan -> 12th Jan 2023",
          "quantity": "2.4",
          "unit": "hourly",
          "unit_amount": "20.65",
          "unit_buy_amount": "10.15",
          "tax": true,
          "taxes": [
            {
              "id": 3247,
              "name": "GST",
              "rate": "10.00",
              "total": "151.00"
            }
          ],
          "discount": "20.00%",
          "total": "495.00",
          "buy_total": "200.00",
          "buy_total_fixed": false,
          "order": 2,
          "parent_group_id": 234842
        }
      ],
      "groups": [
        {
          "id": 23425,
          "name": "Video Editing Services",
          "description": "Includes all editing services",
          "order": 2,
          "hide_items": true
        }
      ],
      "status": [
        {
          "id": 2,
          "name": "Submitted"
        }
      ],
      "project": [
        {
          "id": 2342354,
          "name": "Andor S1 EP7 Annoucement",
          "code": "AND-S1-EP7",
          "description": "Colonel Yularen announces that the ISB has gained more surveillance and punitive authority, while Meero is challenged by Blevin for breaking protocol by accessing Imperial data without authorization.",
          "status_id": 1
        }
      ],
      "client": [
        {
          "id": 4,
          "uuid": "p4",
          "name": "Jane Someone",
          "type": "person",
          "email": "[email protected]",
          "contact_person": {
            "id": 2837,
            "name": "Fred Flintstone"
          }
        }
      ],
      "custom_fields": [
        {
          "id": 7823,
          "name": "Type",
          "value": "Video Editing",
          "value_id": 8973,
          "update_key": "2_1_7823"
        }
      ],
      "terms": "Payment to be made in 30 days",
      "template_id": 213,
      "cloned_id": 545647,
      "reference": "QU-9893",
      "currency": "AUD",
      "sub_total": "1289.29",
      "discount_total": "872.98",
      "net_total": "416.31",
      "tax_total": "129.87",
      "total": "546.18",
      "created_sp_flag": "true",
      "created_id": 3,
      "created": 1388552400,
      "updated_id": 3,
      "updated": 1388552400
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 1,
      "current_page": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
id
string

One or more (comma seperated) IDs of invoices to retrieve

​
prefix
string

Perform a partial match text search for the invoice prefix

​
number
integer

One or more (comma seperated) invoice numbers to retrieve

​
status_id
integer

Perform an exact match for the invoice status_id. 1 = Draft, 2 = Submitted, 3 = Awaiting Payment, 4 = Paid

​
project_id
integer

Perform an exact match for the invoice project_id

​
from_time
integer

Return invoices with created date greater than this UNIX timestamp

​
to_time
integer

Return invoices with created date less than this UNIX timestamp

​
created_sp_flag
boolean

If true, return invoices created in Sonderplan. If false, return invoices created in FoxOMS

​
template_id
integer

Return invoices using the specified template_id

​
currency
string

Return invoices using the specified currency shortcode

​
updated_after
integer

Return results that were added, edited or deleted since this UNIX timestamp

​
fields
string

Comma seperated list of fields you wish to return

​
page
integer

Specify the page of results you wish to return

​
limit
integer

The number of results returned per page. Default if not specified is 10

​
order_asc
string

Specify the field (with type of string or integer) you wish to order (ascending) the response with

​
order_desc
string

Specify the field (with type of string or integer) you wish to order (descending) the response with

​
filter_operator
enum<string>
default:OR

Specify if multiple filters should be combined with OR or AND logic

Available options:
OR,
AND

Response

200
application/json

Successful Operation

The response is of type object.