Apideck · Schema

Quote Line Item

IntegrationsUnified API

Properties

Name Type Description
id object
row_id string Row ID
code string User defined item code
line_number object
description string User defined description
type string Item type
tax_amount number Tax amount
total_amount number Total amount of the line item
quantity object
unit_price object
unit_of_measure object
discount_percentage number Discount percentage applied to the line item when supported downstream.
discount_amount number Discount amount applied to the line item when supported downstream.
service_date string Date on which the service was provided or performed - YYYY-MM-DD.
category_id string ID of the category of the line item
location_id object
department_id object
item object
tax_rate object
tracking_categories object
ledger_account object
custom_fields array
row_version object
updated_by object
created_by object
created_at object
updated_at object
View JSON Schema on GitHub

JSON Schema

apideck-quotelineitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/QuoteLineItem",
  "title": "Quote Line Item",
  "type": "object",
  "x-apideck-schema-id": "QuoteLineItem",
  "additionalProperties": false,
  "x-apideck-weights": {
    "id": "high",
    "row_id": "edge-case",
    "code": "medium",
    "line_number": "medium",
    "description": "high",
    "type": "medium",
    "tax_amount": "high",
    "total_amount": "high",
    "quantity": "high",
    "unit_price": "high",
    "unit_of_measure": "edge-case",
    "discount_percentage": "low",
    "discount_amount": "low",
    "service_date": "medium",
    "category_id": "low",
    "location_id": "low",
    "department_id": "low",
    "item": "high",
    "tax_rate": "medium",
    "ledger_account": "low",
    "tracking_categories": "low",
    "custom_fields": "medium",
    "row_version": "edge-case",
    "created_at": "edge-case",
    "updated_at": "high",
    "updated_by": "edge-case",
    "created_by": "edge-case"
  },
  "properties": {
    "id": {
      "$ref": "#/components/schemas/WritableId"
    },
    "row_id": {
      "type": "string",
      "title": "Row ID",
      "description": "Row ID",
      "example": "12345"
    },
    "code": {
      "type": "string",
      "title": "Item code",
      "description": "User defined item code",
      "example": "120-C",
      "nullable": true
    },
    "line_number": {
      "$ref": "#/components/schemas/LineNumber"
    },
    "description": {
      "type": "string",
      "title": "Description",
      "description": "User defined description",
      "example": "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.",
      "nullable": true
    },
    "type": {
      "type": "string",
      "title": "Type",
      "description": "Item type",
      "example": "sales_item",
      "x-apideck-enum-id": "quotes-line-items.type",
      "enum": [
        "sales_item",
        "discount",
        "info",
        "sub_total",
        "service",
        "other"
      ],
      "nullable": true
    },
    "tax_amount": {
      "type": "number",
      "title": "Tax amount",
      "description": "Tax amount",
      "example": 27500,
      "nullable": true
    },
    "total_amount": {
      "type": "number",
      "title": "Total amount",
      "description": "Total amount of the line item",
      "example": 27500,
      "nullable": true
    },
    "quantity": {
      "$ref": "#/components/schemas/Quantity"
    },
    "unit_price": {
      "$ref": "#/components/schemas/UnitPrice"
    },
    "unit_of_measure": {
      "$ref": "#/components/schemas/UnitOfMeasure"
    },
    "discount_percentage": {
      "type": "number",
      "title": "Discount Percentage",
      "description": "Discount percentage applied to the line item when supported downstream.",
      "example": 0.01,
      "nullable": true
    },
    "discount_amount": {
      "type": "number",
      "title": "Discount Amount",
      "description": "Discount amount applied to the line item when supported downstream.",
      "example": 19.99,
      "nullable": true
    },
    "service_date": {
      "type": "string",
      "format": "date",
      "title": "Service Date",
      "description": "Date on which the service was provided or performed - YYYY-MM-DD.",
      "example": "2024-01-15",
      "nullable": true
    },
    "category_id": {
      "type": "string",
      "title": "Category ID",
      "description": "ID of the category of the line item",
      "example": "12345",
      "nullable": true
    },
    "location_id": {
      "$ref": "#/components/schemas/LocationId"
    },
    "department_id": {
      "$ref": "#/components/schemas/DepartmentId"
    },
    "item": {
      "$ref": "#/components/schemas/LinkedInvoiceItem"
    },
    "tax_rate": {
      "$ref": "#/components/schemas/LinkedTaxRate"
    },
    "tracking_categories": {
      "$ref": "#/components/schemas/LinkedTrackingCategories"
    },
    "ledger_account": {
      "$ref": "#/components/schemas/LinkedLedgerAccount"
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CustomField"
      }
    },
    "row_version": {
      "$ref": "#/components/schemas/RowVersion"
    },
    "updated_by": {
      "$ref": "#/components/schemas/UpdatedBy"
    },
    "created_by": {
      "$ref": "#/components/schemas/CreatedBy"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    }
  }
}