Create document

POST

/api/public/v1/documents/document

const url = 'https://app.kontera.ch/api/public/v1/documents/document';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"signedFileName":"example","fileName":"example","processImmediately":false,"paymentType":"not-yet-determined","externalId":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.kontera.ch/api/public/v1/documents/document \
  --header 'Content-Type: application/json' \
  --data '{ "signedFileName": "example", "fileName": "example", "processImmediately": false, "paymentType": "not-yet-determined", "externalId": "example" }'

Creates a new document using an uploaded file.

Request Body^required

application/json

object

signedFileName

required

The received name from the document upload

string

fileName

required

The original filename of the document

string

processImmediately

Whether the AI should extract the documents contents immediately after upload. Defaults to false.

boolean

paymentType

The payment type of the document

string

Allowed values: not-yet-determined no-payment-necessary settled-payment payment-advise reconciliation-with-transaction credit-card expenses-employee

externalId

An optional external ID for the document

string

Responses

200

application/json

object

konteraId

ID of generated and to be processed document within Kontera. Only set, if processImmediately was true.

string

konteraFileId

required

ID of generated file within Kontera

string

Example^generated

{
  "konteraId": "example",
  "konteraFileId": "example"
}

Create document

Request Bodyrequired

Responses

200

Examplegenerated

401

Request Body^required

Example^generated