About the ERPNext category

ERPNext is powered using Frappe Framework.
Add topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: ERPNext API Reference

Connector package documentation

​​Table of Contents

  • 1. Setting up HTTP Client ERPNext
    • 1.1 Steps
  • 2. Subscribing to entities from ERPNext
    • 2.1 Steps
    • 2.2 General concept
  • 3. Publishing entity to ERPNext
    • 3.1 Steps
    • 3.2 General concept

1. Setting up HTTP Client ERPNext

1.1 Steps

  1. In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “ERPNext HTTP Client” as the HTTP Client.
  2. Choose OAuth 2 for Authentication Type.
  3. Fill in the the Base URI Access Token URL, Authorize URL Client ID, Client Secret and Scope.
    (For more information, see ERPNext Oauth2 Authentication Reference)
  4. Click on “Grant access to ERPNext” and you will be redirected to approve the grant.
  5. You can optionally enable logging of request to get the log of the authentication.
  6. Save the HTTP Client for use.
  7. Alternatively, you can use Token Based Authentication. In that case, please select Token Based as Authentication Type, fill the Base URI and Token, then save the HTTP Client.
    (For more information, see ERPNext Token Based Authentication Reference)


2. Subscribing to Entities from ERPNext

2.1 Steps

  1. Go to Connections → Incoming and create a new incoming configuration and select “ERPNext Subscriber” as the subscriber.
  2. Select the entity you want to subscribe to from ERPNext.
  3. Add any request parameters needed to subscribe to the entity.
  4. Select the ERPNext HTTP Client to use.
  5. You can optionally add a transformer to transform the data into something you will be used to request from ERPNext.
  6. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept

We follow ERPNext documentation on building this connector, so you can easily use the connector based on ERPNext API Reference.

HTTP Client

The HTTP Client configuration you will use to access ERPNext.

Entity

The entity you want to subscribe to ERPNext. Please refer to the entities from ERPNext API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the ERPNext API Reference.

Please look at the example below on how to fill path field when subscribing “Retrieve a specific document by name (ID)” entity.

Based on the documentation, we can see that the end point require “doctype” and “name” as a parameter. That is why we set the “doctype” and “name” inside the path key in the Request Parameters.

Alumio will then make a request to ERPNext with the URL /api/resource/Lead/CRM-LEAD-2024-00001

  • Path is the path parameter of the url. For example the {id}.
  • Query is defined set of parameters attached to the end of a url.
    Example: www.url.com?type=true&start=0

3. Publishing Entity to ERPNext

3.1 Steps

  1. Go to Connections → Outgoing, create a new outgoing configuration and select “ERPNext Publisher” as the publisher.
  2. Select the Method that you want the publisher to perform with the data.
  3. Select the ERPNext entity you want the data to be published to.
  4. You can optionally add any query data to the request on the key query.
  5. You can optionally add any payload data to the request on the key payload.
  6. Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Method

Currently, we support HTTP Post method, Update HTTP Put method and HTTP Delete method on submitting data to ERPNext.

Entity

We support publishing to most ERPNext endpoints.
Please refer to ERPNext API Reference page.

For example, we want to add a new product. Please select “Post” as the Method and “Create a new document of this DocType” as the entity of the publisher.

Based on the documentation, it requires a “Request Body”. That is why we set the “Request Body” inside the payload key in the data.

image

Alumio will send an API request to ERPNext with URL /api/resource/Lead

Another example is when we want to delete a product by id. Please select “Delete” as the Action and “Delete a specific document by name (ID)” as the entity of the publisher.

Based on the documentation, we can see that the end point require “doctype” and “name” as a parameter. That is why we set the “doctype” and “name” inside the path key in the data.

image

Alumio will then make a request to ERPNext with the URL /api/resource/Lead/CRM-LEAD-2024-00001

  • Path is the path parameter of the url. For example the {id}.
  • Query is defined set of parameters attached to the end of a url.
    Example: www.url.com?type=true&start=0
  • Payload is the data contained within a request.

HTTP Client

The HTTP Client configuration you will use to access ERPNext.