Skip to main content
PUT
/
cleemy-procurement
/
services
/
inbox-documents
/
{id}
Update Inbox Document
curl --request PUT \
  --url https://{host}/cleemy-procurement/services/inbox-documents/{id} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": {
    "ownerId": 123,
    "context": {
      "purchase": {
        "id": 123
      }
    },
    "documentDate": "2023-12-25",
    "documentNumber": "<string>",
    "amountIncludingTaxes": {
      "excludingTaxes": {
        "value": 123
      },
      "taxes": [
        {
          "rateTypeId": 123,
          "value": 123
        }
      ],
      "includingTaxes": {
        "value": 123
      }
    },
    "accountingLabel": "<string>",
    "comment": "<string>",
    "intraCommunityTaxes": true,
    "dueDate": "2023-12-25",
    "paymentDetails": {
      "bankAccount": {
        "iban": "<string>",
        "bic": "<string>"
      }
    }
  },
  "action": {
    "type": "AttachPurchase",
    "purchaseId": 123,
    "paymentId": 123,
    "installmentId": 123,
    "disputeId": 123,
    "autoConfirmation": true
  }
}
'
import requests

url = "https://{host}/cleemy-procurement/services/inbox-documents/{id}"

payload = {
    "document": {
        "ownerId": 123,
        "context": { "purchase": { "id": 123 } },
        "documentDate": "2023-12-25",
        "documentNumber": "<string>",
        "amountIncludingTaxes": {
            "excludingTaxes": { "value": 123 },
            "taxes": [
                {
                    "rateTypeId": 123,
                    "value": 123
                }
            ],
            "includingTaxes": { "value": 123 }
        },
        "accountingLabel": "<string>",
        "comment": "<string>",
        "intraCommunityTaxes": True,
        "dueDate": "2023-12-25",
        "paymentDetails": { "bankAccount": {
                "iban": "<string>",
                "bic": "<string>"
            } }
    },
    "action": {
        "type": "AttachPurchase",
        "purchaseId": 123,
        "paymentId": 123,
        "installmentId": 123,
        "disputeId": 123,
        "autoConfirmation": True
    }
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    document: {
      ownerId: 123,
      context: {purchase: {id: 123}},
      documentDate: '2023-12-25',
      documentNumber: '<string>',
      amountIncludingTaxes: {
        excludingTaxes: {value: 123},
        taxes: [{rateTypeId: 123, value: 123}],
        includingTaxes: {value: 123}
      },
      accountingLabel: '<string>',
      comment: '<string>',
      intraCommunityTaxes: true,
      dueDate: '2023-12-25',
      paymentDetails: {bankAccount: {iban: '<string>', bic: '<string>'}}
    },
    action: {
      type: 'AttachPurchase',
      purchaseId: 123,
      paymentId: 123,
      installmentId: 123,
      disputeId: 123,
      autoConfirmation: true
    }
  })
};

fetch('https://{host}/cleemy-procurement/services/inbox-documents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/cleemy-procurement/services/inbox-documents/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'document' => [
        'ownerId' => 123,
        'context' => [
                'purchase' => [
                                'id' => 123
                ]
        ],
        'documentDate' => '2023-12-25',
        'documentNumber' => '<string>',
        'amountIncludingTaxes' => [
                'excludingTaxes' => [
                                'value' => 123
                ],
                'taxes' => [
                                [
                                                                'rateTypeId' => 123,
                                                                'value' => 123
                                ]
                ],
                'includingTaxes' => [
                                'value' => 123
                ]
        ],
        'accountingLabel' => '<string>',
        'comment' => '<string>',
        'intraCommunityTaxes' => true,
        'dueDate' => '2023-12-25',
        'paymentDetails' => [
                'bankAccount' => [
                                'iban' => '<string>',
                                'bic' => '<string>'
                ]
        ]
    ],
    'action' => [
        'type' => 'AttachPurchase',
        'purchaseId' => 123,
        'paymentId' => 123,
        'installmentId' => 123,
        'disputeId' => 123,
        'autoConfirmation' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/cleemy-procurement/services/inbox-documents/{id}"

	payload := strings.NewReader("{\n  \"document\": {\n    \"ownerId\": 123,\n    \"context\": {\n      \"purchase\": {\n        \"id\": 123\n      }\n    },\n    \"documentDate\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"amountIncludingTaxes\": {\n      \"excludingTaxes\": {\n        \"value\": 123\n      },\n      \"taxes\": [\n        {\n          \"rateTypeId\": 123,\n          \"value\": 123\n        }\n      ],\n      \"includingTaxes\": {\n        \"value\": 123\n      }\n    },\n    \"accountingLabel\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"intraCommunityTaxes\": true,\n    \"dueDate\": \"2023-12-25\",\n    \"paymentDetails\": {\n      \"bankAccount\": {\n        \"iban\": \"<string>\",\n        \"bic\": \"<string>\"\n      }\n    }\n  },\n  \"action\": {\n    \"type\": \"AttachPurchase\",\n    \"purchaseId\": 123,\n    \"paymentId\": 123,\n    \"installmentId\": 123,\n    \"disputeId\": 123,\n    \"autoConfirmation\": true\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://{host}/cleemy-procurement/services/inbox-documents/{id}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"document\": {\n    \"ownerId\": 123,\n    \"context\": {\n      \"purchase\": {\n        \"id\": 123\n      }\n    },\n    \"documentDate\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"amountIncludingTaxes\": {\n      \"excludingTaxes\": {\n        \"value\": 123\n      },\n      \"taxes\": [\n        {\n          \"rateTypeId\": 123,\n          \"value\": 123\n        }\n      ],\n      \"includingTaxes\": {\n        \"value\": 123\n      }\n    },\n    \"accountingLabel\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"intraCommunityTaxes\": true,\n    \"dueDate\": \"2023-12-25\",\n    \"paymentDetails\": {\n      \"bankAccount\": {\n        \"iban\": \"<string>\",\n        \"bic\": \"<string>\"\n      }\n    }\n  },\n  \"action\": {\n    \"type\": \"AttachPurchase\",\n    \"purchaseId\": 123,\n    \"paymentId\": 123,\n    \"installmentId\": 123,\n    \"disputeId\": 123,\n    \"autoConfirmation\": true\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/cleemy-procurement/services/inbox-documents/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"document\": {\n    \"ownerId\": 123,\n    \"context\": {\n      \"purchase\": {\n        \"id\": 123\n      }\n    },\n    \"documentDate\": \"2023-12-25\",\n    \"documentNumber\": \"<string>\",\n    \"amountIncludingTaxes\": {\n      \"excludingTaxes\": {\n        \"value\": 123\n      },\n      \"taxes\": [\n        {\n          \"rateTypeId\": 123,\n          \"value\": 123\n        }\n      ],\n      \"includingTaxes\": {\n        \"value\": 123\n      }\n    },\n    \"accountingLabel\": \"<string>\",\n    \"comment\": \"<string>\",\n    \"intraCommunityTaxes\": true,\n    \"dueDate\": \"2023-12-25\",\n    \"paymentDetails\": {\n      \"bankAccount\": {\n        \"iban\": \"<string>\",\n        \"bic\": \"<string>\"\n      }\n    }\n  },\n  \"action\": {\n    \"type\": \"AttachPurchase\",\n    \"purchaseId\": 123,\n    \"paymentId\": 123,\n    \"installmentId\": 123,\n    \"disputeId\": 123,\n    \"autoConfirmation\": true\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "document": {
    "id": 123,
    "owner": {
      "id": 123,
      "href": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "pictureHref": "<string>"
    },
    "context": {
      "purchase": {
        "id": 123,
        "href": "<string>",
        "name": "<string>"
      }
    },
    "documentBreakdown": {
      "id": 2,
      "href": "<string>",
      "name": "<string>"
    },
    "documentDate": "2023-12-25",
    "documentNumber": "<string>",
    "amountIncludingTaxes": {
      "excludingTaxes": {
        "value": 123
      },
      "taxes": [
        {
          "rateTypeId": 123,
          "value": 123
        }
      ],
      "includingTaxes": {
        "value": 123
      }
    },
    "accountingLabel": "<string>",
    "comment": "<string>",
    "intraCommunityTaxes": true,
    "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
        }
      }
    ],
    "dueDate": "2023-12-25",
    "paymentDetails": {
      "bankAccount": {
        "iban": "<string>",
        "bic": "<string>"
      }
    },
    "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>"
    }
  },
  "source": {
    "type": "<string>"
  },
  "action": {},
  "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 inbox document.

Body

application/json

Inbox document data to update.

Payload for updating an inbox document.

​
document
object

Document fields to update.

​
action
AttachPurchase · object

Optional action to perform (attach or create a purchase).

Response

200 - application/json

OK

A document in the inbox, pending processing.

​
id
integer<int32>
read-only
​
document
document · object

An invoice document (before booking).

​
source
object

Source of the document (e.g. email, upload).

​
action
object | null

Available action on this inbox document.

​
createdAt
string<date-time>
read-only
​
modifiedAt
string<date-time>
read-only
​
author
Reference to a user · object

Reference to a user.

​
modifier
Reference to a user · object

Reference to a user.