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 docs

Browse Source
This commit is contained in:
David Bomba 2022-08-12 20:44:09 +10:00
parent e6045b3fa9
commit 532b2325b8
8 changed files with 120 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
app/Http/Controllers/OpenAPI/CompanyGatewaySchema.php
View File

@ -3,14 +3,14 @@
* @OA\Schema(
* schema="CompanyGateway",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="company_id", type="string", example="2", description="______"),
* @OA\Property(property="gateway_key", type="string", example="2", description="______"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The hashed id of the company gateway"),
* @OA\Property(property="company_id", type="string", example="2", description="The company hashed id"),
* @OA\Property(property="gateway_key", type="string", example="2", description="The gateway key (hash)"),
* @OA\Property(property="accepted_credit_cards", type="integer", example="32", description="Bitmask representation of cards"),
* @OA\Property(property="require_billing_address", type="boolean", example=true, description="______"),
* @OA\Property(property="require_shipping_address", type="boolean", example=true, description="______"),
* @OA\Property(property="require_billing_address", type="boolean", example=true, description="Determines if the the billing address is required prior to payment."),
* @OA\Property(property="require_shipping_address", type="boolean", example=true, description="Determines if the the billing address is required prior to payment."),
* @OA\Property(property="config", type="string", example="dfadsfdsafsafd", description="The configuration map for the gateway"),
* @OA\Property(property="update_details", type="boolean", example=true, description="______"),
* @OA\Property(property="update_details", type="boolean", example=true, description="Determines if the client details should be updated."),
* @OA\Property(
* property="fees_and_limits",
* type="array",

6
app/Http/Controllers/OpenAPI/CompanySchema.php
View File

@ -17,9 +17,9 @@
* @OA\Property(property="update_products", type="boolean", example=true, description="Toggles updating a product description which description changes"),
* @OA\Property(property="show_product_details", type="boolean", example=true, description="Toggles showing a product description which description changes"),
* @OA\Property(property="custom_fields", type="object", description="Custom fields map"),
* @OA\Property(property="enable_product_cost", type="boolean", example=true, description="______________"),
* @OA\Property(property="enable_product_quantity", type="boolean", example=true, description="______________"),
* @OA\Property(property="default_quantity", type="boolean", example=true, description="______________"),
* @OA\Property(property="enable_product_cost", type="boolean", example=true, description="Show/Hide the product cost field in the UI"),
* @OA\Property(property="enable_product_quantity", type="boolean", example=true, description="Show/hide the product quantity field (used in the UI to show the default quantity)"),
* @OA\Property(property="default_quantity", type="boolean", example=true, description="Enable/Disable whether to use a default quantity"),
* @OA\Property(property="custom_surcharge_taxes1", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_taxes2", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
* @OA\Property(property="custom_surcharge_taxes3", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),

130
app/Http/Controllers/OpenAPI/CompanySettingsSchema.php
View File

@ -4,20 +4,20 @@
* schema="CompanySettings",
* type="object",
* @OA\Property(property="timezone_id", type="string", example="15", description="The timezone id"),
* @OA\Property(property="date_format_id", type="string", example="15", description="____________"),
* @OA\Property(property="military_time", type="boolean", example=true, description="____________"),
* @OA\Property(property="language_id", type="string", example="1", description="____________"),
* @OA\Property(property="show_currency_code", type="boolean", example=true, description="____________"),
* @OA\Property(property="date_format_id", type="string", example="15", description="The date format id"),
* @OA\Property(property="military_time", type="boolean", example=true, description="Toggles 12/24 hour time"),
* @OA\Property(property="language_id", type="string", example="1", description="The language id"),
* @OA\Property(property="show_currency_code", type="boolean", example=true, description="Toggles whether the currency symbol or code is shown"),
* @OA\Property(property="currency_id", type="string", example=true, description="The default currency id"),
* @OA\Property(property="payment_terms", type="integer", example="1", description="-1 sets no payment term, 0 sets payment due immediately, positive integers indicates payment terms in days"),
* @OA\Property(property="company_gateway_ids", type="string", example="1,2,3,4", description="A commad separate list of available gateways"),
* @OA\Property(property="custom_value1", type="string", example="Custom Label", description="____________"),
* @OA\Property(property="custom_value2", type="string", example="Custom Label", description="____________"),
* @OA\Property(property="custom_value3", type="string", example="Custom Label", description="____________"),
* @OA\Property(property="custom_value4", type="string", example="Custom Label", description="____________"),
* @OA\Property(property="default_task_rate", type="number", format="float", example="10.00", description="____________"),
* @OA\Property(property="send_reminders", type="boolean", example=true, description="____________"),
* @OA\Property(property="enable_client_portal_tasks", type="boolean", example=true, description="____________"),
* @OA\Property(property="custom_value1", type="string", example="Custom Label", description="A Custom Label"),
* @OA\Property(property="custom_value2", type="string", example="Custom Label", description="A Custom Label"),
* @OA\Property(property="custom_value3", type="string", example="Custom Label", description="A Custom Label"),
* @OA\Property(property="custom_value4", type="string", example="Custom Label", description="A Custom Label"),
* @OA\Property(property="default_task_rate", type="number", format="float", example="10.00", description="The default task rate"),
* @OA\Property(property="send_reminders", type="boolean", example=true, description="Toggles whether reminders are sent"),
* @OA\Property(property="enable_client_portal_tasks", type="boolean", example=true, description="Show/hide the tasks panel in the client portal"),
* @OA\Property(property="email_style", type="string", example="light", description="options include plain,light,dark,custom"),
* @OA\Property(property="reply_to_email", type="string", example="email@gmail.com", description="The reply to email address"),
* @OA\Property(property="bcc_email", type="string", example="email@gmail.com, contact@gmail.com", description="A comma separate list of BCC emails"),
@ -26,35 +26,35 @@
* @OA\Property(property="email_style_custom", type="string", example="<HTML></HTML>", description="The custom template"),
* @OA\Property(property="counter_number_applied", type="string", example="when_sent", description="enum when the invoice number counter is set, ie when_saved, when_sent, when_paid"),
* @OA\Property(property="quote_number_applied", type="string", example="when_sent", description="enum when the quote number counter is set, ie when_saved, when_sent"),
* @OA\Property(property="custom_message_dashboard", type="string", example="Please pay invoices immediately", description="____________"),
* @OA\Property(property="custom_message_unpaid_invoice", type="string", example="Please pay invoices immediately", description="____________"),
* @OA\Property(property="custom_message_paid_invoice", type="string", example="Thanks for paying this invoice!", description="____________"),
* @OA\Property(property="custom_message_unapproved_quote", type="string", example="Please approve quote", description="____________"),
* @OA\Property(property="lock_invoices", type="boolean", example=true, description="____________"),
* @OA\Property(property="auto_archive_invoice", type="boolean", example=true, description="____________"),
* @OA\Property(property="auto_archive_quote", type="boolean", example=true, description="____________"),
* @OA\Property(property="auto_convert_quote", type="boolean", example=true, description="____________"),
* @OA\Property(property="inclusive_taxes", type="boolean", example=true, description="____________"),
* @OA\Property(property="custom_message_dashboard", type="string", example="Please pay invoices immediately", description="A custom message which is displayed on the dashboard"),
* @OA\Property(property="custom_message_unpaid_invoice", type="string", example="Please pay invoices immediately", description="A custom message which is displayed in the client portal when a client is viewing a unpaid invoice."),
* @OA\Property(property="custom_message_paid_invoice", type="string", example="Thanks for paying this invoice!", description="A custom message which is displayed in the client portal when a client is viewing a paid invoice."),
* @OA\Property(property="custom_message_unapproved_quote", type="string", example="Please approve quote", description="A custom message which is displayed in the client portal when a client is viewing a unapproved quote."),
* @OA\Property(property="lock_invoices", type="boolean", example=true, description="Toggles whether invoices are locked once sent and cannot be modified further"),
* @OA\Property(property="auto_archive_invoice", type="boolean", example=true, description="Toggles whether a invoice is archived immediately following payment"),
* @OA\Property(property="auto_archive_quote", type="boolean", example=true, description="Toggles whether a quote is archived after being converted to a invoice"),
* @OA\Property(property="auto_convert_quote", type="boolean", example=true, description="Toggles whether a quote is converted to a invoice when approved"),
* @OA\Property(property="inclusive_taxes", type="boolean", example=true, description="Boolean flag determining whether inclusive or exclusive taxes are used"),
* @OA\Property(property="translations", type="object", example="", description="JSON payload of customized translations"),
* @OA\Property(property="task_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the task number pattern"),
* @OA\Property(property="task_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="task_number_counter", type="integer", example="1", description="The incrementing counter for tasks"),
* @OA\Property(property="reminder_send_time", type="integer", example="32400", description="Time from UTC +0 when the email will be sent to the client"),
* @OA\Property(property="expense_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the expense number pattern"),
* @OA\Property(property="expense_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="expense_number_counter", type="integer", example="1", description="The incrementing counter for expenses"),
* @OA\Property(property="vendor_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the vendor number pattern"),
* @OA\Property(property="vendor_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="vendor_number_counter", type="integer", example="1", description="The incrementing counter for vendors"),
* @OA\Property(property="ticket_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the ticket number pattern"),
* @OA\Property(property="ticket_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="ticket_number_counter", type="integer", example="1", description="The incrementing counter for tickets"),
* @OA\Property(property="payment_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the payment number pattern"),
* @OA\Property(property="payment_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="payment_number_counter", type="integer", example="1", description="The incrementing counter for payments"),
* @OA\Property(property="invoice_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the invoice number pattern"),
* @OA\Property(property="invoice_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="invoice_number_counter", type="integer", example="1", description="The incrementing counter for invoices"),
* @OA\Property(property="quote_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the quote number pattern"),
* @OA\Property(property="quote_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="quote_number_counter", type="integer", example="1", description="The incrementing counter for quotes"),
* @OA\Property(property="client_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the client number pattern"),
* @OA\Property(property="client_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="client_number_counter", type="integer", example="1", description="The incrementing counter for clients"),
* @OA\Property(property="credit_number_pattern", type="string", example="{$year}-{$counter}", description="Allows customisation of the credit number pattern"),
* @OA\Property(property="credit_number_counter", type="integer", example="1", description="____________"),
* @OA\Property(property="credit_number_counter", type="integer", example="1", description="The incrementing counter for credits"),
* @OA\Property(property="recurring_invoice_number_prefix", type="string", example="R", description="This string is prepended to the recurring invoice number"),
* @OA\Property(property="reset_counter_frequency_id", type="integer", example="1", description="CONSTANT which is used to apply the frequency which the counters are reset"),
* @OA\Property(property="reset_counter_date", type="string", example="2019-01-01", description="The explicit date which is used to reset counters"),
@ -103,52 +103,52 @@
* @OA\Property(property="name", type="string", example="Acme Co", description="The company name"),
* @OA\Property(property="company_logo", type="object", example="logo.png", description="The company logo file"),
* @OA\Property(property="website", type="string", example="www.acme.com", description="The company website URL"),
* @OA\Property(property="address1", type="string", example="Suite 888", description="____________"),
* @OA\Property(property="address2", type="string", example="5 Jimbo Way", description="____________"),
* @OA\Property(property="city", type="string", example="Sydney", description="____________"),
* @OA\Property(property="state", type="string", example="Florisa", description="____________"),
* @OA\Property(property="postal_code", type="string", example="90210", description="____________"),
* @OA\Property(property="phone", type="string", example="555-213-3948", description="____________"),
* @OA\Property(property="email", type="string", example="joe@acme.co", description="____________"),
* @OA\Property(property="address1", type="string", example="Suite 888", description="The company address line 1"),
* @OA\Property(property="address2", type="string", example="5 Jimbo Way", description="The company address line 2"),
* @OA\Property(property="city", type="string", example="Sydney", description="The company city"),
* @OA\Property(property="state", type="string", example="Florisa", description="The company state"),
* @OA\Property(property="postal_code", type="string", example="90210", description="The company zip/postal code"),
* @OA\Property(property="phone", type="string", example="555-213-3948", description="The company phone"),
* @OA\Property(property="email", type="string", example="joe@acme.co", description="The company email"),
* @OA\Property(property="country_id", type="string", example="1", description="The country ID"),
* @OA\Property(property="vat_number", type="string", example="32 120 377 720", description="____________"),
* @OA\Property(property="vat_number", type="string", example="32 120 377 720", description="The company VAT/TAX ID number"),
* @OA\Property(property="page_size", type="string", example="A4", description="The default page size"),
* @OA\Property(property="font_size", type="number", example="9", description="The font size"),
* @OA\Property(property="primary_font", type="string", example="roboto", description="The primary font"),
* @OA\Property(property="secondary_font", type="string", example="roboto", description="The secondary font"),
* @OA\Property(property="hide_paid_to_date", type="boolean", example=false, description="____________"),
* @OA\Property(property="embed_documents", type="boolean", example=false, description="____________"),
* @OA\Property(property="all_pages_header", type="boolean", example=false, description="____________"),
* @OA\Property(property="all_pages_footer", type="boolean", example=false, description="____________"),
* @OA\Property(property="document_email_attachment", type="boolean", example=false, description="____________"),
* @OA\Property(property="enable_client_portal_password", type="boolean", example=false, description="____________"),
* @OA\Property(property="enable_email_markup", type="boolean", example=false, description="____________"),
* @OA\Property(property="enable_client_portal_dashboard", type="boolean", example=false, description="____________"),
* @OA\Property(property="enable_client_portal", type="boolean", example=false, description="____________"),
* @OA\Property(property="email_template_statement", type="string", example="template matter", description="____________"),
* @OA\Property(property="email_subject_statement", type="string", example="subject matter", description="____________"),
* @OA\Property(property="signature_on_pdf", type="boolean", example=false, description="____________"),
* @OA\Property(property="quote_footer", type="string", example="the quote footer", description="____________"),
* @OA\Property(property="email_subject_custom1", type="string", example="Custom Subject 1", description="____________"),
* @OA\Property(property="email_subject_custom2", type="string", example="Custom Subject 2", description="____________"),
* @OA\Property(property="email_subject_custom3", type="string", example="Custom Subject 3", description="____________"),
* @OA\Property(property="email_template_custom1", type="string", example="<HTML>", description="____________"),
* @OA\Property(property="email_template_custom2", type="string", example="<HTML>", description="____________"),
* @OA\Property(property="email_template_custom3", type="string", example="<HTML>", description="____________"),
* @OA\Property(property="enable_reminder1", type="boolean", example=false, description="____________"),
* @OA\Property(property="enable_reminder2", type="boolean", example=false, description="____________"),
* @OA\Property(property="enable_reminder3", type="boolean", example=false, description="____________"),
* @OA\Property(property="hide_paid_to_date", type="boolean", example=false, description="Flags whether to hide the paid to date field"),
* @OA\Property(property="embed_documents", type="boolean", example=false, description="Toggled whether to embed documents in the PDF"),
* @OA\Property(property="all_pages_header", type="boolean", example=false, description="The header for the PDF"),
* @OA\Property(property="all_pages_footer", type="boolean", example=false, description="The footer for the PDF"),
* @OA\Property(property="document_email_attachment", type="boolean", example=false, description="Toggles whether to attach documents in the email"),
* @OA\Property(property="enable_client_portal_password", type="boolean", example=false, description="Toggles password protection of the client portal"),
* @OA\Property(property="enable_email_markup", type="boolean", example=false, description="Toggles the use of markdown in emails"),
* @OA\Property(property="enable_client_portal_dashboard", type="boolean", example=false, description="Toggles whether the client dashboard is shown in the client portal"),
* @OA\Property(property="enable_client_portal", type="boolean", example=false, description="Toggles whether the entire client portal is displayed to the client, or only the context"),
* @OA\Property(property="email_template_statement", type="string", example="template matter", description="The body of the email for statements"),
* @OA\Property(property="email_subject_statement", type="string", example="subject matter", description="The subject of the email for statements"),
* @OA\Property(property="signature_on_pdf", type="boolean", example=false, description="Toggles whether the signature (if available) is displayed on the PDF"),
* @OA\Property(property="quote_footer", type="string", example="the quote footer", description="The default quote footer"),
* @OA\Property(property="email_subject_custom1", type="string", example="Custom Subject 1", description="Custom reminder template subject"),
* @OA\Property(property="email_subject_custom2", type="string", example="Custom Subject 2", description="Custom reminder template subject"),
* @OA\Property(property="email_subject_custom3", type="string", example="Custom Subject 3", description="Custom reminder template subject"),
* @OA\Property(property="email_template_custom1", type="string", example="<HTML>", description="Custom reminder template body"),
* @OA\Property(property="email_template_custom2", type="string", example="<HTML>", description="Custom reminder template body"),
* @OA\Property(property="email_template_custom3", type="string", example="<HTML>", description="Custom reminder template body"),
* @OA\Property(property="enable_reminder1", type="boolean", example=false, description="Toggles whether this reminder is enabled"),
* @OA\Property(property="enable_reminder2", type="boolean", example=false, description="Toggles whether this reminder is enabled"),
* @OA\Property(property="enable_reminder3", type="boolean", example=false, description="Toggles whether this reminder is enabled"),
* @OA\Property(property="num_days_reminder1", type="number", example="9", description="The Reminder interval"),
* @OA\Property(property="num_days_reminder2", type="number", example="9", description="The Reminder interval"),
* @OA\Property(property="num_days_reminder3", type="number", example="9", description="The Reminder interval"),
* @OA\Property(property="schedule_reminder1", type="string", example="after_invoice_date", description="(enum: after_invoice_date, before_due_date, after_due_date)"),
* @OA\Property(property="schedule_reminder2", type="string", example="after_invoice_date", description="(enum: after_invoice_date, before_due_date, after_due_date)"),
* @OA\Property(property="schedule_reminder3", type="string", example="after_invoice_date", description="(enum: after_invoice_date, before_due_date, after_due_date)"),
* @OA\Property(property="late_fee_amount1", type="number", example=10.00, description="____________"),
* @OA\Property(property="late_fee_amount2", type="number", example=20.00, description="____________"),
* @OA\Property(property="late_fee_amount3", type="number", example=100.00, description="____________"),
* @OA\Property(property="endless_reminder_frequency_id", type="string", example="1", description="____________"),
* @OA\Property(property="client_online_payment_notification", type="boolean", example=false, description="____________"),
* @OA\Property(property="client_manual_payment_notification", type="boolean", example=false, description="____________"),
* @OA\Property(property="late_fee_amount1", type="number", example=10.00, description="The late fee amount for reminder 1"),
* @OA\Property(property="late_fee_amount2", type="number", example=20.00, description="The late fee amount for reminder 2"),
* @OA\Property(property="late_fee_amount3", type="number", example=100.00, description="The late fee amount for reminder 2"),
* @OA\Property(property="endless_reminder_frequency_id", type="string", example="1", description="The frequency id of the endless reminder"),
* @OA\Property(property="client_online_payment_notification", type="boolean", example=false, description="Determines if a client should receive the notification for a online payment"),
* @OA\Property(property="client_manual_payment_notification", type="boolean", example=false, description="Determines if a client should receive the notification for a manually entered payment"),
* )
*/

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

@ -3,8 +3,8 @@
* @OA\Schema(
* schema="CreditPaymentable",
* type="object",
* @OA\Property(property="credit_id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="amount", type="string", example="2", description="______"),
* @OA\Property(property="credit_id", type="string", example="Opnel5aKBz", description="The credit hashed id"),
* @OA\Property(property="amount", type="string", example="2", description="The credit amount"),
*
* )
*/

48
app/Http/Controllers/OpenAPI/CreditSchema.php
View File

@ -3,33 +3,33 @@
* @OA\Schema(
* schema="Credit",
* 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="status_id", type="string", example="", description="________"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The credit hashed id"),
* @OA\Property(property="user_id", type="string", example="", description="The user hashed id"),
* @OA\Property(property="assigned_user_id", type="string", example="", description="The assigned user hashed id"),
* @OA\Property(property="company_id", type="string", example="", description="The company hashed id"),
* @OA\Property(property="client_id", type="string", example="", description="The client hashed id"),
* @OA\Property(property="status_id", type="string", example="", description="The status field id infors of the current status of the credit"),
* @OA\Property(property="invoice_id", type="string", example="", description="The linked invoice this credit is applied to"),
* @OA\Property(property="number", type="string", example="QUOTE_101", description="The credit number - is a unique alpha numeric number per credit 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="", description="The purchase order number this credit refers to"),
* @OA\Property(property="terms", type="string", example="", description="The credit terms field"),
* @OA\Property(property="public_notes", type="string", example="", description="The public notes field of the credit"),
* @OA\Property(property="private_notes", type="string", example="", description="The private notes field of the credit"),
* @OA\Property(property="footer", type="string", example="", description="The credit footer text"),
* @OA\Property(property="custom_value1", type="string", example="", description="A Custom value"),
* @OA\Property(property="custom_value2", type="string", example="", 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="tax_name1", type="string", example="", description="The tax name"),
* @OA\Property(property="tax_name2", type="string", example="", description="The tax rate"),
* @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="The tax name"),
* @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 credit"),
* @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="line_items", type="object", example="", description="The line items array containing the line items of the credit"),
* @OA\Property(property="amount", type="number", format="float", example="10.00", description="The total credit amount"),
* @OA\Property(property="balance", type="number", format="float", example="10.00", description="The credit balance"),
* @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="_________"),

24
app/Http/Controllers/OpenAPI/DocumentSchema.php
View File

@ -3,18 +3,18 @@
* @OA\Schema(
* schema="Document",
* type="object",
* @OA\Property(property="id", type="string", example="AS3df3A", description="The design hashed id"),
* @OA\Property(property="user_id", type="string", example="", description="__________"),
* @OA\Property(property="assigned_user_id", type="string", example="", description="__________"),
* @OA\Property(property="project_id", type="string", example="", description="__________"),
* @OA\Property(property="vendor_id", type="string", example="", description="__________"),
* @OA\Property(property="name", type="string", example="Beauty", description="The design name"),
* @OA\Property(property="url", type="string", example="Beauty", description="The design name"),
* @OA\Property(property="preview", type="string", example="Beauty", description="The design name"),
* @OA\Property(property="type", type="string", example="Beauty", description="The design name"),
* @OA\Property(property="disk", type="string", example="Beauty", description="The design name"),
* @OA\Property(property="hash", type="string", example="Beauty", description="The design name"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Flag to determine if the design is deleted"),
* @OA\Property(property="id", type="string", example="AS3df3A", description="The document hashed id"),
* @OA\Property(property="user_id", type="string", example="", description="The user hashed id"),
* @OA\Property(property="assigned_user_id", type="string", example="", description="The assigned user hashed id"),
* @OA\Property(property="project_id", type="string", example="", description="The project associated with this document"),
* @OA\Property(property="vendor_id", type="string", example="", description="The vendor associated with this documents"),
* @OA\Property(property="name", type="string", example="Beauty", description="The document name"),
* @OA\Property(property="url", type="string", example="Beauty", description="The document url"),
* @OA\Property(property="preview", type="string", example="Beauty", description="The document preview url"),
* @OA\Property(property="type", type="string", example="Beauty", description="The document type"),
* @OA\Property(property="disk", type="string", example="Beauty", description="The document disk"),
* @OA\Property(property="hash", type="string", example="Beauty", description="The document hashed"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Flag to determine if the document is deleted"),
* @OA\Property(property="is_default", type="boolean", example=true, description="Flag to determine if the document is a default doc"),
* @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"),

12
app/Http/Controllers/OpenAPI/ExpenseCategorySchema.php
View File

@ -3,11 +3,11 @@
* @OA\Schema(
* schema="ExpenseCategory",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"),
* @OA\Property(property="name", type="string", example="Accounting", description="______"),
* @OA\Property(property="user_id", type="string", example="XS987sD", description="______"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="______"),
* @OA\Property(property="updated_at", type="string", example="2", description="______"),
* @OA\Property(property="created_at", type="string", example="2", description="______"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The expense hashed id"),
* @OA\Property(property="name", type="string", example="Accounting", description="The expense category name"),
* @OA\Property(property="user_id", type="string", example="XS987sD", description="The user hashed id"),
* @OA\Property(property="is_deleted", type="boolean", example=true, description="Flag determining whether the expense category has been deleted"),
* @OA\Property(property="updated_at", type="integer", example="2", description="The updated at timestamp"),
* @OA\Property(property="created_at", type="integer", example="2", description="The created at timestamp"),
* )
*/

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

@ -3,8 +3,8 @@
* @OA\Schema(
* schema="Expense",
* type="object",
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="_________"),
* @OA\Property(property="user_id", type="string", example="", description="__________"),
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The expense hashed id"),
* @OA\Property(property="user_id", type="string", example="", description="The user hashed id"),
* @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="________"),