1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-09-22 17:31:35 +02:00
invoiceninja/openapi/components/schemas/invoice_item.yaml

116 lines
4.4 KiB
YAML
Raw Normal View History

2023-03-19 01:15:52 +01:00
InvoiceItem:
type: object
properties:
quantity:
type: integer
example: 1
2023-05-08 11:11:14 +02:00
description: 'The quantity of the product offered for this line item'
2023-03-19 01:15:52 +01:00
cost:
type: number
format: float
example: 10.00
2023-05-08 11:11:14 +02:00
description: 'The cost of the product offered for this line item'
2023-03-19 01:15:52 +01:00
product_key:
type: string
example: 'Product key'
2023-05-08 11:11:14 +02:00
description: 'The product key of the product offered for this line item (Referred to as Product in the product tab)'
2023-03-19 01:15:52 +01:00
product_cost:
type: number
format: float
example: 10.00
2023-05-08 11:11:14 +02:00
description: 'The cost of the product offered for this line item (Referred to as Cost in the product tab)'
2023-03-19 01:15:52 +01:00
notes:
type: string
example: 'Item notes'
2023-05-08 11:11:14 +02:00
description: 'The notes/description for the product offered for this line item'
2023-03-19 01:15:52 +01:00
discount:
type: number
format: float
example: 5.00
2023-05-08 11:11:14 +02:00
description: 'The discount applied to the product offered for this line item'
2023-03-19 01:15:52 +01:00
is_amount_discount:
type: boolean
example: false
2023-05-08 11:11:14 +02:00
description: 'Indicates whether the discount applied to the product offered for this line item is a fixed amount or a percentage'
2023-03-19 01:15:52 +01:00
tax_name1:
type: string
2023-05-08 11:11:14 +02:00
example: 'GST'
description: 'The name of the first tax applied to the product offered for this line item'
2023-03-19 01:15:52 +01:00
tax_rate1:
type: number
format: float
example: 10.00
2023-05-08 11:11:14 +02:00
description: 'The rate of the first tax applied to the product offered for this line item'
2023-03-19 01:15:52 +01:00
tax_name2:
type: string
2023-05-08 11:11:14 +02:00
example: 'VAT'
description: 'The name of the second tax applied to the product offered for this line item'
2023-03-19 01:15:52 +01:00
tax_rate2:
type: number
format: float
example: 5.00
2023-05-08 11:11:14 +02:00
description: 'The rate of the second tax applied to the product offered for this line item'
2023-03-19 01:15:52 +01:00
tax_name3:
type: string
2023-05-08 11:11:14 +02:00
example: 'CA Sales Tax'
description: 'The name of the third tax applied to the product offered for this line item'
2023-03-19 01:15:52 +01:00
tax_rate3:
type: number
format: float
example: 3.00
2023-05-08 11:11:14 +02:00
description: 'The rate of the third tax applied to the product offered for this line item'
2023-03-19 01:15:52 +01:00
sort_id:
type: string
example: '0'
2023-05-08 11:11:14 +02:00
description: 'Deprecated'
deprecated: true
2023-03-19 01:15:52 +01:00
line_total:
type: number
format: float
example: 10.00
2023-05-08 11:11:14 +02:00
description: 'The total amount of the product offered for this line item'
readOnly: true
2023-03-19 01:15:52 +01:00
gross_line_total:
type: number
format: float
example: 15.00
2023-05-08 11:11:14 +02:00
description: 'The total amount of the product offered for this line item before discounts'
readOnly: true
2023-03-19 01:15:52 +01:00
tax_amount:
type: number
format: float
example: 1.00
2023-05-08 11:11:14 +02:00
description: 'The total amount of tax applied to the product offered for this line item'
readOnly: true
2023-03-19 01:15:52 +01:00
date:
type: string
format: date-time
example: '2023-03-19T00:00:00Z'
2023-05-08 11:11:14 +02:00
description: 'Deprecated'
deprecated: true
2023-03-19 01:15:52 +01:00
custom_value1:
type: string
example: 'Custom value 1'
2023-05-08 11:11:14 +02:00
description: 'The first custom value of the product offered for this line item'
2023-03-19 01:15:52 +01:00
custom_value2:
type: string
example: 'Custom value 2'
2023-05-08 11:11:14 +02:00
description: 'The second custom value of the product offered for this line item'
2023-03-19 01:15:52 +01:00
custom_value3:
type: string
example: 'Custom value 3'
2023-05-08 11:11:14 +02:00
description: 'The third custom value of the product offered for this line item'
2023-03-19 01:15:52 +01:00
custom_value4:
type: string
example: 'Custom value 4'
2023-05-08 11:11:14 +02:00
description: 'The fourth custom value of the product offered for this line item'
2023-03-19 01:15:52 +01:00
type_id:
type: string
example: '1'
2023-05-08 11:11:14 +02:00
description: '1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense'
default: '1'
tax_id:
type: string
example: '1'
default: '1'
description: 'The tax ID of the product: 1 product, 2 service, 3 digital, 4 shipping, 5 exempt, 5 reduced tax, 7 override, 8 zero rate, 9 reverse tax'