Skip to content
aYOUne
← Configuration API

DocumentRenders

Singular: DocumentRender — Base URL: https://config-api.ayoune.app — Access: read-only — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6a72ab2d6a999f58dc5b0d97",
    "_sourceEntityID": "6a701d0f83acdef8be6652cb",
    "sourceEntityType": "Invoices",
    "idempotencyKey": "Invoices:6a701d0f83acdef8be6652cb:default:pdf:0",
    "renderedAt": "2026-08-05T03:17:01.974Z",
    "outputFormat": "pdf",
    "requestedBy": "5a76d07e2d8b3270ff6df587",
    "status": "pending",
    "meta": {
      "locale": "de-DE",
      "requestSource": "actionInvoicePrint"
    },
    "isDraft": true,
    "createdAt": "2026-08-05T03:17:01.975Z",
    "updatedAt": "2026-08-05T03:17:01.975Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/documentrenders/6a72ab2d6a999f58dc5b0d97",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "DocumentTemplates",
        "title": "MODEL_DOCUMENTTEMPLATE",
        "href": "https://api.ayoune.app/config/documenttemplates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.documenttemplates"
      }
    ],
    "debugId": "6adec7d862556e5404c0d864",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_DOCUMENTRENDER",
        "href": "https://api.ayoune.app/config/documentrenders/6a72ab2d6a999f58dc5b0d97/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_DOCUMENTRENDER",
        "href": "https://api.ayoune.app/config/documentrenders/6a72ab2d6a999f58dc5b0d97",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "7096",
      "reset": "1792987338",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 19.375438,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /documentrenders List with filters/pagination config.documentrenders.view
GET /documentrenders/:id Single record by ID config.documentrenders.view

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.documentRenders.find().limit(10).exec();

// Single record
const one = await ay.config.documentRenders.findById('OBJECT_ID').exec();

See also