• Documentation >
• Apps >
• Business Operations and ERPs >
• Unleashed Software

Unleashed Software

With Unleashed Software modules in Ibexa Connect, you can create, update, list, retrieve, and delete:

• sales orders

• products

• customers

• credit notes and credit note lines

To get started with Unleashed Software, create an account at unleashedsoftware.com.

Connect Unleashed Software to Ibexa Connect

To connect to Unleashed Software, you need to obtain an API ID and API key from your unleashed software account.

1. Log in to your Unleashed Software account.

2. Click Integrations > Unleashed API Access and copy the API ID and API Key to a safe place.

   

3. In your Ibexa Connect account, insert Unleashed Software module in your scenario and click the Add button next to the Connection field.

   

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

5. In the API ID and API Key fields, enter the values copied in step 2 in the respective fields and click Save.

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

Sales Orders

You can list, retrieve, complete, update, and delete sales orders using the following modules.

List Sales Orders

Searches for sales orders or lists them all.

Customer ID	Select or map the Customer ID whose sales orders you want to list.
Limit	Set the maximum number of sales orders Ibexa Connect will return during one execution cycle.

For field descriptions, see the Unleashed Software API reference.

Get a Sales Order

Returns a specified sales order.

Sales Order GUID	Select or map the Sales Order GUID whose details you want to retrieve.

Complete a Sales Order

Completes a sales order.

Sales Order GUID	Select or map the Sales Order GUID you want to complete.

Update a Sales Order

Updates a sales order.

Sales Order GUID	Select or map the Sales Order GUID whose details you want to update.

For field descriptions, see the Unleashed Software API reference.

Delete a Sales Order

Deletes a sales order.

Sales Order GUID	Select or map the Sales Order GUID you want to delete.

Products

You can create, update, list, retrieve, and obsolete products using the following modules.

List Products

Searches for products or lists them all.

Group	Select the group whose products you want to list.
Limit	Set the maximum number of products Ibexa Connect will return during one execution cycle.

For field descriptions, see the Unleashed Software API reference.

Get a Product

Returns a specified product.

Product GUID	Select or map the Product GUID whose details you want to retrieve.

Create a Product

Creates a new product.

For field descriptions, see the Unleashed Software API reference.

Update a Product

Updates a specified product.

Product GUID	Select or map the Product GUID whose details you want to update.

Obsolete a Product

Obsoletes a product.

Product GUID	Select or map the Product GUID whom you want to obsolete.

Customers

You can create, update, list, and retrieve customers using the following modules.

List Customers

Searches for customers or lists them all.

Limit	Set the maximum number of customers Ibexa Connect will return during one execution cycle.

For field descriptions, see the Unleashed Software API reference.

Get a Customer

Returns a customer.

Customer GUID	Select or map the Customer ID whose details you want to retrieve.

Create a Customer

Creates a new customer.

For field descriptions, see the Unleashed Software API reference.

Update a Customer

Updates a specified customer.

GUID	Select or map the Customer ID whose details you want to update.

For field descriptions, see the Unleashed Software API reference.

Credit Notes

You can create, update, list, retrieve, complete, and delete credit notes using the following modules.

List Credit Notes

Searches for credit notes or lists them all.

Credit Status	Enter the credit status to list the credits for the specified status. For example, Completed.
Limit	Set the maximum number of credit notes Ibexa Connect will return during one execution cycle.

For field descriptions, see the Unleashed Software API reference.

Get a Credit Note

Returns a credit note.

Credit Note GUID	Select or map the Credit Note GUID whose details you want to retrieve.

Create a Credit Note

Create a free entry credit note.

For field descriptions, see the Unleashed Software API reference.

Update a Credit Note

Updates a credit note. Only free credits can be updated.

Credit Note GUID	Select or map the Credit Note GUID whose details you want to update.

For field descriptions, see the Unleashed Software API reference.

Complete a Credit Note

Completes a credit note.

Credit Note GUID	Select or map the Credit Note GUID you want to complete.

Delete a Credit Note

Deletes a credit note.

Credit Note GUID	Select or map the Credit Note GUID you want to delete.

Credit Notes

You can create, update, list, retrieve, complete, and delete credit notes using the following modules.

List Credit Notes

Searches for credit notes or lists them all.

Credit Status	Enter the credit status to list the credits for the specified status. For example, Completed.
Limit	Set the maximum number of credit notes Ibexa Connect will return during one execution cycle.

For field descriptions, see the Unleashed Software API reference.

Get a Credit Note

Returns a credit note.

Credit Note GUID	Select or map the Credit Note GUID whose details you want to retrieve.

Create a Credit Note

Create a free entry credit note.

For field descriptions, see the Unleashed Software API reference.

Update a Credit Note

Updates a credit note. Only free credits can be updated.

Credit Note GUID	Select or map the Credit Note GUID whose details you want to update.

For field descriptions, see the Unleashed Software API reference.

Complete a Credit Note

Completes a credit note.

Credit Note GUID	Select or map the Credit Note GUID you want to complete.

Delete a Credit Note

Deletes a credit note.

Credit Note GUID	Select or map the Credit Note GUID you want to delete.

Credit Note Lines

You can create, update, and delete credit note lines using the following modules.

Create a Credit Note Line

Creates credit note lines against an existing free entry credit note.

Credit Note GUID	Select or map the Credit Note GUID whose credit note line you want to create.

For field descriptions, see the Unleashed Software API reference.

Update a Credit Note Line

Updates credit note line from an existing free entry credit note.

Credit Note GUID	Select or map the Credit Note GUID whose credit note line you want to update.

For field descriptions, see the Unleashed Software API reference.

Delete a Credit Note Line

Deletes credit note line from an existing free entry credit note.

Credit Note GUID	Select or map the Credit Note GUID whose credit note line you want to delete.
Credit Note Line GUID	Enter the Credit Note Line GUID you want to delete.

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 Unleashed Software API documentation.

URL	Enter a path relative to https://api.unleashedsoftware.com. For example, /Companies.
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 - List Products

The following API call returns the list of products from your Unleashed Software account.

URL: /products

Method: GET

The search matches can be found in the module's Output under Bundle > items. Our example returned 14 products: