Documentation manual- Cygnet KSA

Documentation manual- Cygnet KSA





Dashboard

Quick Access


Users would be redirected to Dashboard page as soon as user log into the KSA Portal.


Using Dashboard module, user will see “Quick Access Dashboard” which comprises of below tiles.

  1. “Welcome”,
  2. “Notifications”,
  3. “Quick Links”
  4. “Other Cygnet offerings”.


Welcome

The welcome tile provides quick access to modules for Creating, Importing Document & View Invoices and Download PD


Notifications:

The Notification tile provide the recent list of notifications.


This Tile will provide quick links to the frequently used modules.


Other Cygnet offerings:

This tile provides the user with a list of insights on the other offerings provided by the cygnet, which can be availed by the user using “Contact Me” option or user can refer them to others using refer to other.


Below is the screen shot from where user will be able to access the Dashboard. Users must apply global filter to select Financial Year for each section.

All stats of above sections would be loaded after applying filter of individual filters of the respective section.




Statistics Dashboard


E-invoice Stats

  1. Users would be able to view E-invoice statistics for the last 7 days, as depicted in the following screenshot.
  2. Below are the details which would be displayed in E-invoice Stats.
  1. Total Uploaded
  2. Yet Not Generated
  3. Generated

Group Shape To Image








  1. Users can access E-invoice statistics corresponding to the selected Financial Year in the Global Filter. The sub-Filter provides options for filtering based on "Entity," "Exclude Child Entity Data," and "Upload Date," allowing for a detailed stat.


Group Shape To Image








E-Invoice Stats -> Filter Criteria

  1. Individual filter criteria are available for the E-invoice Stats section as per below.
  1. Entity
  2. Exclude Child Entity Data
  3. By Uploaded Date
  1. Based on the above criteria, Stats would be displayed on dashboard.

Group Shape To Image







  1. Entity:

Here, all Entity with EINV purpose would be appeared for selection and user can select desired entity to get the E-invoice Stats for all section date wise.

  1. Exclude Child Entity Data:

If users want to exclude the Child Locations of the Business, then user can apply this filter.

  1. By Uploaded Date:

If users wants count based on Uploaded date of the record, then user can apply this filter.

By applying this filter, count of Generated and Yet Not Generated records would be considered only if user has generated or cancelled the record on the same day when uploaded.





Business Intelligence Dashboard:


Business Intelligence provides user with various Summaries and Bifurcations as per the applied “Entity” & “Financial Year” in Global Filter.

Below is the list of tiles available in the module.

  1. Sales Summary
  2. Purchase Summary
  3. Sales Bifurcation
  4. Purchase Bifurcation
  5. State Wise Sales Bifurcation
  6. State Wise Purchase Bifurcation



Sales Summary

  1. User would be able to view “Sales Summary” in Dashboard screen as per below screenshot.


Group Shape To Image









  1. Users would be able to view summary regarding Sales for all months from Jan to Dec as per applied “Entity” & “Financial Year” in Global Filter.
  2. In this section of Business Intelligence Dashboard User can see the bifurcation of Sales done for the applied filters as per below screenshot.Group Shape To Image
      Sales Summary-> Filter Criteria

  1.  Individual filter criteria are available for the Sales summary Stats section as per which Stats would be displayed on dashboard.

  1. Entity

Here, all Entity with EINV purpose would be appeared for selection and user can select desired entity to get the Sales summary for all section onth wise.

  1. Exclude Child Entity Data:

If users want to exclude the Child Locations of the Business, then user can apply this filter.

  1. Year:

Users can filter the records by applying year.

  1. Currency:

If users want to filter by currency, then user can apply this filter.

  1. Total sales, By Rate, By HSN & By Item

If users want to filter the records by Total sales, By Rate, By HSN & By Item, then user can apply this filter.

  1. By Month, By Customer & By State

If users want to filter the records By Month, By Customer & By State, then user can apply this filter.

  1. Total taxable Amount & Tax Amount

If users want to filter the records By Total taxable Amount & Tax Amount, then user can apply this filter.






Purchase Summary

  1. Users would be able to view “Purchase Summary” in Dashboard screen as per below screenshot.

Group Shape To Image







  1. Users would be able to view summary regarding Purchase for all months from Jan to Dec as per applied

“Entity” & “Financial Year” in Global Filter.

  1. In this section of Business Intelligence Dashboard User can see the bifurcation of Purchase done for the applied filters as per below screenshot.

Group Shape To Image






Purchase Summary-> Filter Criteria

  1. Individual filter criteria are available for the Purchase summary Stats section as per below.
  1. Entities
  2. Exclude Child Entity Data
  3. Year
  4. Currency
  5. Total sales, By Rate, By HSN & By Item
  6. By Month, By Customer & By State
  7. Total taxable Amount & Tax Amount
  1. Based on the above criteria, Stats would be displayed on dashboard.
  1. Entity:

Here, all Entity with EINV purpose would be appeared for selection and user can select desired entity to get the Sales summary for all section month wise.

  1. Exclude Child Entity Data:

If users want to exclude the Child Locations of the Business, then user can apply this filter.

  1. Year:


Users can filter the records by applying year.

  1. Currency:

If users want to filter by currency, then user can apply this filter.

  1. Total sales, By Rate, By HSN & By Item

If users want to filter the records by Total sales, By Rate, By HSN & By Item, then user can apply this filter.

  1. By Month, By Customer & By State

If users want to filter the records By Month, By Customer & By State, then user can apply this filter.

  1. Total taxable Amount & Tax Amount

If users want to filter the records By Total taxable Amount & Tax Amount, then user can apply this filter.







Sales Bifurcation

  1. Users would be able to view “Sale Bifurcation” of Transaction type Invoices with respect to Financial Year in Dashboard screen as per below screenshot.

Group Shape To Image










  1. Users would be able to view bifurcation regarding Sales for last 4 years as per applied “Entity” & “Financial Year” in Global Filter.
  2. In this section of Business Intelligence Dashboard User can see the Sales bifurcation for the applied filters as per below screenshot.

Group Shape To Image
















Sales Bifurcation-> Filter Criteria

  1. Individual filter criteria are available for the Sales bifurcation section as per below.
  1. Entities
  2. Exclude Child Entity Data
  3. Currency


  1. Based on the above criteria, Stats would be displayed on dashboard.
  1. Entity:

Here, all Entity with EINV purpose would be appeared for selection and user can select desired entity to get the Sales summary for all section month wise.

  1. Exclude Child Entity Data:

If users want to exclude the Child Locations of the Business, then user can apply this filter.

  1. Currency:

If users want to filter by currency, then user can apply this filter.






Purchase Bifurcation

  1. Users would be able to view “Purchase Bifurcation” of Transaction type Invoices with respect to Financial

Year in Dashboard screen as per below screenshot.


Group Shape To Image










  1. Users would be able to view bifurcation regarding Purchase for last 4 years as per applied “Entity” & “Financial Year” in Global Filter.
  2. In this section of Business Intelligence Dashboard User can see the Purchase bifurcation for the applied filters as per below screenshot.

Group Shape To Image















Purchase Bifurcation-> Filter Criteria

  1. Individual filter criteria are available for the Purchase Bifurcation Stats section as per below.
  1. Entities
  2. Exclude Child Entity Data
  3. Currency
  1. Based on the above criteria, Stats would be displayed on dashboard.
  1. Entity:

Here, all Entity with EINV purpose would be appeared for selection and user can select desired entity to get the Sales summary for all section month wise.

  1. Exclude Child Entity Data:

If users want to exclude the Child Locations of the Business, then user can apply this filter.

  1. Currency:

If users want to filter by currency, then user can apply this filter.





State Wise Sales Bifurcation

  1. Users would be able to view “State wise sales Bifurcation” Based on state bifurcation in Dashboard screen as

per below screenshot.


Group Shape To Image






















  1. Users would be able to view bifurcation regarding sale as per applied “Entity” & “Financial Year” in Global

Filter.

  1. In this section of Business Intelligence Dashboard User can see the Sales bifurcation for the applied filters as per below screenshot.
    Group Shape To Image


State Wise Sales Bifurcation-> Filter Criteria

  1. Individual filter criteria are available for the State Wise Sales bifurcation section as per below.
  1. Entities
  2. Exclude Child Entity Data
  3. Year
  4. Currency


  1. Based on the above criteria, Stats would be displayed on dashboard.
  1. Entity:

Here, all Entity with EINV purpose would be appeared for selection and user can select desired entity to get the Sales summary for all section month wise.

  1. Exclude Child Entity Data:

If users want to exclude the Child Locations of the Business, then user can apply this filter.

  1. Year

Users can filter the records by applying year.

  1. Currency:

If users want to filter by currency, then user can apply this filter.






State Wise Purchase Bifurcation

  1. Users would be able to view “State wise Purchase Bifurcation” Based on state bifurcation in Dashboard

screen as per below screenshot.

Group Shape To Image

















  1. Users would be able to view bifurcation regarding sale as per applied “Entity” & “Financial Year” in Global

Filter.

  1. In this section of Business Intelligence Dashboard User can see the Purchase bifurcation for the applied filters as per below screenshot.

Group Shape To Image














State Wise Purchase Bifurcation-> Filter Criteria

  1. Individual filter criteria are available for the State Wise Sales bifurcation section as per below.
  1. Entities
  2. Exclude Child Entity Data
  3. Year
  4. Currency


  1. Based on the above criteria, Stats would be displayed on dashboard.
  1. Entity:

Here, all Entity with EINV purpose would be appeared for selection and user can select desired entity to get the Sales summary for all section month wise.

  1. Exclude Child Entity Data:

If users want to exclude the Child Locations of the Business, then user can apply this filter.

  1. Year

Users can filter the records by applying year.

  1. Currency:

If users want to filter by currency, then user can apply this filter.





































 Manage Organization 


  1. Users can access Manage Organizations menu from the left side bar menu as shown below.

Group Shape To Image

























  1. This module allows user to manage the organization details like creating Entities, Branches, Departments, adding Users and adding user Roles.
  2. User can access below options from the Manage Organizations menu:
  1. Entities
  2. Branches
  3. Departments
  4. Users
  5. Roles







Entities

User can access this module from Manage Organization > Entities option. On clicking the Entity menu, user can view the Entities list screen as shown below:

Group Shape To Image
























Users can view the list of Created Entities from the Entities list Screen.

User can utilize the below functionalities available in the Entities list Screen.

  1. Filters
  1. Entity Type
  2. Entities
  3. Purpose
  4. VRN status
  5. Onboard Status
  6. Entity Records
  7. Phase Type



  1. Add Entity

User can choose to create the following entities:

  1. Business
  2. Entity
  3. Child Entity

User can create new Entity by providing all mandatory details that are shown below:


Group Shape To Image

























If user must select an Entity For E-invoice the module would ask to fill Basic Details, VAT Details, Set Generation / Integration Phase Details & E-Invoice Notification.


After furnishing all the information for adding new Entity Type, user can click on 'Save ' Button.

Once the Entity is added, it will appear in Entities list screen. The added Entity will be available for selection while creating the locations, child locations etc.







  1. Actions

User can perform various actions from the drop-down menu listed below:

  1. Download Excel
  2. Onboard EGS
  3. Renew EGS
  4. Revoke Onboarded EGS
  5.      Delete
Group Shape To ImageD


Users can download an Excel file with all the Entity details based on the applied filter criteria.

  1. Onboard EGS

Users can onboard the EGS using this option.

  1. Renew EGS

User can Renew the EGS using this option.

  1. Revoke Onboarded EGS

User can Revoke the EGS using this option.

  1. Delete

Admin User has the right to delete the Entity entirely based on the applied filter criteria.





Branches


Users can access this module from Manage Organization > Branches option. On clicking the Branches menu, user can view the Branches list screen as shown below:

Group Shape To Image














User can view the list of Created Branches from the Branches list Screen. User can utilize the functionalities below available in the Branches list Screen.
  1.  Filters
  2.      Code
  1.      Name
  1.      Status
  1.  Add Branch
  1. Actions
  1. Download Excel






Departments


Users can access this module from Manage Organization > Departments option. On clicking the Departments menu, user can view the Departments list screen as shown below:

Group Shape To Image
























User can view the list of Created Departments from the Departments list Screen. User can utilize below functionalities available in the Departments list Screen.

  1. Filters
  1. Code
  2. Name
  3. Status
  1. Add Department
  2. Actions
  1. Download Excel




Users

User can access this module from Manage Organization > Users option. On clicking the Users menu, user can view the Users list screen as shown below:


Group Shape To Image
















Admin can utilize the functionalities below available in the Users list Screen.
  1. Filters
  1. Name
  2. Email Address
  3. Mobile Number
  4. User Name
  5. Status





  1. Add User

Admin User can create new User by providing all mandatory details, in the add User form as shown below:

Group Shape To Image















After furnishing all the information for adding new User, the options will allow Admin to Assign Entities, Assign Roles and set Restriction for the User to certain Records and even Restrict Document Access.

Assign Entities: On clicking, a drop down will appear for assigning Entities to a user. Admin needs to select

Business, Location and Child Location or if he needs to assign all the entities, He can use the “Select All” option.

Assign Role: On clicking, a drop down will appear for assigning Roles to a user. User needs to select Set of predefined Roles which will be discussed in the next Section.

After all the information, Entities and Roles are assigned for new User, Admin must click on the Save button to Successfully create the User.

Then the User will receive his credentials on the email ID furnished during the Add User section already discussed above.

  1. Actions 
  2. Download Excel
The Admin User also has the facility to download the Excel file of all the User Details as per applied filter category as shown below:

Group Shape To Image












  1. Set Enriched API / Data Exchanger Access
  1. Users can set Enriched API / Data Exchanger Access by selecting the Enable API / Data exchanger Access.
  2. Users can also generate the Lifetime Auth-token or Generate Auth Key for Encryption using the Key tab available under User module as shown in below Screenshot.

Group Shape To Image






Group Shape To Image













After Successfully Enabling, the user must click on save.                                                                                             Edit User                                                                                         Admin can edit other users’ information by clicking on the Edit option.                                                                                        

























  1. Reset Password

Admin can reset the password of user using the Reset password option.





  1. Status Toggle.

The User can toggle the Status of the Created user by Clicking on the “Active” of Status Field and choosing the appropriate status as per the requirement.

Group Shape To ImageGroup Shape To Image



































  1. Roles                                                                                                                                                                             User can access this module from Manage Organization > Roles option. On clicking the Roles menu, user can view the Roles list screen as shown below:

Group Shape To ImageU


User can view the list of created Users from the Roles list Screen.

User can utilize the functionalities below available in the Roles list Screen.

  1. Filters
  1. Name
  2. Description
  3. Status





  1. Add Role

User can create new Role by providing all mandatory details and checking the checkboxes against the rights for Portal or Enriched API to be given for any added role, in the Add New Role form as shown below:

Group Shape To Image



All the Roles can have multiple combinations of different Modules and Rights to be assigned for that role.

  1. Actions

The Action button on this screen provides four options as shown below.

Group Shape To Image












After furnishing all the mandatory information for adding new role, user can click on ' Save ' button. Once the Role is created, it will appear in role list screen.

Edit Role: User can edit role details by clicking on icon under the section of Roles list. User will be then redirected to 'Edit Role' page as shown below and after updation user can select the Update, Reset or Cancel option as per the requirement.



Group Shape To Image



  1. Actions
  1. Download Excel

Group Shape To ImageUser can download the Excel file of all the Roles as per applied filter category under the section of Roles list as shown below:





  1. Status Change:

Group Shape To ImageThe user can change the status of the roles to Inactive or Delete as per the preference.






Import

  1. User can access Import module from the left side bar menu as shown below.

Group Shape To Image
















  1. In Import module, a list of pre-uploaded files will be visible to the user, as shown in above screen. The list is basically a history, with details like who uploaded the file, when file gets uploaded, by which source, how many records went into Success/Error and Orphan Status.
  2. Document import validation stop record with same document number from getting overwritten if already available in E-invoice module with “Generated” or “Yet not Generated” Status
  3. Errors are those records which failed the Cygnet KSA Portal validations for set fields.
  4. Orphans are basically those records which cannot be identified by Cygnet KSA Application or the fields that were Mandatory but wasn’t passed by the User while importing, User can use certain filters to extract the appropriate information.
  5. Actions button has the option to let the user Download Excel for all the Import files as listed in the above image.




Import Module has below Filters and Statuses for the bifurcation of every uploaded file.


Group Shape To Image


















  1. Import Module >> Filters
  1. Date
  2. Users
  3. Status
  4. File Name
  5. Import Type
  6. Source

  1. Import Module >> Status
  1. Total: Total number of files uploaded into the application
  2. Yet Not Started: File is in the queue; application has yet not picked the respective file for further processing.
  3. In Process: File is picked by the application and processing the data.
  4. Success: File is successfully uploaded in the application
  5. Success with Errors: File is successfully uploaded but certain records went into the error status.
  6. Failed: File upload is failed due to any reason (E.g.: incorrect format)
  1. Document Import:
In order to import the document into the system, click on Import button > Document option.

Group Shape To ImageI
  1. Import Menu has the option to upload files for multiple purposes listed below:
  1. Entities
  2. Document
  3. Document Action
  4. Business Partner
  5. HSN / SAC
  6. Language Master






On clicking, document action, a pop-up box will display where user can Drag and Drop or browse the file from the system, as shown.

Group Shape To ImageO

After clicking on import, user will be able to see the status of the file during the import process (below screen) and post the import process, the number of files went to success, error and orphans will be displayed in respective sections.

  1. Should the imported file display a "Success with error" status, the user has the option to download the processed file, review the list of errors, make necessary corrections, and then proceed to import it again.

Group Shape To ImageS

Group Shape To Image

Case 1: if the file was pertaining to document import, all the error related to document import will come under

Error → Document option.

  1. In order to view success with error records. User needs to click on Error>> Document Option as show in below and he will be greeted with the Import Document error tab page Which showcase the list of error records along with their errors.

Group Shape To Image










User can either rectify the error from the below screen itself, by filling in the red marked fields or by downloading the error file from the Action tab → Download Excel. Once it gets downloaded, correct the error in the same import file and import it again.




Group Shape To Image


Case 2: if the file was pertaining to document import, all the orphan related to document import will come under Orphan → Document option.


Group Shape To Image.


Group Shape To Image



Import Module >> Filters

Users can use certain filters to extract the appropriate information. User can filter the data by

  1. Entity
  2. Return Period
  3. Users
  4. Errors
  5. Document No.
  6. Supply Type
  7. Entity VRN
  8. Entity Name
  9. Business Partner Code
  10. Uploaded Date
  11. Error Fields


Group Shape To Image






















Create Document

User can manually create E-Invoice from this module individually.

Group Shape To Image






























E-Invoice

In order to generate the E-Invoice, following are the pre-requisite:

  1. Set the Entity for E-invoice purpose (Section Add Entity: Manage Organization Module)
  2. Enter the E-invoice credentials (Section Add Entity: Manage Organization Module)
  3. Import the file with purpose of E-invoicing “EINV” (Section Import Document: Import Module)


Once user imported the file, user can access the E-invoice module, by clicking E-invoice from the menu.

Group Shape To Image
















Using the above screen, user can push E-invoice to ZATCA and generate E-invoice.

Users can segregate the data using the filters and view the statistics of the records (Shown in above screen).






  1. E-Invoice Module >> Filters

  1. Subscriber
  2. Year
  3. Month
  4. Entity
  5. VRN
  6. Name
  7. Supply Type
  8. Document number
  9. Document type
  10. Transaction Type
  11. Status
  12. Payment Status



  1. E-Invoice Module >> Status

It will give the statistics of the files uploaded in the portal pertaining to E-invoice.

  1. Yet Not Generated: Invoices uploaded on cygnet portal and not pushed to ZATCA
  2. In Progress: Invoices being pushed to ZATCA.
  3. Generated: Invoices successfully pushed to ZATCA
  4. Failed: The failed Invoices from ZATCA.



  1. Generate IRN

Case 1: In order to generate the E-invoice, firstly the User has to filter out the data which is Yet Not Generated status.

Click on E-invoice Action → Generate

In this, all the records with “Yet Not Generated status” will be pushed to ZATCA.

  Once the data get pushed successfully, a success message will display, shown in below screen:


Group Shape To Image



Case 2: If user wants to generate E-invoice for selective records, click on check box of the respective records. Click on E-invoice Action→ Generate.

In this, only the selected records will be pushed to ZATCA.

Once the data get pushed successfully, a success message will display, already shown in above screen.

Group Shape To Image




























  1. View Document Details:

To view the UUID , Hash, QR code of generated E-invoice, user can filter out the data which is in Generated status. Once user applies the filter, below screen will display all generated records.

Group Shape To Image














In order to view the document details, click on Document number, it will open the panel with all details and association pertaining to the selected record.

Group Shape To Image





















  1. Print Document with QR code

To print any generated document, click on Download pdf    icon.


Group Shape To Image

After clicking on the icon, the pdf will open, and user can print the document from the below screen.

Group Shape To Image


















E-invoice >> Actions

A number of actions are available under the action tab in E-invoice module.

  1. Send Email : User can share the invoice on the configured email.
  2. Bulk Download PDF: Multiple invoices pdf can be downloaded by filtering the document number or checking the box option.
  3. Download Excel: User can download the excel of the invoice.
  4. Download Response Excel: User can download the response excel of the invoice.
  1. Download XML: User can download the XML for the invoice.

Group Shape To Image


















  1. More Filters

User can user more filters option to filter out the records with multiple criteria. (Shown in below image)

Group Shape To Image













Group Shape To Image





Reports

  1. Through this Module user can access multiple reports:
  1. Role rights Report

The report provides details on all roles created in the application vs rights allocated to them amongst all the rights present in the application.

  1. User ID Population Report

Report provides details on each Users created in the application by User ID and Roles assigned to them. It also provides information on when was the User Created, Last Modified, who modified them and when was it last approved and who was the Checker. Apart from this it gives meaningful insights on Last Password Changed Date & Time and Last Login Date and Time.

  1. User Activity Report

Report provides details on each Users created in the application by User ID and Roles assigned to them. It provides detailed information on Old Name vs New Name, Old Role vs New Role assigned, and Old and New Branch assigned. The report also records Maker Information responsible for changes and Checker information who has approved the request.


  1. Audit Trail Report

Report provides UAM History of each module in the system with Maker, Checker information in detail along with Action taken and Changes done in records.

  1. Authentication Report

Report provides complete history of user login and logout in the system. It also tracks how users logged out from the system.

  1. Notification Status Report

Report provides details on notification sent to the recipient. It provides details on Emails and SMS sent.


Group Shape To Image






















Data Activities

  1. Through this module user can see the status of all the data he has pushed, and Failed callbacks.

Group Shape To Image











Push

  1. Through this function user can see all the status of all those modules which has been pushed to ZATCA,
  2. You can check the status of passed data filter wise under push section such as Year, Month, Entity, Date, Users , Category , Type and Status.

Group Shape To Image

























Failed Callbacks

  1. Through Failed Callbacks module user can track failed callbacks & retry callbacks whenever they want to receive it again.
  2. Users can filter and search their filed callbacks with Users, Reference ID , Request ID and Date.
  3. Retry Callback: Through this Retry call back under Action user can retry for call back API if it got failed at first attempt based on the filter applied of reference ID and Request ID.

Group Shape To Image





















Masters

Through the master feature user can access multiple masters which need to be maintained by user itself.

  1. Series
  2. Allocated Series
  3. Vendors
  4. HSN/SAC
  5. IP Addresses
  6. Email Templates
  7. Notification Reply

Group Shape To ImageGroup Shape To Image


































Series

Through series master user can create document series manually for Auto-generation of document number.

To enable this feature, User needs to toggle the “Document Autonumbering” option from settings.

Group Shape To ImageGroup Shape To Image





















  1. Add Series: Through this action user can manually create the series where user need to select the Series parameter on which basis they wants to create the series such as if they want to create Alphanumeric series they need to select parameter as static Value and If they want to Add financial year into that series the should select Financial year.



Group Shape To Image







  3. : Through this action user can activate or deactivate the series manually. It is mandatory

to activate the series once it’s created.

  1. Reset Auto-Number on New FY: When user select this option the financial year in generated series will change automatically on the change of every financial year.
  2. Action: Through Action user can download excel of generated series and if user wish to delete the filtered data can be possible with this.
  3. Users can filter the generated series based on Series Name, Series Code, Reset Auto Number on New FY, User, and status.
  4. Status: Through this user can filter the series whether it is Active or Inactive.
  5. Assign Series to Users: Through this action bar user can assign the generated series to their users. Once User click on that action, portal will ask user to select the username from the drop down whom he wish to assign the series and click on SAVE.

Group Shape To ImageGroup Shape To Image















Assign Signature to series: User can assign the signature through this action on particular series on which they wish to set signature.

Group Shape To Image










Group Shape To Image


  1. The Series and Allocated series function will only work if the setting is turned on of Setting >>System

>>Document Auto-numbering.

Group Shape To Image










Allocated Series

  1. Allocated series based on the settings applied at subscriber, business or Entity level. Using Entity & series, user can allocate series for all document types.


Group Shape To Image








  1. At the time of allocating series user need to select the series and click on Allocate series where user need to select the particular, Series Code and Entity for each series and click on SAVE.

Group Shape To Image


Group Shape To Image


Group Shape To Image

























Business Partners

Users can access this module from Masters >> Business Partner option. On click of Business Partner option, user can view the 'Manage Business partners’ and also user can view the list of created Business Partners. User can import the Business master through import module by entering all the required details of business partners and also add Business partners.

Group Shape To Image







Business Partners >> Filters

  1. VRN: User can filter their vendor data based on VRN numbers that user can also filter single or bulk wise.
  2. VRN Type: User can filter the Business partners details through their VRN Type.
  3. Sch Add ID Details: User can filter the business partners details through their Sch Add ID.
  4. Name: User can filter the vendor business partner’s details through their Name.
  5. Business Partner Code: User can filter the business partner details through their state code.
  6. City: User can filter the business partner details through their city code.
  7. Pin Code: User can filter the business partner details through their Pin code.
  8. State: User can filter the business partner details through their State
  9. Country: User can filter the business partner details through their Country.
  10. Uploaded On: User can filter the business partner details through their Uploaded-on Date (From & To)
  11. Business Partner Type: User can filter the business partner details based on Supplier, Customer & Distributor.

Business Partners >> Actions

  1. Add Business Partner: User can add Business Partner Details manually from this option.
  2. Download Excel: User can download the vendor details in excel as well.
  3. Delete: User can delete any Business partner by selecting the filter.








Add Business Partner

  1. Users can add a Business Partner by entering the specified details as shown in below screen and selecting the appropriate Business Partner Type.

Group Shape To Image
















  1. Distributor code would be enabled if the user select the Business Partner type as Distributor.

Group Shape To Image


  1. From   ,the user will be able to check if the Business partner is onboarded or not in the system.

Group Shape To Image





  1. From  the user will be able to edit the Business partner details.

Group Shape To Image




  1. From     user will be able to view the business partner’s details.

Group Shape To Image











HSN/SAC

  1. Users can access this module from Masters >HSN/SAC option. By clicking of HSN/SAC option, user can view the HSN/SAC master also user can view the list of created HSN/SAC details. Users can import the HSN master through import module by entering all the required details of HSN/SAC and add manually.

Group Shape To Image









  1. Add HSN/SAC: Through this action user can add HSN/SAC details manually.

Group Shape To Image













  1. Download Excel: Through this action user can download the data of all the created HSN/SAC in excel.
  2. Delete: Through this action user can delete the filtered records from cygnet.

Group Shape To Image






  1. Filters: User can filter their HSN/SAC records based on HSN/SAC Code , Product Code , Name , Rate and Tax Type.


Group Shape To Image






IP Addresses

  1. This master “IP Addresses” using which subscriber will be able to define IP addresses from which they want to allow users to login. This module has the facility to bind user with particular IP address also, this is added as a part of security enhancement.

Group Shape To Image









  1. Add IP Address: Through this action user can add the IP Address manually through cygnet.

Group Shape To Image



















  1. Rule Name: To define global rule applicable for all users, user can simply add single or range of IP address & do not assign IP to any user. If any particular rule which is not assigned to any user, will act as global rule and to define user specific rule, you can simply assign IP address to user, that rule will only be applicable to assigned users.


  1. Filters: User can filter their records based on Rule Name, IP address, Status Type.

Group Shape To Image







































Email Templates

  1. User can use “Email Templates” master to override email getting sent.
  2. You can use any of the placeholders below in this email template. These placeholders will be automatically replaced by actual data when email is created. Add *** before and after each placeholder name, without any spaces, such as ***CustomerName***
  3. Action>Reset: User can reset the changes through reset action.

Group Shape To ImageGroup Shape To Image



































  1. Language Master:

User can import the language master.

Group Shape To Image
  1. Add Language:

Group Shape To Image


































Setting

  1. Settings module will help the user to manage settings. User will be able to apply settings for different modules and will have appropriate options for selection in some settings also, By default settings would be off, user need to enable settings as per need and will be able to access settings module in system as per below screen shot.

Group Shape To Image















  1. Settings Modules

Here is a categorized list of settings based on the specific functionalities for which each setting is defined in the system.

  1. System
  2. Import
  3. Document Print
  4. Column Aliasing
  5. Portal
  6. Enriched API
  7. Data Exchanger
  8. Notifications
  9. Security






Settings -> System

User will be able to access System Settings from Settings -> System and Below are the different system settings which user can apply as per requirement.

  1. Enable UAM
  2. Enable Approval Flow
  3. Document Autonumbering
  4. Restrict Single Document Per PDF
  5. Generate Duplicate / Triplicate Document Copies
  6. Club Item Level Data in Download PDF
  7. Auto-populate Business Partner Master

Enable UAM:

  1. Allows to enable UAM (user access management) and its specific functionalities for Branches, Departments, Users & Roles.
  2. Once user will enable this setting then user will be able to user the functionality for Branches, Department, User & Roles.

Group Shape To Image







Enable Approval Flow

  1. Allows to specify whether approval flow needs to be enabled for E-Invoicing. If enabled, then at every stage of document generation, generating E-Invoices will be considered under approval flow mechanism.

Group Shape To Image






  1. Document Autonumbering
User will be able to access above setting from System settings -> Document Autonumbering.

Group Shape To Image

  1. The above setting is for Document Numbering while document creation.
  2. Usage of Document Autonumbering Setting:
  3. If the above setting is enabled, then user need to define Document Series and allocate series to desired Document Type and location.
  4. Users will be able to access Series and Allocate Series from More Features -> Masters -> Series and More Features -> Masters -> Allocate Series.

Group Shape To Image










  1. Series and Allocate Series modules will be enabled only if Document Autonumbering setting is enabled otherwise both will be disabled.
  2. Firstly, user need to create series from Series Master if not created any and need to assign that series from Allocate Series to desired Document Type and Location and After creating and allocating series, user will be able to assign series while creating document or importing document in the system.
  3. There will be a field named “Document Series” while creating document manually in which user need to select desired series from available series and below is the screen shot while creating document manually in the system.

Group Shape To Image

  1. Even, while importing document, there is field named “Document Series Code” in which user need to enter Series Code defined for the series in Series Master and If above setting is not enabled, then user will not be able to assign series to any document and user need to manually enter in “Document Number” field.

Group Shape To Image













  1. Document Number field would be disabled if above setting is enabled and Document Series would be disabled if above settings is not enabled.
  2. While importing the document, system will throw validation according to above setting.








Restrict Single Document Per PDF

  1. Through this setting “Restrict Single Document Per PDF” Settings => System user can generate per document pdf rather than multiple document pdf in bulk pdf download.








Generate Duplicate / Triplicate Document Copies

  1. Through this setting user can generate Triplicate document copies for supply of goods and duplicate document copies for supply of services.

Group Shape To Image








Club Item Level Data in Download PDF    

  1. Through this setting user can club item level data displayed in E-Invoice and E-Way Bill PDF to be clubbed by combination of HSN, Description and UQC. If this setting is enabled, Item level will be clubbed by considering above combination and displayed in E-Invoice PDF.

Group Shape To Image







Auto-populate Business Partner Master    

  1. This setting will help user to auto-populate Business Partner master during import. If below setting is enabled then system will auto-populate Business Partner master during import.

Group Shape To Image












Settings-> Import

Import Settings -> Document

  1. Users will be able to access Document Settings from -> Settings -> Import -> Document.
  2. Below settings will impact Document Import only and Document Import Type settings are bifurcated as per below purposes.

a. Global

  1. Different settings will be available as per the above purpose and by selecting Purpose user will be able to access settings of that purpose.

Group Shape To Image







Edit Error Records

  1. User will be able to access Edit Error Records from More Features -> Settings -> Import -> Document Settings -> Edit Error Records.

Group Shape To Image






  1. Above setting is for allowing to edit error records of Document import type for every purpose.

Usage of Edit Error Records:

  1. Above setting is for Document import type and for all below purposes.
  1. EINV
  2. If the above setting is enabled, then only user will be able to edit Document Error records from Import -> Error -> Document as per below screen shot.


Group Shape To Image

  1. Also, the field in which error occurred will also be enabled and user will be able to edit error fields and save the records as per below screen shot.
Group Shape To Image

  1. If above setting is disabled, then user will not be able to edit any error records of the Document import type for any of the purpose.
  1. Users will be able to view the error records with validation message but will not be able to edit any error field as per below screen shot.






Auto-compute Document Value    

  1. If this setting is enabled, Document Value will be auto computed by performing subtraction of Document Discount from sum of all TotalTaxableAmount at line item level and then adding the calculated VAT amount to it and then adding charges amount at document level.
Group Shape To Image 






Auto-compute Payment Amount Due    

  1. Payment Amount Due will be auto computed by subtracting summation of each individual payment amounts from document value and addition of rounding amount. i.e Payment Amount Due = Document Value - (Summation of each individual payment amounts)+ Rounding Amount.

Group Shape To Image










Auto-compute Taxable Value

Taxable Value will be auto-computed by subtracting UnitDiscountAmount from Unit Price (Unit Price - UnitDiscountAmount).


Group Shape To Image



Auto-compute Total Taxable Amount










Auto-compute Total Taxable Amount

Total Taxable Amount will be auto-computed by performing computation as per (Quantity * TaxableAmount / BaseQuantity) +Charges Amount - DiscountAmount. However, if Total Taxable Amount is specified, it will not auto-compute and accept the value.

Group Shape To Image









Auto-compute Tax Amount

Tax Amount will be auto-computed by performing calculation of TotalTaxableAmount and Rate (Tax Amount = TotalTaxableAmount x (Rate/100)) if it is not specified. However, if a Tax Amount is specified, it will not auto- compute and accept the value.

Group Shape To Image








Auto-compute Total Amount

Item Total will be auto-computed by performing summation of Total Taxable Amount and Tax Amount of each individual item.






Bypass Country Code Validation
Country Code will be not be validated basis Transaction Type even if it is not an export invoice and system will accept any value added. However if this setting is turned off the value will be validated against the actual validations as required by ZATCA.
Group Shape To Image










Auto-compute Rate   

Rate will be auto-computed using Total Taxable Value and Tax Amounts if specified in the document. However, if a rate is specified, it will not auto-compute and accept the value.

Group Shape To Image








Auto-compute Rate    

Rate will be auto-computed using Total Taxable Value and Tax Amounts if specified in the document. However, if a rate is specified, it will not auto-compute and accept the value.

Group Shape To Image







Auto-rectify or Auto-Populate Rate    

Rate will be auto-rectified if incorrect details are furnished or auto-populated if no details are furnished during document import or manual creation depending on option selected below:

  1. HSN/SAC Code
  2. Product Code
Group Shape To Image




Validate Rate

Rate will be validated if incorrect rate is furnished during document import or manual creation depending on option selected below:

  1. HSN/SAC Code
  2. Product Code

Group Shape To Image






Auto-populate Business Partner Details    

Business Partner details will be auto-populated during document import or manual creation.

  1. Business Partner VRN /Name
  2. Business Partner Code


Group Shape To Image



Validate Business Partner

Business Partner data will be validated if it is not available in Business Partner master during document import or manual creation. If this setting is turned OFF, system will allow to import any Business Partner data without checking Business Partner master.

For B2B transactions VRN will be validated and for B2C transactions Name will be validated basis options selected below and purpose applicability.

  1. VRN
  2. Name
Group Shape To Image







Auto-rectify or Auto-Populate HSN Details    

HSN Details (HSN/ SAC Code, Name) will be auto-rectified if incorrect details are furnished or auto-populated if no details are furnished during document import based on option specified below:

  1. HSN/SAC Code
  2. Product Code

Group Shape To Image








Validate HSN/SAC

HSN/SAC will be validated if it is not available in HSN/SAC master during document import or manual creation. If this setting is turned OFF, system will allow to import any HSN/SAC code without checking HSN/SAC Master.

Group Shape To Image










Import Documents without Reference    

Display warning while importing Documents without Reference.

Group Shape To Image








Import CD Notes with Zero Amounts

Display warning while importing CD Notes having Document Value, Taxable Value and Tax Amounts as zero.

Group Shape To Image







Auto-populate Arabic Fields from Language Master    

Arabic Fields will be auto-populated depending upon the fields selected below

Group Shape To Image







Bypass Custom Fields Arabic value

Custom field Arabic value presence will not be validated by the system even if English value is available in Custom1 – Custom 10 field. However, if this setting is turned off, Arabic value presence will be validated against English value as required by ZATCA.

Group Shape To Image










Bypass Validation    

By enabling this setting, the system will not validate validations which are acceptable as warning on ZATCA system.


Group Shape To Image



Auto-populate Prepayment Document Details

Prepayment document details will be auto populated by furnished document number and document date time.

Group Shape To Image











Import Settings -> Document Action

Edit Error Records

Allow to edit imported data into application upon validation issues.

Group Shape To Image






















Import Settings -> Business Partner

Edit Error Records

  1. Allow to edit imported data into application upon validation issues.

Group Shape To Image












Import Settings -> HSN/SAC

Edit Error Records

  1. Allow to edit imported data into application upon validation issues.

Group Shape To Image









Import Settings -> Entities

Edit Error Records

  1. Allow to edit imported data into application upon validation issues.

Group Shape To Image










Import Settings -> Language Master


Edit Error Records

  1. Allow to edit imported data into application upon validation issues.

Group Shape To Image



















Document Settings -> Document Payment

Payment Status


Allows user to specify if the payment status needs to be synced from ESAL directly or from company ERP.

  1. ESAL
  2. Company ERP

Group Shape To Image

 







Restrict SADAD Generation    


Allows user to configure the generation of SADAD based on goods or services in the invoice.

  1. Allow For Goods
  2. Allow For Services

Group Shape To Image










Document Attachments check      

Allows user to restrict generation of SADAD Id unless Document Attachments are available.

  1. Optional
  2. Mandatory

Group Shape To Image












 SADAD Notifications    

Notifications will be sent via Email when SADAD ID is generated.

Group Shape To Image













Document Settings -> Document Print

User will be able to set the basic print details to be printed on the Document for particular document type and Entity or child Entity wise.

Group Shape To Image














Group Shape To Image

 













Header    
Users have the ability to print the header on the PDF by utilizing the Header option and uploading an image with dimensions of 595*50.

Group Shape To Image






The Header Will appear on top of the invoice PDF as shown in below image.




  1. Document Title    


User can mention the tile of the document to be printed on the pdf.

The Document Title will appear at the center of the invoice pdf. As shown in image below





  1. Logo    
Users have the option to include the logo in the PDF by utilizing the Logo feature and uploading an image with dimensions of 100*60.
Group Shape To Image
Group Shape To Image












  • Signatory Text (to override name, image & designation)    
    • If User Passes details in this field then it will override the details passed Signatory Name, Image & designation.

    Group Shape To Image









    With details passed in field:

    Group Shape To Image
















    Without details passed in field:

    Group Shape To Image



















    1. Signatory Name    

    User can pass the details in the fields, and it will be printed on the bottom left of the pdf, as shown below

    Group Shape To ImageGroup Shape To Image


















    1. Signature Image    

    The user can upload a signature which can be printed on the pdf, as shown in the image below.

    Group Shape To Image









    Group Shape To Image



    1. Signatory Designation    

    Group Shape To ImageGroup Shape To Image

















    1. Commercial Registration Number (CRN)    
    The User can mention the CRN to be printed on PDF, and it will be available on the pdf as shown below.

    Group Shape To Image


    Group Shape To Image

















    1. Email Subject    

    Group Shape To Image















    1. Account Details    
    Account details can be specified within the PDF by entering the information into this field, and it will be printed on the PDF as illustrated below.

    Group Shape To Image




    Group Shape To Image










    1. Export/Import Account Details    

    The Export / Import account details can be mentioned in the PDF By passing the details in this field and will be available on the pdf as shown below.

    Group Shape To ImageGroup Shape To Image











    1. Registered Address    

    The Registered address can be mentioned in the PDF. By passing the details in this field

    Users can mention the Registered address details which can be printed on the PDF as shown below.


    Group Shape To Image





    Group Shape To Image







    1. Registered Website    

    The Registered Website can be mentioned in the PDF. By passing the details in this field

    User can mention the Registered account details which can be printed on the PDF as shown below.


    Group Shape To ImageGroup Shape To Image












    1. Note    

    User can mention the notes which can be printed on the PDF as shown below.

    Group Shape To ImageGroup Shape To Image








    1. Footer    

    The User can print the Footer on the pdf, By using Footer option and uploading the image having dimension 595*50.

    Group Shape To Image













    1. Custom Fields    

    The User can toggle the Custom fields needs to be printed on the pdf and the same can be mapped from the Column Aliasing settings.

    Users can tick on the fields and click on the save button.

    Group Shape To Image


































    Document Settings -> Column Aliasing Settings

    Users can specify custom columns that will be printed on the PDF according to the fields defined by the user.

    Group Shape To Image

































    Document Settings -> Portal Settings

    1. Suppress Warnings    

    Warnings related to validations will be suppressed (will not be displayed) while uploading data from Portal if this setting is turned ON. However, if this setting is turned OFF, all the warnings related to validations will be displayed in Portal.

    Group Shape To Image















    Document Settings -> Enriched API Settings

    1. Suppress Deviation Warnings
    Deviation warnings related to Tax Amount Deviation and Document Value Deviation will be suppressed (will not be displayed) while uploading data via Enriched Api if this setting is turned ON. However, if this setting is turned OFF, all deviation related warnings will be returned in Enriched Api response.

    Group Shape To Image






    1. Persist Synchronous Import Document Errors    

    By enabling this setting, system will start preserving records which has errors during Synchronous enriched api calls.

    Group Shape To Image













    Document Settings -> Data Exchanger Settings

    1. Suppress Deviation Warnings

    Warnings related to validations will be suppressed (will not be displayed) while uploading data via Data Exchanger if this setting is turned ON. However, if this setting is turned OFF, all the warnings related to validations will be displayed in Data Exchanger.

    Group Shape To Image

     





    Override Import Processed File Format    

    Allows to override default .XLSX import processed file format when import is done via Data Exchanger. Choose any of the format from currently supported format:

    1. .XLS
    2. .XLSX
    3. .CSV
    4. .XML

    Group Shape To Image















    Document Settings -> Notifications

    1. E-Invoice Notifications

    Notifications will be sent via Email or SMS basis options selected below for different E-Invoice related activities.


    Group Shape To Image













    1. Daily E-invoice Summary Notification via E-mail    
    An email containing daily statistics and a summary of the current month will be sent to the specified email address as part of the daily notification. Users are required to set an email ID, and summary emails will be sent to the provided email address.

    Group Shape To Image