Financial mutations

List all financial mutations

Returns a list of financial mutations in the administration. Limited to 100 financial mutations. If you need more financial mutations, use the synchronize API.

The filter argument allows you to filter on the list of financial mutations. 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

Example: returns all financial mutations of an administration

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "204882894533952971",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2017-11-02",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": null,
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "204882894396589511",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2017-11-02T08:32:56.107Z",
    "updated_at": "2017-11-02T08:32:56.107Z",
    "version": 1509611576,
    "financial_statement_id": "204882894529758666",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [

    ],
    "ledger_account_bookings": [

    ]
  }
]
      

Example: returns all mutations filtered on period

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "204882894953383377",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2017-11-02",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": null,
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "204882894799242701",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2017-11-02T08:32:56.507Z",
    "updated_at": "2017-11-02T08:32:56.507Z",
    "version": 1509611576,
    "financial_statement_id": "204882894948140496",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [

    ],
    "ledger_account_bookings": [

    ]
  }
]
      

Example: raises an error when there are too many mutations to return

Request

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

Response

        
          
          Status: 400 Bad Request
        
      
      {
  "error": "Too many financial mutations to return, please use sync API"
}
      

List all ids and versions

Returns all financial mutations in the administration. The list contains the id and the version of the financial mutation. Check if the version of the financial mutation is newer than the version you have stored locally, use the POST variant for fetching financial mutations with the given ids.

Parameters

Parameter Type Description
filter String

Example: retrieves the id's for synchronization

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "204882895968404963",
    "version": 1509611577
  },
  {
    "id": "204882895850964448",
    "version": 1509611577
  },
  {
    "id": "204882895708358109",
    "version": 1509611577
  }
]
      

Example: retrieves the id's for synchronization with a filter

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "204882896611182063",
    "version": 1509611578
  },
  {
    "id": "204882896519955948",
    "version": 1509611578
  },
  {
    "id": "204882896453895657",
    "version": 1509611577
  }
]
      

Fetch financial mutations with given ids

Given a list of financial mutation ids, returns the financial mutation information belonging to the financial mutation. Returns a maximum of 100 financial mutations, even if more ids are provided.

Parameters

Parameter Type Description
ids Array[integer]

Required

Example: it retrieves financial mutations given by ids

Request

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

Response

        
          
          Status: 200 OK
        
      
      [
  {
    "id": "204882896985523707",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2017-11-02",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": null,
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "204882896753788401",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2017-11-02T08:32:58.446Z",
    "updated_at": "2017-11-02T08:32:58.446Z",
    "version": 1509611578,
    "financial_statement_id": "204882896983426554",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [

    ],
    "ledger_account_bookings": [

    ]
  },
  {
    "id": "204882896910026232",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2017-11-02",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": null,
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "204882896753788401",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2017-11-02T08:32:58.374Z",
    "updated_at": "2017-11-02T08:32:58.374Z",
    "version": 1509611578,
    "financial_statement_id": "204882896906880503",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [

    ],
    "ledger_account_bookings": [

    ]
  }
]