Financial mutations

cURL Ruby

`/financial_mutations`	`GET`	List all financial mutations
`/financial_mutations/synchronization`	`GET`	List all ids and versions
`/financial_mutations/synchronization`	`POST`	Fetch financial mutations with given ids
`/financial_mutations/:id`	`GET`	Get a financial mutation by id
`/financial_mutations/:id/link_booking`	`PATCH`	Links a financial mutation to a booking
`/financial_mutations/:id/unlink_booking`	`DELETE`	Unlinks a booking from a financial mutation

List all financial mutations

GET /financial_mutations(.:format)

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": "416087577242634239",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2024-03-21",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": "",
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "416087577209079803",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2024-03-21T14:40:57.513Z",
    "updated_at": "2024-03-21T14:40:57.513Z",
    "version": 1711032057,
    "financial_statement_id": "416087577240537086",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [
      {
        "id": "416087577456542742",
        "administration_id": 123,
        "invoice_type": "SalesInvoice",
        "invoice_id": "416087577425085458",
        "financial_account_id": "416087577209079803",
        "user_id": 2,
        "payment_transaction_id": null,
        "transaction_identifier": null,
        "price": "80.0",
        "price_base": "80.0",
        "payment_date": "2024-03-21",
        "credit_invoice_id": null,
        "financial_mutation_id": "416087577242634239",
        "ledger_account_id": "416087577452348437",
        "linked_payment_id": null,
        "manual_payment_action": null,
        "created_at": "2024-03-21T14:40:57.715Z",
        "updated_at": "2024-03-21T14:40:57.715Z"
      }
    ],
    "ledger_account_bookings": [
      {
        "id": "416087577287721986",
        "administration_id": 123,
        "financial_mutation_id": "416087577242634239",
        "ledger_account_id": "416087577283527681",
        "project_id": null,
        "description": "Ledger account booking",
        "price": "20.0",
        "created_at": "2024-03-21T14:40:57.554Z",
        "updated_at": "2024-03-21T14:40:57.554Z"
      }
    ]
  }
]

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": "416087577598100507",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2024-03-21",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": "",
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "416087577568740375",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2024-03-21T14:40:57.851Z",
    "updated_at": "2024-03-21T14:40:57.851Z",
    "version": 1711032057,
    "financial_statement_id": "416087577596003354",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [
      {
        "id": "416087577804670002",
        "administration_id": 123,
        "invoice_type": "SalesInvoice",
        "invoice_id": "416087577774261294",
        "financial_account_id": "416087577568740375",
        "user_id": 2,
        "payment_transaction_id": null,
        "transaction_identifier": null,
        "price": "80.0",
        "price_base": "80.0",
        "payment_date": "2024-03-21",
        "credit_invoice_id": null,
        "financial_mutation_id": "416087577598100507",
        "ledger_account_id": "416087577801524273",
        "linked_payment_id": null,
        "manual_payment_action": null,
        "created_at": "2024-03-21T14:40:58.048Z",
        "updated_at": "2024-03-21T14:40:58.048Z"
      }
    ],
    "ledger_account_bookings": [
      {
        "id": "416087577635849246",
        "administration_id": 123,
        "financial_mutation_id": "416087577598100507",
        "ledger_account_id": "416087577632703517",
        "project_id": null,
        "description": "Ledger account booking",
        "price": "20.0",
        "created_at": "2024-03-21T14:40:57.887Z",
        "updated_at": "2024-03-21T14:40:57.887Z"
      }
    ]
  }
]

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

GET /financial_mutations/synchronization(.:format)

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. The filter argument allows you to filter the list of financial mutations. Filters are a combination of keys and values, separated by a comma: period:this_year,state:all. The available options for filtering are:

Filter	Type	Default	Description
period	`String`	`this_year`	This can either be the description of a period (`this_month`, `prev_month`, `next_month`, `this_quarter`, `prev_quarter`, `next_quarter`, `this_year`, `prev_year`, `next_year`) or a custom period (`201301..201302`, `20130101..20130131`)
state	`String`		Can be `all`, `unprocessed` or `processed`
mutation_type	`String`		Can be `all`, `debit` or `credit`
financial_account_id	`String`

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": "416087578900432014",
    "version": 1711032059
  },
  {
    "id": "416087578919306385",
    "version": 1711032059
  },
  {
    "id": "416087578880509067",
    "version": 1711032059
  }
]

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": "416087579039892631",
    "version": 1711032059
  },
  {
    "id": "416087579076592797",
    "version": 1711032059
  },
  {
    "id": "416087579057718426",
    "version": 1711032059
  }
]

Example: retrieves only unique ids

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": "416087579215004838",
    "version": 1711032059
  },
  {
    "id": "416087579232830633",
    "version": 1711032059
  },
  {
    "id": "416087579197179043",
    "version": 1711032059
  }
]

Fetch financial mutations with given ids

POST /financial_mutations/synchronization(.:format)

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":[416087579440448696,416087579459323067]}' \
  https://moneybird.com/api/v2/123/financial_mutations/synchronization.json
    
    

Response

        
          
          Status: 200 OK

[
  {
    "id": "416087579459323067",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2024-03-21",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": "",
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "416087579386971313",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2024-03-21T14:40:59.626Z",
    "updated_at": "2024-03-21T14:40:59.626Z",
    "version": 1711032059,
    "financial_statement_id": "416087579457225914",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [

    ],
    "ledger_account_bookings": [

    ]
  },
  {
    "id": "416087579440448696",
    "administration_id": 123,
    "amount": "100.0",
    "code": null,
    "date": "2024-03-21",
    "message": "Factuur",
    "contra_account_name": null,
    "contra_account_number": "",
    "state": "unprocessed",
    "amount_open": "100.0",
    "sepa_fields": null,
    "batch_reference": null,
    "financial_account_id": "416087579386971313",
    "currency": "EUR",
    "original_amount": null,
    "created_at": "2024-03-21T14:40:59.609Z",
    "updated_at": "2024-03-21T14:40:59.609Z",
    "version": 1711032059,
    "financial_statement_id": "416087579439400119",
    "processed_at": null,
    "account_servicer_transaction_id": null,
    "payments": [

    ],
    "ledger_account_bookings": [

    ]
  }
]

Get a financial mutation by id

GET /financial_mutations/:id(.:format)

Returns a single financial mutation in the administration.

Example: returns financial mutation by the given id

Request

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

Response

        
          
          Status: 200 OK

{
  "id": "416087578233537619",
  "administration_id": 123,
  "amount": "100.0",
  "code": null,
  "date": "2024-03-21",
  "message": "Factuur",
  "contra_account_name": null,
  "contra_account_number": "",
  "state": "unprocessed",
  "amount_open": "100.0",
  "sepa_fields": null,
  "batch_reference": null,
  "financial_account_id": "416087578204177487",
  "currency": "EUR",
  "original_amount": null,
  "created_at": "2024-03-21T14:40:58.457Z",
  "updated_at": "2024-03-21T14:40:58.457Z",
  "version": 1711032058,
  "financial_statement_id": "416087578231440466",
  "processed_at": null,
  "account_servicer_transaction_id": null,
  "payments": [
    {
      "id": "416087578418087018",
      "administration_id": 123,
      "invoice_type": "SalesInvoice",
      "invoice_id": "416087578378241126",
      "financial_account_id": "416087578204177487",
      "user_id": 2,
      "payment_transaction_id": null,
      "transaction_identifier": null,
      "price": "80.0",
      "price_base": "80.0",
      "payment_date": "2024-03-21",
      "credit_invoice_id": null,
      "financial_mutation_id": "416087578233537619",
      "ledger_account_id": "416087578413892713",
      "linked_payment_id": null,
      "manual_payment_action": null,
      "created_at": "2024-03-21T14:40:58.632Z",
      "updated_at": "2024-03-21T14:40:58.632Z"
    }
  ],
  "ledger_account_bookings": [
    {
      "id": "416087578254509142",
      "administration_id": 123,
      "financial_mutation_id": "416087578233537619",
      "ledger_account_id": "416087578250314837",
      "project_id": null,
      "description": "Ledger account booking",
      "price": "20.0",
      "created_at": "2024-03-21T14:40:58.476Z",
      "updated_at": "2024-03-21T14:40:58.476Z"
    }
  ]
}

Example: returns 404 when the financial mutation does not exist

Request

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

Response

        
          
          Status: 404 Not Found

{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}

Links a financial mutation to a booking

PATCH /financial_mutations/:id/link_booking(.:format)

Linking a booking to a financial mutations allows you to process financial mutations. Financial mutations can be linked to invoices, documents, ledger accounts and payment batches.

Parameters

Parameter	Type	Description
`booking_type`	`String`	Required Can be `SalesInvoice`, `Document`, `LedgerAccount`, `PaymentTransactionBatch`, `PurchaseTransaction`, `NewPurchaseInvoice`, `NewReceipt`, `PaymentTransaction`, `PurchaseTransactionBatch`, `ExternalSalesInvoice`, `Payment` or `VatDocument`.
`booking_id`	`Integer`
`price_base`	`Decimal`	Both a decimal and a string ‘10,95’ are accepted.
`price`	`Decimal`	Both a decimal and a string ‘10,95’ are accepted.
`description`	`String`
`payment_batch_identifier`	`String`
`project_id`	`Integer`	Should be a valid project id.
`mark_open_sepa_transaction_as_paid`	`Boolean`

Example: links a sales invoice to the financial mutation

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"booking_type":"SalesInvoice","booking_id":416087579680572616,"price_base":"363.0"}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087579575715009/link_booking.json
    
    

Response

        
          
          Status: 200 OK

Example: links a purchase invoice to the financial mutation

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"booking_type":"Document","booking_id":416087580185986269,"price_base":-100}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087580087420118/link_booking.json
    
    

Response

        
          
          Status: 200 OK

Example: creates a new purchase invoice

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"booking_type":"NewPurchaseInvoice","price_base":-100}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087580374729958/link_booking.json
    
    

Response

        
          
          Status: 200 OK

Example: creates a new receipt

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"booking_type":"NewReceipt","price_base":-100}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087580548793585/link_booking.json
    
    

Response

        
          
          Status: 200 OK

Example: creates a ledger account booking for a positive amount

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"booking_type":"LedgerAccount","booking_id":416087580730197246,"price_base":100}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087580714468604/link_booking.json
    
    

Response

        
          
          Status: 200 OK

Example: creates a ledger account booking for a negative amount

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"booking_type":"LedgerAccount","booking_id":416087580912649483,"price_base":100}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087580896920841/link_booking.json
    
    

Response

        
          
          Status: 200 OK

Example: creates a booking for a foreign invoice with an exchange rate difference

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"booking_type":"LedgerAccount","booking_id":416087581404431655,"price_base":1.48}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087581063644438/link_booking
    
    

Response

        
          
          Status: 200 OK

Unlinks a booking from a financial mutation

DELETE /financial_mutations/:id/unlink_booking(.:format)

Parameters

Parameter Type Description

Parameter	Type	Description
`booking_type`	`Camelcasestring`	Required Can be `Payment` or `LedgerAccountBooking`.
`booking_id`	`Integer`	Required

booking_type

Camelcasestring

Required

Can be Payment or LedgerAccountBooking.

booking_id

Integer

Required

Example: unlinks a payment booking

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{"booking_type":"Payment","booking_id":416087581861610813}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087581594223919/unlink_booking.json
    
    

Response

        
          
          Status: 200 OK

{
  "id": "416087581594223919",
  "administration_id": 123,
  "amount": "100.0",
  "code": null,
  "date": "2024-03-21",
  "message": "Factuur",
  "contra_account_name": null,
  "contra_account_number": "",
  "state": "unprocessed",
  "amount_open": "100.0",
  "sepa_fields": null,
  "batch_reference": null,
  "financial_account_id": "416087581547037995",
  "currency": "EUR",
  "original_amount": null,
  "created_at": "2024-03-21T14:41:01.662Z",
  "updated_at": "2024-03-21T14:41:02.047Z",
  "version": 1711032062,
  "financial_statement_id": "416087581593175342",
  "processed_at": null,
  "account_servicer_transaction_id": null,
  "payments": [

  ],
  "ledger_account_bookings": [

  ]
}

Example: returns an error if booking type is invalid

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{"booking_type":"foobar","booking_id":416087582374364498}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087582088103236/unlink_booking.json
    
    

Response

        
          
          Status: 400 Bad Request

{
  "error": "Booking Type isn't an option",
  "symbolic": {
    "booking_type": "in"
  }
}

Example: returns an error if booking id is not found

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{"booking_type":"Payment","booking_id":123}' \
  https://moneybird.com/api/v2/123/financial_mutations/416087582523262296/unlink_booking.json
    
    

Response

        
          
          Status: 404 Not Found

{
  "error": "record not found",
  "symbolic": {
    "booking_id": "not_found"
  }
}