diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 7498ad9ac37d..7531e69a90ce 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -13312,36 +13312,9 @@ components: - Product: - properties: - id: - description: 'The product hashed id' - type: string - example: Opnel5aKBz - type: object - Project: - properties: - id: - description: 'The project hashed id' - type: string - example: Opnel5aKBz - name: - description: 'The project name' - type: string - example: 'New Project' - type: object - PurchaseOrder: - properties: - id: - description: 'The purchase order hashed id' - type: string - example: Opnel5aKBz - type: object - - - - - + + + TaskSchedulerSchema: properties: paused: @@ -14193,9 +14166,10 @@ components: format: float example: 23.00 line_items: - description: "The array of line items included in the credit" - type: object - example: "[{item1}, {item2}]" + type: array + description: 'An array of objects which define the line items of the credit' + items: + $ref: '#/components/schemas/InvoiceItem' amount: description: "The total amount of the credit" type: number @@ -14740,9 +14714,11 @@ components: format: float example: '10.00' line_items: + type: array description: 'An array of objects which define the line items of the invoice' - type: object - example: '' + items: + $ref: '#/components/schemas/InvoiceItem' + amount: description: 'The invoice amount' type: number @@ -16075,6 +16051,10 @@ components: type: array items: $ref: '#/components/schemas/CreditPaymentable' + number: + description: 'The payment number - is a unique alpha numeric number per payment per company' + type: string + example: PAY_101 type: object User: @@ -16120,6 +16100,178 @@ components: type: string example: google type: object + Project: + type: object + properties: + id: + description: 'The project hashed id' + type: string + example: Opnel5aKBz + user_id: + description: 'The user hashed id' + type: string + example: Opnel5aKBz + assigned_user_id: + description: The assigned user identifier associated with the project + type: string + example: Opnel5aKBz + client_id: + type: string + example: Opnel5aKBz + description: The client identifier associated with the project + name: + type: string + description: The name of the project + example: 'New Project' + task_rate: + type: number + format: float + example: 10 + description: The default rate per task for the project + due_date: + type: string + format: date + example: '2019-01-01' + description: The due date for the project + private_notes: + type: string + description: Private notes associated with the project + budgeted_hours: + type: number + format: float + description: The number of budgeted hours for the project + custom_value1: + type: string + description: Custom value field 1 + custom_value2: + type: string + description: Custom value field 2 + custom_value3: + type: string + description: Custom value field 3 + custom_value4: + type: string + description: Custom value field 4 + created_at: + type: number + format: integer + example: 134341234234 + description: The timestamp of the project creation + updated_at: + type: number + format: integer + example: 134341234234 + description: The timestamp of the last project update + archived_at: + type: number + format: integer + example: 134341234234 + description: The timestamp of the project deletion + public_notes: + type: string + description: Public notes associated with the project + is_deleted: + type: boolean + description: A flag indicating if the project is deleted + number: + type: string + description: The project number + color: + type: string + description: The color associated with the project + required: + - id + - user_id + - company_id + - name + - task_rate + - budgeted_hours + - is_deleted + - color + + InvoiceItem: + type: object + properties: + quantity: + type: integer + example: 1 + cost: + type: number + format: float + example: 10.00 + product_key: + type: string + example: 'Product key' + product_cost: + type: number + format: float + example: 10.00 + notes: + type: string + example: 'Item notes' + discount: + type: number + format: float + example: 5.00 + is_amount_discount: + type: boolean + example: false + tax_name1: + type: string + example: 'Tax name 1' + tax_rate1: + type: number + format: float + example: 10.00 + tax_name2: + type: string + example: 'Tax name 2' + tax_rate2: + type: number + format: float + example: 5.00 + tax_name3: + type: string + example: 'Tax name 3' + tax_rate3: + type: number + format: float + example: 3.00 + sort_id: + type: string + example: '0' + line_total: + type: number + format: float + example: 10.00 + gross_line_total: + type: number + format: float + example: 15.00 + tax_amount: + type: number + format: float + example: 1.00 + date: + type: string + format: date-time + example: '2023-03-19T00:00:00Z' + custom_value1: + type: string + example: 'Custom value 1' + custom_value2: + type: string + example: 'Custom value 2' + custom_value3: + type: string + example: 'Custom value 3' + custom_value4: + type: string + example: 'Custom value 4' + type_id: + type: string + example: '1' + description: '1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense' CompanyUser: properties: permissions: @@ -16842,6 +16994,227 @@ components: format: integer example: '1434342123' type: object + PurchaseOrder: + properties: + id: + description: 'The unique hashed identifier for the purchase order' + type: string + example: Opnel5aKBz + user_id: + description: 'The unique hashed identifier for the user who created the purchase order' + type: string + example: '' + assigned_user_id: + description: 'The unique hashed identifier for the user assigned to the purchase order' + type: string + example: '' + company_id: + description: 'The unique hashed identifier for the company associated with the purchase order' + type: string + example: '' + vendor_id: + description: 'The unique hashed identifier for the vendor associated with the purchase order' + type: string + example: '' + status_id: + description: 'The status of the purchase order represented by a unique identifier' + type: string + example: '' + number: + description: 'The unique alpha-numeric purchase order number per company' + type: string + example: PO_101 + quote_number: + description: 'The quote number associated with this purchase order' + type: string + example: QUOTE_101 + terms: + description: 'The terms and conditions for the purchase order' + type: string + example: 'These are some purchase order terms. Valid for 14 days.' + public_notes: + description: 'Publicly visible notes associated with the purchase order' + type: string + example: 'These are public notes which the vendor may see' + private_notes: + description: 'Privately visible notes associated with the purchase order, not disclosed to the vendor' + type: string + example: 'These are private notes, not to be disclosed to the vendor' + footer: + description: 'The footer text of the purchase order' + type: string + example: 'The text goes in the footer of the purchase order' + custom_value1: + description: 'First custom value field for additional information' + type: string + example: 'A custom value' + custom_value2: + description: 'Second custom value field for additional information' + type: string + example: 'A custom value' + custom_value3: + description: 'Third custom value field for additional information' + type: string + example: 'A custom value' + custom_value4: + description: 'Fourth custom value field for additional information' + type: string + example: 'A custom value' + tax_name1: + description: 'The name of the first tax applied to the purchase order' + type: string + example: GST + tax_name2: + description: 'The name of the second tax applied to the purchase order' + type: string + example: VAT + tax_rate1: + description: 'The rate of the first tax applied to the purchase order' + type: number + format: float + example: 10.00 + tax_rate2: + description: 'The rate of the second tax applied to the purchase order' + type: number + format: float + example: 10.00 + tax_name3: + description: 'The name of the third tax applied to the purchase order' + type: string + example: '' + tax_rate3: + description: 'The rate of the third tax applied to the purchase order' + type: number + format: float + example: 10.00 + total_taxes: + description: 'The total amount of taxes applied to the purchase order' + type: number + format: float + example: 10.00 + line_items: + type: array + description: 'An array of objects which define the line items of the purchase order' + items: + $ref: '#/components/schemas/InvoiceItem' + amount: + description: 'The total amount of the purchase order before taxes and discounts' + type: number + format: float + example: 10.00 + balance: + description: 'The balance due for the purchase order after accounting for payments' + type: number + format: float + example: 10.00 + paid_to_date: + description: 'The total amount paid on the purchase order so far' + type: number + format: float + example: 10.00 + discount: + description: 'The discount amount or percentage applied to the purchase order' + type: number + format: float + example: 10.00 + partial: + description: 'The partial or deposit amount for the purchase order' + type: number + format: float + example: 10.00 + is_amount_discount: + description: 'Boolean flag indicating if the discount is a fixed amount or a percentage' + type: boolean + example: true + is_deleted: + description: 'Boolean flag indicating if the purchase order has been deleted' + type: boolean + example: false + uses_inclusive_taxes: + description: 'Boolean flag indicating if the taxes used are inclusive or exclusive' + type: boolean + example: true + date: + description: 'The date the purchase order was created' + type: string + format: date + example: '1994-07-30' + last_sent_date: + description: 'The last date the purchase order was sent to the vendor' + type: string + format: date + example: '1994-07-30' + next_send_date: + description: 'The next scheduled date for sending a reminder for the purchase order' + type: string + format: date + example: '1994-07-30' + partial_due_date: + description: 'The due date for the partial or deposit amount' + type: string + format: date + example: '1994-07-30' + due_date: + description: 'The due date for the total amount of the purchase order' + type: string + format: date + example: '1994-07-30' + settings: + $ref: '#/components/schemas/CompanySettings' + last_viewed: + description: Timestamp + type: number + format: integer + example: 1434342123 + updated_at: + description: Timestamp + type: number + format: integer + example: 1434342123 + archived_at: + description: Timestamp + type: number + format: integer + example: 1434342123 + custom_surcharge1: + description: 'First custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge2: + description: 'Second custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge3: + description: 'Third custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge4: + description: 'Fourth custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge_tax1: + description: 'Boolean flag indicating if taxes are charged on the first custom surcharge amount' + type: boolean + example: true + custom_surcharge_tax2: + description: 'Boolean flag indicating if taxes are charged on the second custom surcharge amount' + type: boolean + example: true + custom_surcharge_tax3: + description: 'Boolean flag indicating if taxes are charged on the third custom surcharge amount' + type: boolean + example: true + custom_surcharge_tax4: + description: 'Boolean flag indicating if taxes are charged on the fourth custom surcharge amount' + type: boolean + example: true + type: object + + ClientContact: properties: id: @@ -16986,6 +17359,145 @@ components: type: boolean example: 'true' type: object + Product: + type: object + properties: + id: + type: string + description: 'The hashed product ID.' + example: eP01N + company_id: + type: string + description: 'The hashed ID of the company that owns this product.' + example: eP01N + user_id: + type: string + description: 'The hashed ID of the user that created this product.' + example: n30m4 + assigned_user_id: + type: string + description: 'The hashed ID of the user assigned to this product.' + example: pR0j3 + project_id: + type: string + description: 'The hashed ID of the project that this product is associated with.' + example: pR0j3 + vendor_id: + type: string + description: 'The hashed ID of the vendor that this product is associated with.' + example: pR0j3 + custom_value1: + type: string + description: 'Custom value field 1.' + example: 'Custom value 1' + custom_value2: + type: string + description: 'Custom value field 2.' + example: 'Custom value 2' + custom_value3: + type: string + description: 'Custom value field 3.' + example: 'Custom value 3' + custom_value4: + type: string + description: 'Custom value field 4.' + example: 'Custom value 4' + product_key: + type: string + description: 'The product key.' + example: '1234' + notes: + type: string + description: 'Notes about the product.' + example: 'These are some notes about the product.' + cost: + type: number + format: float + description: 'The cost of the product.' + example: 10.0 + price: + type: number + format: float + description: 'The price of the product.' + example: 20.0 + quantity: + type: number + format: float + description: 'The quantity of the product.' + example: 5.0 + tax_name1: + type: string + description: 'The name of tax 1.' + example: 'Tax 1' + tax_rate1: + type: number + format: float + description: 'The rate of tax 1.' + example: 10.0 + tax_name2: + type: string + description: 'The name of tax 2.' + example: 'Tax 2' + tax_rate2: + type: number + format: float + description: 'The rate of tax 2.' + example: 5.0 + tax_name3: + type: string + description: 'The name of tax 3.' + example: 'Tax 3' + tax_rate3: + type: number + format: float + description: 'The rate of tax 3.' + example: 0.0 + archived_at: + type: integer + format: timestamp + description: 'The timestamp when the product was archived.' + example: '2022-03-18T15:00:00Z' + created_at: + type: integer + format: timestamp + description: 'The timestamp when the product was created.' + example: '2022-03-18T15:00:00Z' + updated_at: + description: Timestamp + type: integer + format: timestamp + example: '2022-03-18T12:34:56.789Z' + is_deleted: + type: boolean + description: 'Boolean flag determining if the product has been deleted' + example: false + in_stock_quantity: + type: integer + format: int32 + description: The quantity of the product that is currently in stock + default: 0 + + stock_notification: + type: boolean + description: Indicates whether stock notifications are enabled for this product + default: true + + stock_notification_threshold: + type: integer + format: int32 + description: The minimum quantity threshold for which stock notifications will be triggered + default: 0 + + max_quantity: + type: integer + format: int32 + description: The maximum quantity that can be ordered for this product + + product_image: + type: string + description: The URL of the product image + format: uri-reference + Quote: properties: id: @@ -17085,9 +17597,10 @@ components: format: float example: 10.00 line_items: - description: 'An array of line items associated with the quote' - type: object - example: '' + type: array + description: 'An array of objects which define the line items of the quote' + items: + $ref: '#/components/schemas/InvoiceItem' amount: description: 'The total amount of the quote before taxes and discounts' type: number diff --git a/openapi/components/schemas.yaml b/openapi/components/schemas.yaml index 54ea8bb76f32..3a579727752c 100644 --- a/openapi/components/schemas.yaml +++ b/openapi/components/schemas.yaml @@ -72,36 +72,9 @@ - Product: - properties: - id: - description: 'The product hashed id' - type: string - example: Opnel5aKBz - type: object - Project: - properties: - id: - description: 'The project hashed id' - type: string - example: Opnel5aKBz - name: - description: 'The project name' - type: string - example: 'New Project' - type: object - PurchaseOrder: - properties: - id: - description: 'The purchase order hashed id' - type: string - example: Opnel5aKBz - type: object - - - - - + + + TaskSchedulerSchema: properties: paused: diff --git a/openapi/components/schemas/credit.yaml b/openapi/components/schemas/credit.yaml index 54df65e21de2..bc06f457ea1d 100644 --- a/openapi/components/schemas/credit.yaml +++ b/openapi/components/schemas/credit.yaml @@ -101,9 +101,10 @@ format: float example: 23.00 line_items: - description: "The array of line items included in the credit" - type: object - example: "[{item1}, {item2}]" + type: array + description: 'An array of objects which define the line items of the credit' + items: + $ref: '#/components/schemas/InvoiceItem' amount: description: "The total amount of the credit" type: number diff --git a/openapi/components/schemas/invoice.yaml b/openapi/components/schemas/invoice.yaml index 5b00cef8ad09..6a09eb246788 100644 --- a/openapi/components/schemas/invoice.yaml +++ b/openapi/components/schemas/invoice.yaml @@ -97,9 +97,11 @@ format: float example: '10.00' line_items: + type: array description: 'An array of objects which define the line items of the invoice' - type: object - example: '' + items: + $ref: '#/components/schemas/InvoiceItem' + amount: description: 'The invoice amount' type: number diff --git a/openapi/components/schemas/invoice_item.yaml b/openapi/components/schemas/invoice_item.yaml new file mode 100644 index 000000000000..94c512f49e1b --- /dev/null +++ b/openapi/components/schemas/invoice_item.yaml @@ -0,0 +1,83 @@ + InvoiceItem: + type: object + properties: + quantity: + type: integer + example: 1 + cost: + type: number + format: float + example: 10.00 + product_key: + type: string + example: 'Product key' + product_cost: + type: number + format: float + example: 10.00 + notes: + type: string + example: 'Item notes' + discount: + type: number + format: float + example: 5.00 + is_amount_discount: + type: boolean + example: false + tax_name1: + type: string + example: 'Tax name 1' + tax_rate1: + type: number + format: float + example: 10.00 + tax_name2: + type: string + example: 'Tax name 2' + tax_rate2: + type: number + format: float + example: 5.00 + tax_name3: + type: string + example: 'Tax name 3' + tax_rate3: + type: number + format: float + example: 3.00 + sort_id: + type: string + example: '0' + line_total: + type: number + format: float + example: 10.00 + gross_line_total: + type: number + format: float + example: 15.00 + tax_amount: + type: number + format: float + example: 1.00 + date: + type: string + format: date-time + example: '2023-03-19T00:00:00Z' + custom_value1: + type: string + example: 'Custom value 1' + custom_value2: + type: string + example: 'Custom value 2' + custom_value3: + type: string + example: 'Custom value 3' + custom_value4: + type: string + example: 'Custom value 4' + type_id: + type: string + example: '1' + description: '1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense' \ No newline at end of file diff --git a/openapi/components/schemas/payment.yaml b/openapi/components/schemas/payment.yaml index 978497cac19e..d9c3f437f68d 100644 --- a/openapi/components/schemas/payment.yaml +++ b/openapi/components/schemas/payment.yaml @@ -82,5 +82,9 @@ type: array items: $ref: '#/components/schemas/CreditPaymentable' + number: + description: 'The payment number - is a unique alpha numeric number per payment per company' + type: string + example: PAY_101 type: object \ No newline at end of file diff --git a/openapi/components/schemas/product.yaml b/openapi/components/schemas/product.yaml new file mode 100644 index 000000000000..34fe77b8d77a --- /dev/null +++ b/openapi/components/schemas/product.yaml @@ -0,0 +1,138 @@ + Product: + type: object + properties: + id: + type: string + description: 'The hashed product ID.' + example: eP01N + company_id: + type: string + description: 'The hashed ID of the company that owns this product.' + example: eP01N + user_id: + type: string + description: 'The hashed ID of the user that created this product.' + example: n30m4 + assigned_user_id: + type: string + description: 'The hashed ID of the user assigned to this product.' + example: pR0j3 + project_id: + type: string + description: 'The hashed ID of the project that this product is associated with.' + example: pR0j3 + vendor_id: + type: string + description: 'The hashed ID of the vendor that this product is associated with.' + example: pR0j3 + custom_value1: + type: string + description: 'Custom value field 1.' + example: 'Custom value 1' + custom_value2: + type: string + description: 'Custom value field 2.' + example: 'Custom value 2' + custom_value3: + type: string + description: 'Custom value field 3.' + example: 'Custom value 3' + custom_value4: + type: string + description: 'Custom value field 4.' + example: 'Custom value 4' + product_key: + type: string + description: 'The product key.' + example: '1234' + notes: + type: string + description: 'Notes about the product.' + example: 'These are some notes about the product.' + cost: + type: number + format: float + description: 'The cost of the product.' + example: 10.0 + price: + type: number + format: float + description: 'The price of the product.' + example: 20.0 + quantity: + type: number + format: float + description: 'The quantity of the product.' + example: 5.0 + tax_name1: + type: string + description: 'The name of tax 1.' + example: 'Tax 1' + tax_rate1: + type: number + format: float + description: 'The rate of tax 1.' + example: 10.0 + tax_name2: + type: string + description: 'The name of tax 2.' + example: 'Tax 2' + tax_rate2: + type: number + format: float + description: 'The rate of tax 2.' + example: 5.0 + tax_name3: + type: string + description: 'The name of tax 3.' + example: 'Tax 3' + tax_rate3: + type: number + format: float + description: 'The rate of tax 3.' + example: 0.0 + archived_at: + type: integer + format: timestamp + description: 'The timestamp when the product was archived.' + example: '2022-03-18T15:00:00Z' + created_at: + type: integer + format: timestamp + description: 'The timestamp when the product was created.' + example: '2022-03-18T15:00:00Z' + updated_at: + description: Timestamp + type: integer + format: timestamp + example: '2022-03-18T12:34:56.789Z' + is_deleted: + type: boolean + description: 'Boolean flag determining if the product has been deleted' + example: false + in_stock_quantity: + type: integer + format: int32 + description: The quantity of the product that is currently in stock + default: 0 + + stock_notification: + type: boolean + description: Indicates whether stock notifications are enabled for this product + default: true + + stock_notification_threshold: + type: integer + format: int32 + description: The minimum quantity threshold for which stock notifications will be triggered + default: 0 + + max_quantity: + type: integer + format: int32 + description: The maximum quantity that can be ordered for this product + + product_image: + type: string + description: The URL of the product image + format: uri-reference diff --git a/openapi/components/schemas/project.yaml b/openapi/components/schemas/project.yaml new file mode 100644 index 000000000000..3588dbb4610e --- /dev/null +++ b/openapi/components/schemas/project.yaml @@ -0,0 +1,88 @@ + Project: + type: object + properties: + id: + description: 'The project hashed id' + type: string + example: Opnel5aKBz + user_id: + description: 'The user hashed id' + type: string + example: Opnel5aKBz + assigned_user_id: + description: The assigned user identifier associated with the project + type: string + example: Opnel5aKBz + client_id: + type: string + example: Opnel5aKBz + description: The client identifier associated with the project + name: + type: string + description: The name of the project + example: 'New Project' + task_rate: + type: number + format: float + example: 10 + description: The default rate per task for the project + due_date: + type: string + format: date + example: '2019-01-01' + description: The due date for the project + private_notes: + type: string + description: Private notes associated with the project + budgeted_hours: + type: number + format: float + description: The number of budgeted hours for the project + custom_value1: + type: string + description: Custom value field 1 + custom_value2: + type: string + description: Custom value field 2 + custom_value3: + type: string + description: Custom value field 3 + custom_value4: + type: string + description: Custom value field 4 + created_at: + type: number + format: integer + example: 134341234234 + description: The timestamp of the project creation + updated_at: + type: number + format: integer + example: 134341234234 + description: The timestamp of the last project update + archived_at: + type: number + format: integer + example: 134341234234 + description: The timestamp of the project deletion + public_notes: + type: string + description: Public notes associated with the project + is_deleted: + type: boolean + description: A flag indicating if the project is deleted + number: + type: string + description: The project number + color: + type: string + description: The color associated with the project + required: + - id + - user_id + - company_id + - name + - task_rate + - budgeted_hours + - is_deleted + - color diff --git a/openapi/components/schemas/purchase_order.yaml b/openapi/components/schemas/purchase_order.yaml new file mode 100644 index 000000000000..3202309b4408 --- /dev/null +++ b/openapi/components/schemas/purchase_order.yaml @@ -0,0 +1,220 @@ + PurchaseOrder: + properties: + id: + description: 'The unique hashed identifier for the purchase order' + type: string + example: Opnel5aKBz + user_id: + description: 'The unique hashed identifier for the user who created the purchase order' + type: string + example: '' + assigned_user_id: + description: 'The unique hashed identifier for the user assigned to the purchase order' + type: string + example: '' + company_id: + description: 'The unique hashed identifier for the company associated with the purchase order' + type: string + example: '' + vendor_id: + description: 'The unique hashed identifier for the vendor associated with the purchase order' + type: string + example: '' + status_id: + description: 'The status of the purchase order represented by a unique identifier' + type: string + example: '' + number: + description: 'The unique alpha-numeric purchase order number per company' + type: string + example: PO_101 + quote_number: + description: 'The quote number associated with this purchase order' + type: string + example: QUOTE_101 + terms: + description: 'The terms and conditions for the purchase order' + type: string + example: 'These are some purchase order terms. Valid for 14 days.' + public_notes: + description: 'Publicly visible notes associated with the purchase order' + type: string + example: 'These are public notes which the vendor may see' + private_notes: + description: 'Privately visible notes associated with the purchase order, not disclosed to the vendor' + type: string + example: 'These are private notes, not to be disclosed to the vendor' + footer: + description: 'The footer text of the purchase order' + type: string + example: 'The text goes in the footer of the purchase order' + custom_value1: + description: 'First custom value field for additional information' + type: string + example: 'A custom value' + custom_value2: + description: 'Second custom value field for additional information' + type: string + example: 'A custom value' + custom_value3: + description: 'Third custom value field for additional information' + type: string + example: 'A custom value' + custom_value4: + description: 'Fourth custom value field for additional information' + type: string + example: 'A custom value' + tax_name1: + description: 'The name of the first tax applied to the purchase order' + type: string + example: GST + tax_name2: + description: 'The name of the second tax applied to the purchase order' + type: string + example: VAT + tax_rate1: + description: 'The rate of the first tax applied to the purchase order' + type: number + format: float + example: 10.00 + tax_rate2: + description: 'The rate of the second tax applied to the purchase order' + type: number + format: float + example: 10.00 + tax_name3: + description: 'The name of the third tax applied to the purchase order' + type: string + example: '' + tax_rate3: + description: 'The rate of the third tax applied to the purchase order' + type: number + format: float + example: 10.00 + total_taxes: + description: 'The total amount of taxes applied to the purchase order' + type: number + format: float + example: 10.00 + line_items: + type: array + description: 'An array of objects which define the line items of the purchase order' + items: + $ref: '#/components/schemas/InvoiceItem' + amount: + description: 'The total amount of the purchase order before taxes and discounts' + type: number + format: float + example: 10.00 + balance: + description: 'The balance due for the purchase order after accounting for payments' + type: number + format: float + example: 10.00 + paid_to_date: + description: 'The total amount paid on the purchase order so far' + type: number + format: float + example: 10.00 + discount: + description: 'The discount amount or percentage applied to the purchase order' + type: number + format: float + example: 10.00 + partial: + description: 'The partial or deposit amount for the purchase order' + type: number + format: float + example: 10.00 + is_amount_discount: + description: 'Boolean flag indicating if the discount is a fixed amount or a percentage' + type: boolean + example: true + is_deleted: + description: 'Boolean flag indicating if the purchase order has been deleted' + type: boolean + example: false + uses_inclusive_taxes: + description: 'Boolean flag indicating if the taxes used are inclusive or exclusive' + type: boolean + example: true + date: + description: 'The date the purchase order was created' + type: string + format: date + example: '1994-07-30' + last_sent_date: + description: 'The last date the purchase order was sent to the vendor' + type: string + format: date + example: '1994-07-30' + next_send_date: + description: 'The next scheduled date for sending a reminder for the purchase order' + type: string + format: date + example: '1994-07-30' + partial_due_date: + description: 'The due date for the partial or deposit amount' + type: string + format: date + example: '1994-07-30' + due_date: + description: 'The due date for the total amount of the purchase order' + type: string + format: date + example: '1994-07-30' + settings: + $ref: '#/components/schemas/CompanySettings' + last_viewed: + description: Timestamp + type: number + format: integer + example: 1434342123 + updated_at: + description: Timestamp + type: number + format: integer + example: 1434342123 + archived_at: + description: Timestamp + type: number + format: integer + example: 1434342123 + custom_surcharge1: + description: 'First custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge2: + description: 'Second custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge3: + description: 'Third custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge4: + description: 'Fourth custom surcharge amount for the purchase order' + type: number + format: float + example: 10.00 + custom_surcharge_tax1: + description: 'Boolean flag indicating if taxes are charged on the first custom surcharge amount' + type: boolean + example: true + custom_surcharge_tax2: + description: 'Boolean flag indicating if taxes are charged on the second custom surcharge amount' + type: boolean + example: true + custom_surcharge_tax3: + description: 'Boolean flag indicating if taxes are charged on the third custom surcharge amount' + type: boolean + example: true + custom_surcharge_tax4: + description: 'Boolean flag indicating if taxes are charged on the fourth custom surcharge amount' + type: boolean + example: true + type: object + diff --git a/openapi/components/schemas/quote.yaml b/openapi/components/schemas/quote.yaml index 1aaea7e2c32f..3b7b00a6fb57 100644 --- a/openapi/components/schemas/quote.yaml +++ b/openapi/components/schemas/quote.yaml @@ -97,9 +97,10 @@ format: float example: 10.00 line_items: - description: 'An array of line items associated with the quote' - type: object - example: '' + type: array + description: 'An array of objects which define the line items of the quote' + items: + $ref: '#/components/schemas/InvoiceItem' amount: description: 'The total amount of the quote before taxes and discounts' type: number