Moneybird logo
Moneybird API

Documents: Typeless documents

Endpoint:https://moneybird.com/api/v2

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.

List ids and versions of typeless documents › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · 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

  • filterstring

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

List ids and versions of typeless documents › Responses

IDs and versions of records

  • idinteger | string
  • versioninteger | 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.

Fetch typeless documents with given ids › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · 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

A list of typeless documents

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • attachmentsobject[]
  • eventsobject[]

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.

Download attachment › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • attachment_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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.

Delete an attachment › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • attachment_idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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.

Add attachment to typeless document › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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

  • filestring · 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.

Get a typeless document › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • attachmentsobject[]
  • eventsobject[]

Delete a typeless document

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

Deletes a typeless document.

Delete a typeless document › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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.

The filter argument allows you to filter on the list of documents. Filters are a combination of keys and values, separated by a comma: key:value,key2:value2. The most common filter method will be period: period:this_month. Filtering works the same as in the web application, for more advanced examples, change the filtering in the web application and learn from the resulting URI.

Get typeless documents › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · 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

  • filterstring

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

  • new_filterstring

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

  • pageinteger | string
  • per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$
  • exclude_new_general_journal_documentsboolean | string

Get typeless documents › Responses

A list of typeless documents

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • attachmentsobject[]
  • eventsobject[]

Create a new typeless document

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

Creates a new typeless document.

Create a new typeless document › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · 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

  • typeless_documentobject

Create a new typeless document › Responses

Typeless document created

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • contact_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • attachmentsobject[]
  • eventsobject[]
Documents: ReceiptsEstimates