Skip to main content

Config for erpnext

Jobs that use the erpnext adaptor may require authentication. A "credential" for the erpnext adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "baseUrl": "https://mycompany.erpnext.com"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "baseUrl": {
          "title": "Base URL",
          "type": "string",
          "description": "The base URL of your ERPNext instance",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://mycompany.erpnext.com"
          ]
      },
      "apiKey": {
          "title": "API Key",
          "type": "string",
          "description": "API Key (generate from ERPNext user profile)"
      },
      "apiSecret": {
          "title": "API Secret",
          "type": "string",
          "description": "API Secret (generated with API Key)",
          "writeOnly": true
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "baseUrl",
      "apiKey",
      "apiSecret"
  ]
}