Skip to main content
GET
/
cleemy-procurement
/
api
/
documents
/
{id}
Get Document
curl --request GET \
  --url https://{host}/cleemy-procurement/api/documents/{id} \
  --header 'Authorization: <authorization>'
import requests

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

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://{host}/cleemy-procurement/api/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/api/documents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);

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

curl_close($curl);

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

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

func main() {

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

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<authorization>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{host}/cleemy-procurement/api/documents/{id}")
.header("Authorization", "<authorization>")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body
{
  "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>"
  }
}

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 document.

Response

200 - application/json

OK

An invoice document (before booking).

id
integer<int32>
read-only
owner
Reference to a user · object

Reference to a user.

type
enum<string>

Type of document: Invoice or CreditNote.

Available options:
Invoice,
CreditNote
context
object | null

Context data for the document.

documentBreakdown
Reference to a document-breakdown. · object
documentDate
string<date> | null
documentNumber
string | null
amountIncludingTaxes
taxed-amount · object

Represents an amount of money with VAT taxes.

accountingLabel
string | null
comment
string | null
intraCommunityTaxes
boolean
attachments
attachment · object[]
ocrStatus
enum<string>
read-only

Status of OCR processing.

Available options:
Pending,
Processing,
Processed,
Failed,
NotApplicable
dueDate
string<date> | null
paymentDetails
object | null
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.