mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
57 lines
6.5 KiB
PHP
57 lines
6.5 KiB
PHP
<?php
|
|
/**
|
|
* @OA\Schema(
|
|
* schema="Quote",
|
|
* type="object",
|
|
* @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The quote 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 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="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="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="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"),
|
|
* @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"),
|
|
* )
|
|
*/
|