For AI agents: visit https://docs.instellix.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Home Documentation Recipes API Reference Changelog

Platform Overview Demo Contact Imprint Log In

API Reference

Platform Overview Demo Contact Imprint Log In

Home Documentation Recipes API Reference Changelog

API Introduction

Getting started with the Nitrobox API
OpenAPI Specification (OAS)
API Lifecycle Management
- API Migration Guide
Notifications via HTTP Webhooks

Customer API

Customers
Sellers
Tax Classifications
Configurations

Billing API

Billing Groups
Orders
Plans and Options
Contracts
Usages
Invoices
Billable Items
- Query billable itemsget
Price Adaptations
Customers
Contracts (deprecated)

Usage API

Rated usages
Rated usage aggregations
Billing Group
- Get billing group by identget
- Update billing groupput

Data Access API

Invoices
- Query invoicesget
- Retrieve invoiceget

Invoice API

Documents
Document Labels
Aggregation Configurations
Document Number Configurations
Dunning Configurations
- Retrieve dunning configurationget
- Create dunning configurationpost
Dunning Status Aggregations
- Retrieve dunning status aggregationget
- Lists dunning status aggregation documentsget
Operating Site Configurations
OPOS Cases
OPOS Case Clearing Runs
SAF-T Configurations
Tenant Configurations
- Get polish credit memo flagget
- Set polish credit memo flagpost

Document Output API

Translations
Translation Configurations
- Get All Translationsget
- Get Configured Localesget
Files

Tax API

Tax Calculation
- Calculate tax for a documentpost
Tax Rules Configuration
Tax Provider Configuration
Tax Service Tenant Configuration
- Get the tax service configuration for a tenant.get
- Create or update the tax service configuration for a tenant.post
Tax Service Billing Group Configuration
- Get the tax service configuration for a billing group.get
- Create or update the tax service configuration for a billing group.post

Payment API

Customer Payment Accounts
Merchant Payment Accounts
Merchant Payment Gateways
Payment Categories
Payment Transactions
Payment Categorization Rules
Payment Intents
Payment Intent Tasks
Settlements

Payment Assignment API

Assignment Configuration
Assignments

Bookkeeping API

Closings
Booking Accounts
Booking Entries
- Query booking entriesget
- Query directional booking entries of an accountget
Clearing
Tenants
- Get gain loss configurationget

Report API

Report Files
Reports
Scheduled Reports

Notification API

Notification Configuration
Notifications

Currency Converter API

Currency Converter
- Get exchange ratesget
- Post self provided exchange ratespost

Electronic Invoice API

Electronic Invoicing Workflows

Audit Trail API

Audit Trail Entry
- Query audit trail entriesget
- Retrieve audit trail entryget
Audit Trail Entity Name
- Retrieve entity namesget

Authentication API

Token
Discovery
- OAuth2 Authorization Server Metadata.get
- JSON Web Key Set for a realm.get

Document Image API

Document Image

Powered by

Retrieve images

get

https://api.instellix.io/v2/v2/document-images

List images (paged)

Query Params

search

string

Use RSQL query language. Intro here: https://aboullaite.me/rsql/.

page

integer

≥ 0

Defaults to 0

Zero-based page index (0..N).
Must be greater than or equal to 0.

size

integer

≥ 1

Defaults to 20

The size of the page to be returned.
Must be greater than or equal to 1.

sort

array of strings

Defaults to name,ASC

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

Responses

Updated 23 days ago

Retrieve image data

Did this page help you?

Language

Credentials

OAuth2

Client

Missing 1 required scope

Loading…

Response

Choose an example:

application/json

Updated 23 days ago

Retrieve image data

Did this page help you?