Skip to main content
GET
/
client_proposals
Error
A valid request URL is required to generate request examples
[
  {
    "id": 123,
    "label": "<string>",
    "status": "draft",
    "subtotal": 123,
    "total": 123,
    "taxes": 123,
    "taxable_amount": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "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>"
        }
      ],
      "people": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "position": "<string>",
          "note": "<string>"
        }
      ],
      "category": {
        "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_invoice_ids": [
      123
    ],
    "payment_terms": [
      {
        "id": "<string>",
        "amount": "<string>",
        "due_date": "<string>",
        "payment_terms": "<string>"
      }
    ]
  }
]

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,
review,
approved,
rejected,
invoiced_partially,
invoiced_fully

Response

OK

id
integer
label
string
status
enum<string>
Available options:
draft,
review,
approved,
rejected,
invoiced_partially,
invoiced_fully
subtotal
number
total
number
taxes
number
taxable_amount
number
created_at
string<date-time>
updated_at
string<date-time>
client
object
items
object[]
client_invoice_ids
integer[]
payment_terms
object[]