Documents: Typeless documents

cURL Ruby

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 it via the website.

List ids and versions of typeless documents

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

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/typeless_documents/synchronization.json?

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087537057007397",
    "version": 1711032019
  },
  {
    "id": "416087537071687463",
    "version": 1711032019
  },
  {
    "id": "416087537086367529",
    "version": 1711032019
  }
]

Fetch typeless documents with given ids

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

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":[416087537259382581,416087537273014071]}' \
  https://moneybird.com/api/v2/123/documents/typeless_documents/synchronization.json

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087537259382581",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "20130456",
    "date": "2024-03-21",
    "state": "new",
    "origin": null,
    "created_at": "2024-03-21T14:40:19.381Z",
    "updated_at": "2024-03-21T14:40:19.381Z",
    "version": 1711032019,
    "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:40:19.384Z",
        "updated_at": "2024-03-21T14:40:19.384Z"
      }
    ]
  },
  {
    "id": "416087537273014071",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "20130456",
    "date": "2024-03-21",
    "state": "new",
    "origin": null,
    "created_at": "2024-03-21T14:40:19.394Z",
    "updated_at": "2024-03-21T14:40:19.394Z",
    "version": 1711032019,
    "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:40:19.397Z",
        "updated_at": "2024-03-21T14:40:19.397Z"
      }
    ]
  }
]

Get typeless documents

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

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 typeless_documents

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087533005309601",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "20130456",
    "date": "2024-03-21",
    "state": "new",
    "origin": null,
    "created_at": "2024-03-21T14:40:15.324Z",
    "updated_at": "2024-03-21T14:40:15.324Z",
    "version": 1711032015,
    "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:40:15.327Z",
        "updated_at": "2024-03-21T14:40:15.327Z"
      }
    ]
  },
  {
    "id": "416087532990629535",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "20130456",
    "date": "2024-03-21",
    "state": "new",
    "origin": null,
    "created_at": "2024-03-21T14:40:15.310Z",
    "updated_at": "2024-03-21T14:40:15.310Z",
    "version": 1711032015,
    "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:40:15.313Z",
        "updated_at": "2024-03-21T14:40:15.313Z"
      }
    ]
  },
  {
    "id": "416087532974900893",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "20130456",
    "date": "2024-03-21",
    "state": "new",
    "origin": null,
    "created_at": "2024-03-21T14:40:15.294Z",
    "updated_at": "2024-03-21T14:40:15.294Z",
    "version": 1711032015,
    "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:40:15.298Z",
        "updated_at": "2024-03-21T14:40:15.298Z"
      }
    ]
  }
]

Example: returns paginated typeless documents on page 1

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087533233899185",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "20130456",
    "date": "2024-03-21",
    "state": "new",
    "origin": null,
    "created_at": "2024-03-21T14:40:15.542Z",
    "updated_at": "2024-03-21T14:40:15.542Z",
    "version": 1711032015,
    "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:40:15.545Z",
        "updated_at": "2024-03-21T14:40:15.545Z"
      }
    ]
  }
]

Example: returns paginated typeless documents on page 2

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "416087533433128639",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "reference": "20130456",
    "date": "2024-03-21",
    "state": "new",
    "origin": null,
    "created_at": "2024-03-21T14:40:15.732Z",
    "updated_at": "2024-03-21T14:40:15.732Z",
    "version": 1711032015,
    "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:40:15.735Z",
        "updated_at": "2024-03-21T14:40:15.735Z"
      }
    ]
  }
]

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

Request

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

Response

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

Get typeless documents

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

Example: returns the wanted typeless_document

Request

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "416087533807470299",
  "administration_id": 123,
  "contact_id": null,
  "contact": null,
  "reference": "20130456",
  "date": "2024-03-21",
  "state": "new",
  "origin": null,
  "created_at": "2024-03-21T14:40:16.089Z",
  "updated_at": "2024-03-21T14:40:16.089Z",
  "version": 1711032016,
  "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:40:16.092Z",
      "updated_at": "2024-03-21T14:40:16.092Z"
    }
  ]
}

Example: only returns typeless_documents

Request

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

Response

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

Create a new typeless documents

POST /documents/typeless_documents(.:format)

Parameters

Parameter Type Description
typeless_document[reference] String

Required
typeless_document[date] String

Required
typeless_document[contact_id] Integer

Should be a valid contact id.

Example: creates the typeless_document

Request

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

Response

        
          
          Status: 201 Created
        
      
{
  "id": "416087534174471921",
  "administration_id": 123,
  "contact_id": "416087534057031401",
  "contact": {
    "id": "416087534057031401",
    "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:40:16.327Z",
    "updated_at": "2024-03-21T14:40:16.327Z",
    "version": 1711032016,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5487af4d52337cae854505ceea8721f76c8bb1ee6d3de47c158f6bad715ed2c8/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "reference": "foobar",
  "date": "2024-03-21",
  "state": "new",
  "origin": "api",
  "created_at": "2024-03-21T14:40:16.439Z",
  "updated_at": "2024-03-21T14:40:16.439Z",
  "version": 1711032016,
  "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:40:16.442Z",
      "updated_at": "2024-03-21T14:40:16.442Z"
    }
  ]
}

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/typeless_documents.json

Response

        
          
          Status: 400 Bad Request
        
      
{
  "error": "Typeless Document is required",
  "symbolic": {
    "typeless_document": "required"
  }
}

Example: passes the user agent to the create mutation

Request

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

Response

        
          
          Status: 201 Created
        
      
null

Delete a typeless documents

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

Parameters

Parameter Type Description
refresh_journal_entries Boolean

Example: deletes the typeless_document

Request

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

Response

        
          
          Status: 200 OK
        
      
200

Add attachment to typeless document

POST /documents/typeless_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/typeless_documents/416087534784743194/attachments.json

Response

        
          
          Status: 200 OK
        
      
200

Download attachment

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

Delete an attachment

DELETE /documents/typeless_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/typeless_documents/416087537432397633/attachments/416087537570809667.json

Response

        
          
          Status: 204 No Content