Skip to main content

AccountField

idstringrequired

Field ID

Used as the key for corresponding element of the accountFields dictionary when calling the CreateAccount method

Possible values: non-empty

Example: metadata-field
namestringrequired

User visible name of the field.

Possible values: non-empty

Example: Payment metadata field
shortDescriptionstringnullable

Short description of the field that can be displayed under or next to input fields.

Example: Start date
descriptionstringnullable

Detailed description of the field.

Example: Transactions are downloaded beginning from that date
requiredboolean

Whether or not the field is required.

If true, the field shold be present in the accountFields dictionary when calling the CreateAccount method

Example: false
requiredDuringAuthboolean

For account types with an OAuth flow, this defines if the value must be provided during creation of the OAuth URL.

Example: false
typeCredentialFieldType (string)

Data type of the field.

  • Auth: Accounts of that type require OAuth2 authentication.
  • Selection: The value of the field should be selected from the values array.

Possible values: [Text, Url, Auth, Password, Date, TextLine, Checkbox, Selection, File]

Example: Text
generatedboolean

If true, the value of the field is generated when the account is created.

Used for API keys and other credentials. The partner software should store the generated values and use them for future calls as values of account fields, provided while creating or updating an account.

Example: true
readOnlyboolean

The value of the field is read-only and cannot be changed.

Example: true
defaultValuestringnullable

Optional default value of the field that can be used to pre-fill the user input.

Example: 2021.11.29T00:00:00
values object[]nullable

If type is Selection then this array contains the available values.

  • Array [
    • namestringnullable

    Human readable name of the selection value.

    Example: Market place
    valuestringnullable

    Value of the selection for API usage.

    Example: amazon.de
  • ]
    • minValuestringnullable

    Minimum value.

    Example: -100
    maxValuestringnullable

    Maximum value.

    Example: 100
    requiredFieldsstring[]nullabledeprecated

    If type is Auth then the referenced fields are required in order to obtain the redirect URL.

    Example: ["start-date"]
    isDeprecatedboolean

    Whether the field is deprecated and should not be used anymore.

    Example: false
    deprecationReasonstringnullable

    Reason for the field deprecation and replacement.

    AccountField
    {
      "id": "metadata-field",
      "name": "Payment metadata field",
      "shortDescription": "Start date",
      "description": "Transactions are downloaded beginning from that date",
      "required": false,
      "requiredDuringAuth": false,
      "type": "Text",
      "generated": true,
      "readOnly": true,
      "defaultValue": "2021.11.29T00:00:00",
      "values": [
        {
          "name": "Market place",
          "value": "amazon.de"
        }
      ],
      "minValue": "-100",
      "maxValue": "100",
      "isDeprecated": false,
      "deprecationReason": "string"
    }