Documents: General 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

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

exchange_rate

string | null

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

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

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

Example Request Body

{
  "ids": [
    499053940104496260,
    499053940114982000
  ]
}

json

application/json

Example Responses

[
  {
    "id": "499053940104496282",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2026-09-23",
    "due_date": null,
    "entry_number": 3,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2026-09-23T09:15:46.899Z",
    "updated_at": "2026-09-23T09:15:46.899Z",
    "version": 1790154946,
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": "499053793376207973",
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2026-09-23T09:15:46.902Z",
        "updated_at": "2026-09-23T09:15:46.902Z"
      }
    ]
  },
  {
    "id": "499053940114982044",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2026-09-23",
    "due_date": null,
    "entry_number": 4,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2026-09-23T09:15:46.910Z",
    "updated_at": "2026-09-23T09:15:46.910Z",
    "version": 1790154946,
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": "499053793376207973",
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2026-09-23T09:15:46.912Z",
        "updated_at": "2026-09-23T09:15:46.912Z"
      }
    ]
  }
]

json

application/json

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.

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_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_documents/{general_document_id}/notes{format}

Adds a note to the general 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_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_documents/{general_document_id}/notes{format}

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

Example Request Body

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

json

application/json

Example Responses

{
  "id": "499053939879052389",
  "administration_id": 123,
  "entity_id": "499053939851789409",
  "entity_type": "Document",
  "user_id": "499053793376207973",
  "assignee_id": "499053939862275171",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {},
  "created_at": "2026-09-23T09:15:46.684Z",
  "updated_at": "2026-09-23T09:15:46.684Z"
}

json

application/json

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.

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_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 document

POST

https://moneybird.com/api/v2

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

Add an attachment to a general document.

Required scope(s)

documents

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

file

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

Required scope(s)

documents

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

A general 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

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

exchange_rate

string | null

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

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

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

Example Responses

{
  "id": "499053938446698306",
  "administration_id": 123,
  "contact_id": null,
  "contact": null,
  "reference": "Contract",
  "date": "2026-09-23",
  "due_date": null,
  "entry_number": 2,
  "state": "saved",
  "exchange_rate": "1.0",
  "created_at": "2026-09-23T09:15:45.318Z",
  "updated_at": "2026-09-23T09:15:45.318Z",
  "version": 1790154945,
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": "499053793376207973",
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2026-09-23T09:15:45.321Z",
      "updated_at": "2026-09-23T09:15:45.321Z"
    }
  ]
}

json

application/json

Delete a general document

DELETE

https://moneybird.com/api/v2

/{administration_id}/documents/general_documents/{id}{format}

Deletes a general document.

Required scope(s)

documents

Delete a general 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 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.

Required scope(s)

documents

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

object

remove_contact

boolean | string

Update a general document › Responses

General document updated

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

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

exchange_rate

string | null

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

general_document_response[]

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

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

Example Request Body

{
  "general_document": {
    "reference": "updated reference"
  }
}

json

application/json

Example Responses

{
  "id": "499053938272634655",
  "administration_id": 123,
  "contact_id": null,
  "contact": null,
  "reference": "updated reference",
  "date": "2026-09-23",
  "due_date": null,
  "entry_number": 2,
  "state": "saved",
  "exchange_rate": "1.0",
  "created_at": "2026-09-23T09:15:45.153Z",
  "updated_at": "2026-09-23T09:15:45.172Z",
  "version": 1790154945,
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": "499053793376207973",
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2026-09-23T09:15:45.156Z",
      "updated_at": "2026-09-23T09:15:45.156Z"
    },
    {
      "administration_id": 123,
      "user_id": "499053793376207973",
      "action": "document_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2026-09-23T09:15:45.174Z",
      "updated_at": "2026-09-23T09:15:45.174Z"
    }
  ]
}

json

application/json

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.

Required scope(s)

documents

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

per_page

integer | string · min: 1 · max: 100 · pattern: ^\d+$

Get general documents › Responses

A list of general 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

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

exchange_rate

string | null

created_at

timestamp · date-time

updated_at

timestamp · date-time

version

GET/{administration_id}/documents/general_documents{format}

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

Example Responses

[
  {
    "id": "499053938765465473",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2026-09-23",
    "due_date": null,
    "entry_number": 5,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2026-09-23T09:15:45.621Z",
    "updated_at": "2026-09-23T09:15:45.621Z",
    "version": 1790154945,
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": "499053793376207973",
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2026-09-23T09:15:45.625Z",
        "updated_at": "2026-09-23T09:15:45.625Z"
      }
    ]
  }
]

json

application/json

Create a new general document

POST

https://moneybird.com/api/v2

/{administration_id}/documents/general_documents{format}

Creates a new general document.

Required scope(s)

documents

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

object

Create a new general document › Responses

General 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

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

exchange_rate

string | null

created_at

timestamp · date-time

updated_at

timestamp · date-time

version