Documents: General documents

cURL Ruby

List ids and versions of general documents

GET /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.

Parameters

Parameter Type Description
filter String

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

Example: retrieves all ids for synchronization

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents/synchronization.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087507965314450",
    "version": 1711031991
  },
  {
    "id": "416087507978945940",
    "version": 1711031991
  },
  {
    "id": "416087507993626006",
    "version": 1711031991
  }
]

Example: retrieves all ids for synchronization using a filter

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents/synchronization.json?filter=period%3Athis_month

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087508173981088",
    "version": 1711031991
  },
  {
    "id": "416087508189709730",
    "version": 1711031991
  },
  {
    "id": "416087508205438372",
    "version": 1711031991
  }
]

Fetch general documents with given ids

POST /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.

Parameters

Parameter Type Description
ids Array[integer]

Required

Example: retrieves documents for given ids

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"ids":[416087508378453424,416087508393133490]}' \
  https://moneybird.com/api/v2/123/documents/general_documents/synchronization.json

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087508378453424",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2024-03-21",
    "due_date": null,
    "entry_number": 3,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2024-03-21T14:39:51.837Z",
    "updated_at": "2024-03-21T14:39:51.837Z",
    "version": 1711031991,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17110319469471,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-03-21T14:39:51.841Z",
        "updated_at": "2024-03-21T14:39:51.841Z"
      }
    ]
  },
  {
    "id": "416087508393133490",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2024-03-21",
    "due_date": null,
    "entry_number": 4,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2024-03-21T14:39:51.852Z",
    "updated_at": "2024-03-21T14:39:51.852Z",
    "version": 1711031991,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17110319469471,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-03-21T14:39:51.855Z",
        "updated_at": "2024-03-21T14:39:51.855Z"
      }
    ]
  }
]

Get general documents

GET /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.

Parameters

Parameter Type Description
filter String

Required

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

String terms, example: key1:value1,key2:value2.
page Integer
per_page Integer
exclude_new_general_journal_documents Boolean

Example: returns a list of general_documents

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087502956266728",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2024-03-21",
    "due_date": null,
    "entry_number": 5,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2024-03-21T14:39:46.667Z",
    "updated_at": "2024-03-21T14:39:46.667Z",
    "version": 1711031986,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17110319469471,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-03-21T14:39:46.670Z",
        "updated_at": "2024-03-21T14:39:46.670Z"
      }
    ]
  },
  {
    "id": "416087502940538086",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2024-03-21",
    "due_date": null,
    "entry_number": 4,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2024-03-21T14:39:46.651Z",
    "updated_at": "2024-03-21T14:39:46.651Z",
    "version": 1711031986,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17110319469471,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-03-21T14:39:46.655Z",
        "updated_at": "2024-03-21T14:39:46.655Z"
      }
    ]
  },
  {
    "id": "416087502922712292",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2024-03-21",
    "due_date": null,
    "entry_number": 3,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2024-03-21T14:39:46.635Z",
    "updated_at": "2024-03-21T14:39:46.635Z",
    "version": 1711031986,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17110319469471,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-03-21T14:39:46.639Z",
        "updated_at": "2024-03-21T14:39:46.639Z"
      }
    ]
  }
]

Example: returns paginated general documents on page 1

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents.json?per_page=1

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087503186953464",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2024-03-21",
    "due_date": null,
    "entry_number": 5,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2024-03-21T14:39:46.887Z",
    "updated_at": "2024-03-21T14:39:46.887Z",
    "version": 1711031986,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17110319469471,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-03-21T14:39:46.890Z",
        "updated_at": "2024-03-21T14:39:46.890Z"
      }
    ]
  }
]

Example: returns paginated general documents on page 2

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents.json?page=2&per_page=1

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087503388280070",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "Contract",
    "date": "2024-03-21",
    "due_date": null,
    "entry_number": 4,
    "state": "saved",
    "exchange_rate": "1.0",
    "created_at": "2024-03-21T14:39:47.079Z",
    "updated_at": "2024-03-21T14:39:47.079Z",
    "version": 1711031987,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17110319469471,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-03-21T14:39:47.082Z",
        "updated_at": "2024-03-21T14:39:47.082Z"
      }
    ]
  }
]

Example: returns an error when too many general documents are requested

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents.json?per_page=101

Response

        
          
          Status: 400 Bad Request
        
      
{
  "error": "Per Page is too big",
  "symbolic": {
    "per_page": "max"
  }
}

Get general documents

GET /documents/general_documents/:id(.:format)

Example: returns the wanted general_document

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents/416087503787787554.json?

Response

        
          
          Status: 200 OK
        
      
{
  "id": "416087503787787554",
  "administration_id": 123,
  "contact_id": null,
  "contact": null,
  "reference": "Contract",
  "date": "2024-03-21",
  "due_date": null,
  "entry_number": 2,
  "state": "saved",
  "exchange_rate": "1.0",
  "created_at": "2024-03-21T14:39:47.460Z",
  "updated_at": "2024-03-21T14:39:47.460Z",
  "version": 1711031987,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:39:47.463Z",
      "updated_at": "2024-03-21T14:39:47.463Z"
    }
  ]
}

Example: only returns general_documents

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/general_documents/416087503928296745.json?

Response

        
          
          Status: 404 Not Found
        
      
{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}

Create a new general documents

POST /documents/general_documents(.:format)

Parameters

Parameter Type Description
general_document[reference] String

Required.
general_document[date] String

Required

Required.
general_document[due_date] String
general_document[reminder_date] String
general_document[contact_id] Integer

Should be a valid contact id.
general_document[reminder][date] String

Required
general_document[reminder][message] String

Example: creates the general_document

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"general_document":{"reference":"foobar","contact_id":416087504424273227}}' \
  https://moneybird.com/api/v2/123/documents/general_documents.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "416087504542762323",
  "administration_id": 123,
  "contact_id": "416087504424273227",
  "contact": {
    "id": "416087504424273227",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-03-21T14:39:48.067Z",
    "updated_at": "2024-03-21T14:39:48.067Z",
    "version": 1711031988,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5c50c3a3da02ab155d33ea039c502e63f58ecd2875d2f3cc25659f3f22b3b131/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "reference": "foobar",
  "date": "2024-03-21",
  "due_date": null,
  "entry_number": 3,
  "state": "saved",
  "exchange_rate": "1.0",
  "created_at": "2024-03-21T14:39:48.180Z",
  "updated_at": "2024-03-21T14:39:48.180Z",
  "version": 1711031988,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:39:48.184Z",
      "updated_at": "2024-03-21T14:39:48.184Z"
    }
  ]
}

Example: requires all input

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/general_documents.json

Response

        
          
          Status: 400 Bad Request
        
      
{
  "error": "General Document is required",
  "symbolic": {
    "general_document": "required"
  }
}

Delete a general documents

DELETE /documents/general_documents/:id(.:format)

Parameters

Parameter Type Description
refresh_journal_entries Boolean

Example: deletes the general_document

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/general_documents/416087505181345148.json

Response

        
          
          Status: 200 OK
        
      
200

Update a general documents

PATCH /documents/general_documents/:id(.:format)

Parameters

Parameter Type Description
general_document[reference] String

Required.
general_document[date] String

Required

Required.
general_document[due_date] String
general_document[reminder_date] String
general_document[contact_id] Integer

Should be a valid contact id.
general_document[reminder][date] String

Required
general_document[reminder][message] String
remove_contact Boolean

Example: updates the general_document

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"general_document":{"reference":"updated reference"}}' \
  https://moneybird.com/api/v2/123/documents/general_documents/416087504842655079.json

Response

        
          
          Status: 200 OK
        
      
{
  "id": "416087504842655079",
  "administration_id": 123,
  "contact_id": null,
  "contact": null,
  "reference": "updated reference",
  "date": "2024-03-21",
  "due_date": null,
  "entry_number": 2,
  "state": "saved",
  "exchange_rate": "1.0",
  "created_at": "2024-03-21T14:39:48.466Z",
  "updated_at": "2024-03-21T14:39:48.520Z",
  "version": 1711031988,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:39:48.469Z",
      "updated_at": "2024-03-21T14:39:48.469Z"
    },
    {
      "administration_id": 123,
      "user_id": 17110319469471,
      "action": "document_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-03-21T14:39:48.522Z",
      "updated_at": "2024-03-21T14:39:48.522Z"
    }
  ]
}

Add attachment to general document

POST /documents/general_documents/:id/attachments(.:format)

Example: uploads an attachment

Request

curl -s -H "Content-Type: multipart/mixed" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -F file=@/tmp/upload.pdf \
  https://moneybird.com/api/v2/123/documents/general_documents/416087505377428871/attachments.json

Response

        
          
          Status: 200 OK
        
      
200

Download attachment

GET /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.

Delete an attachment

DELETE /documents/general_documents/:id/attachments/:attachment_id(.:format)

Deletes an attachment of an attachable.

Example: destroys an attachment

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/general_documents/416087508622771644/attachments/416087508768523710.json

Response

        
          
          Status: 204 No Content

Adds note to entity

POST /documents/general_documents/:general_document_id/notes(.:format)

Parameters

Parameter Type Description
note[note] String

Required. Text for the note or to-do.
note[todo] Boolean

If true the note is a to-do.
note[assignee_id] Integer

Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do.

Example: create a note

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"note":{"note":"Text of the note","assignee_id":416087504115991864,"todo":true}}' \
  https://moneybird.com/api/v2/123/documents/general_documents/416087504104457526/notes.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "416087504166323514",
  "administration_id": 123,
  "entity_id": "416087504104457526",
  "entity_type": "Document",
  "user_id": 17110319469471,
  "assignee_id": "416087504115991864",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {
  },
  "created_at": "2024-03-21T14:39:47.820Z",
  "updated_at": "2024-03-21T14:39:47.820Z"
}

Destroys note from entity

DELETE /documents/general_documents/:general_document_id/notes/:id(.:format)

Example: destroy a note

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/general_documents/416087504295298372/notes/416087504307881286.json

Response

        
          
          Status: 204 No Content