ERerply
v1

Save

NB: You cannot have 2 configurations with the same level,level_id, type, name and application level, level_id and type are optional fields.

post/configuration

Request

  • Base URL
    (relative, and it does not resolve against the document’s source URL)
  • Auth
    • API key in header sessionKey
    • or API key in header clientCode
    • or API key in header hmac-auth
    • or API key in header jwt
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

timestampstring

UNIX timestamp used for the HMAC Auth method only

Request body

applicationstring

Application (s) name that uses CAFA to store configs, application name has to be generated manually before it can be used in Identity Admin.

levelstring

Level is the operating level where the config will be stored. Has to be one of Company, Warehouse, Pos, User

level_idstring

LevelID is a unique value, used to identify the instance of the level. for User level, user id for Pos - Point of Sale ID. Each Pos belongs to Warehouse. When we query CAFA for configuration on level: 'Pos', and add 'Look-Deeper: true' header, if CAFA dooes not find any configuration with the query parameters, CAFA will use the level_id(PointOfSaleID), to find which Warehouse the Pos belongs to and check for configuration with the same name(and type if present) Warehouse can use any unique string to identify the instance of its level, because the higher level for each Warehouse is Company level, which can only be one instance per account Company level does not need level_id because there can only be one company per account in Erply.

namestring

Name of the configuration

typestring

Type is an optional grouping property, in this case its 'payment', indicating that this configuration belongs to payment integrations group used to query groups of related configurations

valueunknown

Example request

{
  "application": "woo-comm",
  "level": "Pos",
  "level_id": "1",
  "name": "adyen",
  "type": "payment"
}

Response

Created

idinteger
messagestring
statusCodestring

Changes

No recorded changes to this operation across all 1 revision of this API.