Skip to main content
GET
/
client_invoices
Error
A valid request URL is required to generate request examples
[
  {
    "id": 123,
    "project_id": 123,
    "status": "draft",
    "invoice_date": "<string>",
    "note": "<string>",
    "payment_terms": [
      {
        "id": "<string>",
        "amount": "<string>",
        "due_date": "<string>",
        "payment_terms": "<string>"
      }
    ],
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "tax_amount": 123,
    "taxable_amount": 123,
    "amount": 123,
    "amount_with_tax": 123,
    "balance": 123,
    "retainer_amount": 123,
    "products_amount": 123,
    "services_amount": 123,
    "balance_transactions_amount": 123,
    "client": {
      "id": 123,
      "name": "<string>",
      "data": {},
      "addresses": [
        {
          "id": 123,
          "name": "<string>",
          "phone": "<string>",
          "post_code": "<string>",
          "address_line_1": "<string>",
          "address_line_2": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "priority": true
        }
      ],
      "people": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "position": "<string>",
          "note": "<string>",
          "priority": true
        }
      ],
      "categories": [
        {
          "id": 123,
          "type": "client"
        }
      ]
    },
    "items": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "unit_type": "<string>",
        "quantity": 123,
        "price": 123,
        "taxable": true,
        "second_taxable": true,
        "project_item_id": 123
      }
    ],
    "client_proposal_id": 123,
    "purchase_order_ids": [
      123
    ]
  }
]

Authorizations

authorization
string
header
required

Query Parameters

project_id
integer[]
page
string
default:1
per_page
integer
default:25
Required range: 1 <= x <= 100
updated_since
integer
status
enum<string>[]
Available options:
draft,
sent,
paid,
overdue,
deposited,
void,
paid_partially,
revised

Response

OK

id
integer
project_id
integer
status
enum<string>
Available options:
draft,
sent,
paid,
overdue,
deposited,
void,
paid_partially,
revised
invoice_date
string | null
note
string | null
payment_terms
object[]
label
string
created_at
string<date-time>
updated_at
string<date-time>
tax_amount
number
taxable_amount
number
amount
number
amount_with_tax
number
balance
number
retainer_amount
number
products_amount
number
services_amount
number
balance_transactions_amount
number
client
object
items
object[]
client_proposal_id
integer | null
purchase_order_ids
integer[]