mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-14 15:13:29 +01:00
58 lines
6.2 KiB
PHP
58 lines
6.2 KiB
PHP
<?php
|
|
/**
|
|
* @OA\Schema(
|
|
* schema="Credit",
|
|
* type="object",
|
|
* @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="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="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="_________"),
|
|
* @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 Credit Date"),
|
|
* @OA\Property(property="last_sent_date", type="string", format="date", example="1994-07-30", description="The last date the credit 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="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"),
|
|
* )
|
|
*/
|