Skip to content
  • Documentation >
  • Apps >
  • Commerce >
  • QuickFile

QuickFile

With QuickFile modules in Ibexa Connect, you can:

  • search, retrieve, create, update, and delete clients

  • search, retrieve, create, update, and delete invoice

  • search and create bank accounts

To get started with QuickFile, create an account at Zendesk.com.

Connect QuickFile to Ibexa Connect

To connect QuickFile app, you need to obtain the Account Number, API Key, and Application ID.

  1. Log in to your QuickFile account.

  2. Copy the Account Number at the top right corner.

    QuickFile_3.png

  3. Click Account Settings > 3rd Party Integration > API. Copy the Account API Key to a safe place.

    QuickFile_2.png

  4. Click Account Settings > 3rd Party Integration > API > App ID. Copy the AppID to a safe place.

    QuickFile_4.png

  5. In your Ibexa Connect account, insert a QuickFile module in your scenario and click the Add button next to the Connection field.

    QuickFile_1.png

  6. In the Connection name field, enter a name for the connection.

  7. In the Account Number, API Key, and Application ID fields, enter the details copied in steps 2, 3, and 4. Click Save.

    You have successfully connected the QuickFile app and can now build scenarios.

Clients

You can search, retrieve, create, update, and delete clients using the following modules.

Search Clients

Searches for clients or lists them all.
Limit Set the maximum number of clients Ibexa Connect will return during one execution cycle. The default value is 10.

See QuickFile Client API reference for entering the field values to search the clients that match the specified value.

Get a Client

Retrieves client and contact data.
Client ID Select or map the Client ID whose details you want to retrieve.

For field descriptions, see the QuickFile API reference.

Create a Client

Creates a new client record.

For field descriptions, see the QuickFile API reference.

Update a Client

Updates an existing client record.
Client ID Select or map the Client ID whose details you want to update.

For field descriptions, see the QuickFile API reference.

Delete a Client

Deletes a client record.

For field descriptions, see the QuickFile API reference.

Invoices

You can search, retrieve, create, update, and delete invoices using the following modules.

Search Invoices

Searches for invoices or lists them all.
Limit Set the maximum number of invoices Ibexa Connect will return during one execution cycle. The default value is 10.

See QuickFile Invoice API reference for entering the field values to search the invoices that match the specified value.

Get an Invoice

Retrieves a single invoice, estimate, or recurring invoice template.

For field descriptions, see the QuickFile Invoice API reference.

Create an Invoice

Creates a new invoice, estimate, or recurring invoice template.

For field descriptions, see the QuickFile Invoice API reference.

Update an Invoice

Updates an invoice, estimate, or recurring invoice template.

For field descriptions, see the QuickFile Invoice API reference.

Delete an Invoice

Deletes an invoice, estimate, or recurring invoice template.

For field descriptions, see the QuickFile Invoice API reference.

Bank Accounts

You can search and create bank accounts using the following modules.

Search Bank Accounts

Searches for bank accounts or lists them all.
Limit Set the maximum number of bank accounts Ibexa Connect will return during one execution cycle. The default value is 10.

See QuickFile Bank Accounts API reference for entering the field values to search the invoices that match the specified value.

Create a Bank Account

Creates a new bank account.

For field descriptions, see the QuickFile API reference.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

Note

For the list of available endpoints, refer to the QuickFile API documentation.

URL

Enter a path relative to https://api.quickfile.co.uk. For example, /1_2/Client/Search.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of use - Search Invoices

The following API call returns all invoices from your account based on the specified criteria.

URL: /1_2/invoice/search

Method: POST

Body: { "SearchParameters": { "ReturnCount": "5", "Offset": "0", "OrderResultsBy": "InvoiceNumber", "OrderDirection": "ASC", "InvoiceType": "INVOICE" }}

quickfile-6.png

The search matches can be found in the module's Output under Bundle > Body > Invoice_Search > Body > Record.

In our example, a total of 74 invoices are returned with details showing of 5 as specified.

quickfile-5.png