InvoiceLeaf
API docs by Redocly

InvoiceLeaf API (1.0)

Download OpenAPI specification:Download

Support: support@invoiceleaf.com URL: https://invoiceleaf.com License: Apache 2.0

InvoiceLeaf provides a REST API that can be accessed directly from another web application or from within a Javascript single page application. The API can be used from any programming language.

This API should be used if you want to create, send or extract invoices at InvoiceLeaf.

Please email support@invoiceleaf.com if you have questions or need help while using the API.

Pagination

When you're making calls to the API, there'll be a lot of results to return. For that reason, we paginate the results to make sure responses are easier to handle. We recommend you to set the limit parameter in every request to ensure you know how many results per page you'll get. The default limit is 100 items per page. You can paginate through the results with the page parameter, starting with 1. If you set the limit to 10 and page to 1 you will get the results from 1-10. If you set the limit to 10 and page to 2, you'll get the results from 11-20.

Profile

Endpoint to retrieve and manage the current user.

Delete account

Delete account of the user

Responses

Delete profiles data

Delete data of the user

Responses

Get profile

Retrieves the profile of the current user.

query Parameters
referrer
string

Responses

Response samples

Content type
{
  • "expires": 0,
  • "permission": 0,
  • "status": 0,
  • "plan": 0,
  • "email": "string",
  • "paymentOption": "string",
  • "appleTransactionId": "string",
  • "imageUrl": "string",
  • "business": "string",
  • "taxId": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "countryIso": "string",
  • "country": "string",
  • "currency": "string",
  • "timezone": "string",
  • "dateFormat": "string",
  • "timeFormat": "string",
  • "csvSeparator": "string",
  • "language": "string",
  • "referrer": "string",
  • "brandName": "string",
  • "brandLogo": "string",
  • "brandColor": 0,
  • "includeTaxForBusiness": true,
  • "newsletter": true,
  • "gdprConsent": true,
  • "invited": true,
  • "activated": true,
  • "cancellationOffer": true,
  • "user": "string",
  • "lastUpdate": 0,
  • "subscriptionActive": true,
  • "subscriptionCancelled": true,
  • "subscriptionInactive": true,
  • "active": true,
  • "displayName": "string",
  • "valid": true,
  • "initials": "string",
  • "member": true,
  • "expired": true,
  • "applePayment": true,
  • "enterpise": true,
  • "validProfile": true,
  • "validAndActivated": true,
  • "payPalPayment": true,
  • "stripePayment": true,
  • "invoicePayment": true,
  • "businessCustomer": true,
  • "euCustomer": true,
  • "licenseHolder": true,
  • "eu": true,
  • "at": true,
  • "uk": true,
  • "product": "string",
  • "basic": true,
  • "standard": true,
  • "pro": true,
  • "monthly": true,
  • "yearly": true,
  • "inactive": true,
  • "trial": true,
  • "admin": true
}

Update profile

Updates the profile of the current user.

Request Body schema: multipart/form-data
object (FormDataBodyPart)
object (FormDataContentDisposition)

Responses

Response samples

Content type
application/json
{
  • "expires": 0,
  • "permission": 0,
  • "status": 0,
  • "plan": 0,
  • "email": "string",
  • "paymentOption": "string",
  • "appleTransactionId": "string",
  • "imageUrl": "string",
  • "business": "string",
  • "taxId": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "street": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "countryIso": "string",
  • "country": "string",
  • "currency": "string",
  • "timezone": "string",
  • "dateFormat": "string",
  • "timeFormat": "string",
  • "csvSeparator": "string",
  • "language": "string",
  • "referrer": "string",
  • "brandName": "string",
  • "brandLogo": "string",
  • "brandColor": 0,
  • "includeTaxForBusiness": true,
  • "newsletter": true,
  • "gdprConsent": true,
  • "invited": true,
  • "activated": true,
  • "cancellationOffer": true,
  • "user": "string",
  • "lastUpdate": 0,
  • "subscriptionActive": true,
  • "subscriptionCancelled": true,
  • "subscriptionInactive": true,
  • "active": true,
  • "displayName": "string",
  • "valid": true,
  • "initials": "string",
  • "member": true,
  • "expired": true,
  • "applePayment": true,
  • "enterpise": true,
  • "validProfile": true,
  • "validAndActivated": true,
  • "payPalPayment": true,
  • "stripePayment": true,
  • "invoicePayment": true,
  • "businessCustomer": true,
  • "euCustomer": true,
  • "licenseHolder": true,
  • "eu": true,
  • "at": true,
  • "uk": true,
  • "product": "string",
  • "basic": true,
  • "standard": true,
  • "pro": true,
  • "monthly": true,
  • "yearly": true,
  • "inactive": true,
  • "trial": true,
  • "admin": true
}

Update branding

Updates the branding of the current user.

Request Body schema:
brandName
string
brandLogo
string
brandColor
integer <int32>

Responses

Request samples

Content type
{
  • "brandName": "string",
  • "brandLogo": "string",
  • "brandColor": 0
}

Response samples

Content type
{
  • "brandName": "string",
  • "brandLogo": "string",
  • "brandColor": 0
}

Space

Endpoint to retrieve and manage spaces.

List spaces

List spaces.

query Parameters
statistics
boolean
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Create space

Create a new space.

Request Body schema:
name
string
description
string
image
string
color
integer <int32>
defaultSupplierId
string
defaultReceiverId
string
defaultCurrencyId
string
completionRateInvoiceId
boolean
completionRateInvoiceDate
boolean
completionRateSupplier
boolean
completionRateReceiver
boolean
completionRateTotalAmount
boolean
completionRateTaxAmount
boolean
completionRateDueDate
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "color": 0,
  • "defaultSupplierId": "string",
  • "defaultReceiverId": "string",
  • "defaultCurrencyId": "string",
  • "completionRateInvoiceId": true,
  • "completionRateInvoiceDate": true,
  • "completionRateSupplier": true,
  • "completionRateReceiver": true,
  • "completionRateTotalAmount": true,
  • "completionRateTaxAmount": true,
  • "completionRateDueDate": true
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "color": 0,
  • "defaultSupplier": {
    },
  • "defaultReceiver": {
    },
  • "defaultCurrency": {
    },
  • "completionRateInvoiceId": true,
  • "completionRateInvoiceDate": true,
  • "completionRateSupplier": true,
  • "completionRateReceiver": true,
  • "completionRateTotalAmount": true,
  • "completionRateTaxAmount": true,
  • "completionRateDueDate": true,
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "permission": {
    },
  • "categories": 0,
  • "tags": 0,
  • "documents": 0,
  • "members": 0
}

Get member

Get space member by id.

path Parameters
spaceId
required
string
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "imageUrl": "string",
  • "uploadKey": "string",
  • "defaultSupplierId": "string",
  • "defaultReceiverId": "string",
  • "permission": {
    },
  • "lastUpdate": 0,
  • "created": 0,
  • "displayName": "string",
  • "initials": "string"
}

Update member

Update space member by id.

path Parameters
spaceId
required
string
id
required
string
Request Body schema:
firstname
string
lastname
string
uploadKey
string
defaultSupplierId
string
defaultReceiverId
string
object (SpacePermissionDto)

Responses

Request samples

Content type
{
  • "firstname": "string",
  • "lastname": "string",
  • "uploadKey": "string",
  • "defaultSupplierId": "string",
  • "defaultReceiverId": "string",
  • "permission": {
    }
}

Response samples

Content type
{
  • "firstname": "string",
  • "lastname": "string",
  • "uploadKey": "string",
  • "defaultSupplierId": "string",
  • "defaultReceiverId": "string",
  • "permission": {
    }
}

Remove member

Remove space member by space id and member id.

path Parameters
spaceId
required
string
id
required
string

Responses

Get colleagues

Get colleagues of the current user by the given parameters.

query Parameters
spaceId
string
deleted
boolean
withoutMe
boolean

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

List space members

List space members.

path Parameters
spaceId
required
string
query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>
withoutMe
boolean
deleted
boolean

Responses

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Register new space member

Register a new member for provided space id.

path Parameters
spaceId
required
string
Request Body schema:
email
string
firstname
string
lastname
string
uploadKey
string
defaultSupplierId
string
defaultReceiverId
string
object (SpacePermissionDto)

Responses

Request samples

Content type
{
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "uploadKey": "string",
  • "defaultSupplierId": "string",
  • "defaultReceiverId": "string",
  • "permission": {
    }
}

Response samples

Content type
{
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "uploadKey": "string",
  • "defaultSupplierId": "string",
  • "defaultReceiverId": "string",
  • "permission": {
    }
}

Get space

Get space by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "color": 0,
  • "defaultSupplier": {
    },
  • "defaultReceiver": {
    },
  • "defaultCurrency": {
    },
  • "completionRateInvoiceId": true,
  • "completionRateInvoiceDate": true,
  • "completionRateSupplier": true,
  • "completionRateReceiver": true,
  • "completionRateTotalAmount": true,
  • "completionRateTaxAmount": true,
  • "completionRateDueDate": true,
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "permission": {
    },
  • "categories": 0,
  • "tags": 0,
  • "documents": 0,
  • "members": 0
}

Update space

Update space by id.

path Parameters
id
required
string
Request Body schema:
name
string
description
string
image
string
color
integer <int32>
defaultSupplierId
string
defaultReceiverId
string
defaultCurrencyId
string
completionRateInvoiceId
boolean
completionRateInvoiceDate
boolean
completionRateSupplier
boolean
completionRateReceiver
boolean
completionRateTotalAmount
boolean
completionRateTaxAmount
boolean
completionRateDueDate
boolean
deleted
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "color": 0,
  • "defaultSupplierId": "string",
  • "defaultReceiverId": "string",
  • "defaultCurrencyId": "string",
  • "completionRateInvoiceId": true,
  • "completionRateInvoiceDate": true,
  • "completionRateSupplier": true,
  • "completionRateReceiver": true,
  • "completionRateTotalAmount": true,
  • "completionRateTaxAmount": true,
  • "completionRateDueDate": true,
  • "deleted": true
}

Response samples

Content type
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "image": "string",
  • "color": 0,
  • "defaultSupplier": {
    },
  • "defaultReceiver": {
    },
  • "defaultCurrency": {
    },
  • "completionRateInvoiceId": true,
  • "completionRateInvoiceDate": true,
  • "completionRateSupplier": true,
  • "completionRateReceiver": true,
  • "completionRateTotalAmount": true,
  • "completionRateTaxAmount": true,
  • "completionRateDueDate": true,
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "permission": {
    },
  • "categories": 0,
  • "tags": 0,
  • "documents": 0,
  • "members": 0
}

Remove space

Remove space by id.

path Parameters
id
required
string

Responses

List members

List space members by given parameters.

path Parameters
spaceId
required
string
Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
spaceId
string
withoutMe
boolean
deleted
boolean
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "spaceId": "string",
  • "withoutMe": true,
  • "deleted": true,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Search spaces

Search spaces by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Company

Endpoint to retrieve and manage companies.

List companies

List companies.

query Parameters
spaceId
string
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Create company

Create a new company.

Request Body schema: multipart/form-data
object (FormDataBodyPart)
object (FormDataContentDisposition)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "space": {
    },
  • "user": "string",
  • "deleted": true,
  • "lastUpdate": 0,
  • "created": 0,
  • "displayName": "string",
  • "name": "string",
  • "country": "string",
  • "countryIso": "string",
  • "street": "string",
  • "zip": "string",
  • "city": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "taxNumber": "string",
  • "vatId": "string",
  • "commercialRegister": "string",
  • "iban": "string",
  • "bic": "string",
  • "url": "string",
  • "icon": "string",
  • "supplier": 0,
  • "receiver": 0
}

Get company

Get company by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "space": {
    },
  • "user": "string",
  • "deleted": true,
  • "lastUpdate": 0,
  • "created": 0,
  • "displayName": "string",
  • "name": "string",
  • "country": "string",
  • "countryIso": "string",
  • "street": "string",
  • "zip": "string",
  • "city": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "taxNumber": "string",
  • "vatId": "string",
  • "commercialRegister": "string",
  • "iban": "string",
  • "bic": "string",
  • "url": "string",
  • "icon": "string",
  • "supplier": 0,
  • "receiver": 0
}

Update company

Update company by id.

path Parameters
id
required
string
Request Body schema: multipart/form-data
object (FormDataBodyPart)
object (FormDataContentDisposition)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "space": {
    },
  • "user": "string",
  • "deleted": true,
  • "lastUpdate": 0,
  • "created": 0,
  • "displayName": "string",
  • "name": "string",
  • "country": "string",
  • "countryIso": "string",
  • "street": "string",
  • "zip": "string",
  • "city": "string",
  • "email": "string",
  • "phone": "string",
  • "fax": "string",
  • "taxNumber": "string",
  • "vatId": "string",
  • "commercialRegister": "string",
  • "iban": "string",
  • "bic": "string",
  • "url": "string",
  • "icon": "string",
  • "supplier": 0,
  • "receiver": 0
}

Remove company

Remove company by id.

path Parameters
id
required
string

Responses

Search companies

Search companies by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
spaceId
string
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "spaceId": "string",
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Category

Endpoint to retrieve and manage categories.

List categories

List categories.

query Parameters
spaceId
string
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Create category

Create a new category.

Request Body schema:
name
string
color
integer <int32>
outgoing
boolean
spaceId
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": 0,
  • "outgoing": true,
  • "spaceId": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "name": "string",
  • "color": 0,
  • "outgoing": true,
  • "space": {
    },
  • "documents": 0
}

Get category

Get category by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "name": "string",
  • "color": 0,
  • "outgoing": true,
  • "space": {
    },
  • "documents": 0
}

Update category

Update category by id.

path Parameters
id
required
string
Request Body schema:
name
string
color
integer <int32>
outgoing
boolean
deleted
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": 0,
  • "outgoing": true,
  • "deleted": true
}

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "name": "string",
  • "color": 0,
  • "outgoing": true,
  • "space": {
    },
  • "documents": 0
}

Remove category

Remove category by id.

path Parameters
id
required
string

Responses

Search categories

Search categories by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
spaceId
string
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "spaceId": "string",
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Tag

Endpoint to retrieve and manage tags.

List tags

List tags.

query Parameters
spaceId
string
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Create tag

Create a new tag.

Request Body schema:
name
string
color
integer <int32>
spaceId
string

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": 0,
  • "spaceId": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "name": "string",
  • "color": 0,
  • "space": {
    }
}

Get tag

Get tag by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "name": "string",
  • "color": 0,
  • "space": {
    }
}

Update tag

Update tag by id.

path Parameters
id
required
string
Request Body schema:
name
string
color
integer <int32>
deleted
boolean

Responses

Request samples

Content type
{
  • "name": "string",
  • "color": 0,
  • "deleted": true
}

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "name": "string",
  • "color": 0,
  • "space": {
    }
}

Remove tag

Remove tag by id.

path Parameters
id
required
string

Responses

Search tags

Search tags by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
spaceId
string
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "spaceId": "string",
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Document

Endpoint to retrieve and manage documents.

List documents

List documents.

query Parameters
spaceId
string
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Create document

Create a new document.

Request Body schema: multipart/form-data
object (FormDataBodyPart)
object (FormDataContentDisposition)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "space": {
    },
  • "category": {
    },
  • "tags": [
    ],
  • "member": {
    },
  • "description": "string",
  • "supplier": {
    },
  • "receiver": {
    },
  • "invoiceId": "string",
  • "invoiceDate": "string",
  • "currency": {
    },
  • "dueDate": "string",
  • "netAmount": 0,
  • "taxAmount": 0,
  • "subtotalAmount": 0,
  • "totalAmount": 0,
  • "discount": 0,
  • "tip": 0,
  • "fileName": "string",
  • "fileSource": "string",
  • "uploadSource": "string",
  • "completionRate": 0,
  • "processed": true,
  • "approved": true,
  • "log": "string",
  • "next": "string",
  • "previous": "string",
  • "displayName": "string",
  • "paymentDate": "string",
  • "paymentMethod": {
    },
  • "paymentStatus": 0,
  • "lineItems": [
    ],
  • "taxItems": [
    ],
  • "barcodes": [
    ],
  • "title": "string"
}

Get document

Get document by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "space": {
    },
  • "category": {
    },
  • "tags": [
    ],
  • "member": {
    },
  • "description": "string",
  • "supplier": {
    },
  • "receiver": {
    },
  • "invoiceId": "string",
  • "invoiceDate": "string",
  • "currency": {
    },
  • "dueDate": "string",
  • "netAmount": 0,
  • "taxAmount": 0,
  • "subtotalAmount": 0,
  • "totalAmount": 0,
  • "discount": 0,
  • "tip": 0,
  • "fileName": "string",
  • "fileSource": "string",
  • "uploadSource": "string",
  • "completionRate": 0,
  • "processed": true,
  • "approved": true,
  • "log": "string",
  • "next": "string",
  • "previous": "string",
  • "displayName": "string",
  • "paymentDate": "string",
  • "paymentMethod": {
    },
  • "paymentStatus": 0,
  • "lineItems": [
    ],
  • "taxItems": [
    ],
  • "barcodes": [
    ],
  • "title": "string"
}

Update document

Update document by id.

path Parameters
id
required
string
Request Body schema:
description
string
categoryId
string
tagIds
Array of strings
supplierId
string
receiverId
string
invoiceId
string
invoiceDate
string
currency
string
dueDate
string
netAmount
integer <int32>
taxAmount
integer <int32>
subtotalAmount
integer <int32>
totalAmount
integer <int32>
discount
integer <int32>
tip
integer <int32>
processed
boolean
approved
boolean
deleted
boolean
Array of objects (DocumentLineItemDto)
Array of objects (DocumentTaxItemDto)
Array of objects (DocumentBarcodeDto)
displayName
string
paymentDate
string
paymentMethodId
string
paymentStatus
integer <int32>

Responses

Request samples

Content type
{
  • "description": "string",
  • "categoryId": "string",
  • "tagIds": [
    ],
  • "supplierId": "string",
  • "receiverId": "string",
  • "invoiceId": "string",
  • "invoiceDate": "string",
  • "currency": "string",
  • "dueDate": "string",
  • "netAmount": 0,
  • "taxAmount": 0,
  • "subtotalAmount": 0,
  • "totalAmount": 0,
  • "discount": 0,
  • "tip": 0,
  • "processed": true,
  • "approved": true,
  • "deleted": true,
  • "lineItems": [
    ],
  • "taxItems": [
    ],
  • "barcodes": [
    ],
  • "displayName": "string",
  • "paymentDate": "string",
  • "paymentMethodId": "string",
  • "paymentStatus": 0
}

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "space": {
    },
  • "category": {
    },
  • "tags": [
    ],
  • "member": {
    },
  • "description": "string",
  • "supplier": {
    },
  • "receiver": {
    },
  • "invoiceId": "string",
  • "invoiceDate": "string",
  • "currency": {
    },
  • "dueDate": "string",
  • "netAmount": 0,
  • "taxAmount": 0,
  • "subtotalAmount": 0,
  • "totalAmount": 0,
  • "discount": 0,
  • "tip": 0,
  • "fileName": "string",
  • "fileSource": "string",
  • "uploadSource": "string",
  • "completionRate": 0,
  • "processed": true,
  • "approved": true,
  • "log": "string",
  • "next": "string",
  • "previous": "string",
  • "displayName": "string",
  • "paymentDate": "string",
  • "paymentMethod": {
    },
  • "paymentStatus": 0,
  • "lineItems": [
    ],
  • "taxItems": [
    ],
  • "barcodes": [
    ],
  • "title": "string"
}

Remove document

Remove document by id.

path Parameters
id
required
string

Responses

Get document

Get file by id.

path Parameters
id
required
string

Responses

Retry document processing

Retry document processing by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0,
  • "deleted": true,
  • "space": {
    },
  • "category": {
    },
  • "tags": [
    ],
  • "member": {
    },
  • "description": "string",
  • "supplier": {
    },
  • "receiver": {
    },
  • "invoiceId": "string",
  • "invoiceDate": "string",
  • "currency": {
    },
  • "dueDate": "string",
  • "netAmount": 0,
  • "taxAmount": 0,
  • "subtotalAmount": 0,
  • "totalAmount": 0,
  • "discount": 0,
  • "tip": 0,
  • "fileName": "string",
  • "fileSource": "string",
  • "uploadSource": "string",
  • "completionRate": 0,
  • "processed": true,
  • "approved": true,
  • "log": "string",
  • "next": "string",
  • "previous": "string",
  • "displayName": "string",
  • "paymentDate": "string",
  • "paymentMethod": {
    },
  • "paymentStatus": 0,
  • "lineItems": [
    ],
  • "taxItems": [
    ],
  • "barcodes": [
    ],
  • "title": "string"
}

Search documents

Search documents by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
startDate
string
endDate
string
spaceId
string
categoryId
string
currency
string
tagIds
Array of strings
categoryIds
Array of strings
userIds
Array of strings
includedIds
Array of strings
excludedIds
Array of strings
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "startDate": "string",
  • "endDate": "string",
  • "spaceId": "string",
  • "categoryId": "string",
  • "currency": "string",
  • "tagIds": [
    ],
  • "categoryIds": [
    ],
  • "userIds": [
    ],
  • "includedIds": [
    ],
  • "excludedIds": [
    ],
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}

Zip documents

Zip documents by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
startDate
string
endDate
string
spaceId
string
categoryId
string
currency
string
tagIds
Array of strings
categoryIds
Array of strings
userIds
Array of strings
includedIds
Array of strings
excludedIds
Array of strings
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "startDate": "string",
  • "endDate": "string",
  • "spaceId": "string",
  • "categoryId": "string",
  • "currency": "string",
  • "tagIds": [
    ],
  • "categoryIds": [
    ],
  • "userIds": [
    ],
  • "includedIds": [
    ],
  • "excludedIds": [
    ],
  • "offset": 0
}

Response samples

Content type
{
  • "name": "string",
  • "url": "string",
  • "bytes": [
    ]
}

Export

Endpoint to retrieve and manage exports.

List exports

List exports.

query Parameters
sort
string
order
string
page
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Create export

Create a new export.

Request Body schema:
report
integer <int32>
format
string
startDate
string
endDate
string
filename
string
currency
string
spaceIds
Array of strings
categoryIds
Array of strings
tagIds
Array of strings
userIds
Array of strings
documentIds
Array of strings

Responses

Request samples

Content type
{
  • "report": 0,
  • "format": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "filename": "string",
  • "currency": "string",
  • "spaceIds": [
    ],
  • "categoryIds": [
    ],
  • "tagIds": [
    ],
  • "userIds": [
    ],
  • "documentIds": [
    ]
}

Response samples

Content type
{
  • "id": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "report": 0,
  • "format": "string",
  • "filename": "string",
  • "currency": "string",
  • "fileSize": 0,
  • "documentCount": 0,
  • "spaceIds": [
    ],
  • "categoryIds": [
    ],
  • "tagIds": [
    ],
  • "userIds": [
    ],
  • "documentIds": [
    ],
  • "fileSource": "string",
  • "state": 0,
  • "message": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0
}

Get export

Get export by id.

path Parameters
id
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "startDate": "string",
  • "endDate": "string",
  • "report": 0,
  • "format": "string",
  • "filename": "string",
  • "currency": "string",
  • "fileSize": 0,
  • "documentCount": 0,
  • "spaceIds": [
    ],
  • "categoryIds": [
    ],
  • "tagIds": [
    ],
  • "userIds": [
    ],
  • "documentIds": [
    ],
  • "fileSource": "string",
  • "state": 0,
  • "message": "string",
  • "user": "string",
  • "lastUpdate": 0,
  • "created": 0
}

Remove export

Remove export by id.

path Parameters
id
required
string

Responses

Search exports

Search exports by given parameters.

Request Body schema:
search
string
sort
string
order
string
count
integer <int32>
page
integer <int32>
limit
integer <int32>
startDate
string
endDate
string
offset
integer <int32>

Responses

Request samples

Content type
{
  • "search": "string",
  • "sort": "string",
  • "order": "string",
  • "count": 0,
  • "page": 0,
  • "limit": 0,
  • "startDate": "string",
  • "endDate": "string",
  • "offset": 0
}

Response samples

Content type
{
  • "items": [
    ],
  • "params": {
    }
}