Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-05-24 02:14:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

Open API

Browse Source
This commit is contained in:
David Bomba 2022-08-18 23:13:06 +10:00
parent 45d658cf47
commit d6ccc27507
10 changed files with 211 additions and 112 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
app/Http/Controllers/OpenAPI/QuoteSchema.php
View File

@ -10,36 +10,36 @@
* @OA\Property(property="client_id", type="string", example="", description="The client hashed id"),
* @OA\Property(property="status_id", type="string", example="", description="The status of the quote"),
* @OA\Property(property="number", type="string", example="QUOTE_101", description="The quote number - is a unique alpha numeric number per quote per company"),
* @OA\Property(property="po_number", type="string", example="", description="________"),
* @OA\Property(property="terms", type="string", example="", description="________"),
* @OA\Property(property="public_notes", type="string", example="", description="________"),
* @OA\Property(property="private_notes", type="string", example="", description="________"),
* @OA\Property(property="footer", type="string", example="", description="________"),
* @OA\Property(property="custom_value1", type="string", example="", description="________"),
* @OA\Property(property="custom_value2", type="string", example="", description="________"),
* @OA\Property(property="custom_value3", type="string", example="", description="________"),
* @OA\Property(property="custom_value4", type="string", example="", description="________"),
* @OA\Property(property="tax_name1", type="string", example="", description="________"),
* @OA\Property(property="tax_name2", type="string", example="", description="________"),
* @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="tax_rate2", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="tax_name3", type="string", example="", description="________"),
* @OA\Property(property="tax_rate3", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="po_number", type="string", example="PO-1234", description="The purchase order number associated with this quote"),
* @OA\Property(property="terms", type="string", example="These are some quote terms. Valid for 14 days.", description="The quote terms"),
* @OA\Property(property="public_notes", type="string", example="These are public notes which the client may see", description="Public notes for the quote"),
* @OA\Property(property="private_notes", type="string", example="These are private notes, not to be disclosed to the client", description="Private notes for the quote"),
* @OA\Property(property="footer", type="string", example="The text goes in the footer of the quote", description="Footer text of quote"),
* @OA\Property(property="custom_value1", type="string", example="A custom value", description="Custom value field"),
* @OA\Property(property="custom_value2", type="string", example="A custom value", description="Custom value field"),
* @OA\Property(property="custom_value3", type="string", example="A custom value", description="Custom value field"),
* @OA\Property(property="custom_value4", type="string", example="A custom value", description="Custom value field"),
* @OA\Property(property="tax_name1", type="string", example="GST", description="The tax name"),
* @OA\Property(property="tax_name2", type="string", example="VAT", description="The tax name"),
* @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_rate2", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_name3", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_rate3", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="total_taxes", type="number", format="float", example="10.00", description="The total taxes for the quote"),
* @OA\Property(property="line_items", type="object", example="", description="_________"),
* @OA\Property(property="amount", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="balance", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="paid_to_date", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="discount", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="partial", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="is_amount_discount", type="boolean", example=true, description="_________"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="_________"),
* @OA\Property(property="line_items", type="object", example="[{"product_key":"test", "unit_cost":10},{"product_key":"test", "unit_cost":10}]", description="An array of line items of the quote"),
* @OA\Property(property="amount", type="number", format="float", example="10.00", description="The total amount of the quote"),
* @OA\Property(property="balance", type="number", format="float", example="10.00", description="The balance due of the quote"),
* @OA\Property(property="paid_to_date", type="number", format="float", example="10.00", description="The amount that has been paid to date on the quote"),
* @OA\Property(property="discount", type="number", format="float", example="10.00", description="The quote discount"),
* @OA\Property(property="partial", type="number", format="float", example="10.00", description="The partial/deposit amount"),
* @OA\Property(property="is_amount_discount", type="boolean", example=true, description="Boolean flag determining if the quote is an amount or percentage"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Boolean flag determining if the quote has been deleted"),
* @OA\Property(property="uses_inclusive_taxes", type="boolean", example=true, description="Defines the type of taxes used as either inclusive or exclusive"),
* @OA\Property(property="date", type="string", format="date", example="1994-07-30", description="The Quote Date"),
* @OA\Property(property="last_sent_date", type="string", format="date", example="1994-07-30", description="The last date the quote was sent out"),
* @OA\Property(property="next_send_date", type="string", format="date", example="1994-07-30", description="The Next date for a reminder to be sent"),
* @OA\Property(property="partial_due_date", type="string", format="date", example="1994-07-30", description="_________"),
* @OA\Property(property="due_date", type="string", format="date", example="1994-07-30", description="_________"),
* @OA\Property(property="partial_due_date", type="string", format="date", example="1994-07-30", description="The date when the partial/deposit is due"),
* @OA\Property(property="due_date", type="string", format="date", example="1994-07-30", description="The date the quote is valid until"),
* @OA\Property(property="settings",ref="#/components/schemas/CompanySettings"),
* @OA\Property(property="last_viewed", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"),

71
app/Http/Controllers/OpenAPI/RecurringExpense.php
View File

@ -3,44 +3,43 @@
* @OA\Schema(
* schema="RecurringExpense",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="_________"),
* @OA\Property(property="user_id", type="string", example="", description="__________"),
* @OA\Property(property="assigned_user_id", type="string", example="", description="__________"),
* @OA\Property(property="company_id", type="string", example="", description="________"),
* @OA\Property(property="client_id", type="string", example="", description="________"),
* @OA\Property(property="invoice_id", type="string", example="", description="________"),
* @OA\Property(property="bank_id", type="string", example="", description="________"),
* @OA\Property(property="invoice_currency_id", type="string", example="", description="________"),
* @OA\Property(property="expense_currency_id", type="string", example="", description="________"),
* @OA\Property(property="invoice_category_id", type="string", example="", description="________"),
* @OA\Property(property="payment_type_id", type="string", example="", description="________"),
* @OA\Property(property="recurring_expense_id", type="string", example="", description="________"),
* @OA\Property(property="private_notes", type="string", example="", description="________"),
* @OA\Property(property="public_notes", type="string", example="", description="________"),
* @OA\Property(property="transaction_reference", type="string", example="", description="________"),
* @OA\Property(property="transcation_id", type="string", example="", description="________"),
* @OA\Property(property="custom_value1", type="string", example="", description="________"),
* @OA\Property(property="custom_value2", type="string", example="", description="________"),
* @OA\Property(property="custom_value3", type="string", example="", description="________"),
* @OA\Property(property="custom_value4", type="string", example="", description="________"),
* @OA\Property(property="tax_name1", type="string", example="", description="________"),
* @OA\Property(property="tax_name2", type="string", example="", description="________"),
* @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="tax_rate2", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="tax_name3", type="string", example="", description="________"),
* @OA\Property(property="tax_rate3", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="amount", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="frequency_id", type="number", format="int", example="1", description="_________"),
* @OA\Property(property="remaining_cycles", type="number", format="int", example="1", description="_________"),
* @OA\Property(property="foreign_amount", type="number", format="float", example="10.00", description="_________"),
* @OA\Property(property="exchange_rate", type="number", format="float", example="0.80", description="_________"),
* @OA\Property(property="date", type="string", example="", description="________"),
* @OA\Property(property="payment_date", type="string", example="", description="________"),
* @OA\Property(property="should_be_invoiced", type="boolean", example=true, description="_________"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="_________"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the recurring expense"),
* @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The hashed id of the user who created the recurring expense"),
* @OA\Property(property="assigned_user_id", type="string", example="Opnel5aKBz", description="The hashed id of the user assigned to this recurring expense"),
* @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The hashed id of the company"),
* @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="The hashed id of the client"),
* @OA\Property(property="invoice_id", type="string", example="Opnel5aKBz", description="The hashed id of the invoice"),
* @OA\Property(property="bank_id", type="string", example="22", description="The id of the bank associated with this recurring expense"),
* @OA\Property(property="invoice_currency_id", type="string", example="1", description="The currency id of the invoice associated with this recurring expense"),
* @OA\Property(property="expense_currency_id", type="string", example="1", description="The currency id of the expense associated with this recurring expense"),
* @OA\Property(property="invoice_category_id", type="string", example="1", description="The category id of the invoice"),
* @OA\Property(property="payment_type_id", type="string", example="1", description="The payment type id"),
* @OA\Property(property="private_notes", type="string", example="Private and confidential", description="The recurring expense private notes"),
* @OA\Property(property="public_notes", type="string", example="This is the best client in the world", description="The recurring expense public notes"),
* @OA\Property(property="transaction_reference", type="string", example="EXP-1223-2333", description="The recurring expense transaction reference"),
* @OA\Property(property="transcation_id", type="string", example="1233312312", description="The transaction id of the recurring expense"),
* @OA\Property(property="custom_value1", type="string", example="$1000", description="Custom value field"),
* @OA\Property(property="custom_value2", type="string", example="2022-10-10", description="Custom value field"),
* @OA\Property(property="custom_value3", type="string", example="short text", description="Custom value field"),
* @OA\Property(property="custom_value4", type="string", example="very long text", description="Custom value field"),
* @OA\Property(property="tax_name1", type="string", example="GST", description="The tax name"),
* @OA\Property(property="tax_name2", type="string", example="VAT", description="The tax name"),
* @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_rate2", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_name3", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_rate3", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="amount", type="number", format="float", example="10.00", description="The total amount of the recurring expense"),
* @OA\Property(property="frequency_id", type="number", format="int", example="1", description="The frequency this recurring expense fires"),
* @OA\Property(property="remaining_cycles", type="number", format="int", example="1", description="The number of remaining cycles for this recurring expense"),
* @OA\Property(property="foreign_amount", type="number", format="float", example="10.00", description="The foreign currency amount of the recurring expense"),
* @OA\Property(property="exchange_rate", type="number", format="float", example="0.80", description="The exchange rate for the expernse"),
* @OA\Property(property="date", type="string", example="", description="The date of the expense"),
* @OA\Property(property="payment_date", type="string", example="", description="The date the expense was paid"),
* @OA\Property(property="should_be_invoiced", type="boolean", example=true, description="Boolean flag determining if the expense should be invoiced"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Boolean flag determining if the recurring expense is deleted"),
* @OA\Property(property="last_sent_date", type="string", format="date", example="1994-07-30", description="The Date it was sent last"),
* @OA\Property(property="next_send_date", type="string", format="date", example="1994-07-30", description="The next send date"),
* @OA\Property(property="invoice_documents", type="boolean", example=true, description=""),
* @OA\Property(property="invoice_documents", type="boolean", example=true, description="Boolean flag determining if the documents associated with this expense should be passed onto the invoice if it is converted to an invoice"),
* @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="archived_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* )

52
app/Http/Controllers/OpenAPI/RecurringInvoice.php
View File

@ -3,6 +3,56 @@
* @OA\Schema(
* schema="RecurringInvoice",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the recurring invoice"),
* @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The user hashed id"),
* @OA\Property(property="assigned_user_id", type="string", example="Opnel5aKBz", description="The assigned user hashed id"),
* @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The company hashed id"),
* @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="The client hashed id"),
* @OA\Property(property="status_id", type="string", example="4", description="The invoice status variable"),
* @OA\Property(property="frequency_id", type="number", example="4", description="The recurring invoice frequency"),
* @OA\Property(property="remaining_cycles", type="number", example="4", description="The number of invoices left to be generated"),
* @OA\Property(property="number", type="string", example="INV_101", description="The recurringinvoice number - is a unique alpha numeric number per invoice per company"),
* @OA\Property(property="po_number", type="string", example="PO-1234", description="The purchase order associated with this recurring invoice"),
* @OA\Property(property="terms", type="string", example="These are invoice terms", description="The invoice terms"),
* @OA\Property(property="public_notes", type="string", example="These are some public notes", description="The public notes of the invoice"),
* @OA\Property(property="private_notes", type="string", example="These are some private notes", description="The private notes of the invoice"),
* @OA\Property(property="footer", type="string", example="", description="The invoice footer notes"),
* @OA\Property(property="custom_value1", type="string", example="2022-10-01", description="A custom field value"),
* @OA\Property(property="custom_value2", type="string", example="Something custom", description="A custom field value"),
* @OA\Property(property="custom_value3", type="string", example="", description="A custom field value"),
* @OA\Property(property="custom_value4", type="string", example="", description="A custom field value"),
* @OA\Property(property="tax_name1", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_name2", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_rate2", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_name3", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_rate3", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="total_taxes", type="number", format="float", example="10.00", description="The total taxes for the invoice"),
* @OA\Property(property="line_items", type="object", example="", description="An array of objects which define the line items of the invoice"),
* @OA\Property(property="amount", type="number", format="float", example="10.00", description="The invoice amount"),
* @OA\Property(property="balance", type="number", format="float", example="10.00", description="The invoice balance"),
* @OA\Property(property="paid_to_date", type="number", format="float", example="10.00", description="The amount paid on the invoice to date"),
* @OA\Property(property="discount", type="number", format="float", example="10.00", description="The invoice discount, can be an amount or a percentage"),
* @OA\Property(property="partial", type="number", format="float", example="10.00", description="The deposit/partial amount"),
* @OA\Property(property="is_amount_discount", type="boolean", example=true, description="Flag determining if the discount is an amount or a percentage"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Defines if the invoice has been deleted"),
* @OA\Property(property="uses_inclusive_taxes", type="boolean", example=true, description="Defines the type of taxes used as either inclusive or exclusive"),
* @OA\Property(property="date", type="string", format="date", example="1994-07-30", description="The Invoice Date"),
* @OA\Property(property="last_sent_date", type="string", format="date", example="1994-07-30", description="The last date the invoice was sent out"),
* @OA\Property(property="next_send_date", type="string", format="date", example="1994-07-30", description="The Next date for a reminder to be sent"),
* @OA\Property(property="partial_due_date", type="string", format="date", example="1994-07-30", description="The due date for the deposit/partial amount"),
* @OA\Property(property="due_date", type="string", format="date", example="1994-07-30", description="The due date of the invoice"),
* @OA\Property(property="settings",ref="#/components/schemas/CompanySettings"),
* @OA\Property(property="last_viewed", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="archived_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="custom_surcharge1", type="number", format="float", example="10.00", description="First Custom Surcharge"),
* @OA\Property(property="custom_surcharge2", type="number", format="float", example="10.00", description="Second Custom Surcharge"),
* @OA\Property(property="custom_surcharge3", type="number", format="float", example="10.00", description="Third Custom Surcharge"),
* @OA\Property(property="custom_surcharge4", type="number", format="float", example="10.00", description="Fourth Custom Surcharge"),
* @OA\Property(property="custom_surcharge_tax1", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_tax2", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_tax3", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_tax4", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* )
*/

52
app/Http/Controllers/OpenAPI/RecurringQuote.php
View File

@ -3,6 +3,56 @@
* @OA\Schema(
* schema="RecurringQuote",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the recurring quote"),
* @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The user hashed id"),
* @OA\Property(property="assigned_user_id", type="string", example="Opnel5aKBz", description="The assigned user hashed id"),
* @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The company hashed id"),
* @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="The client hashed id"),
* @OA\Property(property="status_id", type="string", example="4", description="The quote status variable"),
* @OA\Property(property="frequency_id", type="number", example="4", description="The recurring quote frequency"),
* @OA\Property(property="remaining_cycles", type="number", example="4", description="The number of quotes left to be generated"),
* @OA\Property(property="number", type="string", example="INV_101", description="The recurringquote number - is a unique alpha numeric number per quote per company"),
* @OA\Property(property="po_number", type="string", example="PO-1234", description="The purchase order associated with this recurring quote"),
* @OA\Property(property="terms", type="string", example="These are quote terms", description="The quote terms"),
* @OA\Property(property="public_notes", type="string", example="These are some public notes", description="The public notes of the quote"),
* @OA\Property(property="private_notes", type="string", example="These are some private notes", description="The private notes of the quote"),
* @OA\Property(property="footer", type="string", example="", description="The quote footer notes"),
* @OA\Property(property="custom_value1", type="string", example="2022-10-01", description="A custom field value"),
* @OA\Property(property="custom_value2", type="string", example="Something custom", description="A custom field value"),
* @OA\Property(property="custom_value3", type="string", example="", description="A custom field value"),
* @OA\Property(property="custom_value4", type="string", example="", description="A custom field value"),
* @OA\Property(property="tax_name1", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_name2", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_rate2", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="tax_name3", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_rate3", type="number", format="float", example="10.00", description="The tax rate"),
* @OA\Property(property="total_taxes", type="number", format="float", example="10.00", description="The total taxes for the quote"),
* @OA\Property(property="line_items", type="object", example="", description="An array of objects which define the line items of the quote"),
* @OA\Property(property="amount", type="number", format="float", example="10.00", description="The quote amount"),
* @OA\Property(property="balance", type="number", format="float", example="10.00", description="The quote balance"),
* @OA\Property(property="paid_to_date", type="number", format="float", example="10.00", description="The amount paid on the quote to date"),
* @OA\Property(property="discount", type="number", format="float", example="10.00", description="The quote discount, can be an amount or a percentage"),
* @OA\Property(property="partial", type="number", format="float", example="10.00", description="The deposit/partial amount"),
* @OA\Property(property="is_amount_discount", type="boolean", example=true, description="Flag determining if the discount is an amount or a percentage"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Defines if the quote has been deleted"),
* @OA\Property(property="uses_inclusive_taxes", type="boolean", example=true, description="Defines the type of taxes used as either inclusive or exclusive"),
* @OA\Property(property="date", type="string", format="date", example="1994-07-30", description="The quote Date"),
* @OA\Property(property="last_sent_date", type="string", format="date", example="1994-07-30", description="The last date the quote was sent out"),
* @OA\Property(property="next_send_date", type="string", format="date", example="1994-07-30", description="The Next date for a reminder to be sent"),
* @OA\Property(property="partial_due_date", type="string", format="date", example="1994-07-30", description="The due date for the deposit/partial amount"),
* @OA\Property(property="due_date", type="string", format="date", example="1994-07-30", description="The due date of the quote"),
* @OA\Property(property="settings",ref="#/components/schemas/CompanySettings"),
* @OA\Property(property="last_viewed", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="archived_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="custom_surcharge1", type="number", format="float", example="10.00", description="First Custom Surcharge"),
* @OA\Property(property="custom_surcharge2", type="number", format="float", example="10.00", description="Second Custom Surcharge"),
* @OA\Property(property="custom_surcharge3", type="number", format="float", example="10.00", description="Third Custom Surcharge"),
* @OA\Property(property="custom_surcharge4", type="number", format="float", example="10.00", description="Fourth Custom Surcharge"),
* @OA\Property(property="custom_surcharge_tax1", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_tax2", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_tax3", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_tax4", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* )
*/

4
app/Http/Controllers/OpenAPI/SystemLogSchema.php
View File

@ -11,7 +11,7 @@
* @OA\Property(property="category_id", type="integer", example=1, description="The Category Type ID"),
* @OA\Property(property="type_id", type="integer", example=1, description="The Type Type ID"),
* @OA\Property(property="log", type="object", example="{'key':'value'}", description="The json object of the error"),
* @OA\Property(property="updated_at", type="string", example="2", description="______"),
* @OA\Property(property="created_at", type="string", example="2", description="______"),
* @OA\Property(property="updated_at", type="string", example="2", description="Timestamp"),
* @OA\Property(property="created_at", type="string", example="2", description="Timestamp"),
* )
*/

38
app/Http/Controllers/OpenAPI/TaskSchema.php
View File

@ -3,25 +3,25 @@
* @OA\Schema(
* schema="Task",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="_________"),
* @OA\Property(property="user_id", type="string", example="", description="__________"),
* @OA\Property(property="assigned_user_id", type="string", example="", description="__________"),
* @OA\Property(property="company_id", type="string", example="", description="________"),
* @OA\Property(property="client_id", type="string", example="", description="________"),
* @OA\Property(property="invoice_id", type="string", example="", description="________"),
* @OA\Property(property="project_id", type="string", example="", description="________"),
* @OA\Property(property="number", type="string", example="", description="________"),
* @OA\Property(property="time_log", type="string", example="", description="________"),
* @OA\Property(property="is_running", type="boolean", example=true, description="________"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="________"),
* @OA\Property(property="task_status_id", type="string", example="", description="________"),
* @OA\Property(property="description", type="string", example="", description="________"),
* @OA\Property(property="duration", type="integer", example="", description="________"),
* @OA\Property(property="task_status_order", type="integer", example="", description="________"),
* @OA\Property(property="custom_value1", type="string", example="", description="________"),
* @OA\Property(property="custom_value2", type="string", example="", description="________"),
* @OA\Property(property="custom_value3", type="string", example="", description="________"),
* @OA\Property(property="custom_value4", type="string", example="", description="________"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the task"),
* @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The hashed id of the user who created the task"),
* @OA\Property(property="assigned_user_id", type="string", example="Opnel5aKBz", description="The assigned user of the task"),
* @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The hashed id of the company"),
* @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="The hashed if of the client"),
* @OA\Property(property="invoice_id", type="string", example="Opnel5aKBz", description="The hashed id of the invoice associated with the task"),
* @OA\Property(property="project_id", type="string", example="Opnel5aKBz", description="The hashed id of the project associated with the task"),
* @OA\Property(property="number", type="string", example="TASK-123", description="The number of the task"),
* @OA\Property(property="time_log", type="string", example="[[1,2],[3,4]]", description="An array of unix time stamps defining the start and end times of the task"),
* @OA\Property(property="is_running", type="boolean", example=true, description="Determines if the task is still running"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Boolean flag determining if the task has been deleted"),
* @OA\Property(property="task_status_id", type="string", example="Opnel5aKBz", description="The hashed id of the task status"),
* @OA\Property(property="description", type="string", example="A wonder task to work on", description="The task description"),
* @OA\Property(property="duration", type="integer", example="", description="The task duration"),
* @OA\Property(property="task_status_order", type="integer", example="4", description="The order of the task"),
* @OA\Property(property="custom_value1", type="string", example="2022-10-10", description="A custom value"),
* @OA\Property(property="custom_value2", type="string", example="$1100", description="A custom value"),
* @OA\Property(property="custom_value3", type="string", example="I need help", description="A custom value"),
* @OA\Property(property="custom_value4", type="string", example="INV-3343", description="A custom value"),
* @OA\Property(property="created_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"),
* @OA\Property(property="archived_at", type="number", format="integer", example="1434342123", description="Timestamp"),

2
app/Http/Controllers/OpenAPI/TaskStatusSchema.php
View File

@ -5,7 +5,7 @@
* type="object",
* @OA\Property(property="name", type="string", example="Backlog", description="The task status name"),
* @OA\Property(property="created_at", type="number", format="integer", example="134341234234", description="Timestamp"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="______"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="A boolean flag determining if the task status has been deleted"),
* @OA\Property(property="updated_at", type="number", format="integer", example="134341234234", description="Timestamp"),
* @OA\Property(property="archived_at", type="number", format="integer", example="134341234234", description="Timestamp"),
* )

8
app/Http/Controllers/OpenAPI/TaxRateSchema.php
View File

@ -3,9 +3,9 @@
* @OA\Schema(
* schema="TaxRate",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="name", type="string", example="GST", description="______"),
* @OA\Property(property="rate", type="number", example="10", description="______"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="______"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="Thie hashed id of the tax"),
* @OA\Property(property="name", type="string", example="GST", description="The tax name"),
* @OA\Property(property="rate", type="number", example="10", description="The tax rate"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Boolean flag determining if the tax has been deleted"),
* )
*/

20
app/Http/Controllers/OpenAPI/UserSchema.php
View File

@ -3,15 +3,15 @@
* @OA\Schema(
* schema="User",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="__________"),
* @OA\Property(property="first_name", type="string", example="The users first name", description="________"),
* @OA\Property(property="last_name", type="string", example="The users last name", description="_________"),
* @OA\Property(property="email", type="string", example="", description="_________"),
* @OA\Property(property="phone", type="string", example="555-1233-23232", description="_________"),
* @OA\Property(property="signature", type="string", example="A users text signature", description="_________"),
* @OA\Property(property="avatar", type="string", example="https://url.to.your/avatar.png", description="_________"),
* @OA\Property(property="accepted_terms_version", type="string", example="1.0.1", description="_________"),
* @OA\Property(property="oauth_user_id", type="string", example="jkhasdf789as6f675sdf768sdfs", description="_________"),
* @OA\Property(property="oauth_provider_id", type="string", example="google", description="_________"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the user"),
* @OA\Property(property="first_name", type="string", example="Brad", description="The first name of the user"),
* @OA\Property(property="last_name", type="string", example="Pitt", description="The last name of the user"),
* @OA\Property(property="email", type="string", example="brad@pitt.com", description="The users email address"),
* @OA\Property(property="phone", type="string", example="555-1233-23232", description="The users phone number"),
* @OA\Property(property="signature", type="string", example="Have a nice day!", description="The users sign off signature"),
* @OA\Property(property="avatar", type="string", example="https://url.to.your/avatar.png", description="The users avatar"),
* @OA\Property(property="accepted_terms_version", type="string", example="1.0.1", description="The version of the invoice ninja terms that has been accepted by the user"),
* @OA\Property(property="oauth_user_id", type="string", example="jkhasdf789as6f675sdf768sdfs", description="The provider id of the oauth entity"),
* @OA\Property(property="oauth_provider_id", type="string", example="google", description="The oauth entity id"),
* )
*/

26
app/Http/Controllers/OpenAPI/VendorContact.php
View File

@ -3,19 +3,19 @@
* @OA\Schema(
* schema="VendorContact",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="_________"),
* @OA\Property(property="user_id", type="string", example="", description="__________"),
* @OA\Property(property="company_id", type="string", example="", description="________"),
* @OA\Property(property="vendor_id", type="string", example="", description="________"),
* @OA\Property(property="first_name", type="string", example="", description="________"),
* @OA\Property(property="last_name", type="string", example="", description="________"),
* @OA\Property(property="phone", type="string", example="", description="________"),
* @OA\Property(property="custom_value1", type="string", example="", description="________"),
* @OA\Property(property="custom_value2", type="string", example="", description="________"),
* @OA\Property(property="custom_value3", type="string", example="", description="________"),
* @OA\Property(property="custom_value4", type="string", example="", description="________"),
* @OA\Property(property="email", type="string", example="", description="________"),
* @OA\Property(property="is_primary", type="boolean", example=true, description="________"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the vendor contact"),
* @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The hashed id of the user id"),
* @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The hashed id of the company"),
* @OA\Property(property="vendor_id", type="string", example="Opnel5aKBz", description="The hashed id of the vendor"),
* @OA\Property(property="first_name", type="string", example="Harry", description="The first name of the contact"),
* @OA\Property(property="last_name", type="string", example="Windsor", description="The last name of the contact"),
* @OA\Property(property="phone", type="string", example="555-123-1234", description="The contacts phone number"),
* @OA\Property(property="custom_value1", type="string", example="2022-10-10", description="A custom value"),
* @OA\Property(property="custom_value2", type="string", example="$1000", description="A custom value"),
* @OA\Property(property="custom_value3", type="string", example="", description="A custom value"),
* @OA\Property(property="custom_value4", type="string", example="", description="A custom value"),
* @OA\Property(property="email", type="string", example="harry@windsor.com", description="The contact email address"),
* @OA\Property(property="is_primary", type="boolean", example=true, description="Boolean flag determining if the contact is the primary contact for the vendor"),
* @OA\Property(property="created_at", type="number", format="integer", example="134341234234", description="Timestamp"),
* @OA\Property(property="updated_at", type="number", format="integer", example="134341234234", description="Timestamp"),
* @OA\Property(property="deleted_at", type="number", format="integer", example="134341234234", description="Timestamp"),