1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-11 13:42:49 +01:00
invoiceninja/openapi/components/schemas/expense.yaml

159 lines
4.7 KiB
YAML
Raw Normal View History

2023-03-19 00:39:21 +01:00
Expense:
properties:
id:
description: 'The expense hashed id'
type: string
2023-11-23 01:22:04 +01:00
example: 'Opnel5aKBz'
2023-03-19 00:39:21 +01:00
user_id:
description: 'The user hashed id'
type: string
2023-11-23 01:22:04 +01:00
example: 'Opnel5aKBz'
2023-03-19 00:39:21 +01:00
assigned_user_id:
description: 'The assigned user hashed id'
type: string
2023-11-23 01:22:04 +01:00
example: 'Opnel5aKBz'
project_id:
description: 'The associated project_id'
type: string
example: 'Opnel5aKBz'
2023-03-19 00:39:21 +01:00
client_id:
description: 'The client hashed id'
type: string
2023-11-23 01:22:04 +01:00
example: 'Opnel5aKBz'
2023-03-19 00:39:21 +01:00
invoice_id:
description: 'The related invoice hashed id'
type: string
2023-11-23 01:22:04 +01:00
example: 'Opnel5aKBz'
2023-03-19 00:39:21 +01:00
bank_id:
description: 'The bank id related to this expense'
type: string
example: ''
invoice_currency_id:
description: 'The currency id of the related invoice'
type: string
2023-11-23 01:22:04 +01:00
example: '1'
2024-01-18 01:53:07 +01:00
currency_id:
2023-03-19 00:39:21 +01:00
description: 'The currency id of the expense'
type: string
2023-11-23 01:22:04 +01:00
example: '2'
2023-03-19 00:39:21 +01:00
invoice_category_id:
description: 'The invoice category id'
type: string
2023-11-23 01:22:04 +01:00
example: 'Opnel5aKBz'
2023-03-19 00:39:21 +01:00
payment_type_id:
description: 'The payment type id'
type: string
example: ''
recurring_expense_id:
description: 'The related recurring expense this expense was created from'
type: string
2023-11-23 01:22:04 +01:00
example: 'Opnel5aKBz'
2023-03-19 00:39:21 +01:00
private_notes:
description: 'The private notes of the expense'
type: string
example: ''
public_notes:
description: 'The public notes of the expense'
type: string
example: ''
transaction_reference:
description: 'The transaction references of the expense'
type: string
example: ''
transcation_id:
description: 'The transaction id of the expense'
type: string
example: ''
custom_value1:
description: 'A custom value'
type: string
example: ''
custom_value2:
description: 'A custom value'
type: string
example: ''
custom_value3:
description: 'A custom value'
type: string
example: ''
custom_value4:
description: 'A custom value'
type: string
example: ''
2023-11-23 01:22:04 +01:00
tax_amount:
description: 'The tax amount'
type: number
example: 10.00
2023-03-19 00:39:21 +01:00
tax_name1:
2023-11-23 01:22:04 +01:00
description: 'Tax Name 1'
2023-03-19 00:39:21 +01:00
type: string
2023-11-23 01:22:04 +01:00
example: 'GST'
2023-03-19 00:39:21 +01:00
tax_name2:
2023-11-23 01:22:04 +01:00
description: 'Tax Name 2'
2023-03-19 00:39:21 +01:00
type: string
2023-11-23 01:22:04 +01:00
example: 'VAT'
tax_name3:
description: 'Tax Name 3'
type: string
example: 'IVA'
2023-03-19 00:39:21 +01:00
tax_rate1:
2023-11-23 01:22:04 +01:00
description: 'Tax rate 1'
2023-03-19 00:39:21 +01:00
type: number
format: float
example: '10.00'
tax_rate2:
2023-11-23 01:22:04 +01:00
description: 'Tax rate 2'
2023-03-19 00:39:21 +01:00
type: number
format: float
example: '10.00'
tax_rate3:
2023-11-23 01:22:04 +01:00
description: 'Tax rate 3'
2023-03-19 00:39:21 +01:00
type: number
format: float
example: '10.00'
amount:
description: 'The total expense amont'
type: number
format: float
example: '10.00'
foreign_amount:
description: 'The total foreign amount of the expense'
type: number
format: float
example: '10.00'
exchange_rate:
description: 'The exchange rate at the time of the expense'
type: number
format: float
example: '0.80'
date:
2023-11-23 01:22:04 +01:00
description: 'The expense date format Y-m-d'
2023-03-19 00:39:21 +01:00
type: string
example: '2022-12-01'
payment_date:
description: 'The date of payment for the expense, format Y-m-d'
type: string
2023-11-23 01:22:04 +01:00
example: '2022-12-01'
2023-03-19 00:39:21 +01:00
should_be_invoiced:
description: 'Flag whether the expense should be invoiced'
type: boolean
example: true
is_deleted:
description: 'Boolean determining whether the expense has been deleted'
type: boolean
example: true
invoice_documents:
description: 'Passing the expense documents over to the invoice'
type: boolean
example: true
updated_at:
description: Timestamp
type: number
format: integer
example: '1434342123'
archived_at:
description: Timestamp
type: number
format: integer
example: '1434342123'
type: object