Moneybird logo
Moneybird API

Documents: General documents

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

General documents are documents that are not invoices, estimates, or other specific document types. They can be used to store other financial documents.

List ids and versions of general documents

GET
https://moneybird.com/api/v2
/{administration_id}/documents/general_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 general 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 general documents › query Parameters

  • filterstring

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

List ids and versions of general documents › Responses

IDs and versions of records

  • idinteger | string
  • versioninteger | string

Fetch general documents with given ids

POST
https://moneybird.com/api/v2
/{administration_id}/documents/general_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 general 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 general documents with given ids › Request Body

  • ids(integer | string)[] · required

Fetch general documents with given ids › Responses

A list of general 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
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • exchange_ratestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Destroys note from entity

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/general_documents/{general_document_id}/notes/{id}{format}

Deletes a note from the general document.

Destroys note from entity › path Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

  • 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

Destroys note from entity › Responses

Note deleted

No data returned

Adds note to entity

POST
https://moneybird.com/api/v2
/{administration_id}/documents/general_documents/{general_document_id}/notes{format}

Adds a note to the general document.

Adds note to entity › path Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • general_document_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

Adds note to entity › Request Body

  • noteobject

Adds note to entity › Responses

Note created

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

  • entity_typestring
  • user_idstring | integer · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • todoboolean | string | null
    Default: false
  • notestring | null
  • completed_atstring | null · date-time
  • completed_by_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • todo_typestring | null · enum
    Enum values:
    sales_invoice_due
    purchase_invoice_due
    general_document_reminder
    general_document_due
    new_document_awaiting_processing
    new_financial_mutation_awaiting_processing
    financial_mutations_not_updated
    sales_invoice_payment_not_linked_to_financial_mutation
  • dataobject | null
  • created_atstring · date-time
  • updated_atstring · date-time

Download attachment

GET
https://moneybird.com/api/v2
/{administration_id}/documents/general_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/general_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 general document

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

Add an attachment to a general document.

Add attachment to general 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 general document › Request Body

  • filestring · binary

Add attachment to general document › Responses

Status code

integer

Get general document

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

Returns a general document by id.

Get general 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 general document › Responses

A general 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
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • exchange_ratestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Delete a general document

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

Deletes a general document.

Delete a general 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 general document › Responses

Status code

integer

Update a general document

PATCH
https://moneybird.com/api/v2
/{administration_id}/documents/general_documents/{id}{format}

Updates a general document.

Update a general 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

Update a general document › Request Body

  • general_documentobject
  • remove_contactboolean | string

Update a general document › Responses

General document updated

  • 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
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • exchange_ratestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Get general documents

GET
https://moneybird.com/api/v2
/{administration_id}/documents/general_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 general 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 general 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 general documents › Responses

A list of general 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
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • exchange_ratestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Create a new general document

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

Creates a new general document.

Create a new general 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 general document › Request Body

  • general_documentobject

Create a new general document › Responses

General 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
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • exchange_ratestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
Document stylesDocuments: General journal documents