Documents: General journal documents

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

journal_type

string | null · enum

Enum values:

fiscal_year_ending

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

POST/{administration_id}/documents/general_journal_documents/synchronization{format}

curl https://moneybird.com/api/v2/:administration_id/documents/general_journal_documents/synchronization:format \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "ids": [
    501033118838293500,
    501033118854022200
  ]
}'

Example Request Body

{
  "ids": [
    501033118838293500,
    501033118854022200
  ]
}

json

application/json

Example Responses

[
  {
    "id": "501033118838293536",
    "administration_id": 123,
    "reference": "Deprecations",
    "date": "2026-10-15",
    "journal_type": null,
    "created_at": "2026-10-15T05:33:58.826Z",
    "updated_at": "2026-10-15T05:33:58.826Z",
    "version": 1792042438,
    "general_journal_document_entries": [
      {
        "id": "501033118838293537",
        "administration_id": 123,
        "ledger_account_id": "501033118829904927",
        "project_id": null,
        "contact_id": null,
        "debit": "100.0",
        "credit": "0.0",
        "row_order": 1,
        "created_at": "2026-10-15T05:33:58.826Z",
        "updated_at": "2026-10-15T05:33:58.826Z",
        "description": "First"
      },
      {
        "id": "501033118839342114",
        "administration_id": 123,
        "ledger_account_id": "501033118829904927",
        "project_id": null,
        "contact_id": null,
        "debit": "0.0",
        "credit": "100.0",
        "row_order": 2,
        "created_at": "2026-10-15T05:33:58.827Z",
        "updated_at": "2026-10-15T05:33:58.827Z",
        "description": "Second"
      },
      {
        "id": "501033118839342115",
        "administration_id": 123,
        "ledger_account_id": "501033118829904927",
        "project_id": null,
        "contact_id": null,
        "debit": "50.0",
        "credit": "0.0",
        "row_order": 3,
        "created_at": "2026-10-15T05:33:58.827Z",
        "updated_at": "2026-10-15T05:33:58.827Z",
        "description": "Third"
      },
      {
        "id": "501033118839342116",
        "administration_id": 123,
        "ledger_account_id": "501033118829904927",
        "project_id": null,
        "contact_id": null,
        "debit": "0.0",
        "credit": "50.0",
        "row_order": 4,
        "created_at": "2026-10-15T05:33:58.827Z",
        "updated_at": "2026-10-15T05:33:58.827Z",
        "description": "Fourth"
      }
    ],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": "501033067832411237",
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2026-10-15T05:33:58.828Z",
        "updated_at": "2026-10-15T05:33:58.828Z"
      }
    ]
  },
  {
    "id": "501033118854022195",
    "administration_id": 123,
    "reference": "Deprecations",
    "date": "2026-10-15",
    "journal_type": null,
    "created_at": "2026-10-15T05:33:58.841Z",
    "updated_at": "2026-10-15T05:33:58.841Z",
    "version": 1792042438,
    "general_journal_document_entries": [
      {
        "id": "501033118855070772",
        "administration_id": 123,
        "ledger_account_id": "501033118846682162",
        "project_id": null,
        "contact_id": null,
        "debit": "100.0",
        "credit": "0.0",
        "row_order": 1,
        "created_at": "2026-10-15T05:33:58.842Z",
        "updated_at": "2026-10-15T05:33:58.842Z",
        "description": "First"
      },
      {
        "id": "501033118855070773",
        "administration_id": 123,
        "ledger_account_id": "501033118846682162",
        "project_id": null,
        "contact_id": null,
        "debit": "0.0",
        "credit": "100.0",
        "row_order": 2,
        "created_at": "2026-10-15T05:33:58.842Z",
        "updated_at": "2026-10-15T05:33:58.842Z",
        "description": "Second"
      },
      {
        "id": "501033118856119350",
        "administration_id": 123,
        "ledger_account_id": "501033118846682162",
        "project_id": null,
        "contact_id": null,
        "debit": "50.0",
        "credit": "0.0",
        "row_order": 3,
        "created_at": "2026-10-15T05:33:58.843Z",
        "updated_at": "2026-10-15T05:33:58.843Z",
        "description": "Third"
      },
      {
        "id": "501033118856119351",
        "administration_id": 123,
        "ledger_account_id": "501033118846682162",
        "project_id": null,
        "contact_id": null,
        "debit": "0.0",
        "credit": "50.0",
        "row_order": 4,
        "created_at": "2026-10-15T05:33:58.843Z",
        "updated_at": "2026-10-15T05:33:58.843Z",
        "description": "Fourth"
      }
    ],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": "501033067832411237",
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2026-10-15T05:33:58.844Z",
        "updated_at": "2026-10-15T05:33:58.844Z"
      }
    ]
  }
]

json

application/json

Destroys note from entity

DELETE

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents/{general_journal_document_id}/notes/{id}{format}

Deletes a note from the general journal document.

Required scope(s)

documents

Destroys note from entity › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

general_journal_document_id

identifier · pattern: ^\d+$ · required

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

Destroys note from entity › Responses

Note deleted

No data returned

Adds note to entity

POST

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents/{general_journal_document_id}/notes{format}

Adds a note to the general journal document.

Required scope(s)

documents

Adds note to entity › path Parameters

administration_id

administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

general_journal_document_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

Adds note to entity › Request Body

object

Adds note to entity › Responses

Note created

note_response

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

entity_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

entity_type

string

user_id

identifier · pattern: ^\d+$

A unique record identifier

assignee_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

todo

boolean | string | null

Default: false

note

string | null

completed_at

string | null · date-time

completed_by_id

identifier_nullable · pattern: ^\d+$

A unique record identifier

todo_type

string | 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

data

object | null

created_at

timestamp · date-time

updated_at

timestamp · date-time

POST/{administration_id}/documents/general_journal_documents/{general_journal_document_id}/notes{format}

curl https://moneybird.com/api/v2/:administration_id/documents/general_journal_documents/:general_journal_document_id/notes:format \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "note": {
    "note": "Text of the note",
    "assignee_id": 501033115945272500,
    "todo": true
  }
}'

Example Request Body

{
  "note": {
    "note": "Text of the note",
    "assignee_id": 501033115945272500,
    "todo": true
  }
}

json

application/json

Example Responses

{
  "id": "501033115952612516",
  "administration_id": 123,
  "entity_id": "501033115935835280",
  "entity_type": "Document",
  "user_id": "501033067832411237",
  "assignee_id": "501033115945272482",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {},
  "created_at": "2026-10-15T05:33:56.074Z",
  "updated_at": "2026-10-15T05:33:56.074Z"
}

json

application/json

Download attachment

GET

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_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/general_journal_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 general journal document

POST

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents/{id}/attachments{format}

Add an attachment to a general journal document.

Required scope(s)

documents

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

file

string · binary

Add attachment to general journal document › Responses

Status code

integer

Get general journal document

GET

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents/{id}{format}

Returns a general journal document by id.

Required scope(s)

documents

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

A general journal document

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

journal_type

string | null · enum

Enum values:

fiscal_year_ending

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

GET/{administration_id}/documents/general_journal_documents/{id}{format}

curl https://moneybird.com/api/v2/:administration_id/documents/general_journal_documents/:id:format \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "501033119782012649",
  "administration_id": 123,
  "reference": "Deprecations",
  "date": "2026-10-15",
  "journal_type": null,
  "created_at": "2026-10-15T05:33:59.726Z",
  "updated_at": "2026-10-15T05:33:59.726Z",
  "version": 1792042439,
  "general_journal_document_entries": [
    {
      "id": "501033119783061226",
      "administration_id": 123,
      "ledger_account_id": "501033119773624040",
      "project_id": null,
      "contact_id": null,
      "debit": "100.0",
      "credit": "0.0",
      "row_order": 1,
      "created_at": "2026-10-15T05:33:59.727Z",
      "updated_at": "2026-10-15T05:33:59.727Z",
      "description": "First"
    },
    {
      "id": "501033119783061227",
      "administration_id": 123,
      "ledger_account_id": "501033119773624040",
      "project_id": null,
      "contact_id": null,
      "debit": "0.0",
      "credit": "100.0",
      "row_order": 2,
      "created_at": "2026-10-15T05:33:59.727Z",
      "updated_at": "2026-10-15T05:33:59.727Z",
      "description": "Second"
    },
    {
      "id": "501033119783061228",
      "administration_id": 123,
      "ledger_account_id": "501033119773624040",
      "project_id": null,
      "contact_id": null,
      "debit": "50.0",
      "credit": "0.0",
      "row_order": 3,
      "created_at": "2026-10-15T05:33:59.727Z",
      "updated_at": "2026-10-15T05:33:59.727Z",
      "description": "Third"
    },
    {
      "id": "501033119784109805",
      "administration_id": 123,
      "ledger_account_id": "501033119773624040",
      "project_id": null,
      "contact_id": null,
      "debit": "0.0",
      "credit": "50.0",
      "row_order": 4,
      "created_at": "2026-10-15T05:33:59.728Z",
      "updated_at": "2026-10-15T05:33:59.728Z",
      "description": "Fourth"
    }
  ],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": "501033067832411237",
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2026-10-15T05:33:59.729Z",
      "updated_at": "2026-10-15T05:33:59.729Z"
    }
  ]
}

json

application/json

Update a general journal document

PATCH

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents/{id}{format}

Updates a general journal document.

Required scope(s)

documents

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

Update a general journal document › Request Body

object

all_taxes

boolean | string

Update a general journal document › Responses

General journal document updated

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

journal_type

string | null · enum

Enum values:

fiscal_year_ending

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

general_journal_document_response[]

PATCH/{administration_id}/documents/general_journal_documents/{id}{format}

curl https://moneybird.com/api/v2/:administration_id/documents/general_journal_documents/:id:format \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "general_journal_document": {
    "reference": "updated reference"
  }
}'

Example Request Body

{
  "general_journal_document": {
    "reference": "updated reference"
  }
}

json

application/json

Example Responses

{
  "id": "501033118353852069",
  "administration_id": 123,
  "reference": "updated reference",
  "date": "2026-10-15",
  "journal_type": null,
  "created_at": "2026-10-15T05:33:58.363Z",
  "updated_at": "2026-10-15T05:33:58.386Z",
  "version": 1792042438,
  "general_journal_document_entries": [
    {
      "id": "501033118353852070",
      "administration_id": 123,
      "ledger_account_id": "501033118345463460",
      "project_id": null,
      "contact_id": null,
      "debit": "100.0",
      "credit": "0.0",
      "row_order": 1,
      "created_at": "2026-10-15T05:33:58.364Z",
      "updated_at": "2026-10-15T05:33:58.364Z",
      "description": "First"
    },
    {
      "id": "501033118354900647",
      "administration_id": 123,
      "ledger_account_id": "501033118345463460",
      "project_id": null,
      "contact_id": null,
      "debit": "0.0",
      "credit": "100.0",
      "row_order": 2,
      "created_at": "2026-10-15T05:33:58.365Z",
      "updated_at": "2026-10-15T05:33:58.365Z",
      "description": "Second"
    },
    {
      "id": "501033118354900648",
      "administration_id": 123,
      "ledger_account_id": "501033118345463460",
      "project_id": null,
      "contact_id": null,
      "debit": "50.0",
      "credit": "0.0",
      "row_order": 3,
      "created_at": "2026-10-15T05:33:58.365Z",
      "updated_at": "2026-10-15T05:33:58.365Z",
      "description": "Third"
    },
    {
      "id": "501033118354900649",
      "administration_id": 123,
      "ledger_account_id": "501033118345463460",
      "project_id": null,
      "contact_id": null,
      "debit": "0.0",
      "credit": "50.0",
      "row_order": 4,
      "created_at": "2026-10-15T05:33:58.365Z",
      "updated_at": "2026-10-15T05:33:58.365Z",
      "description": "Fourth"
    }
  ],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": "501033067832411237",
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2026-10-15T05:33:58.366Z",
      "updated_at": "2026-10-15T05:33:58.366Z"
    },
    {
      "administration_id": 123,
      "user_id": "501033067832411237",
      "action": "document_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2026-10-15T05:33:58.387Z",
      "updated_at": "2026-10-15T05:33:58.387Z"
    }
  ]
}

json

application/json

Delete a general journal document

DELETE

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents/{id}{format}

Deletes a general journal document.

Required scope(s)

documents

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

Status code

integer

Get general journal documents

GET

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents{format}

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

The exclude_new_general_journal_documents parameter, when set to true, removes documents that are still in the new state from the response. It has no effect on other document types.

Required scope(s)

documents

Get general journal 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 general journal 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:

Filter	Type	Default	Description
period	`String`	`this_year`	A 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`)
state	`String`	`all`	`all`, `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)
recurring	`String`	`all`	`all`, `enabled` or `disabled`
attachment	`String`	`all`	`all`, `with` or `without`
reference	`String`		Documents with the given reference value
contact_id	`Integer`		Documents belonging to the given contact
ledger_account_id	`Integer`		Documents booking against the given ledger account
updated_after	`String`		ISO 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+$

exclude_new_general_journal_documents

boolean | string

Get general journal documents › Responses

A list of general journal documents

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

journal_type

string | null · enum

Enum values:

fiscal_year_ending

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

GET/{administration_id}/documents/general_journal_documents{format}

curl https://moneybird.com/api/v2/:administration_id/documents/general_journal_documents:format \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "id": "501033119182226750",
    "administration_id": 123,
    "reference": "Loonjournaalposten",
    "date": "2025-10-15",
    "journal_type": null,
    "created_at": "2026-10-15T05:33:59.154Z",
    "updated_at": "2026-10-15T05:33:59.154Z",
    "version": 1792042439,
    "general_journal_document_entries": [],
    "notes": [],
    "attachments": [],
    "events": []
  }
]

json

application/json

Create a new general journal document

POST

https://moneybird.com/api/v2

/{administration_id}/documents/general_journal_documents{format}

Creates a new general journal document.

Required scope(s)

documents

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

object

Create a new general journal document › Responses

General journal document created

id

identifier · pattern: ^\d+$

A unique record identifier

administration_id

administration_id · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

journal_type

string | null · enum

Enum values:

fiscal_year_ending

created_at

timestamp · date-time

updated_at

timestamp · date-time

version