mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-07-09 03:14:30 -04:00
Split up yamls
This commit is contained in:
David Bomba
parent
2028027eef
commit
928cf33031
@ -15292,216 +15292,6 @@ components:
|
|||||||
name: X-API-TOKEN
|
name: X-API-TOKEN
|
||||||
schemas:
|
schemas:
|
||||||
|
|
||||||
Activity:
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
description: 'The id field of the activity'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
activity_type_id:
|
|
||||||
description: 'The activity type id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
client_id:
|
|
||||||
description: 'The client hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
company_id:
|
|
||||||
description: 'The company hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
user_id:
|
|
||||||
description: 'The user hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
invoice_id:
|
|
||||||
description: 'The invoice hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
payment_id:
|
|
||||||
description: 'The payment hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
credit_id:
|
|
||||||
description: 'The credit hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
updated_at:
|
|
||||||
description: 'Unixtimestamp the last time the record was updated'
|
|
||||||
type: integer
|
|
||||||
example: '343421434'
|
|
||||||
expense_id:
|
|
||||||
description: 'The expense hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
is_system:
|
|
||||||
description: 'Defines is the activity was performed by the system'
|
|
||||||
type: boolean
|
|
||||||
example: true
|
|
||||||
contact_id:
|
|
||||||
description: 'The contact hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
task_id:
|
|
||||||
description: 'The task hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
notes:
|
|
||||||
description: 'Activity Notes'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
token_id:
|
|
||||||
description: 'The hashed ID of the token who performed the action'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
ip:
|
|
||||||
description: 'The IP Address of the user who performed the action'
|
|
||||||
type: string
|
|
||||||
example: 192.168.1.252
|
|
||||||
user:
|
|
||||||
$ref: '#/components/schemas/User'
|
|
||||||
client:
|
|
||||||
$ref: '#/components/schemas/Client'
|
|
||||||
contact:
|
|
||||||
$ref: '#/components/schemas/ClientContact'
|
|
||||||
recurring_invoice:
|
|
||||||
$ref: '#/components/schemas/RecurringInvoice'
|
|
||||||
invoice:
|
|
||||||
$ref: '#/components/schemas/Invoice'
|
|
||||||
credit:
|
|
||||||
$ref: '#/components/schemas/Credit'
|
|
||||||
quote:
|
|
||||||
$ref: '#/components/schemas/Quote'
|
|
||||||
payment:
|
|
||||||
$ref: '#/components/schemas/Payment'
|
|
||||||
expense:
|
|
||||||
$ref: '#/components/schemas/Expense'
|
|
||||||
task:
|
|
||||||
$ref: '#/components/schemas/Task'
|
|
||||||
purchase_order:
|
|
||||||
$ref: '#/components/schemas/PurchaseOrder'
|
|
||||||
vendor:
|
|
||||||
$ref: '#/components/schemas/Vendor'
|
|
||||||
vendor_contact:
|
|
||||||
$ref: '#/components/schemas/VendorContact'
|
|
||||||
type: object
|
|
||||||
BTRules:
|
|
||||||
properties:
|
|
||||||
data_key:
|
|
||||||
description: 'The key to search'
|
|
||||||
type: string
|
|
||||||
example: 'description,amount'
|
|
||||||
operator:
|
|
||||||
description: 'The operator flag of the search'
|
|
||||||
type: string
|
|
||||||
example: '>'
|
|
||||||
value:
|
|
||||||
description: 'The value to search for'
|
|
||||||
type: string
|
|
||||||
example: bob
|
|
||||||
type: object
|
|
||||||
BankIntegration:
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
description: 'The bank integration hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
company_id:
|
|
||||||
description: 'The company hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
user_id:
|
|
||||||
description: 'The user hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
provider_bank_name:
|
|
||||||
description: 'The providers bank name'
|
|
||||||
type: string
|
|
||||||
example: 'Chase Bank'
|
|
||||||
bank_account_id:
|
|
||||||
description: 'The bank account id'
|
|
||||||
type: integer
|
|
||||||
example: '1233434'
|
|
||||||
bank_account_name:
|
|
||||||
description: 'The name of the account'
|
|
||||||
type: string
|
|
||||||
example: 'My Checking Acc'
|
|
||||||
bank_account_number:
|
|
||||||
description: 'The account number'
|
|
||||||
type: string
|
|
||||||
example: '111 234 2332'
|
|
||||||
bank_account_status:
|
|
||||||
description: 'The status of the bank account'
|
|
||||||
type: string
|
|
||||||
example: ACTIVE
|
|
||||||
bank_account_type:
|
|
||||||
description: 'The type of account'
|
|
||||||
type: string
|
|
||||||
example: CREDITCARD
|
|
||||||
balance:
|
|
||||||
description: 'The current bank balance if available'
|
|
||||||
type: number
|
|
||||||
example: '1000000'
|
|
||||||
currency:
|
|
||||||
description: 'iso_3166_3 code'
|
|
||||||
type: string
|
|
||||||
example: USD
|
|
||||||
type: object
|
|
||||||
BankTransaction:
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
description: 'The bank integration hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
company_id:
|
|
||||||
description: 'The company hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
user_id:
|
|
||||||
description: 'The user hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
transaction_id:
|
|
||||||
description: 'The id of the transaction rule'
|
|
||||||
type: integer
|
|
||||||
example: 343434
|
|
||||||
amount:
|
|
||||||
description: 'The transaction amount'
|
|
||||||
type: number
|
|
||||||
example: 10
|
|
||||||
currency_id:
|
|
||||||
description: 'The currency ID of the currency'
|
|
||||||
type: string
|
|
||||||
example: '1'
|
|
||||||
account_type:
|
|
||||||
description: 'The account type'
|
|
||||||
type: string
|
|
||||||
example: creditCard
|
|
||||||
description:
|
|
||||||
description: 'The description of the transaction'
|
|
||||||
type: string
|
|
||||||
example: 'Potato purchases for kevin'
|
|
||||||
category_id:
|
|
||||||
description: 'The category id'
|
|
||||||
type: integer
|
|
||||||
example: 1
|
|
||||||
category_type:
|
|
||||||
description: 'The category description'
|
|
||||||
type: string
|
|
||||||
example: Expenses
|
|
||||||
base_type:
|
|
||||||
description: 'Either CREDIT or DEBIT'
|
|
||||||
type: string
|
|
||||||
example: CREDIT
|
|
||||||
date:
|
|
||||||
description: 'The date of the transaction'
|
|
||||||
type: string
|
|
||||||
example: '2022-09-01'
|
|
||||||
bank_account_id:
|
|
||||||
description: 'The ID number of the bank account'
|
|
||||||
type: integer
|
|
||||||
example: '1'
|
|
||||||
type: object
|
|
||||||
BankTransactionRule:
|
BankTransactionRule:
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
@ -19349,6 +19139,216 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
example: JSON
|
example: JSON
|
||||||
type: object
|
type: object
|
||||||
|
Activity:
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: 'The id field of the activity'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
activity_type_id:
|
||||||
|
description: 'The activity type id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
client_id:
|
||||||
|
description: 'The client hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
company_id:
|
||||||
|
description: 'The company hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
user_id:
|
||||||
|
description: 'The user hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
invoice_id:
|
||||||
|
description: 'The invoice hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
payment_id:
|
||||||
|
description: 'The payment hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
credit_id:
|
||||||
|
description: 'The credit hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
updated_at:
|
||||||
|
description: 'Unixtimestamp the last time the record was updated'
|
||||||
|
type: integer
|
||||||
|
example: '343421434'
|
||||||
|
expense_id:
|
||||||
|
description: 'The expense hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
is_system:
|
||||||
|
description: 'Defines is the activity was performed by the system'
|
||||||
|
type: boolean
|
||||||
|
example: true
|
||||||
|
contact_id:
|
||||||
|
description: 'The contact hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
task_id:
|
||||||
|
description: 'The task hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
notes:
|
||||||
|
description: 'Activity Notes'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
token_id:
|
||||||
|
description: 'The hashed ID of the token who performed the action'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
ip:
|
||||||
|
description: 'The IP Address of the user who performed the action'
|
||||||
|
type: string
|
||||||
|
example: 192.168.1.252
|
||||||
|
user:
|
||||||
|
$ref: '#/components/schemas/User'
|
||||||
|
client:
|
||||||
|
$ref: '#/components/schemas/Client'
|
||||||
|
contact:
|
||||||
|
$ref: '#/components/schemas/ClientContact'
|
||||||
|
recurring_invoice:
|
||||||
|
$ref: '#/components/schemas/RecurringInvoice'
|
||||||
|
invoice:
|
||||||
|
$ref: '#/components/schemas/Invoice'
|
||||||
|
credit:
|
||||||
|
$ref: '#/components/schemas/Credit'
|
||||||
|
quote:
|
||||||
|
$ref: '#/components/schemas/Quote'
|
||||||
|
payment:
|
||||||
|
$ref: '#/components/schemas/Payment'
|
||||||
|
expense:
|
||||||
|
$ref: '#/components/schemas/Expense'
|
||||||
|
task:
|
||||||
|
$ref: '#/components/schemas/Task'
|
||||||
|
purchase_order:
|
||||||
|
$ref: '#/components/schemas/PurchaseOrder'
|
||||||
|
vendor:
|
||||||
|
$ref: '#/components/schemas/Vendor'
|
||||||
|
vendor_contact:
|
||||||
|
$ref: '#/components/schemas/VendorContact'
|
||||||
|
type: object
|
||||||
|
BankTransaction:
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: 'The bank integration hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
company_id:
|
||||||
|
description: 'The company hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
user_id:
|
||||||
|
description: 'The user hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
transaction_id:
|
||||||
|
description: 'The id of the transaction rule'
|
||||||
|
type: integer
|
||||||
|
example: 343434
|
||||||
|
amount:
|
||||||
|
description: 'The transaction amount'
|
||||||
|
type: number
|
||||||
|
example: 10
|
||||||
|
currency_id:
|
||||||
|
description: 'The currency ID of the currency'
|
||||||
|
type: string
|
||||||
|
example: '1'
|
||||||
|
account_type:
|
||||||
|
description: 'The account type'
|
||||||
|
type: string
|
||||||
|
example: creditCard
|
||||||
|
description:
|
||||||
|
description: 'The description of the transaction'
|
||||||
|
type: string
|
||||||
|
example: 'Potato purchases for kevin'
|
||||||
|
category_id:
|
||||||
|
description: 'The category id'
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
|
category_type:
|
||||||
|
description: 'The category description'
|
||||||
|
type: string
|
||||||
|
example: Expenses
|
||||||
|
base_type:
|
||||||
|
description: 'Either CREDIT or DEBIT'
|
||||||
|
type: string
|
||||||
|
example: CREDIT
|
||||||
|
date:
|
||||||
|
description: 'The date of the transaction'
|
||||||
|
type: string
|
||||||
|
example: '2022-09-01'
|
||||||
|
bank_account_id:
|
||||||
|
description: 'The ID number of the bank account'
|
||||||
|
type: integer
|
||||||
|
example: '1'
|
||||||
|
type: object
|
||||||
|
BankIntegration:
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: 'The bank integration hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
company_id:
|
||||||
|
description: 'The company hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
user_id:
|
||||||
|
description: 'The user hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
provider_bank_name:
|
||||||
|
description: 'The providers bank name'
|
||||||
|
type: string
|
||||||
|
example: 'Chase Bank'
|
||||||
|
bank_account_id:
|
||||||
|
description: 'The bank account id'
|
||||||
|
type: integer
|
||||||
|
example: '1233434'
|
||||||
|
bank_account_name:
|
||||||
|
description: 'The name of the account'
|
||||||
|
type: string
|
||||||
|
example: 'My Checking Acc'
|
||||||
|
bank_account_number:
|
||||||
|
description: 'The account number'
|
||||||
|
type: string
|
||||||
|
example: '111 234 2332'
|
||||||
|
bank_account_status:
|
||||||
|
description: 'The status of the bank account'
|
||||||
|
type: string
|
||||||
|
example: ACTIVE
|
||||||
|
bank_account_type:
|
||||||
|
description: 'The type of account'
|
||||||
|
type: string
|
||||||
|
example: CREDITCARD
|
||||||
|
balance:
|
||||||
|
description: 'The current bank balance if available'
|
||||||
|
type: number
|
||||||
|
example: '1000000'
|
||||||
|
currency:
|
||||||
|
description: 'iso_3166_3 code'
|
||||||
|
type: string
|
||||||
|
example: USD
|
||||||
|
type: object
|
||||||
|
BTRules:
|
||||||
|
properties:
|
||||||
|
data_key:
|
||||||
|
description: 'The key to search'
|
||||||
|
type: string
|
||||||
|
example: 'description,amount'
|
||||||
|
operator:
|
||||||
|
description: 'The operator flag of the search'
|
||||||
|
type: string
|
||||||
|
example: '>'
|
||||||
|
value:
|
||||||
|
description: 'The value to search for'
|
||||||
|
type: string
|
||||||
|
example: bob
|
||||||
|
type: object
|
||||||
Account:
|
Account:
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
|
|||||||
@ -1,215 +1,5 @@
|
|||||||
schemas:
|
schemas:
|
||||||
|
|
||||||
Activity:
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
description: 'The id field of the activity'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
activity_type_id:
|
|
||||||
description: 'The activity type id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
client_id:
|
|
||||||
description: 'The client hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
company_id:
|
|
||||||
description: 'The company hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
user_id:
|
|
||||||
description: 'The user hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
invoice_id:
|
|
||||||
description: 'The invoice hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
payment_id:
|
|
||||||
description: 'The payment hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
credit_id:
|
|
||||||
description: 'The credit hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
updated_at:
|
|
||||||
description: 'Unixtimestamp the last time the record was updated'
|
|
||||||
type: integer
|
|
||||||
example: '343421434'
|
|
||||||
expense_id:
|
|
||||||
description: 'The expense hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
is_system:
|
|
||||||
description: 'Defines is the activity was performed by the system'
|
|
||||||
type: boolean
|
|
||||||
example: true
|
|
||||||
contact_id:
|
|
||||||
description: 'The contact hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
task_id:
|
|
||||||
description: 'The task hashed id'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
notes:
|
|
||||||
description: 'Activity Notes'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
token_id:
|
|
||||||
description: 'The hashed ID of the token who performed the action'
|
|
||||||
type: string
|
|
||||||
example: Opnel5aKBz
|
|
||||||
ip:
|
|
||||||
description: 'The IP Address of the user who performed the action'
|
|
||||||
type: string
|
|
||||||
example: 192.168.1.252
|
|
||||||
user:
|
|
||||||
$ref: '#/components/schemas/User'
|
|
||||||
client:
|
|
||||||
$ref: '#/components/schemas/Client'
|
|
||||||
contact:
|
|
||||||
$ref: '#/components/schemas/ClientContact'
|
|
||||||
recurring_invoice:
|
|
||||||
$ref: '#/components/schemas/RecurringInvoice'
|
|
||||||
invoice:
|
|
||||||
$ref: '#/components/schemas/Invoice'
|
|
||||||
credit:
|
|
||||||
$ref: '#/components/schemas/Credit'
|
|
||||||
quote:
|
|
||||||
$ref: '#/components/schemas/Quote'
|
|
||||||
payment:
|
|
||||||
$ref: '#/components/schemas/Payment'
|
|
||||||
expense:
|
|
||||||
$ref: '#/components/schemas/Expense'
|
|
||||||
task:
|
|
||||||
$ref: '#/components/schemas/Task'
|
|
||||||
purchase_order:
|
|
||||||
$ref: '#/components/schemas/PurchaseOrder'
|
|
||||||
vendor:
|
|
||||||
$ref: '#/components/schemas/Vendor'
|
|
||||||
vendor_contact:
|
|
||||||
$ref: '#/components/schemas/VendorContact'
|
|
||||||
type: object
|
|
||||||
BTRules:
|
|
||||||
properties:
|
|
||||||
data_key:
|
|
||||||
description: 'The key to search'
|
|
||||||
type: string
|
|
||||||
example: 'description,amount'
|
|
||||||
operator:
|
|
||||||
description: 'The operator flag of the search'
|
|
||||||
type: string
|
|
||||||
example: '>'
|
|
||||||
value:
|
|
||||||
description: 'The value to search for'
|
|
||||||
type: string
|
|
||||||
example: bob
|
|
||||||
type: object
|
|
||||||
BankIntegration:
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
description: 'The bank integration hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
company_id:
|
|
||||||
description: 'The company hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
user_id:
|
|
||||||
description: 'The user hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
provider_bank_name:
|
|
||||||
description: 'The providers bank name'
|
|
||||||
type: string
|
|
||||||
example: 'Chase Bank'
|
|
||||||
bank_account_id:
|
|
||||||
description: 'The bank account id'
|
|
||||||
type: integer
|
|
||||||
example: '1233434'
|
|
||||||
bank_account_name:
|
|
||||||
description: 'The name of the account'
|
|
||||||
type: string
|
|
||||||
example: 'My Checking Acc'
|
|
||||||
bank_account_number:
|
|
||||||
description: 'The account number'
|
|
||||||
type: string
|
|
||||||
example: '111 234 2332'
|
|
||||||
bank_account_status:
|
|
||||||
description: 'The status of the bank account'
|
|
||||||
type: string
|
|
||||||
example: ACTIVE
|
|
||||||
bank_account_type:
|
|
||||||
description: 'The type of account'
|
|
||||||
type: string
|
|
||||||
example: CREDITCARD
|
|
||||||
balance:
|
|
||||||
description: 'The current bank balance if available'
|
|
||||||
type: number
|
|
||||||
example: '1000000'
|
|
||||||
currency:
|
|
||||||
description: 'iso_3166_3 code'
|
|
||||||
type: string
|
|
||||||
example: USD
|
|
||||||
type: object
|
|
||||||
BankTransaction:
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
description: 'The bank integration hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
company_id:
|
|
||||||
description: 'The company hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
user_id:
|
|
||||||
description: 'The user hashed id'
|
|
||||||
type: string
|
|
||||||
example: AS3df3A
|
|
||||||
transaction_id:
|
|
||||||
description: 'The id of the transaction rule'
|
|
||||||
type: integer
|
|
||||||
example: 343434
|
|
||||||
amount:
|
|
||||||
description: 'The transaction amount'
|
|
||||||
type: number
|
|
||||||
example: 10
|
|
||||||
currency_id:
|
|
||||||
description: 'The currency ID of the currency'
|
|
||||||
type: string
|
|
||||||
example: '1'
|
|
||||||
account_type:
|
|
||||||
description: 'The account type'
|
|
||||||
type: string
|
|
||||||
example: creditCard
|
|
||||||
description:
|
|
||||||
description: 'The description of the transaction'
|
|
||||||
type: string
|
|
||||||
example: 'Potato purchases for kevin'
|
|
||||||
category_id:
|
|
||||||
description: 'The category id'
|
|
||||||
type: integer
|
|
||||||
example: 1
|
|
||||||
category_type:
|
|
||||||
description: 'The category description'
|
|
||||||
type: string
|
|
||||||
example: Expenses
|
|
||||||
base_type:
|
|
||||||
description: 'Either CREDIT or DEBIT'
|
|
||||||
type: string
|
|
||||||
example: CREDIT
|
|
||||||
date:
|
|
||||||
description: 'The date of the transaction'
|
|
||||||
type: string
|
|
||||||
example: '2022-09-01'
|
|
||||||
bank_account_id:
|
|
||||||
description: 'The ID number of the bank account'
|
|
||||||
type: integer
|
|
||||||
example: '1'
|
|
||||||
type: object
|
|
||||||
BankTransactionRule:
|
BankTransactionRule:
|
||||||
properties:
|
properties:
|
||||||
id:
|
id:
|
||||||
|
|||||||
93
openapi/components/schemas/activity.yaml
Normal file
93
openapi/components/schemas/activity.yaml
Normal file
@ -0,0 +1,93 @@
|
|||||||
|
Activity:
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: 'The id field of the activity'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
activity_type_id:
|
||||||
|
description: 'The activity type id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
client_id:
|
||||||
|
description: 'The client hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
company_id:
|
||||||
|
description: 'The company hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
user_id:
|
||||||
|
description: 'The user hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
invoice_id:
|
||||||
|
description: 'The invoice hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
payment_id:
|
||||||
|
description: 'The payment hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
credit_id:
|
||||||
|
description: 'The credit hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
updated_at:
|
||||||
|
description: 'Unixtimestamp the last time the record was updated'
|
||||||
|
type: integer
|
||||||
|
example: '343421434'
|
||||||
|
expense_id:
|
||||||
|
description: 'The expense hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
is_system:
|
||||||
|
description: 'Defines is the activity was performed by the system'
|
||||||
|
type: boolean
|
||||||
|
example: true
|
||||||
|
contact_id:
|
||||||
|
description: 'The contact hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
task_id:
|
||||||
|
description: 'The task hashed id'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
notes:
|
||||||
|
description: 'Activity Notes'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
token_id:
|
||||||
|
description: 'The hashed ID of the token who performed the action'
|
||||||
|
type: string
|
||||||
|
example: Opnel5aKBz
|
||||||
|
ip:
|
||||||
|
description: 'The IP Address of the user who performed the action'
|
||||||
|
type: string
|
||||||
|
example: 192.168.1.252
|
||||||
|
user:
|
||||||
|
$ref: '#/components/schemas/User'
|
||||||
|
client:
|
||||||
|
$ref: '#/components/schemas/Client'
|
||||||
|
contact:
|
||||||
|
$ref: '#/components/schemas/ClientContact'
|
||||||
|
recurring_invoice:
|
||||||
|
$ref: '#/components/schemas/RecurringInvoice'
|
||||||
|
invoice:
|
||||||
|
$ref: '#/components/schemas/Invoice'
|
||||||
|
credit:
|
||||||
|
$ref: '#/components/schemas/Credit'
|
||||||
|
quote:
|
||||||
|
$ref: '#/components/schemas/Quote'
|
||||||
|
payment:
|
||||||
|
$ref: '#/components/schemas/Payment'
|
||||||
|
expense:
|
||||||
|
$ref: '#/components/schemas/Expense'
|
||||||
|
task:
|
||||||
|
$ref: '#/components/schemas/Task'
|
||||||
|
purchase_order:
|
||||||
|
$ref: '#/components/schemas/PurchaseOrder'
|
||||||
|
vendor:
|
||||||
|
$ref: '#/components/schemas/Vendor'
|
||||||
|
vendor_contact:
|
||||||
|
$ref: '#/components/schemas/VendorContact'
|
||||||
|
type: object
|
||||||
47
openapi/components/schemas/bank_integration.yaml
Normal file
47
openapi/components/schemas/bank_integration.yaml
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
BankIntegration:
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: 'The bank integration hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
company_id:
|
||||||
|
description: 'The company hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
user_id:
|
||||||
|
description: 'The user hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
provider_bank_name:
|
||||||
|
description: 'The providers bank name'
|
||||||
|
type: string
|
||||||
|
example: 'Chase Bank'
|
||||||
|
bank_account_id:
|
||||||
|
description: 'The bank account id'
|
||||||
|
type: integer
|
||||||
|
example: '1233434'
|
||||||
|
bank_account_name:
|
||||||
|
description: 'The name of the account'
|
||||||
|
type: string
|
||||||
|
example: 'My Checking Acc'
|
||||||
|
bank_account_number:
|
||||||
|
description: 'The account number'
|
||||||
|
type: string
|
||||||
|
example: '111 234 2332'
|
||||||
|
bank_account_status:
|
||||||
|
description: 'The status of the bank account'
|
||||||
|
type: string
|
||||||
|
example: ACTIVE
|
||||||
|
bank_account_type:
|
||||||
|
description: 'The type of account'
|
||||||
|
type: string
|
||||||
|
example: CREDITCARD
|
||||||
|
balance:
|
||||||
|
description: 'The current bank balance if available'
|
||||||
|
type: number
|
||||||
|
example: '1000000'
|
||||||
|
currency:
|
||||||
|
description: 'iso_3166_3 code'
|
||||||
|
type: string
|
||||||
|
example: USD
|
||||||
|
type: object
|
||||||
55
openapi/components/schemas/bank_transaction.yaml
Normal file
55
openapi/components/schemas/bank_transaction.yaml
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
BankTransaction:
|
||||||
|
properties:
|
||||||
|
id:
|
||||||
|
description: 'The bank integration hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
company_id:
|
||||||
|
description: 'The company hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
user_id:
|
||||||
|
description: 'The user hashed id'
|
||||||
|
type: string
|
||||||
|
example: AS3df3A
|
||||||
|
transaction_id:
|
||||||
|
description: 'The id of the transaction rule'
|
||||||
|
type: integer
|
||||||
|
example: 343434
|
||||||
|
amount:
|
||||||
|
description: 'The transaction amount'
|
||||||
|
type: number
|
||||||
|
example: 10
|
||||||
|
currency_id:
|
||||||
|
description: 'The currency ID of the currency'
|
||||||
|
type: string
|
||||||
|
example: '1'
|
||||||
|
account_type:
|
||||||
|
description: 'The account type'
|
||||||
|
type: string
|
||||||
|
example: creditCard
|
||||||
|
description:
|
||||||
|
description: 'The description of the transaction'
|
||||||
|
type: string
|
||||||
|
example: 'Potato purchases for kevin'
|
||||||
|
category_id:
|
||||||
|
description: 'The category id'
|
||||||
|
type: integer
|
||||||
|
example: 1
|
||||||
|
category_type:
|
||||||
|
description: 'The category description'
|
||||||
|
type: string
|
||||||
|
example: Expenses
|
||||||
|
base_type:
|
||||||
|
description: 'Either CREDIT or DEBIT'
|
||||||
|
type: string
|
||||||
|
example: CREDIT
|
||||||
|
date:
|
||||||
|
description: 'The date of the transaction'
|
||||||
|
type: string
|
||||||
|
example: '2022-09-01'
|
||||||
|
bank_account_id:
|
||||||
|
description: 'The ID number of the bank account'
|
||||||
|
type: integer
|
||||||
|
example: '1'
|
||||||
|
type: object
|
||||||
15
openapi/components/schemas/btrules.yaml
Normal file
15
openapi/components/schemas/btrules.yaml
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
BTRules:
|
||||||
|
properties:
|
||||||
|
data_key:
|
||||||
|
description: 'The key to search'
|
||||||
|
type: string
|
||||||
|
example: 'description,amount'
|
||||||
|
operator:
|
||||||
|
description: 'The operator flag of the search'
|
||||||
|
type: string
|
||||||
|
example: '>'
|
||||||
|
value:
|
||||||
|
description: 'The value to search for'
|
||||||
|
type: string
|
||||||
|
example: bob
|
||||||
|
type: object
|
||||||
Loading…
x
Reference in New Issue
Block a user