PlanMill API documentation version 1.5

Introduction to PlanMill API 1.5

PlanMill REST API 1.5 enables developers to access some of the core functionality of PlanMill CRM, project management, and ERP products.

Getting started with PlanMill API 1.5

Please read https://github.com/planmill/api/wiki/Getting-started

The API endpoint can be found in your PlanMill instance behind a URL like shown here:

https://{server}/{customer_instance}/api/{api_version}

Where 'server' and 'customer_instance' are replaced by the server address and customer instance name. For example, if your instance name is "abc" and it is hosted on online.planmill.com, the API version 1.5 endpoint would be:

https://online.planmill.com/abc/api/1.5

Recent changes

See https://help.planmill.com/help/release-notes

Other information

Read more in our wiki https://github.com/planmill/api/wiki

Check open issues or report a new https://github.com/planmill/api/issues

Clone us in Github https://github.com/planmill/api.git

Refer https://github.com/planmill/api/wiki/WebHooks for how to register hooks

/absences

Collection of available absences in PlanMill. See absences/meta for list of filters, columns and formats.

get post

get

Get a list of absences. See absences/meta for list of filters, columns and formats.

post

Add a new absence to PlanMill or update existing (if id is given). See absences/meta for list of columns and formats.

Add a new absence to PlanMill or update existing (if id is given). See absences/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all absence entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/absence" }
    },
    {
      "$ref": "#/definitions/absence"
    }
  ],
  "definitions": {
    "absence": {
      "type": "object",
      "required": [ "finish", "person", "start", "absenceType" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal ID of an absence"
        },
        "vacationYear": {
          "type": [ "integer", "null" ],
          "description": "Vacation year of the user"
        },
        "project": {
          "type": "integer",
          "description": ""
        },
        "accepterPerson": {
          "type": [ "integer", "null" ],
          "description": "Superior of user who accepts an absence"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of an absence"
        },
        "person": {
          "type": "integer",
          "description": "Absentee and user of a system"
        },
        "substitutePerson": {
          "type": [ "integer", "null" ],
          "description": "Superior of user who accepts an absence when actual superior of user is not available"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an absence"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of an absence"
        },
        "description": {
          "type": [ "string", "null" ],
          "description": "Description of an absence"
        },
        "absenceType": {
          "type": "integer",
          "description": "Type of an absence"
        },
        "vacationLength": {
          "type": "integer",
          "description": "Length of an absence represented in minutes"
        },
        "interruptionDate": {
          "type": [ "string", "null" ],
          "description": "Interruption date of an absence"
        },
        "created": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Creation date of an absence"
        },
        "modified": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Modification date of an absence"
        }
      }
    }
  }
}

Example:

{
  "accepterPerson": 2850921,
  "interruptionDate": null,
  "start": "2015-09-07T00:00:00.000+0300",
  "project": 2850931,
  "description": "child care leave",
  "vacationYear": null,
  "vacationLength": 450,
  "person": 2850921,
  "absenceType": 1130,
  "finish": "2015-09-07T00:00:00.000+0300",
  "id": 2850933,
  "substitutePerson": null,
  "status": 40
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for absences. Includes resource's fields names and type and related filters

get

View details of a single meta.

get post delete

A single absence in PlanMill.

get

View details of a single absence. See absences/meta for list of filters, columns and formats.

post

Update an existing resource absence to PlanMill. See absences/meta for list of filters, columns and formats.

delete

Remove a absence from PlanMill.

View details of a single absence. See absences/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • absence_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all absence entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/absence" }
    },
    {
      "$ref": "#/definitions/absence"
    }
  ],
  "definitions": {
    "absence": {
      "type": "object",
      "required": [ "finish", "person", "start", "absenceType" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal ID of an absence"
        },
        "vacationYear": {
          "type": [ "integer", "null" ],
          "description": "Vacation year of the user"
        },
        "project": {
          "type": "integer",
          "description": ""
        },
        "accepterPerson": {
          "type": [ "integer", "null" ],
          "description": "Superior of user who accepts an absence"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of an absence"
        },
        "person": {
          "type": "integer",
          "description": "Absentee and user of a system"
        },
        "substitutePerson": {
          "type": [ "integer", "null" ],
          "description": "Superior of user who accepts an absence when actual superior of user is not available"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an absence"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of an absence"
        },
        "description": {
          "type": [ "string", "null" ],
          "description": "Description of an absence"
        },
        "absenceType": {
          "type": "integer",
          "description": "Type of an absence"
        },
        "vacationLength": {
          "type": "integer",
          "description": "Length of an absence represented in minutes"
        },
        "interruptionDate": {
          "type": [ "string", "null" ],
          "description": "Interruption date of an absence"
        },
        "created": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Creation date of an absence"
        },
        "modified": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Modification date of an absence"
        }
      }
    }
  }
}

Example:

{
  "accepterPerson": 2850921,
  "interruptionDate": null,
  "start": "2015-09-07T00:00:00.000+0300",
  "project": 2850931,
  "description": "child care leave",
  "vacationYear": null,
  "vacationLength": 450,
  "person": 2850921,
  "absenceType": 1130,
  "finish": "2015-09-07T00:00:00.000+0300",
  "id": 2850933,
  "substitutePerson": null,
  "status": 40
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource absence to PlanMill. See absences/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • absence_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all absence entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/absence" }
    },
    {
      "$ref": "#/definitions/absence"
    }
  ],
  "definitions": {
    "absence": {
      "type": "object",
      "required": [ "finish", "person", "start", "absenceType" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal ID of an absence"
        },
        "vacationYear": {
          "type": [ "integer", "null" ],
          "description": "Vacation year of the user"
        },
        "project": {
          "type": "integer",
          "description": ""
        },
        "accepterPerson": {
          "type": [ "integer", "null" ],
          "description": "Superior of user who accepts an absence"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of an absence"
        },
        "person": {
          "type": "integer",
          "description": "Absentee and user of a system"
        },
        "substitutePerson": {
          "type": [ "integer", "null" ],
          "description": "Superior of user who accepts an absence when actual superior of user is not available"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an absence"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of an absence"
        },
        "description": {
          "type": [ "string", "null" ],
          "description": "Description of an absence"
        },
        "absenceType": {
          "type": "integer",
          "description": "Type of an absence"
        },
        "vacationLength": {
          "type": "integer",
          "description": "Length of an absence represented in minutes"
        },
        "interruptionDate": {
          "type": [ "string", "null" ],
          "description": "Interruption date of an absence"
        },
        "created": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Creation date of an absence"
        },
        "modified": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Modification date of an absence"
        }
      }
    }
  }
}

Example:

{
  "accepterPerson": 2850921,
  "interruptionDate": null,
  "start": "2015-09-07T00:00:00.000+0300",
  "project": 2850931,
  "description": "child care leave",
  "vacationYear": null,
  "vacationLength": 450,
  "person": 2850921,
  "absenceType": 1130,
  "finish": "2015-09-07T00:00:00.000+0300",
  "id": 2850933,
  "substitutePerson": null,
  "status": 40
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a absence from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • absence_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the absence

get

View details of a single meta.

View details of a single meta.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • absence_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "accepterPerson": {
    "caption": "Acceptor",
    "format": "int"
  },
  "interruptionDate": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Interruption date",
    "format": "string",
    "maxlength": "10",
    "values": null
  },
  "start": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Start",
    "format": "string",
    "values": null
  },
  "project": {
    "caption": "Project",
    "values": {
      "Absences 2011": "2691515"
    },
    "format": "int"
  },
  "description": {
    "caption": "",
    "format": "string",
    "values": null
  },
  "vacationYear": {
    "caption": "Vacation year",
    "values": {
      "-": ""
    },
    "format": "int"
  },
  "vacationLength": {
    "caption": "",
    "values": null
  },
  "person": {
    "caption": "Person",
    "values": {
      
    },
    "format": "int"
  },
  "absenceType": {
    "caption": "Absence type",
    "values": {
      "Military refresher": "1110",
      "Maternal leave (unpaid)": "1190",
      "Sick leave due to child": "1020",
      "Paid holiday": "1070",
      "Balance leave": "1090",
      "Sick leave by medical certificate": "1025",
      "Paternal leave (unpaid)": "1040",
      "-": "",
      "Study leave (unpaid)": "1140",
      "Annual holiday": "1000",
      "Maternal leave (paid)": "1030",
      "Layoff": "1120",
      "Overtime leave": "1080",
      "Bonus holiday pay": "1100",
      "Military leave": "1050",
      "Saved leave": "1165",
      "Sick leave": "1010",
      "Paternal leave (paid)": "1180",
      "Child care leave": "1130",
      "Unpaid holiday": "1060",
      "Other annual vacation": "1160"
    },
    "format": "int",
    "enumeration": "Enumeration values.Task.Absence offduty"
  },
  "finish": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Finish",
    "format": "string",
    "values": null
  },
  "id": {
    "caption": "",
    "format": "int",
    "values": null
  },
  "substitutePerson": {
    "description": "Substitute for acceptance handling during my absence",
    "caption": "Substitute",
    "values": {
      "Jim, Harris": "2752646",
      "Sara, Johnson": "580283",
      "Mike, Hike": "2828584"
    },
    "format": "int"
  },
  "status": {
    "caption": "Status"
  }
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/accounts

Collection of available accounts in PlanMill. See accounts/meta for list of filters, columns and formats.

get post

get

Get a list of accounts. See accounts/meta for list of filters, columns and formats.

post

Add a new account to PlanMill or update existing (if id is given). See accounts/meta for list of columns and formats.

Add a new account to PlanMill or update existing (if id is given). See accounts/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8
    )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: array of string

Example:

{
  "lineOfBusiness": null,
  "shippingCity": "Helsinki",
  "businessId": "123456",
  "vatId": "852645",
  "invoiceEmail": "invoice_email@planmill.com",
  "shippingPostalCode": 13233,
  "type": 100,
  "blog": "http://www.blog.com",
  "twitter": "http://www.twitter.com",
  "shippingCountry": 73,
  "invoiceChannel": 22,
  "rfReferenceNumber": 0,
  "billingCountry": 73,
  "id": 4635,
  "fax": "+358-46-333605",
  "supplierAccount": 353,
  "billingState": "",
  "serviceLevel": 0,
  "eInvoiceAddress": 123456,
  "autoReplyRequestMails": 1,
  "combineInvoices": 0,
  "reverseCharge": 10,
  "phone": "+358-46-334605",
  "name": "Test Account",
  "billingReference": "Finance Department",
  "shippingState": "",
  "termsOfPayment": 0,
  "billingLocationId": 4632,
  "handlingFee": 10,
  "invoiceVat": 24,
  "description": "<p>test description</p>",
  "shippingLocationId": 4633,
  "industry": 100000,
  "parentAccount": null,
  "ceo": "Hannu",
  "parentAccountName": null,
  "shippingReference": "HR department",
  "turnover": 100000,
  "email": "email@planmill.com",
  "owner": 4891,
  "website": "http://www.planmill.com",
  "facebook": "http://www.facebook.com",
  "staff": null,
  "passive": 0,
  "invoiceNetOperator": "NDEAFIHH",
  "billingPostalCode": "00500",
  "firstInvoiceNumber": 3000,
  "shippingAddress": "Siltasaarenkatu 18",
  "billingAddress": "Hämeentie 19",
  "billingCity": "Helsinki"
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for accounts. Includes resource's fields names and type and related filters

get

View details of a single meta.

get post delete

A single account in PlanMill.

get

View details of a single account. See accounts/meta for list of filters, columns and formats.

post

Update an existing resource account to PlanMill. See accounts/meta for list of filters, columns and formats.

delete

Remove a account from PlanMill.

View details of a single account. See accounts/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • account_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: string

Example:

{
  "lineOfBusiness": null,
  "shippingCity": "Helsinki",
  "businessId": "123456",
  "vatId": "852645",
  "invoiceEmail": "invoice_email@planmill.com",
  "shippingPostalCode": 13233,
  "type": 100,
  "blog": "http://www.blog.com",
  "twitter": "http://www.twitter.com",
  "shippingCountry": 73,
  "invoiceChannel": 22,
  "rfReferenceNumber": 0,
  "billingCountry": 73,
  "id": 4635,
  "fax": "+358-46-333605",
  "supplierAccount": 353,
  "billingState": "",
  "serviceLevel": 0,
  "eInvoiceAddress": 123456,
  "autoReplyRequestMails": 1,
  "combineInvoices": 0,
  "reverseCharge": 10,
  "phone": "+358-46-334605",
  "name": "Test Account",
  "billingReference": "Finance Department",
  "shippingState": "",
  "termsOfPayment": 0,
  "billingLocationId": 4632,
  "handlingFee": 10,
  "invoiceVat": 24,
  "description": "<p>test description</p>",
  "shippingLocationId": 4633,
  "industry": 100000,
  "parentAccount": null,
  "ceo": "Hannu",
  "parentAccountName": null,
  "shippingReference": "HR department",
  "turnover": 100000,
  "email": "email@planmill.com",
  "owner": 4891,
  "website": "http://www.planmill.com",
  "facebook": "http://www.facebook.com",
  "staff": null,
  "passive": 0,
  "invoiceNetOperator": "NDEAFIHH",
  "billingPostalCode": "00500",
  "firstInvoiceNumber": 3000,
  "shippingAddress": "Siltasaarenkatu 18",
  "billingAddress": "Hämeentie 19",
  "billingCity": "Helsinki"
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource account to PlanMill. See accounts/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • account_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: string

Example:

{
  "lineOfBusiness": null,
  "shippingCity": "Helsinki",
  "businessId": "123456",
  "vatId": "852645",
  "invoiceEmail": "invoice_email@planmill.com",
  "shippingPostalCode": 13233,
  "type": 100,
  "blog": "http://www.blog.com",
  "twitter": "http://www.twitter.com",
  "shippingCountry": 73,
  "invoiceChannel": 22,
  "rfReferenceNumber": 0,
  "billingCountry": 73,
  "id": 4635,
  "fax": "+358-46-333605",
  "supplierAccount": 353,
  "billingState": "",
  "serviceLevel": 0,
  "eInvoiceAddress": 123456,
  "autoReplyRequestMails": 1,
  "combineInvoices": 0,
  "reverseCharge": 10,
  "phone": "+358-46-334605",
  "name": "Test Account",
  "billingReference": "Finance Department",
  "shippingState": "",
  "termsOfPayment": 0,
  "billingLocationId": 4632,
  "handlingFee": 10,
  "invoiceVat": 24,
  "description": "<p>test description</p>",
  "shippingLocationId": 4633,
  "industry": 100000,
  "parentAccount": null,
  "ceo": "Hannu",
  "parentAccountName": null,
  "shippingReference": "HR department",
  "turnover": 100000,
  "email": "email@planmill.com",
  "owner": 4891,
  "website": "http://www.planmill.com",
  "facebook": "http://www.facebook.com",
  "staff": null,
  "passive": 0,
  "invoiceNetOperator": "NDEAFIHH",
  "billingPostalCode": "00500",
  "firstInvoiceNumber": 3000,
  "shippingAddress": "Siltasaarenkatu 18",
  "billingAddress": "Hämeentie 19",
  "billingCity": "Helsinki"
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a account from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • account_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the account

get

View details of a single meta.

View details of a single meta.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • account_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "lineOfBusiness": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "shippingCity": {
    "caption": "City",
    "format": "string",
    "description": "",
    "values": null
  },
  "businessId": {
    "caption": "Business ID",
    "format": "string",
    "description": "",
    "maxlength": "80",
    "values": null
  },
  "vatId": {
    "caption": "VAT Reg. No.",
    "format": "string",
    "description": "",
    "maxlength": "80",
    "values": null
  },
  "invoiceEmail": {
    "caption": "Invoice email",
    "format": "multiemail",
    "description": "",
    "maxlength": "180",
    "values": null
  },
  "shippingPostalCode": {
    "caption": "Postal/Zip code",
    "format": "string",
    "description": "",
    "values": null
  },
  "type": {
    "caption": "Type",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.Type",
    "values": {
      "Competitor": "2",
      "My company - other": "110",
      "Customer": "3",
      "Reseller": "9",
      "Vendor": "11",
      "-": "0",
      "Analyst": "1",
      "My company": "100",
      "Subcontractor": "12",
      "Integrator": "4",
      "Prospect": "8",
      "Investor": "5",
      "Partner": "6",
      "Press": "7",
      "Other": "10"
    }
  },
  "blog": {
    "caption": "Blog",
    "format": "url",
    "description": "",
    "maxlength": "255",
    "values": null
  },
  "twitter": {
    "caption": "Twitter",
    "format": "url",
    "description": "",
    "maxlength": "255",
    "values": null
  },
  "shippingCountry": {
    "caption": "Country",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Location.CountryId",
    "values": {
      "Papua New Guinea": "165",
      "Cambodia": "37",
      "Paraguay": "166",
      "�land Islands": "236",
      "Bahamas": "17",
      "Solomon Islands": "188",
      "Montserrat": "142",
      "Mali": "130",
      "Marshall Islands": "132",
      "Guadeloupe": "239",
      "Panama": "164",
      "Virgin Islands, British": "27",
      "Iran, Islamic Republic of": "98",
      "Tanzania, United Republic of": "205",
      "Argentina": "9",
      "Seychelles": "183",
      "Zambia": "233",
      "Belize": "23",
      "Bahrain": "19",
      "-": "0",
      "Guinea-Bissau": "89",
      "Namibia": "146",
      "Comoros": "50",
      "Faroe Islands": "71",
      "Finland": "73",
      "Netherlands Antilles": "150",
      "Georgia": "79",
      "French Southern territories": "258",
      "Saint Kitts and Nevis": "194",
      "Yemen": "235",
      "Eritrea": "67",
      "Puerto Rico": "171",
      "Viet Nam": "225",
      "Yugoslavia (discontinued)": "231",
      "Aruba": "11",
      "Madagascar": "126",
      "Svalbard and Jan Mayen": "254",
      "Saint Martin": "251",
      "South Georgia and the South Sandwich Islands": "253",
      "Sweden": "199",
      "Malawi": "127",
      "Cocos (Keeling) Islands": "260",
      "Andorra": "5",
      "Liechtenstein": "122",
      "Poland": "169",
      "Bulgaria": "34",
      "Jordan": "106",
      "Tunisia": "211",
      "Australian External Territories(discontinued)": "14",
      "Tuvalu": "214",
      "United Arab Emirates": "217",
      "Kenya": "108",
      "Yemen Arab Republic (North Yemen)(discontinued)": "230",
      "French Polynesia": "202",
      "Lebanon": "117",
      "Djibouti": "62",
      "Azerbaijan": "16",
      "Cuba": "55",
      "Czech Republic": "57",
      "Saint Lucia": "250",
      "Mauritania": "134",
      "Guernsey": "240",
      "Mayotte": "136",
      "Korea, Republic of (South Korea)": "111",
      "San Marino": "178",
      "Israel": "101",
      "Australia": "13",
      "Tajikistan": "204",
      "Other": "1000",
      "Myanmar": "145",
      "Cameroon": "38",
      "Gibraltar": "82",
      "Cyprus": "56",
      "Northern Mariana Islands": "159",
      "Saipan(double)": "177",
      "Malaysia": "128",
      "Oman": "161",
      "Iceland": "95",
      "Armenia": "10",
      "Macedonia, The former Yugoslav Republic of": "125",
      "Gabon": "77",
      "Luxembourg": "123",
      "Brazil": "31",
      "Turks and Caicos Islands": "255",
      "Algeria": "3",
      "Jersey": "247",
      "Slovenia": "187",
      "Antigua and Barbuda": "8",
      "Colombia": "49",
      "Ecuador": "63",
      "Cape Verdi(double)": "43",
      "Vanuatu": "222",
      "United States Minor Outlying Islands": "257",
      "Honduras": "92",
      "Italy": "102",
      "Antarctica": "237",
      "Nauru": "147",
      "Haiti": "91",
      "Afghanistan": "1",
      "Burundi": "36",
      "Russian Federation": "175",
      "Singapore": "185",
      "French Guiana": "76",
      "American Samoa": "4",
      "Christmas Island": "259",
      "Congo (Congo-Kinshasa)": "232",
      "Netherlands": "149",
      "China": "47",
      "Martinique": "133",
      "Palestinian Territory, Occupied": "244",
      "Saint Pierre and Miquelon": "195",
      "Kyrgyzstan": "114",
      "Bhutan": "26",
      "Romania": "174",
      "Falkland Islands (Malvinas)": "70",
      "Togo": "207",
      "Philippines": "168",
      "Uzbekistan": "221",
      "Holy See (Vatican City State)": "223",
      "Pitcairn": "248",
      "Zimbabwe": "234",
      "British Indian Ocean Territory": "59",
      "Montenegro": "242",
      "Dominica": "60",
      "Indonesia": "97",
      "Benin": "24",
      "Yemen (People's Democratic Republic of)(discontinued)": "229",
      "Angola": "6",
      "East Timor": "245",
      "Sudan": "196",
      "Brunei Darussalam": "33",
      "Portugal": "170",
      "New Caledonia": "152",
      "Grenada": "85",
      "Cayman Islands": "42",
      "Greece": "83",
      "Latvia": "115",
      "Mongolia": "141",
      "Congo (Congo-Brazzaville)": "51",
      "Morocco": "143",
      "Guatemala": "87",
      "Guyana": "90",
      "Iraq": "99",
      "Chile": "46",
      "Nepal": "148",
      "Heard Island and McDonald Islands": "241",
      "Isle of Man": "246",
      "Ukraine": "216",
      "Ghana": "81",
      "Anguilla": "7",
      "India": "96",
      "Canada": "39",
      "Maldives": "129",
      "Turkey": "212",
      "Belgium": "22",
      "C�te d?Ivoire": "103",
      "Khmer Republic (Cambodia/Kampuchea)(double)": "109",
      "South Africa": "190",
      "Trinidad and Tobago": "210",
      "Bermuda": "25",
      "Central African Republic": "44",
      "Lao People?s Democratic Republic": "116",
      "Jamaica": "104",
      "Peru": "167",
      "Turkmenistan": "213",
      "Germany": "80",
      "Korea, Democratic People?s Republic of (North Korea)": "112",
      "Fiji": "72",
      "Tokelau": "208",
      "Hong Kong": "93",
      "Guinea": "88",
      "United States": "220",
      "Micronesia, Federated States of": "138",
      "Chad": "45",
      "Somalia": "189",
      "Nevis(double)": "151",
      "Sao Tome and Principe": "179",
      "Thailand": "206",
      "Kiribati": "110",
      "Equatorial Guinea": "66",
      "Costa Rica": "53",
      "Kuwait": "113",
      "Nigeria": "156",
      "Croatia": "54",
      "Syrian Arab Republic": "201",
      "Cook Islands": "52",
      "Sri Lanka": "192",
      "Uruguay": "219",
      "United Kingdom": "218",
      "Switzerland": "200",
      "Samoa": "228",
      "Spain": "191",
      "Liberia": "119",
      "Venezuela": "224",
      "Burkina Faso": "35",
      "Virgin Islands, U.S.": "226",
      "Swaziland": "198",
      "Saint Barth�lemy": "249",
      "Palau": "163",
      "Estonia": "68",
      "Libyan Arab Jamahiriya": "121",
      "Kazakstan": "107",
      "Wallis and Futuna": "227",
      "Niue": "157",
      "Austria": "15",
      "Mozambique": "144",
      "El Salvador": "65",
      "Monaco": "140",
      "Guam": "86",
      "British V.I.(double)": "32",
      "Lesotho": "118",
      "Tonga": "209",
      "Western Sahara": "256",
      "R�union": "173",
      "Hungary": "94",
      "Japan": "105",
      "Belarus": "21",
      "Mauritius": "135",
      "Bouvet Island": "238",
      "Norfolk Island": "243",
      "Albania": "2",
      "New Zealand": "153",
      "Senegal": "181",
      "Moldova, Republic of": "139",
      "Ethiopia": "69",
      "Taiwan(double)": "203",
      "Egypt": "64",
      "Macau": "124",
      "Sierra Leone": "184",
      "North Korea(double)": "158",
      "Bolivia": "28",
      "Malta": "131",
      "Saudi Arabia": "180",
      "Cape Verde": "40",
      "Pakistan": "162",
      "Gambia": "78",
      "Qatar": "172",
      "Ireland": "100",
      "Slovakia": "186",
      "Lithuania": "120",
      "France": "74",
      "Serbia": "182",
      "Bosnia and Herzegovina": "29",
      "Taiwan, Province of China": "48",
      "Niger": "155",
      "French Antilles(discontinued)": "75",
      "Rwanda": "176",
      "Ascension Island(double,now part of  St. Helena)": "12",
      "Bangladesh": "20",
      "Barbados": "18",
      "Nicaragua": "154",
      "Norway": "160",
      "Saint Vincent and the Grenadines": "252",
      "Botswana": "30",
      "Denmark": "58",
      "Dominican Republic": "61",
      "Mexico": "137",
      "Uganda": "215",
      "Suriname": "197",
      "Greenland": "84",
      "Saint Helena": "193"
    }
  },
  "invoiceChannel": {
    "caption": "Invoice delivery channel",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Finance control.Invoice position summary.Invoices.Channel",
    "values": {
      "Email": "4",
      "Printing service": "1",
      "E-invoice": "2",
      "Manually": "3"
    }
  },
  "rfReferenceNumber": {
    "caption": "International RF-reference number",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.International RF-reference number",
    "values": {
      "No": "0",
      "Yes": "1"
    }
  },
  "billingCountry": {
    "caption": "Country",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Location.CountryId",
    "values": {
      "Papua New Guinea": "165",
      "Cambodia": "37",
      "Paraguay": "166",
      "�land Islands": "236",
      "Bahamas": "17",
      "Solomon Islands": "188",
      "Montserrat": "142",
      "Mali": "130",
      "Marshall Islands": "132",
      "Guadeloupe": "239",
      "Panama": "164",
      "Virgin Islands, British": "27",
      "Iran, Islamic Republic of": "98",
      "Tanzania, United Republic of": "205",
      "Argentina": "9",
      "Seychelles": "183",
      "Zambia": "233",
      "Belize": "23",
      "Bahrain": "19",
      "-": "0",
      "Guinea-Bissau": "89",
      "Namibia": "146",
      "Comoros": "50",
      "Faroe Islands": "71",
      "Finland": "73",
      "Netherlands Antilles": "150",
      "Georgia": "79",
      "French Southern territories": "258",
      "Saint Kitts and Nevis": "194",
      "Yemen": "235",
      "Eritrea": "67",
      "Puerto Rico": "171",
      "Viet Nam": "225",
      "Yugoslavia (discontinued)": "231",
      "Aruba": "11",
      "Madagascar": "126",
      "Svalbard and Jan Mayen": "254",
      "Saint Martin": "251",
      "South Georgia and the South Sandwich Islands": "253",
      "Sweden": "199",
      "Malawi": "127",
      "Cocos (Keeling) Islands": "260",
      "Andorra": "5",
      "Liechtenstein": "122",
      "Poland": "169",
      "Bulgaria": "34",
      "Jordan": "106",
      "Tunisia": "211",
      "Australian External Territories(discontinued)": "14",
      "Tuvalu": "214",
      "United Arab Emirates": "217",
      "Kenya": "108",
      "Yemen Arab Republic (North Yemen)(discontinued)": "230",
      "French Polynesia": "202",
      "Lebanon": "117",
      "Djibouti": "62",
      "Azerbaijan": "16",
      "Cuba": "55",
      "Czech Republic": "57",
      "Saint Lucia": "250",
      "Mauritania": "134",
      "Guernsey": "240",
      "Mayotte": "136",
      "Korea, Republic of (South Korea)": "111",
      "San Marino": "178",
      "Israel": "101",
      "Australia": "13",
      "Tajikistan": "204",
      "Other": "1000",
      "Myanmar": "145",
      "Cameroon": "38",
      "Gibraltar": "82",
      "Cyprus": "56",
      "Northern Mariana Islands": "159",
      "Saipan(double)": "177",
      "Malaysia": "128",
      "Oman": "161",
      "Iceland": "95",
      "Armenia": "10",
      "Macedonia, The former Yugoslav Republic of": "125",
      "Gabon": "77",
      "Luxembourg": "123",
      "Brazil": "31",
      "Turks and Caicos Islands": "255",
      "Algeria": "3",
      "Jersey": "247",
      "Slovenia": "187",
      "Antigua and Barbuda": "8",
      "Colombia": "49",
      "Ecuador": "63",
      "Cape Verdi(double)": "43",
      "Vanuatu": "222",
      "United States Minor Outlying Islands": "257",
      "Honduras": "92",
      "Italy": "102",
      "Antarctica": "237",
      "Nauru": "147",
      "Haiti": "91",
      "Afghanistan": "1",
      "Burundi": "36",
      "Russian Federation": "175",
      "Singapore": "185",
      "French Guiana": "76",
      "American Samoa": "4",
      "Christmas Island": "259",
      "Congo (Congo-Kinshasa)": "232",
      "Netherlands": "149",
      "China": "47",
      "Martinique": "133",
      "Palestinian Territory, Occupied": "244",
      "Saint Pierre and Miquelon": "195",
      "Kyrgyzstan": "114",
      "Bhutan": "26",
      "Romania": "174",
      "Falkland Islands (Malvinas)": "70",
      "Togo": "207",
      "Philippines": "168",
      "Uzbekistan": "221",
      "Holy See (Vatican City State)": "223",
      "Pitcairn": "248",
      "Zimbabwe": "234",
      "British Indian Ocean Territory": "59",
      "Montenegro": "242",
      "Dominica": "60",
      "Indonesia": "97",
      "Benin": "24",
      "Yemen (People's Democratic Republic of)(discontinued)": "229",
      "Angola": "6",
      "East Timor": "245",
      "Sudan": "196",
      "Brunei Darussalam": "33",
      "Portugal": "170",
      "New Caledonia": "152",
      "Grenada": "85",
      "Cayman Islands": "42",
      "Greece": "83",
      "Latvia": "115",
      "Mongolia": "141",
      "Congo (Congo-Brazzaville)": "51",
      "Morocco": "143",
      "Guatemala": "87",
      "Guyana": "90",
      "Iraq": "99",
      "Chile": "46",
      "Nepal": "148",
      "Heard Island and McDonald Islands": "241",
      "Isle of Man": "246",
      "Ukraine": "216",
      "Ghana": "81",
      "Anguilla": "7",
      "India": "96",
      "Canada": "39",
      "Maldives": "129",
      "Turkey": "212",
      "Belgium": "22",
      "C�te d?Ivoire": "103",
      "Khmer Republic (Cambodia/Kampuchea)(double)": "109",
      "South Africa": "190",
      "Trinidad and Tobago": "210",
      "Bermuda": "25",
      "Central African Republic": "44",
      "Lao People?s Democratic Republic": "116",
      "Jamaica": "104",
      "Peru": "167",
      "Turkmenistan": "213",
      "Germany": "80",
      "Korea, Democratic People?s Republic of (North Korea)": "112",
      "Fiji": "72",
      "Tokelau": "208",
      "Hong Kong": "93",
      "Guinea": "88",
      "United States": "220",
      "Micronesia, Federated States of": "138",
      "Chad": "45",
      "Somalia": "189",
      "Nevis(double)": "151",
      "Sao Tome and Principe": "179",
      "Thailand": "206",
      "Kiribati": "110",
      "Equatorial Guinea": "66",
      "Costa Rica": "53",
      "Kuwait": "113",
      "Nigeria": "156",
      "Croatia": "54",
      "Syrian Arab Republic": "201",
      "Cook Islands": "52",
      "Sri Lanka": "192",
      "Uruguay": "219",
      "United Kingdom": "218",
      "Switzerland": "200",
      "Samoa": "228",
      "Spain": "191",
      "Liberia": "119",
      "Venezuela": "224",
      "Burkina Faso": "35",
      "Virgin Islands, U.S.": "226",
      "Swaziland": "198",
      "Saint Barth�lemy": "249",
      "Palau": "163",
      "Estonia": "68",
      "Libyan Arab Jamahiriya": "121",
      "Kazakstan": "107",
      "Wallis and Futuna": "227",
      "Niue": "157",
      "Austria": "15",
      "Mozambique": "144",
      "El Salvador": "65",
      "Monaco": "140",
      "Guam": "86",
      "British V.I.(double)": "32",
      "Lesotho": "118",
      "Tonga": "209",
      "Western Sahara": "256",
      "R�union": "173",
      "Hungary": "94",
      "Japan": "105",
      "Belarus": "21",
      "Mauritius": "135",
      "Bouvet Island": "238",
      "Norfolk Island": "243",
      "Albania": "2",
      "New Zealand": "153",
      "Senegal": "181",
      "Moldova, Republic of": "139",
      "Ethiopia": "69",
      "Taiwan(double)": "203",
      "Egypt": "64",
      "Macau": "124",
      "Sierra Leone": "184",
      "North Korea(double)": "158",
      "Bolivia": "28",
      "Malta": "131",
      "Saudi Arabia": "180",
      "Cape Verde": "40",
      "Pakistan": "162",
      "Gambia": "78",
      "Qatar": "172",
      "Ireland": "100",
      "Slovakia": "186",
      "Lithuania": "120",
      "France": "74",
      "Serbia": "182",
      "Bosnia and Herzegovina": "29",
      "Taiwan, Province of China": "48",
      "Niger": "155",
      "French Antilles(discontinued)": "75",
      "Rwanda": "176",
      "Ascension Island(double,now part of  St. Helena)": "12",
      "Bangladesh": "20",
      "Barbados": "18",
      "Nicaragua": "154",
      "Norway": "160",
      "Saint Vincent and the Grenadines": "252",
      "Botswana": "30",
      "Denmark": "58",
      "Dominican Republic": "61",
      "Mexico": "137",
      "Uganda": "215",
      "Suriname": "197",
      "Greenland": "84",
      "Saint Helena": "193"
    }
  },
  "id": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "fax": {
    "description": "e.g. +xxx-xx-xxxx",
    "caption": "Fax",
    "format": "phone",
    "maxlength": "80",
    "values": null
  },
  "supplierAccount": {
    "caption": "Supplier",
    "values": {
      "PlanMill Oy": "2782784",
      "-": "-1"
    },
    "format": "int",
    "description": ""
  },
  "billingState": {
    "caption": "State",
    "format": "string",
    "description": "",
    "values": null
  },
  "serviceLevel": {
    "caption": "Service level",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.Service level",
    "values": {
      "No agreements": "0",
      "Gold Care": "2",
      "Platinum Care": "3",
      "Silver Care": "1"
    }
  },
  "invoiceNetAddress": {
    "caption": "Invoice net address",
    "description": "",
    "maxlength": "80",
    "values": null
  },
  "autoReplyRequestMails": {
    "caption": "Auto-reply request mails",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Administration.Jobs.Enabled",
    "values": {
      "No": "0",
      "Yes": "1"
    }
  },
  "combineInvoices": {
    "caption": "Combine invoices",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Administration.Jobs.Enabled",
    "values": {
      "No": "0",
      "Yes": "1"
    }
  },
  "reverseCharge": {
    "caption": "Reverse charge",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.Reverse charge",
    "values": {
      "0,0 % VAT Reverse charge": "10"
    }
  },
  "phone": {
    "description": "e.g. +xxx-xx-xxxx",
    "caption": "Phone",
    "format": "phone",
    "maxlength": "80",
    "values": null
  },
  "billingReference": {
    "description": "Maximum length of 'Your reference' is 35 characters because of Finvoice standard (Finvoice standard supports only 35 characters)",
    "caption": "Billing Department/Reference",
    "maxlength": "35",
    "values": null
  },
  "shippingState": {
    "caption": "State",
    "format": "string",
    "description": "",
    "values": null
  },
  "termsOfPayment": {
    "caption": "Terms of payment",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.Terms of Payment",
    "values": {
      "180 days net": "180",
      "Immediately": "0",
      "14 days net": "14",
      "45 days net": "45",
      "28 days net": "28",
      "30 days net": "30",
      "120 days net": "120",
      "7 days net": "7",
      "60 days net": "60",
      "90 days net": "90",
      "21 days net": "21"
    }
  },
  "billingLocationId": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "handlingFee": {
    "caption": "Handling fee",
    "format": "double",
    "description": "",
    "values": null
  },
  "invoiceVat": {
    "caption": "VAT",
    "description": "",
    "enumeration": "Enumeration values.Finance control.Invoice position summary.Invoices.VAT",
    "values": {
      "12%": "12.0",
      "9%": "9.0",
      "17,5 %": "17.5",
      "13 %": "13.0",
      "24 %": "24.0",
      "23 %": "23.0",
      "22 %": "22.0",
      "10 %": "10.0",
      "21 %": "21.0",
      "20 %": "20.0",
      "0 %": "0.0",
      "5 %": "5.0",
      "19 %": "19.0",
      "18 %": "18.0",
      "7 %": "7.0",
      "17 %": "17.0",
      "8 %": "8.0",
      "15 %": "15.0",
      "14 %": "14.0",
      "25 %": "25.0"
    }
  },
  "description": {
    "format": "string",
    "description": "",
    "values": null
  },
  "shippingLocationId": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "industry": {
    "caption": "Industry",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.Industry",
    "values": {
      "74 Other prof. services": "74",
      "J ICT": "100900",
      "61 Telecommunication": "61",
      "Q Health&Social work": "101600",
      "I Acc.dation&Food": "100800",
      "6209 Other IT services": "6209",
      "71 Architecture&Eng": "71",
      "O Public administr.": "101400",
      "U Extraterr.org.&bodies": "102000",
      "S Other Service": "101800",
      "E Water & Waste": "100400",
      "72 Sc. Research": "72",
      "F Construction": "100500",
      "K Finance&Insurance": "101000",
      "62 Software&IT serv": "62",
      "B Mining&Quarrying": "100100",
      "X Industry unknown": "102100",
      "H Transport&storage": "100700",
      "N Admin&Support": "101300",
      "6203 IT Facilities": "6203",
      "R Arts, ent.&recreation": "101700",
      "75 Veterinary": "75",
      "69 Legal&Accounting": "69",
      "A Agric and Forestry": "100000",
      "58 Publishing": "58",
      "73 Adv&Marketing": "73",
      "63 Inform. services": "63",
      "L Real Estate": "101100",
      "C Manufacturing": "100200",
      "M Prof. services": "101200",
      "-": "-1",
      "59 Movies & sound pr.": "59",
      "6202 IT Consulting": "6202",
      "T Households as empl.": "101900",
      "G Wholesale&Retail": "100600",
      "6201 Programming": "6201",
      "P Education": "101500",
      "D Electricity Gas etc": "100300",
      "70 Mgmt consultancy": "70",
      "60 Broadcasting": "60"
    }
  },
  "parentAccount": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "ceo": {
    "caption": "CEO",
    "maxlength": "50",
    "values": null
  },
  "parentAccountName": {
    "caption": "Parent account",
    "format": "string",
    "description": "",
    "values": null
  },
  "ediCode": {
    "caption": "EDI/OVT-code",
    "description": "",
    "maxlength": "20",
    "values": null
  },
  "shippingReference": {
    "caption": "Shipping Department/Reference",
    "format": "string",
    "description": "",
    "values": null
  },
  "turnover": {
    "description": "This field supports currently only euros, we will add full currency support later. Please fill in turnover in 1000s of euros",
    "caption": "Turnover K�",
    "format": "int",
    "values": null
  },
  "email": {
    "caption": "Email",
    "format": "string",
    "description": "",
    "maxlength": "80",
    "values": null
  },
  "owner": {
    "caption": "Account owner",
    "values": {
      "Admin, Test": "2833",
      "EmployeeLastName, EmployeeFirstName": "2697"
    },
    "format": "int",
    "description": ""
  },
  "website": {
    "caption": "Website",
    "format": "url",
    "description": "",
    "maxlength": "150",
    "values": null
  },
  "facebook": {
    "caption": "Facebook",
    "format": "url",
    "description": "",
    "maxlength": "255",
    "values": null
  },
  "staff": {
    "caption": "Personnel",
    "format": "int",
    "description": "",
    "values": null
  },
  "passive": {
    "caption": "Status",
    "format": "int",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.Status",
    "values": {
      "Active": "0",
      "Inactive": "1"
    }
  },
  "invoiceNetOperator": {
    "caption": "Intermediator",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Accounts.Invoice net operator",
    "values": {
      "Tapiola Pankki (TAPIFI22)": "130",
      "InExchange Factorum AB (INEXCHANGE)": "250",
      "Maventa Oy (MAVENTA)": "190",
      "Danske Bank Oyj (DABAFIHH)": "100",
      "Handelsbanken (HANDFIHH)": "120",
      "OpusCapita Group Oy (003710948874)": "60",
      "�landsbanken (AABAFI22) - Bank of �land": "140",
      "Paikallisosuuspankit (POPFFI22)": "90",
      "Aktia S��st�pankki Oyj (HELSFIHH)": "150",
      "Tradeshift (00885060259470028)": "220",
      "S��st�pankit (ITELFIHH)": "240",
      "BasWare Oyj (BAWCFI22)": "30",
      "Pagero (PAGERO)": "230",
      "TeliaSonera Finland Oyj (003714756079)": "160",
      "CGI (003703575029)": "180",
      "Nordea (NDEAFIHH)": "70",
      "Liaison Technologies Oy (003708599126)": "10",
      "OP-ryhm� (OKOYFIHH)": "80",
      "Tieto Oyj (003701011385)": "170",
      "Enfo Zender Oy (003714377140)": "50",
      "Svenska Handelsbanken AB (HANDFIHH)": "110",
      "Apix Messaging Oy (00372332748700001)": "210",
      "Notebeat Oy (003717203971)": "200"
    }
  },
  "billingPostalCode": {
    "caption": "Postal/Zip code",
    "format": "string",
    "description": "",
    "values": null
  },
  "firstInvoiceNumber": {
    "caption": "First invoice number",
    "format": "string",
    "description": "",
    "maxlength": "11",
    "values": null
  },
  "shippingAddress": {
    "caption": "Address (shipping)",
    "format": "string",
    "description": "",
    "values": null
  },
  "billingAddress": {
    "description": "(billing or visiting)",
    "caption": "Address",
    "format": "string",
    "values": null
  },
  "billingCity": {
    "caption": "City",
    "format": "string",
    "description": "",
    "values": null
  }
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Collection of available attachments in PlanMill. This is a read-only collection.

get

Get a list of attachments

Get a list of attachments

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • account_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
    {
        "size": 447,
        "createdBy": 50,
        "created": "2019-02-21T10:31:19.170+0200",
        "name": "attached_file_test.txt",
        "modified": "2019-02-21T12:04:05.007+0200",
        "id": 1514
    },
    {
        "size": 466,
        "createdBy": 50,
        "created": "2019-02-21T12:04:05.017+0200",
        "name": "attached_file.txt",
        "modified": "2019-02-21T12:04:05.017+0200",
        "id": 1515
    }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

put get

put
get

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • account_id: required(string)
  • attachment_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • account_id: required(string)
  • attachment_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

Contents of file

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/actions

Collection of available actions in PlanMill. See actions/meta for list of filters, columns and formats.

get post

get

Get a list of actions. See actions/meta for list of filters, columns and formats.

post

Add a new action to PlanMill or update existing (if id is given). See actions/meta for list of columns and formats.

Add a new action to PlanMill or update existing (if id is given). See actions/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all action entities",
  "oneOf": [{
    "type": "array",
    "items": {
      "$ref": "#/definitions/actionArray"
    }
  }, {
    "$ref": "#/definitions/actionSingle" 
  }],
  "definitions": {
    "actionSingle": {
      "type": "object",
      "required": ["subject"],
      "properties": {
        "request": {
          "type": ["string", "null"],
          "description": "Action's request"
        },
        "private": {
          "type": ["integer", "null"],
          "description": "Action's view status: 0=No, 1=Yes"
        },
        "performers": {
          "type": ["string", "null"],
          "description": "List of action's performers"
        },
        "reminder": {
          "type": ["integer", "null"],
          "description": "Action's reminder: 0=No, 1=Same day as due date, 2=1 day before due date, 3= 3 days before due date, 4= 7 days before due date, 5= 14 days before due date, 6= 30 days before due date"
        },
        "subject": {
          "type": "string",
          "description": "Action's subject"
        },
        "dueDate": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's due date"
        },
        "start": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's start date"
        },
        "description": {
          "type": ["string", "null"],
          "description": "Action description"
        },
        "project": {
          "type": ["string", "null"],
          "description": "Action's project"
        },
        "opportunity": {
          "type": ["string", "null"],
          "description": "Action's opportunity"
        },
        "type": {
          "type": ["integer", "null"],
          "description": "Action's type: 0= None, 1= Call, 2=Correspondence, 3= Demo, 4= Email, 5= Event, 6= Fax, 7= Meeting, 9= Presentation, 10= Todo, 11= Webinar"
        },
        "priority": {
          "type": ["integer", "null"],
          "description": "Action priority: 1= High, 2= Medium, 3= Low "
        },
        "salesOrder": {
          "type": ["string", "null"],
          "description": "Action's sales order"
        },
        "responsible": {
          "type": ["integer", "null"],
          "description": "Person responsible for the action"
        },
        "contact": {
          "type": ["integer", "null"],
          "description": "Action's contact"
        },
        "campaign": {
          "type": ["string", "null"],
          "description": "Action's campaign"
        },
        "location": {
          "type": ["string", "null"],
          "description": "Action's location"
        },
        "id": {
          "type": "integer",
          "description": "action id"
        },
        "status": {
          "type": ["integer", "null"],
          "description": "Action's status: 0= Received, 1= In progress, 2= In progress -waiting for more info, 4= Suspended, 40= Completed"
        }
      }
    },
    "actionArray": {
      "type": "object",
      "required": ["subject"],
      "properties": {
        "request": {
          "type": ["string", "integer", "null"],
          "description": "Action's request"
        },
        "private": {
          "type": ["integer", "null"],
          "description": "Action's view status: 0=No, 1=Yes"
        },
        "performers": {
          "type": ["string", "null"],
          "description": "List of action's performers"
        },
        "reminder": {
          "type": ["integer", "null"],
          "description": "Action's reminder: 0=No, 1=Same day as due date, 2=1 day before due date, 3= 3 days before due date, 4= 7 days before due date, 5= 14 days before due date, 6= 30 days before due date"
        },
        "subject": {
          "type": "string",
          "description": "Action's subject"
        },
        "dueDate": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's due date"
        },
        "start": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's start date"
        },
        "project": {
          "type": ["string", "integer", "null"],
          "description": "Action's project"
        },
        "opportunity": {
          "type": ["string", "integer", "null"],
          "description": "Action's opportunity"
        },
        "type": {
          "type": ["integer", "null"],
          "description": "Action's type: 0= None, 1= Call, 2=Correspondence, 3= Demo, 4= Email, 5= Event, 6= Fax, 7= Meeting, 9= Presentation, 10= Todo, 11= Webinar"
        },
        "priority": {
          "type": ["integer", "null"],
          "description": "Action priority: 1= High, 2= Medium, 3= Low "
        },
        "salesOrder": {
          "type": ["string", "integer", "null"],
          "description": "Action's sales order"
        },
        "responsible": {
          "type": ["integer", "null"],
          "description": "Person responsible for the action"
        },
        "contact": {
          "type": ["integer", "null"],
          "description": "Action's contact"
        },
        "campaign": {
          "type": ["string", "integer", "null"],
          "description": "Action's campaign"
        },
        "location": {
          "type": ["string", "null"],
          "description": "Action's location"
        },
        "id": {
          "type": "integer",
          "description": "action id"
        },
        "status": {
          "type": ["integer", "null"],
          "description": "Action's status: 0= Received, 1= In progress, 2= In progress -waiting for more info, 4= Suspended, 40= Completed"
        }
      }
    }
  }
}

Example:

{
  "request": 6875,
  "private": 0,
  "performers": "5547,50",
  "reminder": 1,
  "subject": "Test Action",
  "dueDate": "2015-06-26T10:08:00.000+0300",
  "start": "2015-06-26T10:08:00.000+0300",
  "description": "<p>test description</p>",
  "project": 9851,
  "opportunity": 3257,
  "type": 5,
  "priority": 2,
  "salesOrder": 6981,
  "responsible": 28482,
  "contact": 9647,
  "campaign": 5214,
  "location": "Oulu",
  "id": 2842904,
  "status": 1
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for actions. Includes resource's fields names and type and related filters

get

View details of a single meta.

get post delete

A single action in PlanMill.

get

View details of a single action. See actions/meta for list of filters, columns and formats.

post

Update an existing resource action to PlanMill. See actions/meta for list of filters, columns and formats.

delete

Remove a action from PlanMill.

View details of a single action. See actions/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • action_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all action entities",
  "oneOf": [{
    "type": "array",
    "items": {
      "$ref": "#/definitions/actionArray"
    }
  }, {
    "$ref": "#/definitions/actionSingle" 
  }],
  "definitions": {
    "actionSingle": {
      "type": "object",
      "required": ["subject"],
      "properties": {
        "request": {
          "type": ["string", "null"],
          "description": "Action's request"
        },
        "private": {
          "type": ["integer", "null"],
          "description": "Action's view status: 0=No, 1=Yes"
        },
        "performers": {
          "type": ["string", "null"],
          "description": "List of action's performers"
        },
        "reminder": {
          "type": ["integer", "null"],
          "description": "Action's reminder: 0=No, 1=Same day as due date, 2=1 day before due date, 3= 3 days before due date, 4= 7 days before due date, 5= 14 days before due date, 6= 30 days before due date"
        },
        "subject": {
          "type": "string",
          "description": "Action's subject"
        },
        "dueDate": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's due date"
        },
        "start": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's start date"
        },
        "description": {
          "type": ["string", "null"],
          "description": "Action description"
        },
        "project": {
          "type": ["string", "null"],
          "description": "Action's project"
        },
        "opportunity": {
          "type": ["string", "null"],
          "description": "Action's opportunity"
        },
        "type": {
          "type": ["integer", "null"],
          "description": "Action's type: 0= None, 1= Call, 2=Correspondence, 3= Demo, 4= Email, 5= Event, 6= Fax, 7= Meeting, 9= Presentation, 10= Todo, 11= Webinar"
        },
        "priority": {
          "type": ["integer", "null"],
          "description": "Action priority: 1= High, 2= Medium, 3= Low "
        },
        "salesOrder": {
          "type": ["string", "null"],
          "description": "Action's sales order"
        },
        "responsible": {
          "type": ["integer", "null"],
          "description": "Person responsible for the action"
        },
        "contact": {
          "type": ["integer", "null"],
          "description": "Action's contact"
        },
        "campaign": {
          "type": ["string", "null"],
          "description": "Action's campaign"
        },
        "location": {
          "type": ["string", "null"],
          "description": "Action's location"
        },
        "id": {
          "type": "integer",
          "description": "action id"
        },
        "status": {
          "type": ["integer", "null"],
          "description": "Action's status: 0= Received, 1= In progress, 2= In progress -waiting for more info, 4= Suspended, 40= Completed"
        }
      }
    },
    "actionArray": {
      "type": "object",
      "required": ["subject"],
      "properties": {
        "request": {
          "type": ["string", "integer", "null"],
          "description": "Action's request"
        },
        "private": {
          "type": ["integer", "null"],
          "description": "Action's view status: 0=No, 1=Yes"
        },
        "performers": {
          "type": ["string", "null"],
          "description": "List of action's performers"
        },
        "reminder": {
          "type": ["integer", "null"],
          "description": "Action's reminder: 0=No, 1=Same day as due date, 2=1 day before due date, 3= 3 days before due date, 4= 7 days before due date, 5= 14 days before due date, 6= 30 days before due date"
        },
        "subject": {
          "type": "string",
          "description": "Action's subject"
        },
        "dueDate": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's due date"
        },
        "start": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's start date"
        },
        "project": {
          "type": ["string", "integer", "null"],
          "description": "Action's project"
        },
        "opportunity": {
          "type": ["string", "integer", "null"],
          "description": "Action's opportunity"
        },
        "type": {
          "type": ["integer", "null"],
          "description": "Action's type: 0= None, 1= Call, 2=Correspondence, 3= Demo, 4= Email, 5= Event, 6= Fax, 7= Meeting, 9= Presentation, 10= Todo, 11= Webinar"
        },
        "priority": {
          "type": ["integer", "null"],
          "description": "Action priority: 1= High, 2= Medium, 3= Low "
        },
        "salesOrder": {
          "type": ["string", "integer", "null"],
          "description": "Action's sales order"
        },
        "responsible": {
          "type": ["integer", "null"],
          "description": "Person responsible for the action"
        },
        "contact": {
          "type": ["integer", "null"],
          "description": "Action's contact"
        },
        "campaign": {
          "type": ["string", "integer", "null"],
          "description": "Action's campaign"
        },
        "location": {
          "type": ["string", "null"],
          "description": "Action's location"
        },
        "id": {
          "type": "integer",
          "description": "action id"
        },
        "status": {
          "type": ["integer", "null"],
          "description": "Action's status: 0= Received, 1= In progress, 2= In progress -waiting for more info, 4= Suspended, 40= Completed"
        }
      }
    }
  }
}

Example:

{
  "request": 6875,
  "private": 0,
  "performers": "5547,50",
  "reminder": 1,
  "subject": "Test Action",
  "dueDate": "2015-06-26T10:08:00.000+0300",
  "start": "2015-06-26T10:08:00.000+0300",
  "description": "<p>test description</p>",
  "project": 9851,
  "opportunity": 3257,
  "type": 5,
  "priority": 2,
  "salesOrder": 6981,
  "responsible": 28482,
  "contact": 9647,
  "campaign": 5214,
  "location": "Oulu",
  "id": 2842904,
  "status": 1
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource action to PlanMill. See actions/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • action_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all action entities",
  "oneOf": [{
    "type": "array",
    "items": {
      "$ref": "#/definitions/actionArray"
    }
  }, {
    "$ref": "#/definitions/actionSingle" 
  }],
  "definitions": {
    "actionSingle": {
      "type": "object",
      "required": ["subject"],
      "properties": {
        "request": {
          "type": ["string", "null"],
          "description": "Action's request"
        },
        "private": {
          "type": ["integer", "null"],
          "description": "Action's view status: 0=No, 1=Yes"
        },
        "performers": {
          "type": ["string", "null"],
          "description": "List of action's performers"
        },
        "reminder": {
          "type": ["integer", "null"],
          "description": "Action's reminder: 0=No, 1=Same day as due date, 2=1 day before due date, 3= 3 days before due date, 4= 7 days before due date, 5= 14 days before due date, 6= 30 days before due date"
        },
        "subject": {
          "type": "string",
          "description": "Action's subject"
        },
        "dueDate": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's due date"
        },
        "start": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's start date"
        },
        "description": {
          "type": ["string", "null"],
          "description": "Action description"
        },
        "project": {
          "type": ["string", "null"],
          "description": "Action's project"
        },
        "opportunity": {
          "type": ["string", "null"],
          "description": "Action's opportunity"
        },
        "type": {
          "type": ["integer", "null"],
          "description": "Action's type: 0= None, 1= Call, 2=Correspondence, 3= Demo, 4= Email, 5= Event, 6= Fax, 7= Meeting, 9= Presentation, 10= Todo, 11= Webinar"
        },
        "priority": {
          "type": ["integer", "null"],
          "description": "Action priority: 1= High, 2= Medium, 3= Low "
        },
        "salesOrder": {
          "type": ["string", "null"],
          "description": "Action's sales order"
        },
        "responsible": {
          "type": ["integer", "null"],
          "description": "Person responsible for the action"
        },
        "contact": {
          "type": ["integer", "null"],
          "description": "Action's contact"
        },
        "campaign": {
          "type": ["string", "null"],
          "description": "Action's campaign"
        },
        "location": {
          "type": ["string", "null"],
          "description": "Action's location"
        },
        "id": {
          "type": "integer",
          "description": "action id"
        },
        "status": {
          "type": ["integer", "null"],
          "description": "Action's status: 0= Received, 1= In progress, 2= In progress -waiting for more info, 4= Suspended, 40= Completed"
        }
      }
    },
    "actionArray": {
      "type": "object",
      "required": ["subject"],
      "properties": {
        "request": {
          "type": ["string", "integer", "null"],
          "description": "Action's request"
        },
        "private": {
          "type": ["integer", "null"],
          "description": "Action's view status: 0=No, 1=Yes"
        },
        "performers": {
          "type": ["string", "null"],
          "description": "List of action's performers"
        },
        "reminder": {
          "type": ["integer", "null"],
          "description": "Action's reminder: 0=No, 1=Same day as due date, 2=1 day before due date, 3= 3 days before due date, 4= 7 days before due date, 5= 14 days before due date, 6= 30 days before due date"
        },
        "subject": {
          "type": "string",
          "description": "Action's subject"
        },
        "dueDate": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's due date"
        },
        "start": {
          "type": ["string", "null"],
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Action's start date"
        },
        "project": {
          "type": ["string", "integer", "null"],
          "description": "Action's project"
        },
        "opportunity": {
          "type": ["string", "integer", "null"],
          "description": "Action's opportunity"
        },
        "type": {
          "type": ["integer", "null"],
          "description": "Action's type: 0= None, 1= Call, 2=Correspondence, 3= Demo, 4= Email, 5= Event, 6= Fax, 7= Meeting, 9= Presentation, 10= Todo, 11= Webinar"
        },
        "priority": {
          "type": ["integer", "null"],
          "description": "Action priority: 1= High, 2= Medium, 3= Low "
        },
        "salesOrder": {
          "type": ["string", "integer", "null"],
          "description": "Action's sales order"
        },
        "responsible": {
          "type": ["integer", "null"],
          "description": "Person responsible for the action"
        },
        "contact": {
          "type": ["integer", "null"],
          "description": "Action's contact"
        },
        "campaign": {
          "type": ["string", "integer", "null"],
          "description": "Action's campaign"
        },
        "location": {
          "type": ["string", "null"],
          "description": "Action's location"
        },
        "id": {
          "type": "integer",
          "description": "action id"
        },
        "status": {
          "type": ["integer", "null"],
          "description": "Action's status: 0= Received, 1= In progress, 2= In progress -waiting for more info, 4= Suspended, 40= Completed"
        }
      }
    }
  }
}

Example:

{
  "request": 6875,
  "private": 0,
  "performers": "5547,50",
  "reminder": 1,
  "subject": "Test Action",
  "dueDate": "2015-06-26T10:08:00.000+0300",
  "start": "2015-06-26T10:08:00.000+0300",
  "description": "<p>test description</p>",
  "project": 9851,
  "opportunity": 3257,
  "type": 5,
  "priority": 2,
  "salesOrder": 6981,
  "responsible": 28482,
  "contact": 9647,
  "campaign": 5214,
  "location": "Oulu",
  "id": 2842904,
  "status": 1
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a action from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • action_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the action

get

View details of a single meta.

View details of a single meta.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • action_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "request": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "private": {
    "caption": "Private",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.View status",
    "values": {
      "No": "0",
      "Yes": "1"
    }
  },
  "performers": {
    "caption": "Performer(s)",
    "values": {
      "Admin, Test": "2833",
      "testi, testi": "2981"
    },
    "format": "string",
    "description": ""
  },
  "reminder": {
    "caption": "Reminder",
    "format": "short",
    "description": "",
    "maxlength": "80",
    "enumeration": "Enumeration values.Sales management.Actions.Reminder",
    "values": {
      "14 days before due date": "5",
      "No": "0",
      "1 days before due date": "2",
      "3 days before due date": "3",
      "7 days before due date": "4",
      "Same day as due date": "1",
      "30 days before due date": "6"
    }
  },
  "subject": {
    "caption": "Subject",
    "format": "string",
    "description": "",
    "maxlength": "255",
    "values": null
  },
  "dueDate": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Due date",
    "format": "string",
    "description": "",
    "maxlength": "10",
    "values": null
  },
  "start": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Start date",
    "format": "string",
    "description": "",
    "maxlength": "10",
    "values": null
  },
  "description": {
    "caption": "",
    "format": "string",
    "description": "",
    "values": null
  },
  "project": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "opportunity": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "type": {
    "caption": "Type",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.Type",
    "values": {
      "Call": "1",
      "To do": "10",
      "Demo": "3",
      "Email": "4",
      "Meeting": "7",
      "Webinar": "11",
      "Correspondence": "2",
      "Event": "5",
      "Fax": "6",
      "Presentation": "9",
      "-": "0"
    }
  },
  "priority": {
    "caption": "Priority",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.Priority",
    "values": {
      "1. High": "1",
      "3. Low": "3",
      "2. Medium": "2"
    }
  },
  "salesOrder": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "responsible": {
    "caption": "Responsible person",
    "values": {
      "Admin, Test": 2833,
      "testi, testi": "2801981"
    },
    "format": "int",
    "description": ""
  },
  "contact": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "campaign": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "location": {
    "caption": "Location",
    "format": "string",
    "description": "",
    "maxlength": "255",
    "values": null
  },
  "id": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "status": {
    "caption": "Status",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.Status",
    "values": {
      "3. In progress - waiting for more info": "2",
      "5. Completed": "40",
      "4. Suspended": "3",
      "1. Received": "0",
      "2. In progress": "1"
    }
  }
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Collection of available attachments in PlanMill. This is a read-only collection.

get

Get a list of attachments

Get a list of attachments

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • action_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
    {
        "size": 447,
        "createdBy": 50,
        "created": "2019-02-21T10:31:19.170+0200",
        "name": "attached_file_test.txt",
        "modified": "2019-02-21T12:04:05.007+0200",
        "id": 1514
    },
    {
        "size": 466,
        "createdBy": 50,
        "created": "2019-02-21T12:04:05.017+0200",
        "name": "attached_file.txt",
        "modified": "2019-02-21T12:04:05.017+0200",
        "id": 1515
    }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

put get

put
get

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • action_id: required(string)
  • attachment_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • action_id: required(string)
  • attachment_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

Contents of file

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/batch

Submit multiple API requests as a batch operation. All available individual API requests are supported collected into a JSON array. Responses are also returned as an array in same order as posted. If any request fails, all subsequent requests fail. This is to support execution order inside the batch. All headers apply for all requests unless specific headers applied

post

post
Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all batch entities",
   "type": "array",
   "items": { "$ref": "#/definitions/batch" },
  "definitions": {
    "batch": {
      "type": [ "object", "null" ],
      "required": [ "destination", "method", "headers" ],
      "additionalProperties": false,
      "properties": {
        "destination": {
          "type": "string",
          "description": "API Resource-URI, that might have the ID included"
        },
        "method": {
          "enum": [ "POST", "DELETE", "GET" ],
          "description": "HTTP-method that defines the execution implementation"
        },
        "headers": {
          "type": "object",
          "description": "JSON-Object includes all the individual header parameters needed for each request"
        },
        "body": {
          "oneOf": [
            {
              "type": "array",
              "items": { "type": "object" }
            },
            {
              "type": "object"
            }
          ]
        }
      }
    }
  }
}

Example:

[
  {
    "destination": "projects",
    "method": "POST",
    "header": {
      
    },
    "body": {
      "name": "BatchDraftV1"
    }
  },
  {
    "destination": "projects/2839831",
    "method": "POST",
    "header": {
      
    },
    "body": {
      "name": "BatchDraftV4"
    }
  },
  {
    "destination": "projects/2839830",
    "method": "DELETE",
    "header": {
      
    },
    "body": {
      
    }
  }
]

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[
  {
    "destination": "projects",
    "method": "POST",
    "header": {
      
    },
    "body": {
      "name": "BatchDraftV1"
    }
  },
  {
    "destination": "projects/2839831",
    "method": "POST",
    "header": {
      
    },
    "body": {
      "name": "BatchDraftV4"
    }
  },
  {
    "destination": "projects/2839830",
    "method": "DELETE",
    "header": {
      
    },
    "body": {
      
    }
  }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/boards

Kanban board from PlanMill

get

get

Get a list of boards

get post delete

A single board in PlanMill.

get

View details of a single board

post

Update an existing resource board to PlanMill. See boards/meta for list of filters, columns and formats.

delete

Remove a board from PlanMill.

View details of a single board

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • board_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: board

Example:

{
  "name": "New test board",
  "id": 1782
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource board to PlanMill. See boards/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • board_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: board

Example:

{
  "name": "New test board",
  "id": 1782
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a board from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • board_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/boardlists

Kanban boardlist from PlanMill

get

get

Get a list of boardlists

get post delete

A single boardlist in PlanMill.

get

View details of a single board list

post

Update an existing resource boardlist to PlanMill. See boardlists/meta for list of filters, columns and formats.

delete

Remove a boardlist from PlanMill.

View details of a single board list

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • boardlist_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: boardlist

Example:

{
  "updatedFields": null,
  "ordinalNumber": 1,
  "resource": "projects",
  "name": "Test board list 1",
  "id": 1222,
  "filters": null,
  "board": 122
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource boardlist to PlanMill. See boardlists/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • boardlist_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: boardlist

Example:

{
  "updatedFields": null,
  "ordinalNumber": 1,
  "resource": "projects",
  "name": "Test board list 1",
  "id": 1222,
  "filters": null,
  "board": 122
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a boardlist from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • boardlist_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/campaigns

Collection of available campaigns in PlanMill

get post

get

Get a list of campaigns

post

Add a new campaign to PlanMill or update existing (if id is given). See campaigns/meta for list of columns and formats.

Add a new campaign to PlanMill or update existing (if id is given). See campaigns/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all campaign entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/campaignArray" }
    },
    {
      "$ref": "#/definitions/campaignSingle"
    }
  ],
  "definitions": {
    "campaignArray": {
      "type": "object",
      "required": [ "name", "status", "type", "start", "responsible" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal id of a campaign"
        },
        "notParticipated": {
          "type": "integer",
          "description": "Number of contacts who did not participate in a campaign"
        },
        "latestCreatedMails": {
          "type": ["string", "null"],
          "description": "Subject of latest created mail"
        },
        "participated": {
          "type": "integer",
          "description": "Number of contacts who participated in a campaign"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of a campaign"
        },
        "registered": {
          "type": "integer",
          "description": "Number of contacts who registered in a campaign"
        },
        "type": {
          "type": "integer",
          "description": "Type of a campaign [0=-; 1=Email; 2=Mail; 3=Web; 4=Exhibition; 5=Event]"
        },
        "unsubscribed": {
          "type": "integer",
          "description": "Number of contacts who unsubscribed in a campaign"
        },
        "members": {
          "type": "integer",
          "description": "Number of contacts who are members of a campaign"
        },
        "responsible": {
          "type": "integer",
          "description": "Internal id of a responsible person of a campaign"
        },
        "name": {
          "type": "string",
          "description": "Name of a campaign"
        },
        "latestSentMails": {
          "type": [ "string", "null" ],
          "description": "Subject of latest sent mail"
        },
        "cancelled": {
          "type": "integer",
          "description": "Number of contacts who cancelled in a campaign"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of a campaign"
        },
        "status": {
          "type": "integer",
          "description": "Status of a campaign [0=Planning; 1=Active; 2=Inactive; 3=Completed]"
        }
      }
    },
    "campaignSingle": {
      "type": "object",
      "required": [ "name", "status", "type", "start", "responsible" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal ID of a campaign"
        },
        "plannedCost": {
          "type": "integer",
          "description": "Planned cost of a campaign"
        },
        "partner": {
          "type": ["integer", "null"],
          "description": "Internal id a partner contact related to a campaign"
        },
        "responsible": {
          "type": "integer",
          "description": "Internal id of a responsible person of a campaign"
        },
        "name": {
          "type": "string",
          "description": "Name of a campaign"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of a campaign"
        },
        "description": {
          "type": ["string", "null"],
          "description": "Description of a campaign"
        },
        "project": {
          "type": ["integer", "null"],
          "description": "Internal id of a project related to a campaign"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of a campaign"
        },
        "type": {
          "type": "integer",
          "description": "Type of a campaign [0=-; 1=Email; 2=Mail; 3=Web; 4=Exhibition; 5=Event]"
        },
        "status": {
          "type": "integer",
          "description": "Status of a campaign [0=Planning; 1=Active; 2=Inactive; 3=Completed]"
        },
        "actualCost": {
          "type": "integer",
          "description": "Actual cost of a campaign"
        }
      }
    }
  }
}

Example:

{
  "plannedCost": 500,
  "partner": null,
  "responsible": 356,
  "name": "email campaign",
  "start": "2016-08-01T00:00:00.000+0300",
  "description": "<p>Write and send email for campaign</p>",
  "project": null,
  "finish": "2016-08-03T00:00:00.000+0300",
  "id": 2002,
  "type": 1,
  "status": 3,
  "actualCost": 300
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get post delete

A single campaign in PlanMill.

get

View details of a single campaign

post

Update an existing resource campaign to PlanMill. See campaigns/meta for list of filters, columns and formats.

delete

Remove a campaign from PlanMill.

View details of a single campaign

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • campaign_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all campaign entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/campaignArray" }
    },
    {
      "$ref": "#/definitions/campaignSingle"
    }
  ],
  "definitions": {
    "campaignArray": {
      "type": "object",
      "required": [ "name", "status", "type", "start", "responsible" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal id of a campaign"
        },
        "notParticipated": {
          "type": "integer",
          "description": "Number of contacts who did not participate in a campaign"
        },
        "latestCreatedMails": {
          "type": ["string", "null"],
          "description": "Subject of latest created mail"
        },
        "participated": {
          "type": "integer",
          "description": "Number of contacts who participated in a campaign"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of a campaign"
        },
        "registered": {
          "type": "integer",
          "description": "Number of contacts who registered in a campaign"
        },
        "type": {
          "type": "integer",
          "description": "Type of a campaign [0=-; 1=Email; 2=Mail; 3=Web; 4=Exhibition; 5=Event]"
        },
        "unsubscribed": {
          "type": "integer",
          "description": "Number of contacts who unsubscribed in a campaign"
        },
        "members": {
          "type": "integer",
          "description": "Number of contacts who are members of a campaign"
        },
        "responsible": {
          "type": "integer",
          "description": "Internal id of a responsible person of a campaign"
        },
        "name": {
          "type": "string",
          "description": "Name of a campaign"
        },
        "latestSentMails": {
          "type": [ "string", "null" ],
          "description": "Subject of latest sent mail"
        },
        "cancelled": {
          "type": "integer",
          "description": "Number of contacts who cancelled in a campaign"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of a campaign"
        },
        "status": {
          "type": "integer",
          "description": "Status of a campaign [0=Planning; 1=Active; 2=Inactive; 3=Completed]"
        }
      }
    },
    "campaignSingle": {
      "type": "object",
      "required": [ "name", "status", "type", "start", "responsible" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal ID of a campaign"
        },
        "plannedCost": {
          "type": "integer",
          "description": "Planned cost of a campaign"
        },
        "partner": {
          "type": ["integer", "null"],
          "description": "Internal id a partner contact related to a campaign"
        },
        "responsible": {
          "type": "integer",
          "description": "Internal id of a responsible person of a campaign"
        },
        "name": {
          "type": "string",
          "description": "Name of a campaign"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of a campaign"
        },
        "description": {
          "type": ["string", "null"],
          "description": "Description of a campaign"
        },
        "project": {
          "type": ["integer", "null"],
          "description": "Internal id of a project related to a campaign"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of a campaign"
        },
        "type": {
          "type": "integer",
          "description": "Type of a campaign [0=-; 1=Email; 2=Mail; 3=Web; 4=Exhibition; 5=Event]"
        },
        "status": {
          "type": "integer",
          "description": "Status of a campaign [0=Planning; 1=Active; 2=Inactive; 3=Completed]"
        },
        "actualCost": {
          "type": "integer",
          "description": "Actual cost of a campaign"
        }
      }
    }
  }
}

Example:

{
  "plannedCost": 500,
  "partner": null,
  "responsible": 356,
  "name": "email campaign",
  "start": "2016-08-01T00:00:00.000+0300",
  "description": "<p>Write and send email for campaign</p>",
  "project": null,
  "finish": "2016-08-03T00:00:00.000+0300",
  "id": 2002,
  "type": 1,
  "status": 3,
  "actualCost": 300
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource campaign to PlanMill. See campaigns/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • campaign_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all campaign entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/campaignArray" }
    },
    {
      "$ref": "#/definitions/campaignSingle"
    }
  ],
  "definitions": {
    "campaignArray": {
      "type": "object",
      "required": [ "name", "status", "type", "start", "responsible" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal id of a campaign"
        },
        "notParticipated": {
          "type": "integer",
          "description": "Number of contacts who did not participate in a campaign"
        },
        "latestCreatedMails": {
          "type": ["string", "null"],
          "description": "Subject of latest created mail"
        },
        "participated": {
          "type": "integer",
          "description": "Number of contacts who participated in a campaign"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of a campaign"
        },
        "registered": {
          "type": "integer",
          "description": "Number of contacts who registered in a campaign"
        },
        "type": {
          "type": "integer",
          "description": "Type of a campaign [0=-; 1=Email; 2=Mail; 3=Web; 4=Exhibition; 5=Event]"
        },
        "unsubscribed": {
          "type": "integer",
          "description": "Number of contacts who unsubscribed in a campaign"
        },
        "members": {
          "type": "integer",
          "description": "Number of contacts who are members of a campaign"
        },
        "responsible": {
          "type": "integer",
          "description": "Internal id of a responsible person of a campaign"
        },
        "name": {
          "type": "string",
          "description": "Name of a campaign"
        },
        "latestSentMails": {
          "type": [ "string", "null" ],
          "description": "Subject of latest sent mail"
        },
        "cancelled": {
          "type": "integer",
          "description": "Number of contacts who cancelled in a campaign"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of a campaign"
        },
        "status": {
          "type": "integer",
          "description": "Status of a campaign [0=Planning; 1=Active; 2=Inactive; 3=Completed]"
        }
      }
    },
    "campaignSingle": {
      "type": "object",
      "required": [ "name", "status", "type", "start", "responsible" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "integer",
          "description": "Internal ID of a campaign"
        },
        "plannedCost": {
          "type": "integer",
          "description": "Planned cost of a campaign"
        },
        "partner": {
          "type": ["integer", "null"],
          "description": "Internal id a partner contact related to a campaign"
        },
        "responsible": {
          "type": "integer",
          "description": "Internal id of a responsible person of a campaign"
        },
        "name": {
          "type": "string",
          "description": "Name of a campaign"
        },
        "start": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Start date of a campaign"
        },
        "description": {
          "type": ["string", "null"],
          "description": "Description of a campaign"
        },
        "project": {
          "type": ["integer", "null"],
          "description": "Internal id of a project related to a campaign"
        },
        "finish": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of a campaign"
        },
        "type": {
          "type": "integer",
          "description": "Type of a campaign [0=-; 1=Email; 2=Mail; 3=Web; 4=Exhibition; 5=Event]"
        },
        "status": {
          "type": "integer",
          "description": "Status of a campaign [0=Planning; 1=Active; 2=Inactive; 3=Completed]"
        },
        "actualCost": {
          "type": "integer",
          "description": "Actual cost of a campaign"
        }
      }
    }
  }
}

Example:

{
  "plannedCost": 500,
  "partner": null,
  "responsible": 356,
  "name": "email campaign",
  "start": "2016-08-01T00:00:00.000+0300",
  "description": "<p>Write and send email for campaign</p>",
  "project": null,
  "finish": "2016-08-03T00:00:00.000+0300",
  "id": 2002,
  "type": 1,
  "status": 3,
  "actualCost": 300
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a campaign from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • campaign_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/capacitycalendars

Collection of available capacitycalendars in PlanMill. This is a read-only collection.

get

get

Get a list of capacitycalendars

get

Get meta information for capacity calendars. Includes resource's fields names and type and related filters

get

View details of a single meta.

/capacitycalendars/{id}/capacity/{date}

Set a single day's capacity for a capacity calendar

put

put
Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • id: required(string)
  • date: required(date)

    Capacity date in UTC format

    Example:

    2019-03-01T00:00:00.000+0200

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: any

Example:

{}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/contacts

Collection of available contacts in PlanMill. See contacts/meta for list of filters, columns and formats.

get post

get

Get a list of contacts. See contacts/meta for list of filters, columns and formats.

post

To add a new contact. See contacts/meta for list of columns and formats.

To add a new contact. See contacts/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all contacts entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/contactArray" }
    },
    {
      "$ref": "#/definitions/contactSingle"
    }
  ],
  "definitions": {
    "contactSingle": {
      "type": "object",
      "required": [ "lastName", "account", "email" ],
      "properties": {
        "firstName": {
          "type": "string",
          "maxLength": 80,
          "description": "First name of a contact"
        },
        "lastName": {
          "type": "string",
          "maxLength": 80,
          "description": "Last name of a contact "
        },
        "passive": {
          "type": "integer",
          "description": "Contact status can be active or passive. 0=Active 1=InActive"
        },
        "account": {
          "type": ["integer", "null"],
          "description": "Id of contact's account"
        },
        "languageCode": {
          "type": ["string", "null"],
          "description": "Language code"
        },
        "role": {
          "type": ["integer", "null"],
          "description": "Basic Roles: 1=Administrator, 2=Power, 3=Pro, 4=Team, 5=Sales"
        },
        "title": {
          "type": ["string", "null"],
          "description": "Title of contact"
        },
        "email": {
          "type": ["string", "null"],
          "description": "Email address of contact"
        },
        "secondaryAddress": {
          "type": ["string", "null"],
          "description": "Secondary address of contact"
        },
        "primaryState": {
          "type": ["string", "null"],
          "description": "Primary state of contact"
        },
        "secondaryEmail": {
          "type": ["string", "null"],
          "description": "Secondary email of contact"
        },
        "primaryPostalCode": {
          "type": ["string", "null"],
          "description": "Primary postal code of contact"
        },
        "accountName": {
          "type": ["string", "null"],
          "description": "Account name of contact"
        },
        "secondaryDepartment": {
          "type": ["string", "null"],
          "description": "Secondary Department name of contact"
        },
        "blog": {
          "type": ["string", "null"],
          "description": "Contact's blog"
        },
        "primaryCity": {
          "type": ["string", "null"],
          "description": "Contact's city"
        },
        "secondaryPostalCode": {
          "type": ["string", "null"],
          "description": "Contact's secondary postal code"
        },
        "skype": {
          "type": ["string", "null"],
          "description": "Contact's skype name"
        },
        "twitter": {
          "type": ["string", "null"],
          "description": "Contact's twitter account name"
        },
        "primaryDepartment": {
          "type": ["string", "null"],
          "description": "Contact's primary department"
        },
        "secondaryCity": {
          "type": ["string", "null"],
          "description": "Contact's secondary city"
        },
        "id": {
          "type": "integer",
          "description": "Contact's id"
        },
        "department": {
          "type": ["string", "null"],
          "description": "Contact's department"
        },
        "fax": {
          "type": ["string", "null"],
          "description": "Contact's fax"
        },
        "primaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's primary country"
        },
        "secondaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's secondary country"
        },
        "facebook": {
          "type": ["string", "null"],
          "description": "Contact's facebook address"
        },
        "linkedIn": {
          "type": ["string", "null"],
          "description": "Contact's linkedIn address"
        },
        "projectWikiUserGroup": {
          "type": ["string", "null"],
          "description": "Contact's projectWikiUserGroup"
        },
        "mobilePhone": {
          "type": ["string", "null"],
          "description": "Contact's mobile phone number"
        },
        "workPhone": {
          "type": ["string", "null"],
          "description": "Contact's work phone number"
        },
        "googleTalk": {
          "type": ["string", "null"],
          "description": "Contact's google talk address"
        },
        "primaryAddress": {
          "type": ["string", "null"],
          "description": "Contact's primary address"
        }
      }
    },
    "contactArray": {
      "type": "object",
      "required": [
        "lastName",
        "account",
        "passive"
      ],
      "properties": {
        "firstName": {
          "type": "string",
          "maxLength": 80,
          "description": "First name of a contact"
        },
        "lastName": {
          "type": "string",
          "maxLength": 80,
          "description": "Last name of a contact "
        },
        "passive": {
          "type": "integer",
          "description": "Contact status can be active or passive. 0=Active 1=InActive"
        },
        "account": {
          "type": ["integer", "null"],
          "description": "Id of contact's account"
        },
        "languageCode": {
          "type": ["string", "null"],
          "description": "Language code"
        },
        "role": {
          "type": ["integer", "null"],
          "description": "Basic Roles: 1=Administrator, 2=Power, 3=Pro, 4=Team, 5=Sales"
        },
        "title": {
          "type": ["string", "null"],
          "description": "Title of contact"
        },
        "email": {
          "type": ["string", "null"],
          "description": "Email address of contact"
        },
        "secondaryAddress": {
          "type": ["string", "null"],
          "description": "Secondary address of contact"
        },
        "primaryState": {
          "type": ["string", "null"],
          "description": "Primary state of contact"
        },
        "secondaryEmail": {
          "type": ["string", "null"],
          "description": "Secondary email of contact"
        },
        "primaryPostalCode": {
          "type": ["string", "null"],
          "description": "Primary postal code of contact"
        },
        "accountName": {
          "type": ["string", "null"],
          "description": "Account name of contact"
        },
        "secondaryDepartment": {
          "type": ["string", "null"],
          "description": "Secondary Department name of contact"
        },
        "blog": {
          "type": ["string", "null"],
          "description": "Contact's blog"
        },
        "primaryCity": {
          "type": ["string", "null"],
          "description": "Contact's city"
        },
        "secondaryPostalCode": {
          "type": ["string", "null"],
          "description": "Contact's secondary postal code"
        },
        "skype": {
          "type": ["string", "null"],
          "description": "Contact's skype name"
        },
        "twitter": {
          "type": ["string", "null"],
          "description": "Contact's twitter account name"
        },
        "primaryDepartment": {
          "type": ["string", "null"],
          "description": "Contact's primary department"
        },
        "secondaryCity": {
          "type": ["string", "null"],
          "description": "Contact's secondary city"
        },
        "id": {
          "type": "integer",
          "description": "Contact's id"
        },
        "department": {
          "type": ["string", "null"],
          "description": "Contact's department"
        },
        "fax": {
          "type": ["string", "null"],
          "description": "Contact's fax"
        },
        "primaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's primary country"
        },
        "secondaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's secondary country"
        },
        "facebook": {
          "type": ["string", "null"],
          "description": "Contact's facebook address"
        },
        "linkedIn": {
          "type": ["string", "null"],
          "description": "Contact's linkedIn address"
        },
        "projectWikiUserGroup": {
          "type": ["string", "null"],
          "description": "Contact's projectWikiUserGroup"
        },
        "mobilePhone": {
          "type": ["string", "null"],
          "description": "Contact's mobile phone number"
        },
        "workPhone": {
          "type": ["string", "null"],
          "description": "Contact's work phone number"
        },
        "googleTalk": {
          "type": ["string", "null"],
          "description": "Contact's google talk address"
        },
        "primaryAddress": {
          "type": ["string", "null"],
          "description": "Contact's primary address"
        }
      }
    }
  }
}

Example:

{
    "lastName": "Tester",
    "secondaryAddress": null,
    "primaryState": "",
    "secondaryEmail": "",
    "role": null,
    "primaryPostalCode": "00020",
    "accountName": "PlanMill Oy",
    "description": null,
    "secondaryDepartment": null,
    "title": "Software Engineer",
    "blog": "http://www.blog.com",
    "primaryCity": "NORDEA",
    "secondaryPostalCode": null,
    "skype": "skpe_id",
    "twitter": "http://www.twitter.com",
    "campaigns": null,
    "primaryDepartment": "",
    "secondaryCity": null,
    "id": 1634,
    "department": "Software Development",
    "primaryCountry": 73,
    "email": "mikko.tester@planmill.com",
    "secondaryCountry": null,
    "facebook": "http://www.facebook.com",
    "secondaryState": null,
    "linkedIn": "http://www.linkedin.com",
    "projectWikiUserGroup": null,
    "languageCode": "en",
    "passive": 0,
    "firstName": "Mikko",
    "mobilePhone": "+358-466-5556951",
    "workPhone": "+358 10 322 9110",
    "googleTalk": "gtalk_id",
    "primaryAddress": "Myyntisaatavien palvelut",
    "account": 51
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for contacts. Includes resource's fields names and type and related filters

get

View details of a single meta.

get post delete

A single contact in PlanMill.

get

View details of a single contact. See contacts/meta for list of filters, columns and formats.

post

Update an existing resource contact to PlanMill. See contacts/meta for list of filters, columns and formats.

delete

Remove a contact from PlanMill.

View details of a single contact. See contacts/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • contact_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all contacts entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/contactArray" }
    },
    {
      "$ref": "#/definitions/contactSingle"
    }
  ],
  "definitions": {
    "contactSingle": {
      "type": "object",
      "required": [ "lastName", "account", "email" ],
      "properties": {
        "firstName": {
          "type": "string",
          "maxLength": 80,
          "description": "First name of a contact"
        },
        "lastName": {
          "type": "string",
          "maxLength": 80,
          "description": "Last name of a contact "
        },
        "passive": {
          "type": "integer",
          "description": "Contact status can be active or passive. 0=Active 1=InActive"
        },
        "account": {
          "type": ["integer", "null"],
          "description": "Id of contact's account"
        },
        "languageCode": {
          "type": ["string", "null"],
          "description": "Language code"
        },
        "role": {
          "type": ["integer", "null"],
          "description": "Basic Roles: 1=Administrator, 2=Power, 3=Pro, 4=Team, 5=Sales"
        },
        "title": {
          "type": ["string", "null"],
          "description": "Title of contact"
        },
        "email": {
          "type": ["string", "null"],
          "description": "Email address of contact"
        },
        "secondaryAddress": {
          "type": ["string", "null"],
          "description": "Secondary address of contact"
        },
        "primaryState": {
          "type": ["string", "null"],
          "description": "Primary state of contact"
        },
        "secondaryEmail": {
          "type": ["string", "null"],
          "description": "Secondary email of contact"
        },
        "primaryPostalCode": {
          "type": ["string", "null"],
          "description": "Primary postal code of contact"
        },
        "accountName": {
          "type": ["string", "null"],
          "description": "Account name of contact"
        },
        "secondaryDepartment": {
          "type": ["string", "null"],
          "description": "Secondary Department name of contact"
        },
        "blog": {
          "type": ["string", "null"],
          "description": "Contact's blog"
        },
        "primaryCity": {
          "type": ["string", "null"],
          "description": "Contact's city"
        },
        "secondaryPostalCode": {
          "type": ["string", "null"],
          "description": "Contact's secondary postal code"
        },
        "skype": {
          "type": ["string", "null"],
          "description": "Contact's skype name"
        },
        "twitter": {
          "type": ["string", "null"],
          "description": "Contact's twitter account name"
        },
        "primaryDepartment": {
          "type": ["string", "null"],
          "description": "Contact's primary department"
        },
        "secondaryCity": {
          "type": ["string", "null"],
          "description": "Contact's secondary city"
        },
        "id": {
          "type": "integer",
          "description": "Contact's id"
        },
        "department": {
          "type": ["string", "null"],
          "description": "Contact's department"
        },
        "fax": {
          "type": ["string", "null"],
          "description": "Contact's fax"
        },
        "primaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's primary country"
        },
        "secondaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's secondary country"
        },
        "facebook": {
          "type": ["string", "null"],
          "description": "Contact's facebook address"
        },
        "linkedIn": {
          "type": ["string", "null"],
          "description": "Contact's linkedIn address"
        },
        "projectWikiUserGroup": {
          "type": ["string", "null"],
          "description": "Contact's projectWikiUserGroup"
        },
        "mobilePhone": {
          "type": ["string", "null"],
          "description": "Contact's mobile phone number"
        },
        "workPhone": {
          "type": ["string", "null"],
          "description": "Contact's work phone number"
        },
        "googleTalk": {
          "type": ["string", "null"],
          "description": "Contact's google talk address"
        },
        "primaryAddress": {
          "type": ["string", "null"],
          "description": "Contact's primary address"
        }
      }
    },
    "contactArray": {
      "type": "object",
      "required": [
        "lastName",
        "account",
        "passive"
      ],
      "properties": {
        "firstName": {
          "type": "string",
          "maxLength": 80,
          "description": "First name of a contact"
        },
        "lastName": {
          "type": "string",
          "maxLength": 80,
          "description": "Last name of a contact "
        },
        "passive": {
          "type": "integer",
          "description": "Contact status can be active or passive. 0=Active 1=InActive"
        },
        "account": {
          "type": ["integer", "null"],
          "description": "Id of contact's account"
        },
        "languageCode": {
          "type": ["string", "null"],
          "description": "Language code"
        },
        "role": {
          "type": ["integer", "null"],
          "description": "Basic Roles: 1=Administrator, 2=Power, 3=Pro, 4=Team, 5=Sales"
        },
        "title": {
          "type": ["string", "null"],
          "description": "Title of contact"
        },
        "email": {
          "type": ["string", "null"],
          "description": "Email address of contact"
        },
        "secondaryAddress": {
          "type": ["string", "null"],
          "description": "Secondary address of contact"
        },
        "primaryState": {
          "type": ["string", "null"],
          "description": "Primary state of contact"
        },
        "secondaryEmail": {
          "type": ["string", "null"],
          "description": "Secondary email of contact"
        },
        "primaryPostalCode": {
          "type": ["string", "null"],
          "description": "Primary postal code of contact"
        },
        "accountName": {
          "type": ["string", "null"],
          "description": "Account name of contact"
        },
        "secondaryDepartment": {
          "type": ["string", "null"],
          "description": "Secondary Department name of contact"
        },
        "blog": {
          "type": ["string", "null"],
          "description": "Contact's blog"
        },
        "primaryCity": {
          "type": ["string", "null"],
          "description": "Contact's city"
        },
        "secondaryPostalCode": {
          "type": ["string", "null"],
          "description": "Contact's secondary postal code"
        },
        "skype": {
          "type": ["string", "null"],
          "description": "Contact's skype name"
        },
        "twitter": {
          "type": ["string", "null"],
          "description": "Contact's twitter account name"
        },
        "primaryDepartment": {
          "type": ["string", "null"],
          "description": "Contact's primary department"
        },
        "secondaryCity": {
          "type": ["string", "null"],
          "description": "Contact's secondary city"
        },
        "id": {
          "type": "integer",
          "description": "Contact's id"
        },
        "department": {
          "type": ["string", "null"],
          "description": "Contact's department"
        },
        "fax": {
          "type": ["string", "null"],
          "description": "Contact's fax"
        },
        "primaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's primary country"
        },
        "secondaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's secondary country"
        },
        "facebook": {
          "type": ["string", "null"],
          "description": "Contact's facebook address"
        },
        "linkedIn": {
          "type": ["string", "null"],
          "description": "Contact's linkedIn address"
        },
        "projectWikiUserGroup": {
          "type": ["string", "null"],
          "description": "Contact's projectWikiUserGroup"
        },
        "mobilePhone": {
          "type": ["string", "null"],
          "description": "Contact's mobile phone number"
        },
        "workPhone": {
          "type": ["string", "null"],
          "description": "Contact's work phone number"
        },
        "googleTalk": {
          "type": ["string", "null"],
          "description": "Contact's google talk address"
        },
        "primaryAddress": {
          "type": ["string", "null"],
          "description": "Contact's primary address"
        }
      }
    }
  }
}

Example:

{
    "lastName": "Tester",
    "secondaryAddress": null,
    "primaryState": "",
    "secondaryEmail": "",
    "role": null,
    "primaryPostalCode": "00020",
    "accountName": "PlanMill Oy",
    "description": null,
    "secondaryDepartment": null,
    "title": "Software Engineer",
    "blog": "http://www.blog.com",
    "primaryCity": "NORDEA",
    "secondaryPostalCode": null,
    "skype": "skpe_id",
    "twitter": "http://www.twitter.com",
    "campaigns": null,
    "primaryDepartment": "",
    "secondaryCity": null,
    "id": 1634,
    "department": "Software Development",
    "primaryCountry": 73,
    "email": "mikko.tester@planmill.com",
    "secondaryCountry": null,
    "facebook": "http://www.facebook.com",
    "secondaryState": null,
    "linkedIn": "http://www.linkedin.com",
    "projectWikiUserGroup": null,
    "languageCode": "en",
    "passive": 0,
    "firstName": "Mikko",
    "mobilePhone": "+358-466-5556951",
    "workPhone": "+358 10 322 9110",
    "googleTalk": "gtalk_id",
    "primaryAddress": "Myyntisaatavien palvelut",
    "account": 51
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource contact to PlanMill. See contacts/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • contact_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all contacts entities",
  "oneOf": [
    {
      "type": "array",
      "items": { "$ref": "#/definitions/contactArray" }
    },
    {
      "$ref": "#/definitions/contactSingle"
    }
  ],
  "definitions": {
    "contactSingle": {
      "type": "object",
      "required": [ "lastName", "account", "email" ],
      "properties": {
        "firstName": {
          "type": "string",
          "maxLength": 80,
          "description": "First name of a contact"
        },
        "lastName": {
          "type": "string",
          "maxLength": 80,
          "description": "Last name of a contact "
        },
        "passive": {
          "type": "integer",
          "description": "Contact status can be active or passive. 0=Active 1=InActive"
        },
        "account": {
          "type": ["integer", "null"],
          "description": "Id of contact's account"
        },
        "languageCode": {
          "type": ["string", "null"],
          "description": "Language code"
        },
        "role": {
          "type": ["integer", "null"],
          "description": "Basic Roles: 1=Administrator, 2=Power, 3=Pro, 4=Team, 5=Sales"
        },
        "title": {
          "type": ["string", "null"],
          "description": "Title of contact"
        },
        "email": {
          "type": ["string", "null"],
          "description": "Email address of contact"
        },
        "secondaryAddress": {
          "type": ["string", "null"],
          "description": "Secondary address of contact"
        },
        "primaryState": {
          "type": ["string", "null"],
          "description": "Primary state of contact"
        },
        "secondaryEmail": {
          "type": ["string", "null"],
          "description": "Secondary email of contact"
        },
        "primaryPostalCode": {
          "type": ["string", "null"],
          "description": "Primary postal code of contact"
        },
        "accountName": {
          "type": ["string", "null"],
          "description": "Account name of contact"
        },
        "secondaryDepartment": {
          "type": ["string", "null"],
          "description": "Secondary Department name of contact"
        },
        "blog": {
          "type": ["string", "null"],
          "description": "Contact's blog"
        },
        "primaryCity": {
          "type": ["string", "null"],
          "description": "Contact's city"
        },
        "secondaryPostalCode": {
          "type": ["string", "null"],
          "description": "Contact's secondary postal code"
        },
        "skype": {
          "type": ["string", "null"],
          "description": "Contact's skype name"
        },
        "twitter": {
          "type": ["string", "null"],
          "description": "Contact's twitter account name"
        },
        "primaryDepartment": {
          "type": ["string", "null"],
          "description": "Contact's primary department"
        },
        "secondaryCity": {
          "type": ["string", "null"],
          "description": "Contact's secondary city"
        },
        "id": {
          "type": "integer",
          "description": "Contact's id"
        },
        "department": {
          "type": ["string", "null"],
          "description": "Contact's department"
        },
        "fax": {
          "type": ["string", "null"],
          "description": "Contact's fax"
        },
        "primaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's primary country"
        },
        "secondaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's secondary country"
        },
        "facebook": {
          "type": ["string", "null"],
          "description": "Contact's facebook address"
        },
        "linkedIn": {
          "type": ["string", "null"],
          "description": "Contact's linkedIn address"
        },
        "projectWikiUserGroup": {
          "type": ["string", "null"],
          "description": "Contact's projectWikiUserGroup"
        },
        "mobilePhone": {
          "type": ["string", "null"],
          "description": "Contact's mobile phone number"
        },
        "workPhone": {
          "type": ["string", "null"],
          "description": "Contact's work phone number"
        },
        "googleTalk": {
          "type": ["string", "null"],
          "description": "Contact's google talk address"
        },
        "primaryAddress": {
          "type": ["string", "null"],
          "description": "Contact's primary address"
        }
      }
    },
    "contactArray": {
      "type": "object",
      "required": [
        "lastName",
        "account",
        "passive"
      ],
      "properties": {
        "firstName": {
          "type": "string",
          "maxLength": 80,
          "description": "First name of a contact"
        },
        "lastName": {
          "type": "string",
          "maxLength": 80,
          "description": "Last name of a contact "
        },
        "passive": {
          "type": "integer",
          "description": "Contact status can be active or passive. 0=Active 1=InActive"
        },
        "account": {
          "type": ["integer", "null"],
          "description": "Id of contact's account"
        },
        "languageCode": {
          "type": ["string", "null"],
          "description": "Language code"
        },
        "role": {
          "type": ["integer", "null"],
          "description": "Basic Roles: 1=Administrator, 2=Power, 3=Pro, 4=Team, 5=Sales"
        },
        "title": {
          "type": ["string", "null"],
          "description": "Title of contact"
        },
        "email": {
          "type": ["string", "null"],
          "description": "Email address of contact"
        },
        "secondaryAddress": {
          "type": ["string", "null"],
          "description": "Secondary address of contact"
        },
        "primaryState": {
          "type": ["string", "null"],
          "description": "Primary state of contact"
        },
        "secondaryEmail": {
          "type": ["string", "null"],
          "description": "Secondary email of contact"
        },
        "primaryPostalCode": {
          "type": ["string", "null"],
          "description": "Primary postal code of contact"
        },
        "accountName": {
          "type": ["string", "null"],
          "description": "Account name of contact"
        },
        "secondaryDepartment": {
          "type": ["string", "null"],
          "description": "Secondary Department name of contact"
        },
        "blog": {
          "type": ["string", "null"],
          "description": "Contact's blog"
        },
        "primaryCity": {
          "type": ["string", "null"],
          "description": "Contact's city"
        },
        "secondaryPostalCode": {
          "type": ["string", "null"],
          "description": "Contact's secondary postal code"
        },
        "skype": {
          "type": ["string", "null"],
          "description": "Contact's skype name"
        },
        "twitter": {
          "type": ["string", "null"],
          "description": "Contact's twitter account name"
        },
        "primaryDepartment": {
          "type": ["string", "null"],
          "description": "Contact's primary department"
        },
        "secondaryCity": {
          "type": ["string", "null"],
          "description": "Contact's secondary city"
        },
        "id": {
          "type": "integer",
          "description": "Contact's id"
        },
        "department": {
          "type": ["string", "null"],
          "description": "Contact's department"
        },
        "fax": {
          "type": ["string", "null"],
          "description": "Contact's fax"
        },
        "primaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's primary country"
        },
        "secondaryCountry": {
          "type": ["integer", "null"],
          "description": "Contact's secondary country"
        },
        "facebook": {
          "type": ["string", "null"],
          "description": "Contact's facebook address"
        },
        "linkedIn": {
          "type": ["string", "null"],
          "description": "Contact's linkedIn address"
        },
        "projectWikiUserGroup": {
          "type": ["string", "null"],
          "description": "Contact's projectWikiUserGroup"
        },
        "mobilePhone": {
          "type": ["string", "null"],
          "description": "Contact's mobile phone number"
        },
        "workPhone": {
          "type": ["string", "null"],
          "description": "Contact's work phone number"
        },
        "googleTalk": {
          "type": ["string", "null"],
          "description": "Contact's google talk address"
        },
        "primaryAddress": {
          "type": ["string", "null"],
          "description": "Contact's primary address"
        }
      }
    }
  }
}

Example:

{
    "lastName": "Tester",
    "secondaryAddress": null,
    "primaryState": "",
    "secondaryEmail": "",
    "role": null,
    "primaryPostalCode": "00020",
    "accountName": "PlanMill Oy",
    "description": null,
    "secondaryDepartment": null,
    "title": "Software Engineer",
    "blog": "http://www.blog.com",
    "primaryCity": "NORDEA",
    "secondaryPostalCode": null,
    "skype": "skpe_id",
    "twitter": "http://www.twitter.com",
    "campaigns": null,
    "primaryDepartment": "",
    "secondaryCity": null,
    "id": 1634,
    "department": "Software Development",
    "primaryCountry": 73,
    "email": "mikko.tester@planmill.com",
    "secondaryCountry": null,
    "facebook": "http://www.facebook.com",
    "secondaryState": null,
    "linkedIn": "http://www.linkedin.com",
    "projectWikiUserGroup": null,
    "languageCode": "en",
    "passive": 0,
    "firstName": "Mikko",
    "mobilePhone": "+358-466-5556951",
    "workPhone": "+358 10 322 9110",
    "googleTalk": "gtalk_id",
    "primaryAddress": "Myyntisaatavien palvelut",
    "account": 51
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a contact from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • contact_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the contact

get

View details of a single meta.

View details of a single meta.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • contact_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "request": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "private": {
    "caption": "Private",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.View status",
    "values": {
      "No": "0",
      "Yes": "1"
    }
  },
  "performers": {
    "caption": "Performer(s)",
    "values": {
      "Admin, Test": "2833",
      "testi, testi": "2981"
    },
    "format": "string",
    "description": ""
  },
  "reminder": {
    "caption": "Reminder",
    "format": "short",
    "description": "",
    "maxlength": "80",
    "enumeration": "Enumeration values.Sales management.Actions.Reminder",
    "values": {
      "14 days before due date": "5",
      "No": "0",
      "1 days before due date": "2",
      "3 days before due date": "3",
      "7 days before due date": "4",
      "Same day as due date": "1",
      "30 days before due date": "6"
    }
  },
  "subject": {
    "caption": "Subject",
    "format": "string",
    "description": "",
    "maxlength": "255",
    "values": null
  },
  "dueDate": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Due date",
    "format": "string",
    "description": "",
    "maxlength": "10",
    "values": null
  },
  "start": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Start date",
    "format": "string",
    "description": "",
    "maxlength": "10",
    "values": null
  },
  "description": {
    "caption": "",
    "format": "string",
    "description": "",
    "values": null
  },
  "project": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "opportunity": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "type": {
    "caption": "Type",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.Type",
    "values": {
      "Call": "1",
      "To do": "10",
      "Demo": "3",
      "Email": "4",
      "Meeting": "7",
      "Webinar": "11",
      "Correspondence": "2",
      "Event": "5",
      "Fax": "6",
      "Presentation": "9",
      "-": "0"
    }
  },
  "priority": {
    "caption": "Priority",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.Priority",
    "values": {
      "1. High": "1",
      "3. Low": "3",
      "2. Medium": "2"
    }
  },
  "salesOrder": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "responsible": {
    "caption": "Responsible person",
    "values": {
      "Admin, Test": 2833,
      "testi, testi": "2801981"
    },
    "format": "int",
    "description": ""
  },
  "contact": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "campaign": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "location": {
    "caption": "Location",
    "format": "string",
    "description": "",
    "maxlength": "255",
    "values": null
  },
  "id": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "status": {
    "caption": "Status",
    "format": "short",
    "description": "",
    "enumeration": "Enumeration values.Sales management.Actions.Status",
    "values": {
      "3. In progress - waiting for more info": "2",
      "5. Completed": "40",
      "4. Suspended": "3",
      "1. Received": "0",
      "2. In progress": "1"
    }
  }
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Collection of available attachments in PlanMill. This is a read-only collection.

get

Get a list of attachments

Get a list of attachments

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • contact_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
    {
        "size": 447,
        "createdBy": 50,
        "created": "2019-02-21T10:31:19.170+0200",
        "name": "attached_file_test.txt",
        "modified": "2019-02-21T12:04:05.007+0200",
        "id": 1514
    },
    {
        "size": 466,
        "createdBy": 50,
        "created": "2019-02-21T12:04:05.017+0200",
        "name": "attached_file.txt",
        "modified": "2019-02-21T12:04:05.017+0200",
        "id": 1515
    }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

put

put

Attach existing file to user.( Tips use file id from api/1.5/tempfile )

Attach existing file to user.( Tips use file id from api/1.5/tempfile )

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • contact_id: required(string)
  • attachment_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/enumerations

Enumerations available in PlanMill

get

get

View details of a single enumeration.

/exitcriteria

Kanban board exit criteria from PlanMill

get

get

Get a list of exitcriteria

get post delete

A single exitcriterion in PlanMill.

get

View details of single exit criteria

post

Update an existing resource exitcriterion to PlanMill. See exitcriteria/meta for list of filters, columns and formats.

delete

Remove a exitcriterion from PlanMill.

View details of single exit criteria

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • exit_criteria_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: exitcriterion

Example:

{
  "name": "Test exit criteria",
  "boardlist": 4775,
  "description": null,
  "id": 4785
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource exitcriterion to PlanMill. See exitcriteria/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • exit_criteria_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: exitcriterion

Example:

{
  "name": "Test exit criteria",
  "boardlist": 4775,
  "description": null,
  "id": 4785
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a exitcriterion from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • exit_criteria_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/exitcriteriastatuses

Kanban board exit criteria status from PlanMill

get

get

Get a list of exitcriteriastatuses

get post delete

A single exitcriteriastatus in PlanMill.

get

View details of single exit criteria status

post

Update an existing resource exitcriteriastatus to PlanMill. See exitcriteriastatuses/meta for list of filters, columns and formats.

delete

Remove a exitcriteriastatus from PlanMill.

View details of single exit criteria status

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • exit_criteria_status_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: exitcriteriastatus

Example:

{
  "id": 4722,
  "exitCriterion": 4710,
  "object": 4715,
  "status": 2
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource exitcriteriastatus to PlanMill. See exitcriteriastatuses/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • exit_criteria_status_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: exitcriteriastatus

Example:

{
  "id": 4722,
  "exitCriterion": 4710,
  "object": 4715,
  "status": 2
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a exitcriteriastatus from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • exit_criteria_status_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Collection of available comments in PlanMill. This is a read-only collection.

get

Get a list of comments

Get a list of comments

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • exit_criteria_status_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
  {
    "personName": "Tester, Mikko",
    "data": "API call comment test",
    "person": 4600,
    "created": "2015-09-22T00:29:02.260+0300",
    "pictureLink": "",
    "id": 4655
  }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/expenses

Collection of available expenses in PlanMill. See expenses/meta for list of filters, columns and formats.

get post

get

Get a list of expenses. See expenses/meta for list of filters, columns and formats.

post

Add a new expense to PlanMill or update existing (if id is given). See expenses/meta for list of columns and formats.

Add a new expense to PlanMill or update existing (if id is given). See expenses/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: expense

Example:

{
    "journey": null,
    "acceptor": null,
    "project": 4210,
    "description": "",
    "type": 0,
    "billableStatus": 3,
    "task": -1,
    "name": "test expense 1",
    "expenseOwner": 2297,
    "currency": "1",
    "id": 4211,
    "currencyCode": "EUR",
    "status": 3
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for expenses. Includes resource's fields names and type and related filters

get

View details of a single meta.

get post delete

A single expense in PlanMill.

get

View details of a single expense. See expenses/meta for list of filters, columns and formats.

post

Update an existing resource expense to PlanMill. See expenses/meta for list of filters, columns and formats.

delete

Remove a expense from PlanMill.

View details of a single expense. See expenses/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • Accept: (string)

    Get expense in PDF format

    Example:

    Accept: application/pdf
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: expense

Example:

{
    "journey": null,
    "acceptor": null,
    "project": 4210,
    "description": "",
    "type": 0,
    "billableStatus": 3,
    "task": -1,
    "name": "test expense 1",
    "expenseOwner": 2297,
    "currency": "1",
    "id": 4211,
    "currencyCode": "EUR",
    "status": 3
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource expense to PlanMill. See expenses/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: expense

Example:

{
    "journey": null,
    "acceptor": null,
    "project": 4210,
    "description": "",
    "type": 0,
    "billableStatus": 3,
    "task": -1,
    "name": "test expense 1",
    "expenseOwner": 2297,
    "currency": "1",
    "id": 4211,
    "currencyCode": "EUR",
    "status": 3
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a expense from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get post

Collection of available items in PlanMill. See items/meta for list of filters, columns and formats.

get

Get a list of items. See items/meta for list of filters, columns and formats.

post

Add a new item to PlanMill or update existing (if id is given). See items/meta for list of columns and formats.

Get a list of items. See items/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (string)

    Sorts the results using string that is a JSON attribute

  • interval?: (string)

    Interval type, e.g. start, finish, created, or modified. It is used in combination with intervalstart or intervalfinish

  • intervalstart?: (string)

    Start date of the interval in UTC format, intervalfinish required

    Example:

    2019-03-01T00:00:00.000+0200
  • intervalfinish?: (string)

    Finish date of the interval in UTC format, intervalstart required

    Example:

    2019-03-01T00:00:00.000+0200

HTTP status code 200

Body

Media type: application/json

Type: item

Example:

[
  {
    "quantity": 175,
    "start": "2016-03-02T00:00:00.000+0200",
    "vat": 0,
    "description": "Private car + Passengers(1) (Hämeentie 19, Helsinki - Teekkarinkatu, Tampere)",
    "type": 350,
    "expense": 2972,
    "unit": "km",
    "exchangeRate": 1,
    "advancePayment": 0,
    "paymentMethod": 0,
    "finish": null,
    "id": 2986,
    "debt": 1,
    "currencyCode": "EUR"
  },
  {
    "quantity": 1,
    "start": "2016-03-02T00:00:00.000+0200",
    "vat": null,
    "description": "One night stay at Tampere hotel",
    "type": 3,
    "expense": 2972,
    "unit": "-",
    "exchangeRate": 1,
    "advancePayment": 0,
    "paymentMethod": 1,
    "finish": "2016-03-03T00:00:00.000+0200",
    "id": 2973,
    "debt": 1,
    "currencyCode": "EUR"
  },
  {
    "quantity": 2,
    "start": "2016-03-02T00:00:00.000+0200",
    "vat": 0,
    "description": "",
    "type": 200,
    "expense": 2972,
    "unit": "-",
    "exchangeRate": 1,
    "advancePayment": 0,
    "paymentMethod": 0,
    "finish": "2016-03-03T00:00:00.000+0200",
    "id": 2985,
    "debt": 1,
    "currencyCode": "EUR"
  },
  {
    "quantity": 175,
    "start": "2016-03-03T00:00:00.000+0200",
    "vat": 0,
    "description": "Private car + Passengers(1) (Teekkarinkatu, Tampere - Hämeentie 19, Helsinki)",
    "type": 350,
    "expense": 2972,
    "unit": "km",
    "exchangeRate": 1,
    "advancePayment": 0,
    "paymentMethod": 0,
    "finish": null,
    "id": 2987,
    "debt": 1,
    "currencyCode": "EUR"
  }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Add a new item to PlanMill or update existing (if id is given). See items/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: item

Example:

{
  "quantity": 1,
  "start": "2016-03-02T00:00:00.000+0200",
  "vat": null,
  "description": "One night stay at Tampere hotel",
  "type": 3,
  "expense": 2972,
  "typeCode": "",
  "unit": "-",
  "exchangeRate": 1,
  "generated": "0",
  "advancePayment": 0,
  "paymentMethod": 1,
  "finish": "2016-03-03T00:00:00.000+0200",
  "currency": 1,
  "id": 2973,
  "debt": 1,
  "currencyCode": "EUR",
  "foreignCountryCode": ""
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get post delete

A single item in PlanMill.

get

View details of a single item. See items/meta for list of filters, columns and formats.

post

Update an existing resource item to PlanMill. See items/meta for list of filters, columns and formats.

delete

Remove a item from PlanMill.

View details of a single item. See items/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)
  • expense_item_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: item

Example:

{
  "quantity": 1,
  "start": "2016-03-02T00:00:00.000+0200",
  "vat": null,
  "description": "One night stay at Tampere hotel",
  "type": 3,
  "expense": 2972,
  "typeCode": "",
  "unit": "-",
  "exchangeRate": 1,
  "generated": "0",
  "advancePayment": 0,
  "paymentMethod": 1,
  "finish": "2016-03-03T00:00:00.000+0200",
  "currency": 1,
  "id": 2973,
  "debt": 1,
  "currencyCode": "EUR",
  "foreignCountryCode": ""
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource item to PlanMill. See items/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)
  • expense_item_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: item

Example:

{
  "quantity": 1,
  "start": "2016-03-02T00:00:00.000+0200",
  "vat": null,
  "description": "One night stay at Tampere hotel",
  "type": 3,
  "expense": 2972,
  "typeCode": "",
  "unit": "-",
  "exchangeRate": 1,
  "generated": "0",
  "advancePayment": 0,
  "paymentMethod": 1,
  "finish": "2016-03-03T00:00:00.000+0200",
  "currency": 1,
  "id": 2973,
  "debt": 1,
  "currencyCode": "EUR",
  "foreignCountryCode": ""
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a item from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)
  • expense_item_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the expense

get

View details of a single meta.

View details of a single meta.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)
  • expense_item_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "filters": null,
  "fields": {
    "quantity": {
      "format": "number",
      "caption": "QTY"
    },
    "start": {
      "format": "mediumdate",
      "caption": "Start"
    },
    "vat": {
      "format": "number",
      "caption": null
    },
    "description": {
      "format": "text",
      "caption": "Description"
    },
    "type": {
      "format": "Expense sheet.XHTML.Single item.Types",
      "caption": "Type"
    },
    "expense": {
      "format": "number",
      "caption": null
    },
    "unit": {
      "format": null,
      "caption": "Unit"
    },
    "exchangeRate": {
      "format": "number",
      "caption": "Exchange rate"
    },
    "advancePayment": {
      "format": "number",
      "caption": null
    },
    "paymentMethod": {
      "format": "Enumeration values.Expense.Expense item payment",
      "caption": "Payment"
    },
    "finish": {
      "format": "mediumdate",
      "caption": "Finish"
    },
    "id": {
      "format": "number",
      "caption": null
    },
    "debt": {
      "format": "number",
      "caption": null
    },
    "currencyCode": {
      "format": "text",
      "caption": null
    }
  }
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the expense

get

Get a list of meta

Get a list of meta

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "quantity": {
    "caption": "Quantity",
    "format": "double",
    "values": null
  },
  "start": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Start",
    "format": "string",
    "maxlength": "10",
    "values": null
  },
  "vat": {
    "format": "float",
    "values": null
  },
  "description": {
    "caption": "Description",
    "values": null
  },
  "type": {
    "caption": "Type",
    "values": {
      "1": "Other- VAT 24 %",
      "2": "Advance payment",
      "3": "Accommodation",
      "5": "Other",
      "70": "Taxi",
      "71": "Train",
      "72": "Parking",
      "73": "Air fare",
      "74": "Public transport",
      "80": "Representation",
      "81": "Purchase",
      "82": "Daily allowance - full day, Finland (2007)",
      "83": "Daily allowance - partial day, Finland (2007-2008)",
      "84": "Daily allowance, Sweden (2007)",
      "85": "Daily allowance, Denmark (2007)",
      "86": "Daily allowance, Norway (2007)",
      "87": "Daily allowance, Austria (2007-2008)",
      "89": "Daily allowance, Switzerland (2007-2008)",
      "90": "Daily allowance, UK (2007)",
      "91": "Daily allowance, USA (2009)",
      "92": "Daily allowance, Other",
      "93": "Car usage - private car (2007)",
      "96": "Car usage - company car (2007)",
      "97": "Car usage - passenger (2008)",
      "98": "Motor bike usage (2007)",
      "99": "Meal money (2007)",
      "100": "Daily allowance - full day, Finland (2008)",
      "101": "Daily allowance, Sweden (2008)",
      "102": "Daily allowance, Denmark (2009)",
      "103": "Daily allowance, Norway (2009)",
      "104": "Daily allowance, Germany(2010)",
      "105": "Daily allowance, UK (2009)",
      "106": "Car usage - private car (2008)",
      "107": "Car usage - company car (2008)",
      "108": "Motor bike usage (2008)",
      "109": "Meal money (2008)",
      "110": "Daily allowance, Germany (2007)",
      "112": "Daily allowance - full day, Finland (2009)",
      "113": "Daily allowance - partial day, Finland(2012)",
      "114": "Daily allowance, Sweden (2009)",
      "115": "Daily allowance, Austria (2009)",
      "116": "Daily allowance, Switzerland (2009)",
      "117": "Car usage - private car (2010)",
      "118": "Car usage - company car(2010)",
      "119": "Car usage - passenger",
      "120": "Motor bike usage(2011)",
      "121": "Meal money (2009)",
      "122": "Daily allowance - full day, Finland(2010)",
      "123": "Meal money(2010)",
      "124": "Car usage - limited car benefit(2011)",
      "125": "Daily allowance, Denmark(2012)",
      "126": "Daily allowance, Norway(2011)",
      "127": "Daily allowance, UK(2010)",
      "128": "Daily allowance, Sweden(2010)",
      "129": "Daily allowance, Austria(2010)",
      "130": "Daily allowance, Switzerland(2010)",
      "131": "Daily allowance, USA(2012)",
      "132": "Daily allowance - full day, Finland(2011)",
      "133": "Meal money(2011)",
      "134": "Car usage - private car(2011)",
      "135": "Car usage - company car(2011)",
      "136": "Daily allowance, Sweden(2012)",
      "137": "Daily allowance, Germany(2011)",
      "138": "Daily allowance, Switzerland(2011)",
      "139": "Daily allowance, UK(2012)",
      "140": "Daily allowance, Austria(2011)",
      "141": "Daily allowance, UK London(2013)",
      "143": "Motor bike usage(2012)",
      "144": "Car usage - limited car benefit(2012)",
      "145": "Daily allowance, Norway(2012)",
      "146": "Daily allowance - full day, Finland(2012)",
      "147": "Meal money(2012)",
      "148": "Car usage - private car(2013)",
      "149": "Car usage - company car(2013)",
      "150": "Daily allowance, Germany",
      "151": "Daily allowance, Switzerland(2012)",
      "152": "Daily allowance, Austria",
      "153": "Daily allowance - partial day, Finland(2013)",
      "154": "Daily allowance - full day, Finland(2013)",
      "155": "Daily allowance, Denmark",
      "156": "Daily allowance, Norway(2013)",
      "157": "Daily allowance, Sweden (2014)",
      "158": "Daily allowance, Switzerland (2015)",
      "159": "Daily allowance, UK(2013)",
      "160": "Daily allowance, USA(2013)",
      "161": "Meal money(2013)",
      "162": "Motor bike usage (2015)",
      "163": "Car usage - limited car benefit(2014)",
      "164": "Daily allowance - partial day, Finland (2014)",
      "165": "Daily allowance - full day, Finland (2014)",
      "166": "Car usage - private car (2014)",
      "167": "Meal money (2014)",
      "168": "Daily allowance, Norway (2014)",
      "169": "Daily allowance, UK (2014)",
      "170": "Daily allowance, UK London (2014)",
      "171": "Daily allowance, USA (2014)",
      "172": "Car usage - company car",
      "173": "Daily allowance, Netherlands",
      "174": "Daily allowance, France",
      "175": "Night travel allowance",
      "179": "Daily allowance - partial day, Finland (2015)",
      "180": "Daily allowance - full day, Finland (2015)",
      "181": "Car usage - private car (2015)",
      "182": "Meal money",
      "183": "Daily allowance, Sweden (2015)",
      "184": "Daily allowance, Norway",
      "185": "Daily allowance, UK (2015)",
      "186": "Daily allowance, UK London (2015)",
      "192": "Car usage - limited car benefit (2015)",
      "193": "Daily allowance, USA (2015)",
      "194": "Car usage - company car (2015)",
      "195": "Daily allowance, Other",
      "199": "Daily allowance - partial day, Finland",
      "200": "Daily allowance - full day, Finland",
      "201": "Daily allowance, Switzerland",
      "202": "Motor bike usage",
      "203": "Car usage - private car",
      "204": "Daily allowance, Sweden",
      "205": "Daily allowance, UK",
      "206": "Daily allowance, UK London",
      "207": "Car usage - limited car benefit",
      "208": "Daily allowance, USA",
      "209": "Car usage - company car",
      "325": "Foreign daily allowance",
      "330": "Other- VAT 14 %",
      "340": "Other- VAT 10 %",
      "350": "Own transport",
      "360": "Public transport",
      "370": "Other- VAT 0 %",
      "7000": "Domestic - Train VAT  10%",
      "7005": "Domestic - Representation VAT  0%",
      "7010": "Domestic - Public transport VAT  10%",
      "7015": "Domestic - Air fare VAT  10%",
      "7020": "Domestic - Accommodation’s breakfast VAT  14%",
      "7025": "Domestic - Accommodation VAT  10%",
      "7030": "Domestic - Conference costs VAT  14%",
      "7035": "Domestic - Conference costs VAT  24%",
      "7040": "Domestic - Parking VAT  24%",
      "7045": "Domestic - Taxi VAT  10%",
      "7047": "Domestic - Other cost VAT  0%",
      "7050": "Domestic - Other cost VAT  10%",
      "7055": "Domestic - Other cost VAT  14%",
      "7060": "Domestic - Other cost VAT  24%",
      "7065": "Foreign - Representation  VAT  0%",
      "7070": "Foreign - Air fare VAT  0%",
      "7075": "Foreign - Accommodation VAT  0%",
      "7080": "Foreign - Conference costs (no representation) VAT  0%",
      "7085": "Foreign - Taxi VAT  0%",
      "7090": "Foreign - Public transport VAT  0%",
      "7095": "Foreign - Other cost VAT  0%",
      "7100": "Foreign - Train VAT  0%",
      "7105": "Foreign - Books VAT  0%",
      "7110": "Domestic - Books VAT  10%",
      "7115": "Domestic - Postage VAT  24%",
      "7120": "Domestic - Telecommunications VAT  24%",
      "7125": "Domestic - Office supplies VAT  24%",
      "7130": "Domestic - Foodstuffs VAT  14%",
      "7135": "Domestic - Staff costs VAT  24%",
      "7140": "Domestic - Telecommunications VAT 0%"
    },
    "format": "int"
  },
  "expense": {
    "values": null
  },
  "typeCode": {
    "caption": "TypeCode",
    "format": "string",
    "maxlength": "80",
    "values": null
  },
  "unit": {
    "caption": "Unit",
    "maxlength": "80",
    "values": null
  },
  "exchangeRate": {
    "caption": "Exchange rate",
    "format": "double",
    "description": "",
    "values": null
  },
  "generated": {
    "format": "string",
    "values": null
  },
  "advancePayment": {
    "values": null
  },
  "paymentMethod": {
    "caption": "Payment",
    "enumeration": "Enumeration values.Expense.Expense item payment",
    "values": {
      "Invoice (non-debt)": "4",
      "Own credit card": "3",
      "Advance payment": "5",
      "Company credit card (non-debt)": "2",
      "Company expense (non-debt)": "7",
      "Cash": "1",
      "-": "0"
    }
  },
  "finish": {
    "calendar": "yyyy-MM-dd'T'HH:mm:ss.SSSZ",
    "caption": "Finish",
    "format": "string",
    "maxlength": "10",
    "values": null
  },
  "currency": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "id": {
    "values": null
  },
  "debt": {
    "values": null
  },
  "currencyCode": {
    "caption": "To",
    "format": "string",
    "description": "",
    "values": null
  },
  "foreignCountryCode": {
    "caption": "ForeignCountryCode",
    "format": "string",
    "maxlength": "2",
    "values": null
  }
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

post

Increment the status of expenses

post

Inspected = 3, Accepted = 4, Paid = 6, Rejected = 7

Inspected = 3, Accepted = 4, Paid = 6, Rejected = 7

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: status

Example:

{
  "status": 7
}

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "status": 7
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the expense

get

View details of a single meta.

View details of a single meta.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "task": {
    "caption": "Task",
    "values": {
      "": "-"
    }
  },
  "journey": {
    "values": null
  },
  "acceptor": {
    "caption": "Acceptor",
    "format": "int",
    "values": null
  },
  "name": {
    "caption": "Purpose",
    "maxlength": "255",
    "values": null
  },
  "project": {
    "caption": "Project",
    "values": {
      "2820": "Test project (13004)",
      "2969": "test project - expense (13005)",
      "": "-",
      "test project - expense (13005)": 2969,
      "Test project (13004)": 2820
    }
  },
  "description": {
    "caption": "Description",
    "values": null
  },
  "currency": {
    "caption": "currencyid",
    "format": "string",
    "description": "",
    "values": null
  },
  "id": {
    "values": null
  },
  "type": {
    "caption": "Type",
    "enumeration": "Enumeration values.Expense.Type",
    "values": {
      "Travel": "0",
      "Advance payment": "10",
      "Other": "7"
    }
  },
  "billableStatus": {
    "caption": "Billable status",
    "values": {
      "1": "1",
      "3": "3"
    }
  },
  "currencyCode": {
    "format": "string",
    "description": "",
    "values": null
  },
  "expenseOwner": {
    "format": "integer",
    "description": "id of the person the that owns the expense",
    
  }
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Collection of available attachments in PlanMill. This is a read-only collection.

get

Get a list of attachments

Get a list of attachments

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
    {
        "size": 447,
        "createdBy": 50,
        "created": "2019-02-21T10:31:19.170+0200",
        "name": "attached_file_test.txt",
        "modified": "2019-02-21T12:04:05.007+0200",
        "id": 1514
    },
    {
        "size": 466,
        "createdBy": 50,
        "created": "2019-02-21T12:04:05.017+0200",
        "name": "attached_file.txt",
        "modified": "2019-02-21T12:04:05.017+0200",
        "id": 1515
    }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

put get

put
get

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)
  • attachment_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • expense_id: required(string)
  • attachment_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

Contents of file

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/hooks

The currently available subscribable events are listed here along with usage guidelines

https://github.com/planmill/api/wiki/WebHooks

get post

get

Get a list of hooks. See hooks/meta for list of filters, columns and formats.

post

Add a new hook to PlanMill or update existing (if id is given). See hooks/meta for list of columns and formats.

Add a new hook to PlanMill or update existing (if id is given). See hooks/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all hook subscriptions",
  "items": { "$ref": "#/definitions/hooks" },
  "definitions": {
    "hook": {
      "type": "object",
      "required": [ "hook", "url" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "number",
          "description": "Unique subscription identifier"
        },
        "hook": {
          "type": "string",
          "description": "Event identifier"
        },
        "url": {
          "type": "string",
          "description": "Subscription URL that will be posted with data when event is triggered"
        },
        "eventUser": {
          "type": ["number", "null"]
        },
        "eventProject": {
          "type": ["number", "null"]
        }
      }
    }
  }
}

Example:

{
    "hook": "account.update",
    "eventUser": -1,
    "id": 1409,
    "eventProject": -1,
    "type": 1,
    "url": "https://endurable-hound.glitch.me/hook"
}

Triggered hook would look as below 

{
	"hook": "account.update",
	"resource": {
		"lineOfBusiness": null,
		"shippingCity": "",
		"businessId": "",
		"vatId": "",
		"invoiceEmail": "",
		"shippingPostalCode": "",
		"type": 8,
		"blog": "",
		"twitter": "",
		"shippingCountry": 0,
		"rfReferenceNumber": 0,
		"invoiceChannel": -1,
		"billingCountry": 0,
		"id": 1320,
		"invoiceAppendix": 0,
		"supplierAccount": null,
		"billingState": "",
		"serviceLevel": 0,
		"customerSatisfaction": null,
		"autoReplyRequestMails": 0,
		"combineInvoices": 0,
		"reverseCharge": null,
		"phone": "",
		"name": "Your first prospect name (update)",
		"billingReference": "",
		"invoiceTemplate": "",
		"shippingState": "",
		"termsOfPayment": 14,
		"eInvoicingAddress": null,
		"handlingFee": null,
		"invoiceVat": 24,
		"description": "",
		"industry": -1,
		"parentAccount": null,
		"ceo": null,
		"parentAccountName": null,
		"shippingReference": "",
		"turnover": null,
		"email": "",
		"owner": 50,
		"website": "",
		"facebook": "",
		"staff": null,
		"passive": 0,
		"invoiceNetOperator": null,
		"billingPostalCode": "",
		"firstInvoiceNumber": null,
		"shippingAddress": "",
		"billingAddress": "",
		"billingCity": ""
	},
	"subject": "Your first prospect name (update)",
	"eventUser": 50,
	"Id": 1320
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get post delete

A single hook in PlanMill.

get

View details of a single hook. See hooks/meta for list of filters, columns and formats.

post

Update an existing resource hook to PlanMill. See hooks/meta for list of filters, columns and formats.

delete

Remove a hook from PlanMill.

View details of a single hook. See hooks/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • hook_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all hook subscriptions",
  "items": { "$ref": "#/definitions/hooks" },
  "definitions": {
    "hook": {
      "type": "object",
      "required": [ "hook", "url" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "number",
          "description": "Unique subscription identifier"
        },
        "hook": {
          "type": "string",
          "description": "Event identifier"
        },
        "url": {
          "type": "string",
          "description": "Subscription URL that will be posted with data when event is triggered"
        },
        "eventUser": {
          "type": ["number", "null"]
        },
        "eventProject": {
          "type": ["number", "null"]
        }
      }
    }
  }
}

Example:

{
    "hook": "account.update",
    "eventUser": -1,
    "id": 1409,
    "eventProject": -1,
    "type": 1,
    "url": "https://endurable-hound.glitch.me/hook"
}

Triggered hook would look as below 

{
	"hook": "account.update",
	"resource": {
		"lineOfBusiness": null,
		"shippingCity": "",
		"businessId": "",
		"vatId": "",
		"invoiceEmail": "",
		"shippingPostalCode": "",
		"type": 8,
		"blog": "",
		"twitter": "",
		"shippingCountry": 0,
		"rfReferenceNumber": 0,
		"invoiceChannel": -1,
		"billingCountry": 0,
		"id": 1320,
		"invoiceAppendix": 0,
		"supplierAccount": null,
		"billingState": "",
		"serviceLevel": 0,
		"customerSatisfaction": null,
		"autoReplyRequestMails": 0,
		"combineInvoices": 0,
		"reverseCharge": null,
		"phone": "",
		"name": "Your first prospect name (update)",
		"billingReference": "",
		"invoiceTemplate": "",
		"shippingState": "",
		"termsOfPayment": 14,
		"eInvoicingAddress": null,
		"handlingFee": null,
		"invoiceVat": 24,
		"description": "",
		"industry": -1,
		"parentAccount": null,
		"ceo": null,
		"parentAccountName": null,
		"shippingReference": "",
		"turnover": null,
		"email": "",
		"owner": 50,
		"website": "",
		"facebook": "",
		"staff": null,
		"passive": 0,
		"invoiceNetOperator": null,
		"billingPostalCode": "",
		"firstInvoiceNumber": null,
		"shippingAddress": "",
		"billingAddress": "",
		"billingCity": ""
	},
	"subject": "Your first prospect name (update)",
	"eventUser": 50,
	"Id": 1320
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource hook to PlanMill. See hooks/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • hook_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all hook subscriptions",
  "items": { "$ref": "#/definitions/hooks" },
  "definitions": {
    "hook": {
      "type": "object",
      "required": [ "hook", "url" ],
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "number",
          "description": "Unique subscription identifier"
        },
        "hook": {
          "type": "string",
          "description": "Event identifier"
        },
        "url": {
          "type": "string",
          "description": "Subscription URL that will be posted with data when event is triggered"
        },
        "eventUser": {
          "type": ["number", "null"]
        },
        "eventProject": {
          "type": ["number", "null"]
        }
      }
    }
  }
}

Example:

{
    "hook": "account.update",
    "eventUser": -1,
    "id": 1409,
    "eventProject": -1,
    "type": 1,
    "url": "https://endurable-hound.glitch.me/hook"
}

Triggered hook would look as below 

{
	"hook": "account.update",
	"resource": {
		"lineOfBusiness": null,
		"shippingCity": "",
		"businessId": "",
		"vatId": "",
		"invoiceEmail": "",
		"shippingPostalCode": "",
		"type": 8,
		"blog": "",
		"twitter": "",
		"shippingCountry": 0,
		"rfReferenceNumber": 0,
		"invoiceChannel": -1,
		"billingCountry": 0,
		"id": 1320,
		"invoiceAppendix": 0,
		"supplierAccount": null,
		"billingState": "",
		"serviceLevel": 0,
		"customerSatisfaction": null,
		"autoReplyRequestMails": 0,
		"combineInvoices": 0,
		"reverseCharge": null,
		"phone": "",
		"name": "Your first prospect name (update)",
		"billingReference": "",
		"invoiceTemplate": "",
		"shippingState": "",
		"termsOfPayment": 14,
		"eInvoicingAddress": null,
		"handlingFee": null,
		"invoiceVat": 24,
		"description": "",
		"industry": -1,
		"parentAccount": null,
		"ceo": null,
		"parentAccountName": null,
		"shippingReference": "",
		"turnover": null,
		"email": "",
		"owner": 50,
		"website": "",
		"facebook": "",
		"staff": null,
		"passive": 0,
		"invoiceNetOperator": null,
		"billingPostalCode": "",
		"firstInvoiceNumber": null,
		"shippingAddress": "",
		"billingAddress": "",
		"billingCity": ""
	},
	"subject": "Your first prospect name (update)",
	"eventUser": 50,
	"Id": 1320
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a hook from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • hook_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/integrations

get

get

Get a list of available integration templates and statuses.

post delete get

Using specific saved integration settings for importing or exporting a set of data to like file containing information of different companies to PlanMill as accounts.

post

Begins a new integration process for this template with a given file.

delete

Cancels the current integration process for this template.

get

Previews data transformation with a given amount of rows.

Begins a new integration process for this template with a given file.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Query Parameters

  • file: (integer)

    Id of the file to be used in the integration.

  • delim: (string)

    Delimiter character used in the source CSV file. Optional but might be needed to be supplied if the delimiter cannot be detected.

  • quote: (string - default: (double quote))

    Quote character used in the source CSV file

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Cancels the current integration process for this template.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Previews data transformation with a given amount of rows.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Query Parameters

  • ignoreFirstRow: required(string - default: false)

    Ignore the first row of a file. Useful with CSV files with header rows.

  • rows: required(integer - default: 10)

    Number of rows to preview

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "sourceFields": [
    "contact.lastName",
    "contact.firstName",
    "contact.account",
    "contact.title",
    "contact.mobilePhone",
    "contact.email"
  ],
  "targetRows": [
    [
      "ROW1COL1",
      "ROW1COL2",
      "9999999",
      "ROW1COL4",
      "123456",
      "regressionb@accountb.com"
    ],
    [
      "ROW2COL1",
      "ROW2COL2",
      "123456",
      "ROW2COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW3COL1",
      "ROW3COL2",
      "123456",
      "ROW3COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW4COL1",
      "ROW4COL2",
      "123456",
      "ROW4COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW5COL1",
      "ROW5COL2",
      "123456",
      "ROW5COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW6COL1",
      "ROW6COL2",
      "123456",
      "ROW6COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW7COL1",
      "ROW7COL2",
      "123456",
      "ROW7COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW8COL1",
      "ROW8COL2",
      "123456",
      "ROW8COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW9COL1",
      "ROW9COL2",
      "123456",
      "ROW9COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW10COL1",
      "ROW10COL2",
      "123456",
      "ROW10COL4",
      "123456",
      "a@b.com"
    ]
  ],
  "sourceRows": [
    [
      "ROW1COL1",
      "ROW1COL2",
      "9999999",
      "ROW1COL4",
      "123456",
      "regressionb@accountb.com"
    ],
    [
      "ROW2COL1",
      "ROW2COL2",
      "123456",
      "ROW2COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW3COL1",
      "ROW3COL2",
      "123456",
      "ROW3COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW4COL1",
      "ROW4COL2",
      "123456",
      "ROW4COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW5COL1",
      "ROW5COL2",
      "123456",
      "ROW5COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW6COL1",
      "ROW6COL2",
      "123456",
      "ROW6COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW7COL1",
      "ROW7COL2",
      "123456",
      "ROW7COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW8COL1",
      "ROW8COL2",
      "123456",
      "ROW8COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW9COL1",
      "ROW9COL2",
      "123456",
      "ROW9COL4",
      "123456",
      "a@b.com"
    ],
    [
      "ROW10COL1",
      "ROW10COL2",
      "123456",
      "ROW10COL4",
      "123456",
      "a@b.com"
    ]
  ],
  "targetFields": [
    "contact.lastName",
    "contact.firstName",
    "contact.account",
    "contact.title",
    "contact.mobilePhone",
    "contact.email"
  ]
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

put

put

Transforms source file to insertable data. Returns a list of any omitted rows due to invalid field data.

Transforms source file to insertable data. Returns a list of any omitted rows due to invalid field data.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Query Parameters

  • ignoreFirstRow: required(string - default: false)

    Ignore the first row of a file. Useful with CSV files with header rows.

HTTP status code 202

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

get

Returns errors occurred during transformation. Uses pagination.

Returns errors occurred during transformation. Uses pagination.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Query Parameters

  • from: required(integer - default: 1)

    The row number of the first error row to return.

  • rows: required(integer - default: 100)

    The amount of rows to return.

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

[{
	"row" : "1",
	"message" : "Transformation failed",
	"fields" : {
		"pricebookitem.vat" : "Could not parse value to a double.",
		"pricebookitem.sellingPrice" : "Could not parse value to an integer.",
		"pricebook.owner" : "Please enter a valid number.",
		"pricebookitem.targetEffort" : "Could not parse value to an integer.",
		"priceBook.validFrom" : "Failed to parse date with format dd.MM.yyyy",
		"pricebook.validFrom" : "Please enter a valid date.",
		"pricebook.passive" : "Please enter a valid number.",
		"pricebookitem.invoicingPeriod" : "Enumeration value for key 'PBI Invoicing period' not found.",
		"priceBook.passive" : "Could not parse value to an integer.",
		"priceBook.supplier" : "Could not parse value to an integer.",
		"pricebookitem.discount" : "Could not parse value to a double.",
		"pricebookitem.salesAccount" : "Could not parse value to an integer.",
		"pricebook.supplier" : "Please enter a valid number.",
		"pricebookitem.revenueType" : "Could not parse value to an integer.",
		"priceBook.currency" : "Enumeration value for key 'PB Currency' not found.",
		"pricebookitem.unit" : "Enumeration value for key 'PBI Unit' not found.",
		"pricebook.currency" : "Please enter a valid number."
	}
}]

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

put

put

Compares candidate data with existing objects in PlanMill and returns an appropriate update or insert dataset.

Compares candidate data with existing objects in PlanMill and returns an appropriate update or insert dataset.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

HTTP status code 202

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get put

get

Lists all conflicts by their given import row. In the case that a given import row matches multiple existing objects in the system they are collected as conflicts to be resolved.

put

Resolve matches to multiple existing objects by specifying the preferred object id for each conflict

Lists all conflicts by their given import row. In the case that a given import row matches multiple existing objects in the system they are collected as conflicts to be resolved.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "conflicts": [
    {
      "matchedFields": ["businessId"],
      "matchedValues": ["7777777"],
      "conflictId": 1,
      "matchedObjects": [
        {
          "businessId": "7777777",
          "revenueLastYear": "0",
          "ownerName": "Owner, Thomas",
          "rfReferenceNumber": "0",
          "billingCountry": "73",
          "modified": "2015-07-07T10:43:22.643+0300",
          "activeContacts": "0",
          "id": "2293",
          "owner": "2252",
          "created": "2015-07-06T10:43:22.480+0300",
          "revenueThisYear": "0",
          "passive": "0",
          "combineInvoices": "0",
          "createdBy": "User, First",
          "billingPostalCode": "500",
          "name": "Test Account 1",
          "billingAddress": "Hämeentie 19",
          "billingCity": "Helsinki"
        },
        {
          "shippingCity": "Helsinki",
          "businessId": "7777777",
          "invoiceVat": "24",
          "revenueLastYear": "0",
          "industry": "-1",
          "shippingPostalCode": "12323",
          "type": "8",
          "ownerName": "Owner, Thomas",
          "shippingCountry": "0",
          "rfReferenceNumber": "0",
          "billingCountry": "73",
          "modified": "2015-07-07T10:43:29.853+0300",
          "activeContacts": "0",
          "id": "2305",
          "owner": "2252",
          "created": "2015-07-07T10:43:29.853+0300",
          "revenueThisYear": "0",
          "serviceLevel": "0",
          "passive": "0",
          "combineInvoices": "0",
          "phone": "12323",
          "createdBy": "User, First",
          "billingPostalCode": "1343",
          "name": "Test Account 2",
          "shippingAddress": "TEST",
          "billingAddress": "Hämeentie 19",
          "termsOfPayment": "14",
          "billingCity": "Helsinki"
        },
        {
          "shippingCity": "Helsinki",
          "businessId": "7777777",
          "invoiceVat": "24",
          "revenueLastYear": "0",
          "industry": "-1",
          "shippingPostalCode": "12323",
          "type": "8",
          "ownerName": "938",
          "shippingCountry": "73",
          "rfReferenceNumber": "0",
          "billingCountry": "73",
          "modified": "2015-07-06T17:44:54.717+0300",
          "activeContacts": "0",
          "id": "1021",
          "owner": "938",
          "created": "2015-07-06T17:44:54.717+0300",
          "revenueThisYear": "0",
          "serviceLevel": "0",
          "passive": "0",
          "combineInvoices": "0",
          "phone": "12323",
          "createdBy": "938",
          "billingPostalCode": "1343",
          "name": "Test Account 3",
          "shippingAddress": "Kuitinkatu 2",
          "billingAddress": "Hämeentie 19",
          "termsOfPayment": "14",
          "billingCity": "Helsinki"
        }
      ],
      "objectType": "account",
      "object": {
        "shippingCity": "Espoo",
        "phone": "12323",
        "billingPostalCode": "1343",
        "businessId": "7777777",
        "name": "Test Account 4",
        "shippingAddress": "Kuitinkatu 2",
        "shippingPostalCode": "12323",
        "billingAddress": "Hämeentie 19",
        "billingCity": "Helsinki"
      }
    }
  ]
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Resolve matches to multiple existing objects by specifying the preferred object id for each conflict

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Body

Media type: application/json

Type: any

Example:

{
  "1" : "2839618",
  "2" : "-1"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

post

post

Imports prepared comparison dataset into PlanMill.

Imports prepared comparison dataset into PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Query Parameters

  • mode: required(one of insert, update, merge)

    Importing mode. Insert will only import new objects, update will only update existing objects and merge will do both

  • noComparison: required(boolean - default: false)

    Perform import without comparison by directly using the transformation result

HTTP status code 202

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

get

Returns errors occurred during transformation. Uses pagination.

Returns errors occurred during transformation. Uses pagination.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • template: required(string)

    source.template

    Example:

    Asiakastieto.DecisionMaker

Query Parameters

  • from: required(integer - default: 1)

    The row number of the first error row to return.

  • rows: required(integer - default: 100)

    The amount of rows to return.

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/invoices

Collection of available invoices in PlanMill. This is a read-only collection.

get

get

Get a list of invoices

get

A single invoice in PlanMill. This is a read-only item.

get

View details of a single invoice.

View details of a single invoice.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • invoice_id: required(string)

Headers

  • Accept: (one of application/pdf, application/xml)

    Get invoice in PDF and XML formats. PDF-format works with Invoice + appendix and XML-format works with Finvoice

    Example:

    Accept: application/pdf
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "salesExecutive": 2960,
  "invoiceXSL": "planmill_en_eur.xsl",
  "invoiceAppendix": 0,
  "invoiceNumber": 14,
  "paymentStatus": 0,
  "handlingFeeAccount": 7,
  "sentToAccounting": null
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/languages

Language strings used for localization available in PlanMill

get

get

View details of a single language.

/me

Current user information in PlanMill

get

get

View details of a single me.

/mails

Mail information in PlanMill

get

get

Get a list of mails

get delete

get

View details of single mail.

delete

Remove a mail from PlanMill.

View details of single mail.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • mail_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{
  "sender": "noreply@planmill.com",
  "subject": "This is the first mail",
  "carbonCopy": "tester.carbon@planmill.com",
  "blindCarbonCopy": null,
  "nonDraft": 0,
  "id": 7415,
  "primaryTo": "tester.primary@planmill.com",
  "body": "This is the first mail main from planmill api regression test"
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a mail from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • mail_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Collection of available attachments in PlanMill. This is a read-only collection.

get

Get a list of attachments

Get a list of attachments

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • mail_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
    {
        "size": 447,
        "createdBy": 50,
        "created": "2019-02-21T10:31:19.170+0200",
        "name": "attached_file_test.txt",
        "modified": "2019-02-21T12:04:05.007+0200",
        "id": 1514
    },
    {
        "size": 466,
        "createdBy": 50,
        "created": "2019-02-21T12:04:05.017+0200",
        "name": "attached_file.txt",
        "modified": "2019-02-21T12:04:05.017+0200",
        "id": 1515
    }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

A single attachment in PlanMill. This is a read-only item.

get

View details of a single attachment.

View details of a single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • mail_id: required(string)
  • attachment_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

Contents of file

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

/opportunities

Collection of available opportunities in PlanMill. See opportunities/meta for list of filters, columns and formats.

get post

get

Get a list of opportunities. See opportunities/meta for list of filters, columns and formats.

post

Add a new opportunity to PlanMill or update existing (if id is given). See opportunities/meta for list of columns and formats.

Add a new opportunity to PlanMill or update existing (if id is given). See opportunities/meta for list of columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all opportunities entities",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/definitions/opportunityArray"
      }
    },
    {
      "$ref": "#/definitions/opportunitySingle"
    }
  ],
  "definitions": {
    "opportunitySingle": {
      "type": "object",
      "required": [ "subject", "contact", "responsible", "closed" ],
      "properties": {
        "subject": {
          "type": "string",
          "description": "Name of an opportunity"
        },
        "probability": {
          "type": "integer",
          "description": "Probability to win an opportunity"
        },
        "priority": {
          "type": "integer",
          "description": "Priority of an opportunity"
        },
        "stage": {
          "type": "integer",
          "description": "Stage of an opportunity"
        },
        "contact": {
          "type": "integer",
          "description": "Contact person id of an opportunity"
        },
        "responsible": {
          "type": "integer",
          "description": "Responsible person id of an opportunity"
        },
        "closed": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Closed date of an opportunity"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an opportunity"
        }
      }
    },
    "opportunityArray": {
      "type": "object",
      "required": [ "subject", "responsible", "closed" ],
      "properties": {
        "subject": {
          "type": "string",
          "description": "Name of an opportunity"
        },
        "probability": {
          "type": "integer",
          "description": "Probability to win an opportunity"
        },
        "priority": {
          "type": "integer",
          "description": "Priority of an opportunity"
        },
        "stage": {
          "type": "integer",
          "description": "Stage of an opportunity"
        },
        "contact": {
          "type": "integer",
          "description": "Contact id of an opportunity"
        },
        "closed": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of an opportunity"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an opportunity"
        }
      }
    }
  }
}

Example:

{
  "id": 12345,
  "reason": 0,
  "request": 1234,
  "subject": "Opportunity test",
  "probability": 10,
  "project": 123123,
  "description": "",
  "source": 0,
  "priority": 2,
  "type": 0,
  "stage": 10,
  "competitor": -1,
  "partnerContact": null,
  "responsible": 2834513,
  "contact": 2834513,
  "nextStep": 0,
  "campaign": 12345,
  "finish": "2015-04-30T00:00:00.000+0300",
  "status": 0
}

HTTP status code 201

Body

Media type: application/json

Type: object

Example:

{ "id" : 123456 }

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for opportunities. Includes resource's fields names and type and related filters

get

View details of a single meta.

get post delete

A single opportunity in PlanMill.

get

View details of a single opportunity. See opportunities/meta for list of filters, columns and formats.

post

Update an existing resource opportunity to PlanMill. See opportunities/meta for list of filters, columns and formats.

delete

Remove a opportunity from PlanMill.

View details of a single opportunity. See opportunities/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • opportunity_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all opportunities entities",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/definitions/opportunityArray"
      }
    },
    {
      "$ref": "#/definitions/opportunitySingle"
    }
  ],
  "definitions": {
    "opportunitySingle": {
      "type": "object",
      "required": [ "subject", "contact", "responsible", "closed" ],
      "properties": {
        "subject": {
          "type": "string",
          "description": "Name of an opportunity"
        },
        "probability": {
          "type": "integer",
          "description": "Probability to win an opportunity"
        },
        "priority": {
          "type": "integer",
          "description": "Priority of an opportunity"
        },
        "stage": {
          "type": "integer",
          "description": "Stage of an opportunity"
        },
        "contact": {
          "type": "integer",
          "description": "Contact person id of an opportunity"
        },
        "responsible": {
          "type": "integer",
          "description": "Responsible person id of an opportunity"
        },
        "closed": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Closed date of an opportunity"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an opportunity"
        }
      }
    },
    "opportunityArray": {
      "type": "object",
      "required": [ "subject", "responsible", "closed" ],
      "properties": {
        "subject": {
          "type": "string",
          "description": "Name of an opportunity"
        },
        "probability": {
          "type": "integer",
          "description": "Probability to win an opportunity"
        },
        "priority": {
          "type": "integer",
          "description": "Priority of an opportunity"
        },
        "stage": {
          "type": "integer",
          "description": "Stage of an opportunity"
        },
        "contact": {
          "type": "integer",
          "description": "Contact id of an opportunity"
        },
        "closed": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of an opportunity"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an opportunity"
        }
      }
    }
  }
}

Example:

{
  "id": 12345,
  "reason": 0,
  "request": 1234,
  "subject": "Opportunity test",
  "probability": 10,
  "project": 123123,
  "description": "",
  "source": 0,
  "priority": 2,
  "type": 0,
  "stage": 10,
  "competitor": -1,
  "partnerContact": null,
  "responsible": 2834513,
  "contact": 2834513,
  "nextStep": 0,
  "campaign": 12345,
  "finish": "2015-04-30T00:00:00.000+0300",
  "status": 0
}

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Update an existing resource opportunity to PlanMill. See opportunities/meta for list of filters, columns and formats.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • opportunity_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "base schema for all opportunities entities",
  "oneOf": [
    {
      "type": "array",
      "items": {
        "$ref": "#/definitions/opportunityArray"
      }
    },
    {
      "$ref": "#/definitions/opportunitySingle"
    }
  ],
  "definitions": {
    "opportunitySingle": {
      "type": "object",
      "required": [ "subject", "contact", "responsible", "closed" ],
      "properties": {
        "subject": {
          "type": "string",
          "description": "Name of an opportunity"
        },
        "probability": {
          "type": "integer",
          "description": "Probability to win an opportunity"
        },
        "priority": {
          "type": "integer",
          "description": "Priority of an opportunity"
        },
        "stage": {
          "type": "integer",
          "description": "Stage of an opportunity"
        },
        "contact": {
          "type": "integer",
          "description": "Contact person id of an opportunity"
        },
        "responsible": {
          "type": "integer",
          "description": "Responsible person id of an opportunity"
        },
        "closed": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Closed date of an opportunity"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an opportunity"
        }
      }
    },
    "opportunityArray": {
      "type": "object",
      "required": [ "subject", "responsible", "closed" ],
      "properties": {
        "subject": {
          "type": "string",
          "description": "Name of an opportunity"
        },
        "probability": {
          "type": "integer",
          "description": "Probability to win an opportunity"
        },
        "priority": {
          "type": "integer",
          "description": "Priority of an opportunity"
        },
        "stage": {
          "type": "integer",
          "description": "Stage of an opportunity"
        },
        "contact": {
          "type": "integer",
          "description": "Contact id of an opportunity"
        },
        "closed": {
          "type": "string",
          "pattern": "(\\d{4})-([0][1-9]|[1][0-2])-([0][1-9]|[1-2][0-9]|[3][0-1])T([0][0-9]|[1][0-9]|[2][0-3]):([0-5][0-9]):([0-5][0-9]).(\\d{3})((\\+|\\-)([0-9]|[0][0-9]|[1][0-9]|[2][0-3])([0-5][0-9]))",
          "description": "Finish date of an opportunity"
        },
        "status": {
          "type": [ "integer", "null" ],
          "description": "Status of an opportunity"
        }
      }
    }
  }
}

Example:

{
  "id": 12345,
  "reason": 0,
  "request": 1234,
  "subject": "Opportunity test",
  "probability": 10,
  "project": 123123,
  "description": "",
  "source": 0,
  "priority": 2,
  "type": 0,
  "stage": 10,
  "competitor": -1,
  "partnerContact": null,
  "responsible": 2834513,
  "contact": 2834513,
  "nextStep": 0,
  "campaign": 12345,
  "finish": "2015-04-30T00:00:00.000+0300",
  "status": 0
}

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

Remove a opportunity from PlanMill.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • opportunity_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Collection of available attachments in PlanMill. This is a read-only collection.

get

Get a list of attachments

Get a list of attachments

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • opportunity_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

Query Parameters

  • rowcount?: (integer - minimum: 1)

    It limits the result set amount to the specified limit to avoid API call to return too many records. Default row count is 100

  • nextrows?: (integer)

    The number of the next starting row. It is dependent on rowcount. For example, for total 250 items, if rowcount is 100 and nextrows is 101, it return items 101-201

  • order?: (integer)

    Orders the results in ascending or descending order. 0=Ascending and 1=Descending. It is used in combination with sort

  • sort?: (integer)

    Sorts the results using number that is associated with each column

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

[
    {
        "size": 447,
        "createdBy": 50,
        "created": "2019-02-21T10:31:19.170+0200",
        "name": "attached_file_test.txt",
        "modified": "2019-02-21T12:04:05.007+0200",
        "id": 1514
    },
    {
        "size": 466,
        "createdBy": 50,
        "created": "2019-02-21T12:04:05.017+0200",
        "name": "attached_file.txt",
        "modified": "2019-02-21T12:04:05.017+0200",
        "id": 1515
    }
]

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

put get

put
get

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • opportunity_id: required(string)
  • attachment_id: required(string)

Headers

  • Content-Type: required(string - default: application/json;charset=UTF-8 )

    Example:

    application/json;charset=UTF-8
  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 204

No HTTP body returned

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

View details of single attachment.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • opportunity_id: required(string)
  • attachment_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

Contents of file

HTTP status code 400

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "ID in GET request URI was malformed",
  "code": "00003"
}

HTTP status code 401

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Nonce too old",
  "code": "00401"
}

HTTP status code 403

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Timer is not allowed to go over 24h! Rounding it down.",
  "code": "00403"
}

HTTP status code 404

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Item not found",
  "code": "00404"
}

HTTP status code 429

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

HTTP status code 500

Headers

  • Content-type: required(string - default: application/json;charset=UTF-8 )

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid date pattern",
  "code": "00500"
}

Secured by oauth_2.0

Headers

  • Authorization: required(string)

    Used to send a valid OAuth 2 access token.

get

Get meta information for the updatable fields of the sales orders

get

View details of a single meta.

View details of a single meta.

Secured by oauth_2.0

PlanMill supports OAuth 2.0 for authenticating all API requests. More information about it in the security part of the documentation.

URI Parameters

  • opportunity_id: required(string)

Headers

  • x-PlanMill-Currency: (string - minLength: 3 - maxLength: 3)

    Recommended to be given. If currency not given in request header, user's current currency set in user settings is used. ISO code of currency in which money values should be shown or saved. Applies to all money attributes of the object, but may be converted by backend to the object specific currency. Some objects and their attributes may not care about the given currency but use the object's own currency

    Example:

    EUR

HTTP status code 200

Body

Media type: application/json

Type: object

Example:

{
  "reason": {
    "caption": "Reason won/lost",
    "format": "int",
    "enumeration": "Enumeration values.Sales management.Opportunities.Reason lost",
    "values": {
      "Not qualified": "7",
      "Installed base": "1",
      "No current project": "5",
      "Lost to competition": "8",
      "Lost to no decision": "9",
      "Price": "2",
      "Relationship": "3",
      "No budget": "6",
      "-": "0",
      "Track record": "4",
      "Other": "10"
    }
  },
  "request": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "subject": {
    "caption": "Name",
    "format": "string",
    "maxlength": "255",
    "values": null
  },
  "probability": {
    "caption": "Probability",
    "format": "int",
    "enumeration": "Enumeration values.Sales management.Opportunities.Probability",
    "values": {
      "25%": "25",
      "100%": "100",
      "0%": "0",
      "10%": "10",
      "75%": "75",
      "50%": "50"
    }
  },
  "project": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "description": {
    "caption": "",
    "format": "string",
    "description": "",
    "values": null
  },
  "source": {
    "caption": "Source",
    "format": "int",
    "enumeration": "Enumeration values.Sales management.Opportunities.Source",
    "values": {
      "Event - seminar": "4",
      "Email": "3",
      "Event - trade show": "5",
      "-": "0",
      "Direct mail": "2",
      "Referral - customer": "13",
      "Newspaper & Magazine": "12",
      "Referral - external": "10",
      "List - purchased": "7",
      "List - rented": "8",
      "Advertisement": "1",
      "Referral - employee": "9",
      "Web site": "11",
      "Event - other": "6",
      "Other": "20"
    }
  },
  "priority": {
    "caption": "Priority",
    "format": "int",
    "enumeration": "Enumeration values.Sales management.Opportunities.Priority",
    "values": {
      "High": "3",
      "Low": "1",
      "Medium": "2"
    }
  },
  "type": {
    "caption": "Business type",
    "format": "int",
    "enumeration": "Enumeration values.Sales management.Opportunities.Business type",
    "values": {
      "New": "0",
      "Existing": "1"
    }
  },
  "stage": {
    "description": "The sales stage describes in which stage the opportunity is, e.g. 2. Validated or 5. Closed. When changing the sales stage the Probability-field is automatically changed to reflect the sales stage.",
    "caption": "Sales stage",
    "format": "string",
    "maxlength": "80",
    "enumeration": "Enumeration values.Sales management.Opportunities.Sales stage probability mapping",
    "values": {
      "10": "10",
      "25": "25",
      "50": "50",
      "75": "75",
      "100": "100",
      "5. Closed": "100",
      "3. Qualified": "50",
      "2. Validated": "25",
      "1. Identified": "10",
      "4. Quoted": "75"
    }
  },
  "competitor": {
    "caption": "Competitor",
    "values": {
      "Test Comp Ltd": 501997
    },
    "format": "int"
  },
  "partnerContact": {
    "caption": "",
    "format": "int",
    "description": "",
    "values": null
  },
  "responsible": {
    "caption": "Owner",
    "values": {
      "Mill, Will": "2801981",
      "Selleri, Seppo": "2795446",
      "Lowe, Jared": "580283"
    },
    "format": "