Skip to content
D
Documentation

Apps

guide
3 min readUpdated

Applications › Apps

rocket_launch Apps

Overview

Use Apps (rocket_launch Apps) to access the application area of your installation and provide the required API key when prompted. Business owners, accountants, and financial administrators can use this area to locate application-related entries, including Company, Localisation, and Invoice, before continuing to the relevant business workflow.

Use the search fields to narrow the displayed entries when the available list is longer than the items you need to review.

Settings

Before saving changes on the Apps screen, enter a value in Enter API Key. This field is required.

Note: Do not leave Enter API Key blank. The screen identifies this field as required.

  1. Open Apps (rocket_launch Apps) from the application navigation.

    rocket_launch Apps
    rocket_launch Apps
Save
  1. Enter the required value in Enter API Key.

  2. Review the value before you save it. If it is not correct, revise the field before continuing.

  3. Select Save to save the API key.

Tip: Save the API key immediately after entering or revising it so that the screen does not retain an unsaved required value.

Workflow

  1. Open the Apps area.
    Select Apps (rocket_launch Apps) to display the Apps screen.

    rocket_launch Apps
    rocket_launch Apps
Save
  1. Decide whether you need to locate an entry or update the required key.

    • To find an entry, enter a term in one of the Type to search.. fields. Use a relevant term such as Company, Localisation, or Invoice to narrow what you are reviewing.
    • To update the required key, enter or revise the value in Enter API Key.
  2. Confirm the required information before saving.
    Check that Enter API Key contains the intended value. If the value needs correction, revise it before saving. Because the field is required, do not proceed with an empty value.

  3. Save the current configuration.
    Select Save when the API key is complete and the entries you need have been located.

    rocket_launch Apps
    rocket_launch Apps
Save
  1. Continue to the applicable application area.
    Use the available application entries to continue with the relevant work:
    • Company (business Company) for company-related work.
    • Localisation (flag Localisation) for localisation-related work.
    • Invoice (description Invoice) for invoice-related work.

Warning: The Apps screen provides a required API key field, but the available information does not describe the purpose or format of the key. Use the value provided by your organization and avoid substituting an unverified value.

Examples

A financial administrator needs to review the available application entries and save the API key provided for the business.

  1. The administrator opens Apps (rocket_launch Apps).

  2. In Type to search.., the administrator enters Invoice to locate the Invoice entry.

  3. The administrator enters the organization-provided value in Enter API Key.

  4. Before saving, the administrator verifies that the API key field is not blank and that the search term is appropriate for the entry being reviewed.

  5. The administrator selects Save.

  6. The administrator then selects Invoice (description Invoice) to continue to invoice-related work.

Tips

Tip: Use a specific search term, such as Company, Localisation, or Invoice, rather than a broad term, to make the Apps list easier to review.

Note: The screen includes multiple Type to search.. fields. Enter search text only in the field associated with the area you are reviewing.

Warning: If you change the API key, select Save before navigating away from the Apps screen.

Troubleshooting

SymptomLikely causeFix
You cannot complete the required information.Enter API Key is blank.Enter the API key in Enter API Key, then select Save.
You cannot find the application entry you need.The displayed entries have not been narrowed.Enter a relevant term in Type to search.., such as Company, Localisation, or Invoice.
Your changes are not retained.The updated value was not saved.Review Enter API Key and select Save before leaving the screen.

Was this page helpful?

Apps — Akaunting (Laravel fixture)