Retrieve all invoices, filter by query

curl --request GET \
  --url https://api.zivio.net/api/v3/invoices \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

{
  "invoices": [
    {
      "id": "1",
      "status": "draft",
      "job_id": "23",
      "job_summary": "Some text about the project",
      "net_total": "16000.00",
      "tax_total": "2000.00",
      "total": "18000.00",
      "ccy": "GBP",
      "due_on": "2023-11-07T05:31:56Z",
      "dated_on": "2023-11-07T05:31:56Z",
      "milestone_id": "435",
      "line_item_sheet_id": "234",
      "credit_note_id": "124",
      "is_credit_note": "null",
      "credit_note_reason": "invoice paid in error",
      "invoice_items": [
        {
          "id": "1",
          "invoice_id": "123",
          "milestone_id": "3654",
          "line_item_sheet_id": "3645",
          "purchase_order_line_id": "284",
          "description": "Some text about the item",
          "quantity": "10.0",
          "unit_type": "milestone",
          "billing_start": "YYYY-MM-DD",
          "billing_end": "YYYY-MM-DD",
          "ccy": "GBP",
          "unit_cost": "30000.00",
          "cis_type": "materials",
          "net_total_price": "30000.00",
          "tax_rate": "20.0",
          "tax_total": "6000.00",
          "total_price": "36000.00",
          "tax_type": {
            "id": "123",
            "label": "UK VAT",
            "tax_reference": "sales",
            "key": "cis_registered_contractors_deduction",
            "rate": "20.0",
            "country_code": "GB",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "archived": "false",
            "custom_fields": {
              "key": "value"
            }
          }
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "approved_at": "2023-11-07T05:31:56Z",
      "approved_by": {
        "id": "7158",
        "first_name": "Jack",
        "last_name": "Jones",
        "email": "[email protected]",
        "org_name": "Organisation Ltd",
        "org_id": "567",
        "business_unit": "Public Private Partnerships",
        "division": "Infastructure",
        "department": "Bridges",
        "vetting_status": "PASSED",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "custom_fields": {
          "key": "value"
        },
        "has_oversight": "<string>"
      },
      "client": {
        "id": "7158",
        "first_name": "Jack",
        "last_name": "Jones",
        "email": "[email protected]",
        "org_name": "Organisation Ltd",
        "org_id": "567",
        "business_unit": "Public Private Partnerships",
        "division": "Infastructure",
        "department": "Bridge Building",
        "vetting_status": "PASSED",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "custom_fields": {
          "key": "value"
        },
        "has_oversight": "<string>"
      },
      "client_org": {
        "id": "7158",
        "name": "Company Ltd",
        "is_external_client": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "supplier": {
        "id": "77",
        "name": "Company Inc",
        "email": "[email protected]",
        "vetting_status": "PASSED",
        "tax_number": "9876543234",
        "tax_registered": "true",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

GET

invoices

curl --request GET \
  --url https://api.zivio.net/api/v3/invoices \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'

{
  "invoices": [
    {
      "id": "1",
      "status": "draft",
      "job_id": "23",
      "job_summary": "Some text about the project",
      "net_total": "16000.00",
      "tax_total": "2000.00",
      "total": "18000.00",
      "ccy": "GBP",
      "due_on": "2023-11-07T05:31:56Z",
      "dated_on": "2023-11-07T05:31:56Z",
      "milestone_id": "435",
      "line_item_sheet_id": "234",
      "credit_note_id": "124",
      "is_credit_note": "null",
      "credit_note_reason": "invoice paid in error",
      "invoice_items": [
        {
          "id": "1",
          "invoice_id": "123",
          "milestone_id": "3654",
          "line_item_sheet_id": "3645",
          "purchase_order_line_id": "284",
          "description": "Some text about the item",
          "quantity": "10.0",
          "unit_type": "milestone",
          "billing_start": "YYYY-MM-DD",
          "billing_end": "YYYY-MM-DD",
          "ccy": "GBP",
          "unit_cost": "30000.00",
          "cis_type": "materials",
          "net_total_price": "30000.00",
          "tax_rate": "20.0",
          "tax_total": "6000.00",
          "total_price": "36000.00",
          "tax_type": {
            "id": "123",
            "label": "UK VAT",
            "tax_reference": "sales",
            "key": "cis_registered_contractors_deduction",
            "rate": "20.0",
            "country_code": "GB",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "archived": "false",
            "custom_fields": {
              "key": "value"
            }
          }
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "approved_at": "2023-11-07T05:31:56Z",
      "approved_by": {
        "id": "7158",
        "first_name": "Jack",
        "last_name": "Jones",
        "email": "[email protected]",
        "org_name": "Organisation Ltd",
        "org_id": "567",
        "business_unit": "Public Private Partnerships",
        "division": "Infastructure",
        "department": "Bridges",
        "vetting_status": "PASSED",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "custom_fields": {
          "key": "value"
        },
        "has_oversight": "<string>"
      },
      "client": {
        "id": "7158",
        "first_name": "Jack",
        "last_name": "Jones",
        "email": "[email protected]",
        "org_name": "Organisation Ltd",
        "org_id": "567",
        "business_unit": "Public Private Partnerships",
        "division": "Infastructure",
        "department": "Bridge Building",
        "vetting_status": "PASSED",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "custom_fields": {
          "key": "value"
        },
        "has_oversight": "<string>"
      },
      "client_org": {
        "id": "7158",
        "name": "Company Ltd",
        "is_external_client": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "supplier": {
        "id": "77",
        "name": "Company Inc",
        "email": "[email protected]",
        "vetting_status": "PASSED",
        "tax_number": "9876543234",
        "tax_registered": "true",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

X-API-Key

string

header

required

zivio-tenant-id

string

header

required

Query Parameters

status

string

Filter by a status, [draft, unpaid, paid, level_1_approved, approved, pending, rejected]

created

string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on created timestamp for object.

updated

string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

approved

string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

due_on

string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

sort

string

Results are sorted by created desc as default. Ordering may be specified, available options are ['approved', 'created', 'updated'], which can be combined in a comma separated list, e.g. approved:asc,updated:desc,created:asc

limit

integer

Number of results returned per request

page

integer

Paginate results when number of results exceeds limit

Response

invoices

object[]

Show child attributes

invoices.id

integer

Example:

"1"

invoices.status

string

Example:

"draft"

invoices.job_id

integer

Example:

"23"

invoices.job_summary

string

Example:

"Some text about the project"

invoices.net_total

string

Example:

"16000.00"

invoices.tax_total

string

Example:

"2000.00"

invoices.total

string

Example:

"18000.00"

invoices.ccy

string

Example:

"GBP"

invoices.due_on

string<date-time>

invoices.dated_on

string<date-time>

invoices.milestone_id

integer

Example:

"435"

invoices.line_item_sheet_id

integer

Example:

"234"

invoices.credit_note_id

integer

Example:

"124"

invoices.is_credit_note

boolean

Example:

null

invoices.credit_note_reason

string

Example:

"invoice paid in error"

invoices.invoice_items

object[]

Show child attributes

invoices.invoice_items.id

integer

Example:

"1"

invoices.invoice_items.invoice_id

integer

Example:

"123"

invoices.invoice_items.milestone_id

integer

Example:

"3654"

invoices.invoice_items.line_item_sheet_id

integer

Example:

"3645"

invoices.invoice_items.purchase_order_line_id

integer

Example:

"284"

invoices.invoice_items.description

string

Example:

"Some text about the item"

invoices.invoice_items.quantity

number<double>

Example:

"10.0"

invoices.invoice_items.unit_type

string

Example:

"milestone"

invoices.invoice_items.billing_start

string

Example:

"YYYY-MM-DD"

invoices.invoice_items.billing_end

string

Example:

"YYYY-MM-DD"

invoices.invoice_items.ccy

string

Example:

"GBP"

invoices.invoice_items.unit_cost

string

Example:

"30000.00"

invoices.invoice_items.cis_type

enum<string>

Available options:

materials,

labour,

gross,

null

invoices.invoice_items.net_total_price

string

Example:

"30000.00"

invoices.invoice_items.tax_rate

number<double>

Example:

"20.0"

invoices.invoice_items.tax_total

string

Example:

"6000.00"

invoices.invoice_items.total_price

string

Example:

"36000.00"

invoices.invoice_items.tax_type

object

Show child attributes

invoices.invoice_items.tax_type.id

integer

Example:

"123"

invoices.invoice_items.tax_type.label

string

Example:

"UK VAT"

invoices.invoice_items.tax_type.tax_reference

enum<string>

Available options:

sales,

cis

invoices.invoice_items.tax_type.key

string

Example:

"cis_registered_contractors_deduction"

invoices.invoice_items.tax_type.rate

string

Example:

"20.0"

invoices.invoice_items.tax_type.country_code

string

Example:

"GB"

invoices.invoice_items.tax_type.created_at

string<date-time>

invoices.invoice_items.tax_type.updated_at

string<date-time>

invoices.invoice_items.tax_type.archived

boolean

Example:

"false"

invoices.invoice_items.tax_type.custom_fields

object

Show child attributes

invoices.invoice_items.tax_type.custom_fields.key

string

Example:

"value"

invoices.created_at

string<date-time>

invoices.updated_at

string<date-time>

invoices.approved_at

string<date-time>

invoices.approved_by

object

Show child attributes

invoices.approved_by.id

integer

Example:

"7158"

invoices.approved_by.first_name

string

Example:

"Jack"

invoices.approved_by.last_name

string

Example:

"Jones"

invoices.approved_by.email

string

Example:

"[email protected]"

invoices.approved_by.org_name

string

Example:

"Organisation Ltd"

invoices.approved_by.org_id

integer

Example:

"567"

invoices.approved_by.business_unit

string

Example:

"Public Private Partnerships"

invoices.approved_by.division

string

Example:

"Infastructure"

invoices.approved_by.department

string

Example:

"Bridges"

invoices.approved_by.vetting_status

string

Example:

"PASSED"

invoices.approved_by.created_at

string<date-time>

invoices.approved_by.updated_at

string<date-time>

invoices.approved_by.custom_fields

object

Show child attributes

invoices.approved_by.custom_fields.key

string

Example:

"value"

invoices.approved_by.has_oversight

string<true>

invoices.client

object

Show child attributes

invoices.client.id

integer

Example:

"7158"

invoices.client.first_name

string

Example:

"Jack"

invoices.client.last_name

string

Example:

"Jones"

invoices.client.email

string

Example:

"[email protected]"

invoices.client.org_name

string

Example:

"Organisation Ltd"

invoices.client.org_id

integer

Example:

"567"

invoices.client.business_unit

string

Example:

"Public Private Partnerships"

invoices.client.division

string

Example:

"Infastructure"

invoices.client.department

string

Example:

"Bridge Building"

invoices.client.vetting_status

string

Example:

"PASSED"

invoices.client.created_at

string<date-time>

invoices.client.updated_at

string<date-time>

invoices.client.custom_fields

object

Show child attributes

invoices.client.custom_fields.key

string

Example:

"value"

invoices.client.has_oversight

string<true>

invoices.client_org

object

Show child attributes

invoices.client_org.id

integer

Example:

"7158"

invoices.client_org.name

string

Example:

"Company Ltd"

invoices.client_org.is_external_client

string<true>

invoices.client_org.created_at

string<date-time>

invoices.client_org.updated_at

string<date-time>

invoices.supplier

object

Show child attributes

invoices.supplier.id

integer

Example:

"77"

invoices.supplier.name

string

Example:

"Company Inc"

invoices.supplier.email

string

Example:

"[email protected]"

invoices.supplier.vetting_status

string

Example:

"PASSED"

invoices.supplier.tax_number

string

Example:

"9876543234"

invoices.supplier.tax_registered

boolean

Example:

"true"

invoices.supplier.created_at

string<date-time>

invoices.supplier.updated_at

string<date-time>

Retrieve an EOI Response by ID Create an Invoice

⌘I

Endpoints

Authorizations

Query Parameters

Response