Accounting Documents API
- List connections
- Connect accounting document
- Disconnect accounting document
- Change connection amount
- List payments
- List document attachments
- Attach document attachment
- Remove document attachment
- List scanned attachments
- Attach scan
- Remov scanned attachment
- Change state
- List possible states
- Update country variant specific settings
- List line items
- Add line item
- Remove line item
- Update line item
- List bank accounts
- Attach bank account
- Dettach bank account
- Get header
- Update header
- Unassign contact
- Assign contact
- Assign sequence
- Update VAT recap
Bulk Operations API
- Bulk operation on accounting documents
Bank Accounts API
- List bank statements
- Upload bank statement
- Remove bank statement
- Process bank statement
- List payment orders
- Create payment order
Cash Registers API
- List inventories
- Create inventory
Contacts API
- List persons
- Add person
- Remove person
- Update person
- List addresses
- Add address
- Remove address
- Update address
Documents API
Financial Accounts API
- List financial accounts
Miscellaneous API
- List company types
- List VAT rates
- List branches
- List projects
- List currencies
- List countries
- List banks
Searching API
Sequences API
Tasks API
Templates API
- Remove scheduler
- Set scheduler
Files API
- Uploads a new file

List documents and folders

get https://api.trivi.com/v2/documents/{documentItemUniqueId}

Sorts by type and name automatically:

In case of ASC sorting Folders are returned first (alphabetically sorted) and Files afterwards (alphabetically sorted).
In case of DESC sorting the order is completely reveresed (Files go first, Folders after them).

REQUEST

Path Variables

documentItemUniqueId
string required

GUID

Query Variables

page
integer optional

Default 1

pageSize
integer optional

Default 20 Minimum 10 Maximum 100

sortingDirection
string optional

Default ASC

type
integer optional

0 - File

1 - Folder

Format int8 Default 0

RESPONSE

Status 200

DocumentsSearchResult

documentItems
Array of DocumentItem optional

pagesCount
integer optional

currentPage
integer optional

pageSize
number optional

currentDocumentItem
DocumentItem optional

parentDocumentInfo
DocumentDescriptor optional

{
  "documentItems": [
    {
      "uniqueId": "string",
      "fileId": 0,
      "name": "string",
      "size": 0,
      "note": "string",
      "parentUniqueId": "string",
      "itemType": 0,
      "folderType": 0,
      "children": [
        {
          "uniqueId": "string",
          "fileId": 0,
          "name": "string",
          "size": 0,
          "note": "string",
          "parentUniqueId": "string",
          "itemType": 0,
          "folderType": 0,
          "children": [
            {
              "uniqueId": "string",
              "fileId": 0,
              "name": "string",
              "size": 0,
              "note": "string",
              "parentUniqueId": "string",
              "itemType": 0,
              "folderType": 0,
              "children": "....",
              "isReadOnly": null,
              "canBeChanged": null,
              "canChildrenBeCreated": null
            }
          ],
          "isReadOnly": null,
          "canBeChanged": null,
          "canChildrenBeCreated": null
        }
      ],
      "isReadOnly": null,
      "canBeChanged": null,
      "canChildrenBeCreated": null
    }
  ],
  "pagesCount": 0,
  "currentPage": 0,
  "pageSize": 0,
  "currentDocumentItem": {
    "uniqueId": "string",
    "fileId": 0,
    "name": "string",
    "size": 0,
    "note": "string",
    "parentUniqueId": "string",
    "itemType": 0,
    "folderType": 0,
    "children": [
      {
        "uniqueId": "string",
        "fileId": 0,
        "name": "string",
        "size": 0,
        "note": "string",
        "parentUniqueId": "string",
        "itemType": 0,
        "folderType": 0,
        "children": [
          {
            "uniqueId": "string",
            "fileId": 0,
            "name": "string",
            "size": 0,
            "note": "string",
            "parentUniqueId": "string",
            "itemType": 0,
            "folderType": 0,
            "children": "....",
            "isReadOnly": null,
            "canBeChanged": null,
            "canChildrenBeCreated": null
          }
        ],
        "isReadOnly": null,
        "canBeChanged": null,
        "canChildrenBeCreated": null
      }
    ],
    "isReadOnly": null,
    "canBeChanged": null,
    "canChildrenBeCreated": null
  },
  "parentDocumentInfo": {
    "uniqueId": "string",
    "name": "string",
    "parentDocumentInfo": {
      "uniqueId": "string",
      "name": "string",
      "parentDocumentInfo": {
        "uniqueId": "string",
        "name": "string",
        "parentDocumentInfo": "....",
        "isReadOnly": null
      },
      "isReadOnly": null
    },
    "isReadOnly": null
  }
}

DocumentDescriptor

uniqueId
string optional

Only in GET UUID

name
string optional

parentDocumentInfo
DocumentDescriptor optional

isReadOnly
boolean optional

If null, the DocumentDescriptor inherits settings from parent DocumentDescriptor.

DocumentItem

uniqueId
string optional

Only in GET UUID

fileId
integer optional

Only in GET

Format int64

name
string optional

size
integer optional

Only in GET

In bytes

note
string optional

parentUniqueId
string optional

Only in GET UUID

Parent folder ID. If empty, the document is in the root.

itemType
number optional

0 - File, 1 - Folder

folderType
number optional

0 - Generic

children
Array of DocumentItem optional

Only in GET

isReadOnly
boolean optional

Only in GET

If null, the DocumentItem inherits settings from parent DocumentItem.

canBeChanged
boolean optional

Only in GET

Based on current user permissions.

canChildrenBeCreated
boolean optional

Only in GET

Based on current user permissions.

List documents and folders

REQUEST

RESPONSE

References of endpoint

References of endpoint

References of endpoint