Client Statements

This commit is contained in:
David Bomba 2021-08-25 12:03:58 +10:00
parent f29318d665
commit aa0f1b3bdf
4 changed files with 76 additions and 62 deletions

View File

@ -585,64 +585,5 @@ class ClientController extends BaseController
}
/**
* Update the specified resource in storage.
*
* @param UploadClientRequest $request
* @param Client $client
* @return Response
*
*
*
* @OA\Put(
* path="/api/v1/clients/{id}/adjust_ledger",
* operationId="adjustLedger",
* tags={"clients"},
* summary="Adjust the client ledger to rebalance",
* description="Adjust the client ledger to rebalance",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(ref="#/components/parameters/include"),
* @OA\Parameter(
* name="id",
* in="path",
* description="The Client Hashed ID",
* example="D2J234DFA",
* required=true,
* @OA\Schema(
* type="string",
* format="string",
* ),
* ),
* @OA\Response(
* response=200,
* description="Returns the client object",
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
* @OA\JsonContent(ref="#/components/schemas/Client"),
* ),
* @OA\Response(
* response=422,
* description="Validation error",
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
*
* ),
* @OA\Response(
* response="default",
* description="Unexpected Error",
* @OA\JsonContent(ref="#/components/schemas/Error"),
* ),
* )
*/
//@deprecated - not available
public function adjustLedger(AdjustClientLedgerRequest $request, Client $client)
{
// $adjustment = $request->input('adjustment');
// $notes = $request->input('notes');
// $client->service()->updateBalance
}
}

View File

@ -35,6 +35,79 @@ class ClientStatementController extends BaseController
parent::__construct();
}
/**
* Update the specified resource in storage.
*
* @param CreateStatementRequest $request
* @return Response
*
* @OA\Post(
* path="/api/v1/client_statement",
* operationId="clientStatement",
* tags={"clients"},
* summary="Return a PDF of the client statement",
* description="Return a PDF of the client statement",
* @OA\Parameter(ref="#/components/parameters/X-Api-Secret"),
* @OA\Parameter(ref="#/components/parameters/X-Api-Token"),
* @OA\Parameter(ref="#/components/parameters/X-Requested-With"),
* @OA\Parameter(ref="#/components/parameters/include"),
* @OA\RequestBody(
* description="Statment Options",
* required=true,
* @OA\MediaType(
* mediaType="application/json",
* @OA\Schema(
* type="object",
* @OA\Property(
* property="start_date",
* description="The start date of the statement period - format Y-m-d",
* type="string",
* ),
* @OA\Property(
* property="end_date",
* description="The start date of the statement period - format Y-m-d",
* type="string",
* ),
* @OA\Property(
* property="client_id",
* description="The hashed ID of the client",
* type="string",
* ),
* @OA\Property(
* property="show_payments_table",
* description="Flag which determines if the payments table is shown",
* type="boolean",
* ),
* @OA\Property(
* property="show_aging_table",
* description="Flag which determines if the aging table is shown",
* type="boolean",
* )
* )
* )
* ),
* @OA\Response(
* response=200,
* description="Returns the client object",
* @OA\Header(header="X-MINIMUM-CLIENT-VERSION", ref="#/components/headers/X-MINIMUM-CLIENT-VERSION"),
* @OA\Header(header="X-RateLimit-Remaining", ref="#/components/headers/X-RateLimit-Remaining"),
* @OA\Header(header="X-RateLimit-Limit", ref="#/components/headers/X-RateLimit-Limit"),
* @OA\JsonContent(ref="#/components/schemas/Client"),
* ),
* @OA\Response(
* response=422,
* description="Validation error",
* @OA\JsonContent(ref="#/components/schemas/ValidationError"),
*
* ),
* @OA\Response(
* response="default",
* description="Unexpected Error",
* @OA\JsonContent(ref="#/components/schemas/Error"),
* ),
* )
*/
public function statement(CreateStatementRequest $request)
{
$pdf = $this->createStatement($request);

View File

@ -31,8 +31,8 @@ class CreateStatementRequest extends Request
public function rules()
{
return [
'start_date' => ['required'],
'end_date' => ['required'],
'start_date' => 'required|date_format:Y-m-d',
'end_date' => 'required|date_format:Y-m-d',
'client_id' => 'bail|required|exists:clients,id,company_id,'.auth()->user()->company()->id,
'show_payments_table' => 'boolean',
'show_aging_table' => 'boolean',

View File

@ -424,7 +424,7 @@ class Design extends BaseDesign
public function statementPaymentTableTotals(): array
{
if ($this->type !== self::STATEMENT) {
if ($this->type !== self::STATEMENT || !$this->payments->first()) {
return [];
}