Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
wmandai committed Sep 29, 2022
1 parent 0102007 commit 1809ff9
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 100 deletions.
121 changes: 59 additions & 62 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,21 +70,21 @@ Create a new expense
Parameters
^^^^^^^^^^

+---------------+------------+-----------------------------------------------------+
| Name | Required | Description |
+===============+============+=====================================================+
| amount | required | Expense amount e.g 1500.00 |
+---------------+------------+-----------------------------------------------------+
| category_id | required | Expense category |
+---------------+------------+-----------------------------------------------------+
| expense_date | required | Expense date |
+---------------+------------+-----------------------------------------------------+
| vendor | required | Vendor name e.g Apple |
+---------------+------------+-----------------------------------------------------+
| invoiced | required | A value 0 or 1 |
+---------------+------------+-----------------------------------------------------+
| project_id | optional | Associated project ID if any |
+---------------+------------+-----------------------------------------------------+
+--------------+----------+------------------------------+
| Name | Required | Description |
+==============+==========+==============================+
| amount | required | Expense amount e.g 1500.00 |
+--------------+----------+------------------------------+
| category_id | required | Expense category |
+--------------+----------+------------------------------+
| expense_date | required | Expense date |
+--------------+----------+------------------------------+
| vendor | required | Vendor name e.g Apple |
+--------------+----------+------------------------------+
| invoiced | required | A value 0 or 1 |
+--------------+----------+------------------------------+
| project_id | optional | Associated project ID if any |
+--------------+----------+------------------------------+

``GET`` - /api/v1/expenses/{id}
--------------------------------
Expand Down Expand Up @@ -151,23 +151,23 @@ Update an expense
Parameters
^^^^^^^^^^

+---------------+------------+-----------------------------------------------------+
| Name | Required | Description |
+===============+============+=====================================================+
| amount | required | Expense amount e.g 1500.00 |
+---------------+------------+-----------------------------------------------------+
| category_id | required | Expense category |
+---------------+------------+-----------------------------------------------------+
| expense_date | required | Expense date |
+---------------+------------+-----------------------------------------------------+
| billable | optional | Whether the expense is billable. Default 1 |
+---------------+------------+-----------------------------------------------------+
| notes | optional | Expense notes |
+---------------+------------+-----------------------------------------------------+
| project_id | required | Associated project ID if any |
+---------------+------------+-----------------------------------------------------+
| vendor | optional | Associated vendor name |
+---------------+------------+-----------------------------------------------------+
+--------------+----------+--------------------------------------------+
| Name | Required | Description |
+==============+==========+============================================+
| amount | required | Expense amount e.g 1500.00 |
+--------------+----------+--------------------------------------------+
| category_id | required | Expense category |
+--------------+----------+--------------------------------------------+
| expense_date | required | Expense date |
+--------------+----------+--------------------------------------------+
| billable | optional | Whether the expense is billable. Default 1 |
+--------------+----------+--------------------------------------------+
| notes | optional | Expense notes |
+--------------+----------+--------------------------------------------+
| project_id | required | Associated project ID if any |
+--------------+----------+--------------------------------------------+
| vendor | optional | Associated vendor name |
+--------------+----------+--------------------------------------------+

``DELETE`` - /api/v1/expenses/{id}
-----------------------------------
Expand Down Expand Up @@ -199,9 +199,6 @@ Show expense comments
Accept: application/json
Authorization: Bearer {your-token}
``POST`` - /api/v1/expenses/{id}/copy
----------------------------------------

Payments
"""""""""""""""""

Expand Down Expand Up @@ -364,33 +361,33 @@ Create a new client
Parameters
^^^^^^^^^^
+---------------+------------+-----------------------------------------------------+
| Name | Required | Description |
+===============+============+=====================================================+
| name | required | Client Name |
+---------------+------------+-----------------------------------------------------+
| email | required | Client email address |
+---------------+------------+-----------------------------------------------------+
| phone | optional | Client phone number |
+---------------+------------+-----------------------------------------------------+
| street | optional | Street Address |
+---------------+------------+-----------------------------------------------------+
| zip_code | optional | Zip Code |
+---------------+------------+-----------------------------------------------------+
| city | optional | City |
+---------------+------------+-----------------------------------------------------+
| state | optional | State |
+---------------+------------+-----------------------------------------------------+
| locale | optional | Preferred locale |
+---------------+------------+-----------------------------------------------------+
| country_id | required | Country |
+---------------+------------+-----------------------------------------------------+
| tax_number | optional | Client tax number if any |
+---------------+------------+-----------------------------------------------------+
| currency_id | required | Preferred currency |
+---------------+------------+-----------------------------------------------------+
| notes | optional | Additional notes |
+---------------+------------+-----------------------------------------------------+
+-------------+----------+--------------------------+
| Name | Required | Description |
+=============+==========+==========================+
| name | required | Client Name |
+-------------+----------+--------------------------+
| email | required | Client email address |
+-------------+----------+--------------------------+
| phone | optional | Client phone number |
+-------------+----------+--------------------------+
| street | optional | Street Address |
+-------------+----------+--------------------------+
| zip_code | optional | Zip Code |
+-------------+----------+--------------------------+
| city | optional | City |
+-------------+----------+--------------------------+
| state | optional | State |
+-------------+----------+--------------------------+
| locale | optional | Preferred locale |
+-------------+----------+--------------------------+
| country_id | required | Country |
+-------------+----------+--------------------------+
| tax_number | optional | Client tax number if any |
+-------------+----------+--------------------------+
| currency_id | required | Preferred currency |
+-------------+----------+--------------------------+
| notes | optional | Additional notes |
+-------------+----------+--------------------------+

``GET`` - /api/v1/clients/{id}
--------------------------------
Expand Down
24 changes: 12 additions & 12 deletions docs/source/clients.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
customers
Customers
=========
.. meta::
:description: Stay organized by keeping your customers, projects, hourly rates and invoices in one place.
:keywords: projects,invoices,freelancer,tasks,contacts,time tracking,codecanyon

Your customers are the core of your freelance business. customers in `Sereni <https://sereni.beanflare.com/>`_ will typically hold all information specific to a company that your organisation will have a relationship with. In real world terms an Account may be a business entity that is a qualified Sales Prospect, Customer, Supplier or Re-seller and can be used to track all interactions that take place between these entities and your organisation. The relationship between the account and contact records is one-to-many, such that there can be many contacts associated with a single account.
Your customers are the core of your freelance business. Customers in `Sereni <https://sereni.beanflare.com/>`_ will typically hold all information specific to a company that your organisation will have a relationship with. In real world terms an Account may be a business entity that is a qualified Sales Prospect, Customer, Supplier or Re-seller and can be used to track all interactions that take place between these entities and your organisation. The relationship between the account and contact records is one-to-many, such that there can be many contacts associated with a single account.

Contacts
""""""""
Expand All @@ -13,7 +13,7 @@ In Sereni, a Contact is an individual who is typically associated with a client
List Customers
""""""""""""""

The Customers page is a list page that presents a summary of all your customers in a user-friendly table. Think of Customers page as the "central station" of your client activity. Most of your day-to-day invoicing actions can be taken from the various links and buttons that appear on this page. And you can use the Customers page as your starting point to explore more in-depth client information, view client projects and more. Now, well take a closer look at the setup of the customers page, and the range of actions available to you on the page.
The Customers page is a list page that presents a summary of all your customers in a user-friendly table. Think of Customers page as the "central station" of your client activity. Most of your day-to-day invoicing actions can be taken from the various links and buttons that appear on this page. And you can use the Customers page as your starting point to explore more in-depth client information, view client projects and more. Now, we'll take a closer look at the setup of the customers page, and the range of actions available to you on the page.

To view your client list page, go to the main sidebar and click the Customers tab.

Expand All @@ -25,15 +25,15 @@ The customers page presents a list summary of all your current customers in a ta
- **Name:** The name of the client
- **Phone:** Company phone number and contact person
- **Email:** The client email address
- **Balance:** The clients payment balance
- **Location:** The clients addresses
- **Balance:** The client's payment balance
- **Location:** The client's addresses

Create Customer
""""""""""""""""

So, youve taken on a new client? Congratulations!
So, you've taken on a new client? Congratulations!

Your customers list is at the heart of your invoicing activity, so it's really important to maintain current information on all your customers. When you start working with a new client, the first thing youll need to do is to add the new client by entering their contact information and business details.
Your customers list is at the heart of your invoicing activity, so it's really important to maintain current information on all your customers. When you start working with a new client, the first thing you'll need to do is to add the new client by entering their contact information and business details.

When creating and saving a new client to your Client list, make sure to have the relevant, up-to-date information at hand. You are only required to enter the information one time. Sereni automatically tracks all invoicing,projects and payment activity for each client.

Expand All @@ -42,17 +42,17 @@ When creating and saving a new client to your Client list, make sure to have the

To create customers individually.

| In the customers section, click (Create button) to add a new account.
| In the Create Client page, enter the account details.
| In the customers section, click (New Customer button) to add a new account.
| In the modal form, enter the account details.
| Click Save
.. TIP:: The New Customer modal is divided into four sections. Enter the information in the relevant fields.

.. Note: You dont have to complete every field. Enter the information that is important or necessary for your needs.
.. Note: You don't have to complete every field. Enter the information that is important or necessary for your needs.
Lets take a closer look at each section:
Let's take a closer look at each section:

- **Customer Information**: Enter details about your clients business/company/organization, including the company name, email, tax number and logo (optional).
- **Customer Information**: Enter details about your client's business/company/organization, including the company name, email, tax number and logo (optional).

- **Shipping Address**: Enter shipping address if required.
- **Billing Address**: Enter your client billing address.
Expand Down
11 changes: 5 additions & 6 deletions docs/source/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can change the queue driver in your .env file ``QUEUE_DRIVER=database``
Supervisord Configuration
-----------------------------
We highly recommend configuring supervisord to monitor your processes and restart your queue if it fails.
Read more on `Supervisord Configuration <https://laravel.com/docs/9.0/queues#supervisor-configuration>`__
Read more on `Supervisord Configuration <https://laravel.com/docs/9.x/queues#supervisor-configuration>`__


Application Configuration
Expand Down Expand Up @@ -65,9 +65,9 @@ To setup paypal;
- Copy Client ID and paste it in your .env file PAYPAL_CLIENT_ID=your-key
- Copy Secret key and paste in your .env file PAYPAL_CLIENT_SECRET=your-secret
- At the bottom of the page click Add Webhook
- Set the webhook URL to https://{YOUR-DOMAIN}/api/v1/paypal/webhook replace {YOUR-DOMAIN} with your actual domain e.g https://portal.domain.com/paypal/webhook
- Set the webhook URL to https://{YOUR-DOMAIN}/api/v1/paypal/webhook replace {YOUR-DOMAIN} with your actual domain e.g https://portal.domain.com/api/v1/paypal/webhook
- Enable events **Payment Authorization created, Payment authorization voided, Payment capture completed, Payment capture denied, Payment Capture pending, Payment capture refunded, Payment capture reversed, Payment order cancelled, Payment order created**
- After the webhook is created, copy the Webhook ID and paste to your .env file PAYPAL_WEBHOOK_ID=your-webhook-id}
- After the webhook is created, copy the Webhook ID and paste to your .env file PAYPAL_WEBHOOK_ID={your-webhook-id}

.. ATTENTION:: To enable PayPal Live, open .env file and change PAYPAL_MODE=sandbox to PAYPAL_MODE=live

Expand All @@ -77,7 +77,6 @@ To configure `Stripe <https://dashboard.stripe.com>`__, proceed as follows;

- Login to your stripe dashboard account
- Get your API Keys by clicking Developers section
- Obtain your stripe webhook keys by clicking on Webhooks under Developers section of your stripe dashboard.

Open your .env file in Sereni and modify the values below;

Expand All @@ -103,7 +102,7 @@ To configure `RazorPay <https://dashboard.razorpay.com>`__, proceed as follows;
- Login to your razorpay dashboard account
- Get your API Keys by clicking Settings -> API Keys section

Open your .env file in Sereni App and modify the values below;
Open your .env file and modify the values below;

.. code-block:: shell
Expand All @@ -119,7 +118,7 @@ To configure mollie, proceed as follows;
- Login to your `Mollie <https://www.mollie.com/dashboard>`__ dashboard account
- Get your API Keys by clicking on Developers section

Open your .env file in Sereni App and modify the values below;
Open your .env file and modify the values below;

.. code-block:: shell
Expand Down

0 comments on commit 1809ff9

Please sign in to comment.