diff --git a/app/Http/Controllers/OpenAPI/ExpenseSchema.php b/app/Http/Controllers/OpenAPI/ExpenseSchema.php index 492778f1c8..32d56b1aa5 100644 --- a/app/Http/Controllers/OpenAPI/ExpenseSchema.php +++ b/app/Http/Controllers/OpenAPI/ExpenseSchema.php @@ -5,38 +5,38 @@ * type="object", * @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="________"), - * @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="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="invoice_documents", type="boolean", example=true, description=""), + * @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="invoice_id", type="string", example="", description="The related invoice hashed id"), + * @OA\Property(property="bank_id", type="string", example="", description="The bank id related to this expense"), + * @OA\Property(property="invoice_currency_id", type="string", example="", description="The currency id of the related invoice"), + * @OA\Property(property="expense_currency_id", type="string", example="", description="The currency id of the expense"), + * @OA\Property(property="invoice_category_id", type="string", example="", description="The invoice category id"), + * @OA\Property(property="payment_type_id", type="string", example="", description="The payment type id"), + * @OA\Property(property="recurring_expense_id", type="string", example="", description="The related recurring expense this expense was created from"), + * @OA\Property(property="private_notes", type="string", example="", description="The private notes of the expense"), + * @OA\Property(property="public_notes", type="string", example="", description="The public notes of the expense"), + * @OA\Property(property="transaction_reference", type="string", example="", description="The transaction references of the expense"), + * @OA\Property(property="transcation_id", type="string", example="", description="The transaction id of the expense"), + * @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="Tax name"), + * @OA\Property(property="tax_name2", type="string", example="", description="Tax name"), + * @OA\Property(property="tax_rate1", type="number", format="float", example="10.00", description="Tax rate"), + * @OA\Property(property="tax_rate2", type="number", format="float", example="10.00", description="Tax rate"), + * @OA\Property(property="tax_name3", type="string", example="", description="Tax name"), + * @OA\Property(property="tax_rate3", type="number", format="float", example="10.00", description="Tax rate"), + * @OA\Property(property="amount", type="number", format="float", example="10.00", description="The total expense amont"), + * @OA\Property(property="foreign_amount", type="number", format="float", example="10.00", description="The total foreign amount of the expense"), + * @OA\Property(property="exchange_rate", type="number", format="float", example="0.80", description="The exchange rate at the time of the expense"), + * @OA\Property(property="date", type="string", example="2022-12-01", description="The expense date formate Y-m-d"), + * @OA\Property(property="payment_date", type="string", example="", description="The date of payment for the expense, format Y-m-d"), + * @OA\Property(property="should_be_invoiced", type="boolean", example=true, description="Flag whether the expense should be invoiced"), + * @OA\Property(property="is_deleted", type="boolean", example=true, description="Boolean determining whether the expense has been deleted"), + * @OA\Property(property="invoice_documents", type="boolean", example=true, description="Passing the expense documents over to the 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"), * ) diff --git a/app/Http/Controllers/OpenAPI/FeesAndLimitsSchema.php b/app/Http/Controllers/OpenAPI/FeesAndLimitsSchema.php index eaeaec5ca7..96ea5cc48e 100644 --- a/app/Http/Controllers/OpenAPI/FeesAndLimitsSchema.php +++ b/app/Http/Controllers/OpenAPI/FeesAndLimitsSchema.php @@ -3,17 +3,17 @@ * @OA\Schema( * schema="FeesAndLimits", * type="object", - * @OA\Property(property="min_limit", type="string", example="2", description="______"), - * @OA\Property(property="max_limit", type="string", example="2", description="______"), - * @OA\Property(property="fee_amount", type="number", format="float", example="2.0", description="______"), - * @OA\Property(property="fee_percent", type="number", format="float", example="2.0", description="______"), - * @OA\Property(property="fee_tax_name1", type="string", example="2", description="______"), - * @OA\Property(property="fee_tax_name2", type="string", example="2", description="______"), - * @OA\Property(property="fee_tax_name3", type="string", example="2", description="______"), - * @OA\Property(property="fee_tax_rate1", type="number", format="float", example="2.0", description="______"), - * @OA\Property(property="fee_tax_rate2", type="number", format="float", example="2.0", description="______"), - * @OA\Property(property="fee_tax_rate3", type="number", format="float", example="2.0", description="______"), - * @OA\Property(property="fee_cap", type="number", format="float", example="2.0", description="______"), - * @OA\Property(property="adjust_fee_percent", type="boolean", example=true, description="______"), + * @OA\Property(property="min_limit", type="string", example="2", description="The minimum amount accepted for this gateway"), + * @OA\Property(property="max_limit", type="string", example="2", description="The maximum amount accepted for this gateway"), + * @OA\Property(property="fee_amount", type="number", format="float", example="2.0", description="The gateway fee amount"), + * @OA\Property(property="fee_percent", type="number", format="float", example="2.0", description="The gateway fee percentage"), + * @OA\Property(property="fee_tax_name1", type="string", example="GST", description="Fee tax name"), + * @OA\Property(property="fee_tax_name2", type="string", example="VAT", description="Fee tax name"), + * @OA\Property(property="fee_tax_name3", type="string", example="CA Sales Tax", description="Fee tax name"), + * @OA\Property(property="fee_tax_rate1", type="number", format="float", example="10.0", description="The tax rate"), + * @OA\Property(property="fee_tax_rate2", type="number", format="float", example="17.5", description="The tax rate"), + * @OA\Property(property="fee_tax_rate3", type="number", format="float", example="25.0", description="The tax rate"), + * @OA\Property(property="fee_cap", type="number", format="float", example="2.0", description="If set the fee amount will be no higher than this amount"), + * @OA\Property(property="adjust_fee_percent", type="boolean", example=true, description="Adjusts the fee to match the exact gateway fee."), * ) */ diff --git a/app/Http/Controllers/OpenAPI/GroupSettingSchema.php b/app/Http/Controllers/OpenAPI/GroupSettingSchema.php index 2da966cd3c..febf878e98 100644 --- a/app/Http/Controllers/OpenAPI/GroupSettingSchema.php +++ b/app/Http/Controllers/OpenAPI/GroupSettingSchema.php @@ -3,10 +3,10 @@ * @OA\Schema( * schema="GroupSetting", * 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="name", type="string", example="", description="________"), - * @OA\Property(property="settings", type="object", example="", description="________"), + * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The group setting hashed id"), + * @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The user hashed id"), + * @OA\Property(property="company_id", type="string", example="Opnel5aKBz", description="The company hashed id"), + * @OA\Property(property="name", type="string", example="A groupies group", description="The name of the group"), + * @OA\Property(property="settings", type="object", example="", description="The settings object"), * ) */ diff --git a/app/Http/Controllers/OpenAPI/InvoiceSchema.php b/app/Http/Controllers/OpenAPI/InvoiceSchema.php index 4376403c97..1e9fef4a3d 100644 --- a/app/Http/Controllers/OpenAPI/InvoiceSchema.php +++ b/app/Http/Controllers/OpenAPI/InvoiceSchema.php @@ -3,43 +3,43 @@ * @OA\Schema( * schema="Invoice", * 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 invoice hashed id"), + * @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="number", type="string", example="INV_101", description="The invoice number - is a unique alpha numeric number per invoice 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 associated with this 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="_________"), - * @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="", 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="_________"), - * @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 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"), diff --git a/app/Http/Controllers/OpenAPI/PaymentSchema.php b/app/Http/Controllers/OpenAPI/PaymentSchema.php index 98b681a625..a8d2374490 100644 --- a/app/Http/Controllers/OpenAPI/PaymentSchema.php +++ b/app/Http/Controllers/OpenAPI/PaymentSchema.php @@ -3,18 +3,18 @@ * @OA\Schema( * schema="Payment", * type="object", - * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"), - * @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="______"), - * @OA\Property(property="invitation_id", type="string", example="Opnel5aKBz", description="______"), - * @OA\Property(property="client_contact_id", type="string", example="Opnel5aKBz", description="______"), - * @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="______"), + * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The payment hashed id"), + * @OA\Property(property="client_id", type="string", example="Opnel5aKBz", description="The client hashed id"), + * @OA\Property(property="invitation_id", type="string", example="Opnel5aKBz", description="The invitation hashed id"), + * @OA\Property(property="client_contact_id", type="string", example="Opnel5aKBz", description="The client contact hashed id"), + * @OA\Property(property="user_id", type="string", example="Opnel5aKBz", description="The user hashed id"), * @OA\Property(property="type_id", type="string", example="1", description="The Payment Type ID"), * @OA\Property(property="date", type="string", example="1-1-2014", description="The Payment date"), * @OA\Property(property="transaction_reference", type="string", example="xcsSxcs124asd", description="The transaction reference as defined by the payment gateway"), - * @OA\Property(property="assigned_user_id", type="string", example="Opnel5aKBz", description="______"), - * @OA\Property(property="private_notes", type="string", example="The payment was refunded due to error", description="______"), - * @OA\Property(property="is_manual", type="boolean", example=true, description="______"), - * @OA\Property(property="is_deleted", type="boolean", example=true, description="______"), + * @OA\Property(property="assigned_user_id", type="string", example="Opnel5aKBz", description="The assigned user hashed id"), + * @OA\Property(property="private_notes", type="string", example="The payment was refunded due to error", description="The private notes of the payment"), + * @OA\Property(property="is_manual", type="boolean", example=true, description="Flags whether the payment was made manually or processed via a gateway"), + * @OA\Property(property="is_deleted", type="boolean", example=true, description="Defines if the payment has been deleted"), * @OA\Property(property="amount", type="number", example=10.00, description="The amount of this payment"), * @OA\Property(property="refunded", type="number", example=10.00, description="The refunded amount of this payment"), * @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"), diff --git a/app/Http/Controllers/OpenAPI/PaymentableSchema.php b/app/Http/Controllers/OpenAPI/PaymentableSchema.php index 357dc40c5f..46a55570c3 100644 --- a/app/Http/Controllers/OpenAPI/PaymentableSchema.php +++ b/app/Http/Controllers/OpenAPI/PaymentableSchema.php @@ -6,8 +6,8 @@ * @OA\Property(property="id", type="string", example="AS3df3A", description="The paymentable hashed id"), * @OA\Property(property="invoice_id", type="string", example="AS3df3A", description="The invoice hashed id"), * @OA\Property(property="credit_id", type="string", example="AS3df3A", description="The credit hashed id"), - * @OA\Property(property="refunded", type="number", format="float", example="10.00", description="______"), - * @OA\Property(property="amount", type="number", format="float", example="10.00", description="______"), + * @OA\Property(property="refunded", type="number", format="float", example="10.00", description="The amount that has been refunded for this payment"), + * @OA\Property(property="amount", type="number", format="float", example="10.00", description="The amount that has been applied to the payment"), * @OA\Property(property="updated_at", type="number", format="integer", example="1434342123", description="Timestamp"), * @OA\Property(property="created_at", type="number", format="integer", example="1434342123", description="Timestamp"),* * ) diff --git a/app/Http/Controllers/OpenAPI/ProductSchema.php b/app/Http/Controllers/OpenAPI/ProductSchema.php index 506fd381f4..dd203aa379 100644 --- a/app/Http/Controllers/OpenAPI/ProductSchema.php +++ b/app/Http/Controllers/OpenAPI/ProductSchema.php @@ -3,6 +3,6 @@ * @OA\Schema( * schema="Product", * type="object", - * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"), + * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The product hashed id"), * ) */ diff --git a/app/Http/Controllers/OpenAPI/ProjectSchema.php b/app/Http/Controllers/OpenAPI/ProjectSchema.php index a3455a16b0..3eafd3a04c 100644 --- a/app/Http/Controllers/OpenAPI/ProjectSchema.php +++ b/app/Http/Controllers/OpenAPI/ProjectSchema.php @@ -3,7 +3,7 @@ * @OA\Schema( * schema="Project", * type="object", - * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="______"), - * @OA\Property(property="name", type="string", example="New Project", description="______"), + * @OA\Property(property="id", type="string", example="Opnel5aKBz", description="The project hashed id"), + * @OA\Property(property="name", type="string", example="New Project", description="The project name"), * ) */ diff --git a/app/Http/Controllers/OpenAPI/QuoteSchema.php b/app/Http/Controllers/OpenAPI/QuoteSchema.php index 5ccbd71f08..b47f43bbbf 100644 --- a/app/Http/Controllers/OpenAPI/QuoteSchema.php +++ b/app/Http/Controllers/OpenAPI/QuoteSchema.php @@ -3,12 +3,12 @@ * @OA\Schema( * schema="Quote", * 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 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="", description="________"), * @OA\Property(property="terms", type="string", example="", description="________"),