Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-11-04 06:37:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

Updates for openapi definitions

Browse Source
This commit is contained in:
David Bomba 2023-03-19 11:15:52 +11:00
parent e52d61d369
commit 30c64b64b9
10 changed files with 1099 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

583
openapi/api-docs.yaml
View File

@ -13312,33 +13312,6 @@ 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
@ -14193,9 +14166,10 @@ components:
format: float format: float
example: 23.00 example: 23.00
line_items: line_items:
description: "The array of line items included in the credit" type: array
type: object description: 'An array of objects which define the line items of the credit'
example: "[{item1}, {item2}]" items:
$ref: '#/components/schemas/InvoiceItem'
amount: amount:
description: "The total amount of the credit" description: "The total amount of the credit"
type: number type: number
@ -14740,9 +14714,11 @@ components:
format: float format: float
example: '10.00' example: '10.00'
line_items: line_items:
type: array
description: 'An array of objects which define the line items of the invoice' description: 'An array of objects which define the line items of the invoice'
type: object items:
example: '' $ref: '#/components/schemas/InvoiceItem'
amount: amount:
description: 'The invoice amount' description: 'The invoice amount'
type: number type: number
@ -16075,6 +16051,10 @@ components:
type: array type: array
items: items:
$ref: '#/components/schemas/CreditPaymentable' $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 type: object
User: User:
@ -16120,6 +16100,178 @@ components:
type: string type: string
example: google example: google
type: object 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: CompanyUser:
properties: properties:
permissions: permissions:
@ -16842,6 +16994,227 @@ components:
format: integer format: integer
example: '1434342123' example: '1434342123'
type: object 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: ClientContact:
properties: properties:
id: id:
@ -16986,6 +17359,145 @@ components:
type: boolean type: boolean
example: 'true' example: 'true'
type: object 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: Quote:
properties: properties:
id: id:
@ -17085,9 +17597,10 @@ components:
format: float format: float
example: 10.00 example: 10.00
line_items: line_items:
description: 'An array of line items associated with the quote' type: array
type: object description: 'An array of objects which define the line items of the quote'
example: '' items:
$ref: '#/components/schemas/InvoiceItem'
amount: amount:
description: 'The total amount of the quote before taxes and discounts' description: 'The total amount of the quote before taxes and discounts'
type: number type: number

27
openapi/components/schemas.yaml
View File

@ -72,33 +72,6 @@
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

7
openapi/components/schemas/credit.yaml
View File

@ -101,9 +101,10 @@
format: float format: float
example: 23.00 example: 23.00
line_items: line_items:
description: "The array of line items included in the credit" type: array
type: object description: 'An array of objects which define the line items of the credit'
example: "[{item1}, {item2}]" items:
$ref: '#/components/schemas/InvoiceItem'
amount: amount:
description: "The total amount of the credit" description: "The total amount of the credit"
type: number type: number

6
openapi/components/schemas/invoice.yaml
View File

@ -97,9 +97,11 @@
format: float format: float
example: '10.00' example: '10.00'
line_items: line_items:
type: array
description: 'An array of objects which define the line items of the invoice' description: 'An array of objects which define the line items of the invoice'
type: object items:
example: '' $ref: '#/components/schemas/InvoiceItem'
amount: amount:
description: 'The invoice amount' description: 'The invoice amount'
type: number type: number

83
openapi/components/schemas/invoice_item.yaml Normal file
View File

@ -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'

4
openapi/components/schemas/payment.yaml
View File

@ -82,5 +82,9 @@
type: array type: array
items: items:
$ref: '#/components/schemas/CreditPaymentable' $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 type: object

138
openapi/components/schemas/product.yaml Normal file
View File

@ -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

88
openapi/components/schemas/project.yaml Normal file
View File

@ -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

220
openapi/components/schemas/purchase_order.yaml Normal file
View File

@ -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

7
openapi/components/schemas/quote.yaml
View File

@ -97,9 +97,10 @@
format: float format: float
example: 10.00 example: 10.00
line_items: line_items:
description: 'An array of line items associated with the quote' type: array
type: object description: 'An array of objects which define the line items of the quote'
example: '' items:
$ref: '#/components/schemas/InvoiceItem'
amount: amount:
description: 'The total amount of the quote before taxes and discounts' description: 'The total amount of the quote before taxes and discounts'
type: number type: number