Mirrors/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-06 03:02:34 +01:00
Code Issues Releases Activity
c132e9ace8
invoiceninja/app/Http/Controllers/OpenAPI/QuoteSchema.php

53 lines
5.2 KiB
PHP
Raw Normal View History

Finalized OpenAPI
2019-10-07 06:57:14 +02:00
<?php
Fixes for api docs
2020-10-10 14:07:52 +02:00
/**
Finalized OpenAPI
2019-10-07 06:57:14 +02:00
* @OA\Schema(
* schema="Quote",
* type="object",
Implement EmailInvoice Job (#3166) * Working on quote counter * Add tests for quote number + shared counter tests * Create invoice job * Add last_sent_date to invoice/quote table, remove type_id * Implement EmailInvoice Job
2019-12-22 11:28:41 +01:00
* @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="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="_________"),
Fixes for validation. (#3130) * Fixes for OpenAPI Documentation + fix support for docs for PHP 7.4 * Minor fixes for GMail API * Add fix for 2 contacts with no email addresses failing validation, emails are optional! but cannot be duplicated if a value is set * Return template as a object with subject and body components * Fixes for OpenAPI Schema * Stubs for payment edge cases * payment tests
2019-12-05 07:22:20 +01:00
* @OA\Property(property="total_taxes", type="number", format="float", example="10.00", description="The total taxes for the quote"),
Implement EmailInvoice Job (#3166) * Working on quote counter * Add tests for quote number + shared counter tests * Create invoice job * Add last_sent_date to invoice/quote table, remove type_id * Implement EmailInvoice Job
2019-12-22 11:28:41 +01:00
* @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="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="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"),
Refactors (#3148) * Refactor company properties to be presented from settings object instead of company properties * Working on Email Tests * Working on emails * Working on email templats * Include text version of email * Refactor Email template builder into trait' * Fix for custom_value4 * Refactor payment_date -> date && payment_type_id -> type_id * expose paymentables to API * expose paymentables to API * Implement a next_send_date field in invoice/quote tables to allow control over reminder scheduling * Add custom_values to users,documents and company_gateways tables
2019-12-16 12:34:38 +01:00
* @OA\Property(property="next_send_date", type="string", format="date", example="1994-07-30", description="The Next date for a reminder to be sent"),
Implement EmailInvoice Job (#3166) * Working on quote counter * Add tests for quote number + shared counter tests * Create invoice job * Add last_sent_date to invoice/quote table, remove type_id * Implement EmailInvoice Job
2019-12-22 11:28:41 +01:00
* @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="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_taxes", type="boolean", example=true, description="Toggles charging taxes on custom surcharge amounts"),
Finalized OpenAPI
2019-10-07 06:57:14 +02:00
* )
Fixes for tests (#3184) * fix typo * php-cs traits * CS fixer pass * Password protect User routes * Implement checks to prevent editing a deleted record * Clean up payment flows * Fixes for tests
2019-12-30 22:59:12 +01:00
*/
Copy Permalink