Moneybird logo
Moneybird API

Documents: Typeless documents

Typeless documents are documents of which the type is not yet known. For example, a document uploaded via email or via the bulk uploader. It is not possible to update a typeless document, except for adding attachments. You will need to set its type first. You cannot set the type of typeless documents using the API yet, but you can do this via the website.


List ids and versions of typeless documents

GET
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents/synchronization{format}

Returns all documents in the administration. The list contains the document id and the version of the document. Check if the version of the document is newer than the version you have stored locally, use the POST variant for fetching documents with the given ids.

Required scope(s)

documents

List ids and versions of typeless documents › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List ids and versions of typeless documents › query Parameters

filter
​string

Comma-separated key:value filter terms. Same syntax as GET /documents/typeless_documents — see that operation's description for the available keys.

List ids and versions of typeless documents › Responses

200

IDs and versions of records

​object[]
id
​integer | string
version
​integer | string

Fetch typeless documents with given ids

POST
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents/synchronization{format}

Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided.

Required scope(s)

documents

Fetch typeless documents with given ids › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Fetch typeless documents with given ids › Request Body

ids
​(integer | string)[] · required

Fetch typeless documents with given ids › Responses

200

A list of typeless documents

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​attachment_response[]

Download attachment

GET
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents/{id}/attachments/{attachment_id}/download{format}

Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment.

Required scope(s)

documents

Download attachment › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

attachment_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Download attachment › Responses

Found

string

Delete an attachment

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents/{id}/attachments/{attachment_id}{format}

Deletes an attachment of an attachable.

Required scope(s)

documents

Delete an attachment › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

attachment_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Delete an attachment › Responses

Attachment deleted

No data returned

Add attachment to typeless document

POST
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents/{id}/attachments{format}

Add an attachment to a typeless document.

Required scope(s)

documents

Add attachment to typeless document › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Add attachment to typeless document › Request Body

file
​string · binary

Add attachment to typeless document › Responses

Status code

integer

Get a typeless document

GET
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents/{id}{format}

Returns a typeless document by id.

Required scope(s)

documents

Get a typeless document › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Get a typeless document › Responses

A typeless document

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​attachment_response[]

Delete a typeless document

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents/{id}{format}

Deletes a typeless document.

Required scope(s)

documents

Delete a typeless document › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Delete a typeless document › Responses

Status code

integer

Get typeless documents

GET
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents{format}

Returns a paginated list of documents of this type in the administration.

Required scope(s)

documents

Get typeless documents › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Get typeless documents › query Parameters

filter
​string

Filters are key:value terms separated by commas (e.g. period:this_year,state:open). Any filter you pass replaces the defaults below entirely, so include every key you need — in particular pass an explicit period (a named period or a YYYYMMDD..YYYYMMDD range) to look beyond the default financial year. Available filters:

FilterTypeDefaultDescription
periodStringthis_yearA named period (this_week, prev_week, next_week, this_month, prev_month, next_month, this_quarter, prev_quarter, next_quarter, this_year, prev_year, next_year) or a custom range (201301..201302, 20130101..20130131)
stateStringallall, new, saved, open, paid, late or pending_payment. paid, late and pending_payment only apply to documents with a payment lifecycle (purchase invoices and receipts)
recurringStringallall, enabled or disabled
attachmentStringallall, with or without
referenceStringDocuments with the given reference value
contact_idIntegerDocuments belonging to the given contact
ledger_account_idIntegerDocuments booking against the given ledger account
updated_afterStringISO 8601 timestamp in UTC; documents updated strictly after this time

Multiple values for state, recurring and attachment can be combined with a pipe, e.g. state:open|paid.

Default: period:this_year
new_filter
​string

String terms, example: key1:value1,key2:value2.

page
​integer | string
sort
​string · enum

Sorts the list on date, so the newest (date_desc) or the oldest (date_asc) items come first.

Enum values:
date_desc
date_asc
Default: date_desc
per_page
​integer | string · min: 1 · max: 100 · pattern: ^\d+$

Get typeless documents › Responses

A list of typeless documents

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​attachment_response[]

Create a new typeless document

POST
https://moneybird.com/api/v2
/{administration_id}/documents/typeless_documents{format}

Creates a new typeless document.

Required scope(s)

documents

Create a new typeless document › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Create a new typeless document › Request Body

​object

Create a new typeless document › Responses

Typeless document created

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
reference
​string | null
date
​string · date
state
​string · enum
Enum values:
new
open
late
paid
saved
pending_payment
origin
​string | null · enum
Enum values:
upload
endpoint
si
email
si_local
si_peppol
api
moneybird_bv
created_at
​timestamp · date-time
updated_at
​timestamp · date-time
version
​version
​attachment_response[]