Server : Apache/2.4.62 (Unix) OpenSSL/1.0.2k-fips System : Linux server1.richineiserver.com 3.10.0-1160.119.1.el7.x86_64 #1 SMP Tue Jun 4 14:43:51 UTC 2024 x86_64 User : fdshops ( 1003) PHP Version : 8.2.21 Disable Function : NONE Directory : /home/fdshops/public_html/Modules/Connector/Http/Controllers/Api/ |
<?php
namespace Modules\Connector\Http\Controllers\Api;
use App\ExpenseCategory;
use App\Transaction;
use App\Utils\TransactionUtil;
use DB;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Support\Facades\Auth;
use Modules\Connector\Transformers\CommonResource;
use Modules\Connector\Transformers\ExpenseResource;
/**
* @group Expense management
* @authenticated
*
* APIs for managing expenses
*/
class ExpenseController extends ApiController
{
protected $transactionUtil;
/**
* Constructor
*
* @param ProductUtils $product
* @return void
*/
public function __construct(TransactionUtil $transactionUtil)
{
$this->transactionUtil = $transactionUtil;
}
/**
* List expenses
*
* @queryParam location_id id of the location Example: 1
* @queryParam payment_status payment status Example: paid
* @queryParam start_date format:Y-m-d Example: 2018-06-25
* @queryParam end_date format:Y-m-d Example: 2018-06-25
* @queryParam expense_for id of the user for which expense is created
* @queryParam per_page Total records per page. default: 10, Set -1 for no pagination Example:15
*
* @response {
"data": [
{
"id": 59,
"business_id": 1,
"location_id": 1,
"payment_status": "due",
"ref_no": "EP2020/0001",
"transaction_date": "2020-07-03 12:58:00",
"total_before_tax": "50.0000",
"tax_id": null,
"tax_amount": "0.0000",
"final_total": "50.0000",
"expense_category_id": null,
"document": null,
"created_by": 9,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-03 12:58:23",
"updated_at": "2020-07-03 12:58:24",
"transaction_for": {
"id": 1,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin",
"last_name": null,
"username": "admin",
"email": "admin@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19"
}
}
],
"links": {
"first": "http://local.pos.com/connector/api/expense?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http://local.pos.com/connector/api/expense",
"per_page": 10,
"to": 1
}
}
*/
public function index()
{
$user = Auth::user();
$business_id = $user->business_id;
$filters = request()->only(['location_id', 'payment_status', 'start_date', 'end_date', 'expense_for', 'per_page']);
$query = Transaction::where('business_id', $business_id)
->where('type', 'expense')
->with(['transaction_for']);
$permitted_locations = $user->permitted_locations($business_id);
if ($permitted_locations != 'all') {
$query->whereIn('transactions.location_id', $permitted_locations);
}
if (! empty($filters['location_id'])) {
if (! empty($filters['location_id'])) {
$query->where('transactions.location_id', $filters['location_id']);
}
}
if (! empty($filters['payment_status'])) {
if (! empty($filters['payment_status'])) {
$query->where('transactions.payment_status', $filters['payment_status']);
}
}
if (! empty($filters['start_date'])) {
if (! empty($filters['start_date'])) {
$query->whereDate('transactions.transaction_date', '>=', $filters['start_date']);
}
}
if (! empty($filters['end_date'])) {
if (! empty($filters['end_date'])) {
$query->whereDate('transactions.transaction_date', '<=', $filters['end_date']);
}
}
if (! empty($filters['expense_for'])) {
if (! empty($filters['expense_for'])) {
$query->where('transactions.expense_for', $filters['expense_for']);
}
}
$perPage = ! empty($filters['per_page']) ? $filters['per_page'] : $this->perPage;
if ($perPage == -1) {
$expenses = $query->get();
} else {
$expenses = $query->paginate($perPage);
$expenses->appends(request()->query());
}
return ExpenseResource::collection($expenses);
}
/**
* Get the specified expense / expense refund
*
* @urlParam expense required comma separated ids of the expenses Example: 59
*
* @response {
"data": [
{
"id": 59,
"business_id": 1,
"location_id": 1,
"payment_status": "due",
"ref_no": "EP2020/0001",
"transaction_date": "2020-07-03 12:58:00",
"total_before_tax": "50.0000",
"tax_id": null,
"tax_amount": "0.0000",
"final_total": "50.0000",
"expense_category_id": null,
"document": null,
"created_by": 9,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-03 12:58:23",
"updated_at": "2020-07-03 12:58:24",
"transaction_for": {
"id": 1,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin",
"last_name": null,
"username": "admin",
"email": "admin@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19"
}
}
]
}
*/
public function show($expense_ids)
{
$user = Auth::user();
$business_id = $user->business_id;
$expense_ids = explode(',', $expense_ids);
$expenses = Transaction::where('business_id', $business_id)
->whereIn('type', ['expense', 'expense_refund'])
->whereIn('id', $expense_ids)
->with(['transaction_for'])
->get();
$permitted_locations = $user->permitted_locations($business_id);
if ($permitted_locations != 'all') {
$query->whereIn('transactions.location_id', $permitted_locations);
}
return ExpenseResource::collection($expenses);
}
/**
* Create expense / expense refund
*
* @bodyParam location_id int required id of the business location Example: 1
* @bodyParam final_total float required Expense amount
* @bodyParam transaction_date string transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22
* @bodyParam tax_rate_id int id of the tax rate applicable to the expense
* @bodyParam expense_for int id of the user for which expense is created
* @bodyParam contact_id int id of the contact(customer or supplier) for which expense is created
* @bodyParam expense_category_id int id of the expense category
* @bodyParam expense_sub_category_id int id of the expense sub-category
* @bodyParam additional_notes string
* @bodyParam is_refund int whether expense refund (0, 1) Example: 0
* @bodyParam is_recurring int whether expense is recurring (0, 1) Example: 0
* @bodyParam recur_interval int value of the interval expense will be regenerated
* @bodyParam recur_interval_type string type of the recur interval ('days', 'months', 'years') Example: months
* @bodyParam subscription_repeat_on int day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15
* @bodyParam subscription_no string subscription number
* @bodyParam recur_repetitions int total number of expense to be generated
* @bodyParam payment array payment lines for the expense
*
* @bodyParam payment.*.amount float amount of the payment Example: 453.1300
* @bodyParam payment.*.method string payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash
* @bodyParam payment.*.account_id int account id
* @bodyParam payment.*.card_number string
* @bodyParam payment.*.card_holder_name string
* @bodyParam payment.*.card_transaction_number string
* @bodyParam payment.*.card_type string
* @bodyParam payment.*.card_month string
* @bodyParam payment.*.card_year string
* @bodyParam payment.*.card_security string
* @bodyParam payment.*.transaction_no_1 string
* @bodyParam payment.*.transaction_no_2 string
* @bodyParam payment.*.transaction_no_3 string
* @bodyParam payment.*.note string payment note
* @bodyParam payment.*.cheque_number string
*
* @response {
"data": {
"id": 75,
"business_id": 1,
"location_id": "1",
"payment_status": "due",
"ref_no": "EP2020/0013",
"transaction_date": "2020-07-06T05:31:29.480975Z",
"total_before_tax": "43",
"tax_id": null,
"tax_amount": 0,
"final_total": "43",
"expense_category_id": null,
"document": null,
"created_by": 1,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-06 11:01:29",
"updated_at": "2020-07-06 11:01:29",
"expense_for": []
}
}
*/
public function store(Request $request)
{
try {
$user = Auth::user();
$business_id = $user->business_id;
DB::beginTransaction();
$expense = $this->transactionUtil->createExpense($request, $business_id, $user->id, false);
DB::commit();
return new ExpenseResource($expense);
} catch (ModelNotFoundException $e) {
DB::rollback();
return $this->modelNotFoundExceptionResult($e);
} catch (\Exception $e) {
DB::rollback();
\Log::emergency('File:'.$e->getFile().'Line:'.$e->getLine().'Message:'.$e->getMessage());
return $this->otherExceptions($e);
}
}
/**
* Update expense / expense refund
*
* @bodyParam final_total float Expense amount
* @bodyParam transaction_date string transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22
* @bodyParam tax_rate_id int id of the tax rate applicable to the expense
* @bodyParam expense_for int id of the user for which expense is created
* @bodyParam contact_id int id of the contact(customer or supplier) for which expense is created
* @bodyParam expense_category_id int id of the expense category
* @bodyParam expense_sub_category_id int id of the expense sub-category
* @bodyParam additional_notes string
* @bodyParam is_recurring int whether expense is recurring (0, 1) Example: 0
* @bodyParam recur_interval int value of the interval expense will be regenerated
* @bodyParam recur_interval_type string type of the recur interval ('days', 'months', 'years') Example: months
* @bodyParam subscription_repeat_on int day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15
* @bodyParam subscription_no string subscription number
* @bodyParam recur_repetitions int total number of expense to be generated
* @bodyParam payment array payment lines for the expense
*
*
* @response {
"data": {
"id": 75,
"business_id": 1,
"location_id": "1",
"payment_status": "due",
"ref_no": "EP2020/0013",
"transaction_date": "2020-07-06T05:31:29.480975Z",
"total_before_tax": "43",
"tax_id": null,
"tax_amount": 0,
"final_total": "43",
"expense_category_id": null,
"document": null,
"created_by": 1,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-06 11:01:29",
"updated_at": "2020-07-06 11:01:29",
"expense_for": []
}
}
*/
public function update(Request $request, $id)
{
try {
$user = Auth::user();
$business_id = $user->business_id;
DB::beginTransaction();
$expense = $this->transactionUtil->updateExpense($request, $id, $business_id, false);
DB::commit();
return new ExpenseResource($expense);
} catch (ModelNotFoundException $e) {
DB::rollback();
return $this->modelNotFoundExceptionResult($e);
} catch (\Exception $e) {
DB::rollback();
\Log::emergency('File:'.$e->getFile().'Line:'.$e->getLine().'Message:'.$e->getMessage());
return $this->otherExceptions($e);
}
}
/**
* List expense refunds
*
* @queryParam location_id id of the location Example: 1
* @queryParam payment_status payment status Example: paid
* @queryParam start_date format:Y-m-d Example: 2018-06-25
* @queryParam end_date format:Y-m-d Example: 2018-06-25
* @queryParam expense_for id of the user for which expense is created
* @queryParam per_page Total records per page. default: 10, Set -1 for no pagination Example:15
*
* @response {
"data": [
{
"id": 230,
"business_id": 1,
"location_id": 1,
"payment_status": "partial",
"ref_no": "refund",
"transaction_date": "2020-12-15 11:16:00",
"total_before_tax": "65.0000",
"tax_id": null,
"tax_amount": "0.0000",
"final_total": "65.0000",
"expense_category_id": null,
"document": null,
"created_by": 9,
"created_at": "2020-12-15 11:46:56",
"updated_at": "2020-12-15 12:47:30",
"expense_for": []
}
],
"links": {
"first": "http://local.pos.com/connector/api/expense-refund?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http://local.pos.com/connector/api/expense-refund",
"per_page": 15,
"to": 1
}
}
*/
public function listExpenseRefund()
{
$user = Auth::user();
$business_id = $user->business_id;
$filters = request()->only(['location_id', 'payment_status', 'start_date', 'end_date', 'expense_for', 'per_page']);
$query = Transaction::where('business_id', $business_id)
->where('type', 'expense_refund')
->with(['transaction_for']);
$permitted_locations = $user->permitted_locations($business_id);
if ($permitted_locations != 'all') {
$query->whereIn('transactions.location_id', $permitted_locations);
}
if (! empty($filters['location_id'])) {
if (! empty($filters['location_id'])) {
$query->where('transactions.location_id', $filters['location_id']);
}
}
if (! empty($filters['payment_status'])) {
if (! empty($filters['payment_status'])) {
$query->where('transactions.payment_status', $filters['payment_status']);
}
}
if (! empty($filters['start_date'])) {
if (! empty($filters['start_date'])) {
$query->whereDate('transactions.transaction_date', '>=', $filters['start_date']);
}
}
if (! empty($filters['end_date'])) {
if (! empty($filters['end_date'])) {
$query->whereDate('transactions.transaction_date', '<=', $filters['end_date']);
}
}
if (! empty($filters['expense_for'])) {
if (! empty($filters['expense_for'])) {
$query->where('transactions.expense_for', $filters['expense_for']);
}
}
$perPage = ! empty($filters['per_page']) ? $filters['per_page'] : $this->perPage;
if ($perPage == -1) {
$expenses = $query->get();
} else {
$expenses = $query->paginate($perPage);
$expenses->appends(request()->query());
}
return ExpenseResource::collection($expenses);
}
/**
* List expense categories
*
* @response {
"data": [
{
"id": 1,
"name": "cat 1",
"business_id": 1,
"code": null,
"parent_id": null,
"deleted_at": null,
"created_at": "2021-12-16 17:54:40",
"updated_at": "2021-12-16 17:54:40",
"sub_categories": [
{
"id": 3,
"name": "sub cat 1",
"business_id": 1,
"code": null,
"parent_id": 1,
"deleted_at": null,
"created_at": "2021-12-16 18:12:07",
"updated_at": "2021-12-16 18:12:07"
}
]
},
{
"id": 7,
"name": "cat 2",
"business_id": 1,
"code": null,
"parent_id": null,
"deleted_at": null,
"created_at": "2021-12-17 10:36:13",
"updated_at": "2021-12-17 10:36:13",
"sub_categories": [
{
"id": 8,
"name": "sub cat 2",
"business_id": 1,
"code": null,
"parent_id": 7,
"deleted_at": null,
"created_at": "2021-12-17 10:36:44",
"updated_at": "2021-12-17 10:36:44"
}
]
}
]
}
**/
public function listExpenseCategories()
{
$user = Auth::user();
$business_id = $user->business_id;
$query = ExpenseCategory::where('business_id', $business_id)
->onlyParent()
->with('sub_categories');
$categories = $query->get();
return CommonResource::collection($categories);
}
}