Skip to main content
POST
/
projects
/
{id}
/
items
Error
A valid request URL is required to generate request examples
{
  "faild_items": [
    {
      "id": 123,
      "error": "<string>"
    }
  ],
  "items": [
    {
      "id": 123,
      "project_id": 123,
      "position": 123,
      "state": "active",
      "quantity": 123,
      "division": {
        "id": 123,
        "name": "<string>",
        "children": "<array>"
      },
      "vendor_id": 123,
      "revit_id": "<string>",
      "child_item_ids": [
        123
      ],
      "column_values": [
        {
          "column": {
            "id": 123,
            "key": "<string>",
            "type": "<string>",
            "position": 123,
            "property": "project"
          },
          "displayed_value": "<string>",
          "calculated_value": "<string>",
          "users": [
            {
              "id": 123,
              "email": "<string>",
              "name": "<string>"
            }
          ],
          "purchase_orders": [
            {
              "id": 123,
              "rev_num": "<string>",
              "last_revision_num": "<string>",
              "project_id": 123,
              "creator_id": 123,
              "label": "<string>",
              "status": "draft",
              "common_status": "draft",
              "project_name": "<string>",
              "purchase_order_date": "2023-12-25",
              "delivery_date": "2023-12-25",
              "ship_via": "<string>",
              "note": "<string>",
              "payment_terms": "<string>",
              "currency": "<string>",
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z",
              "vendor_id": 123,
              "vendor_address_id": 123,
              "vendor_contact_id": 123,
              "shipping_client_id": 123,
              "shipping_client_address_id": 123,
              "shipping_client_contact_id": 123,
              "billing_client_id": 123,
              "billing_client_address_id": 123,
              "billing_client_contact_id": 123,
              "vendor": {
                "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"
                }
              },
              "shipping_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"
                }
              },
              "billing_client_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"
                }
              },
              "amount": 123,
              "total": 123,
              "shipping_cost": 123,
              "packing_cost": 123,
              "duties_cost": 123,
              "install_cost": 123,
              "other_cost": 123,
              "sales_tax": 123,
              "invoiced_amount": 123,
              "paid_amount": 123,
              "due_amount": 123,
              "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
              ],
              "supplier_invoice_ids": [
                123
              ],
              "shipment_ids": [
                123
              ]
            }
          ],
          "invoices": [
            {
              "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>"
                  }
                ],
                "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_proposal_id": 123,
              "purchase_order_ids": [
                123
              ]
            }
          ],
          "images": [
            {
              "url": "<string>",
              "small_url": "<string>",
              "default": true,
              "presentable": true
            }
          ],
          "docs": [
            {
              "url": "<string>",
              "name": "<string>",
              "extension": "<string>"
            }
          ],
          "supplier": {
            "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"
            }
          },
          "urls": [
            "<string>"
          ]
        }
      ]
    }
  ]
}

Authorizations

authorization
string
header
required

Path Parameters

id
string
required

Body

application/json
areas
object[]
required
settings
object

Response

Created

faild_items
object[]
items
object[]