Skip to main content
POST
/
cleemy-procurement
/
api
/
commitments
/
{id}
/
requests
Create a commitment request
curl --request POST \
  --url https://{host}/cleemy-procurement/api/commitments/{id}/requests \
  --header 'Authorization: <authorization>'
{
  "id": 123,
  "owner": {
    "id": 123,
    "href": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "pictureHref": "<string>"
  },
  "assignee": {
    "id": 123,
    "href": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "pictureHref": "<string>"
  },
  "businessObject": {
    "id": 123,
    "type": "<string>",
    "owner": {
      "id": 123,
      "href": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "pictureHref": "<string>"
    },
    "purchase": {
      "id": 123,
      "href": "<string>",
      "name": "<string>",
      "type": "Subscription"
    },
    "attachments": [
      {
        "id": 123,
        "file": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "href": "<string>",
          "name": "<string>",
          "displayHref": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "pages": {
          "displayHrefTemplate": "<string>",
          "count": 123
        }
      }
    ],
    "comment": "<string>",
    "paymentMethod": "BankTransfer",
    "state": "Created",
    "startDate": "2023-12-25",
    "firstInvoiceDate": "2023-12-25",
    "invoicingFrequency": {
      "value": 123,
      "unit": "Day"
    },
    "subscriptionDuration": {
      "value": 123,
      "unit": "Day"
    },
    "contractualObligation": {
      "value": 123,
      "unit": "Day"
    },
    "terminationNotice": {
      "value": 123,
      "unit": "Day"
    },
    "amountIncludingTaxesPerPeriod": {
      "base": {
        "excludingTaxes": {
          "value": 123,
          "currency": "Invalid"
        },
        "taxes": [
          {
            "rateTypeId": 123,
            "value": 123,
            "currency": "Invalid"
          }
        ],
        "includingTaxes": {
          "value": 123,
          "currency": "Invalid"
        }
      },
      "counter": {
        "excludingTaxes": {
          "value": 123,
          "currency": "Invalid"
        },
        "taxes": [
          {
            "rateTypeId": 123,
            "value": 123,
            "currency": "Invalid"
          }
        ],
        "includingTaxes": {
          "value": 123,
          "currency": "Invalid"
        }
      },
      "rate": 123
    },
    "amountIncludingTaxes": {
      "base": {
        "excludingTaxes": {
          "value": 123,
          "currency": "Invalid"
        },
        "taxes": [
          {
            "rateTypeId": 123,
            "value": 123,
            "currency": "Invalid"
          }
        ],
        "includingTaxes": {
          "value": 123,
          "currency": "Invalid"
        }
      },
      "counter": {
        "excludingTaxes": {
          "value": 123,
          "currency": "Invalid"
        },
        "taxes": [
          {
            "rateTypeId": 123,
            "value": 123,
            "currency": "Invalid"
          }
        ],
        "includingTaxes": {
          "value": 123,
          "currency": "Invalid"
        }
      },
      "rate": 123
    },
    "subscriptionEndDate": "2023-12-25",
    "periodsCount": 123,
    "contractualEndDate": "2023-12-25",
    "createdAt": "2023-11-07T05:31:56Z",
    "author": {
      "id": 123,
      "href": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "pictureHref": "<string>"
    },
    "modifiedAt": "2023-11-07T05:31:56Z",
    "modifier": {
      "id": 123,
      "href": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "pictureHref": "<string>"
    }
  },
  "stepId": 123,
  "workflowId": "<string>",
  "templateId": 123,
  "state": "Pending",
  "createdAt": "2023-11-07T05:31:56Z",
  "modifiedAt": "2023-11-07T05:31:56Z",
  "author": {
    "id": 123,
    "href": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "pictureHref": "<string>"
  },
  "modifier": {
    "id": 123,
    "href": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "pictureHref": "<string>"
  }
}

Headers

​
Authorization
string
required

API key. Value must be formatted like so: lucca application={api_key}.

Path Parameters

​
id
integer<int32>
required

ID of the commitment you want to create a request for.

Response

201 - application/json

Commitment request successfuly created.

Approval request (workflow) for a purchase commitment.

​
id
integer<int32>
​
owner
Reference to a user · object

Reference to a user.

​
assignee
Reference to a user · object

Reference to a user.

​
businessObject
Subscription Commitment · object

Represents a purchase commitment. Can be one of two types: Subscription or OneTime.

A "subscription" typed commitment represents a purchase commitment that will be paid in installments over a given period, whereas a "one-time" commitment will be paid in full once.

​
stepId
integer<int32>
​
workflowId
string
​
templateId
integer<int32>
​
state
enum<string>
Available options:
Pending,
Cancelled,
Denied,
Approved
​
createdAt
string<date-time>
​
modifiedAt
string<date-time>
​
author
Reference to a user · object

Reference to a user.

​
modifier
Reference to a user · object

Reference to a user.