Purchase transactions

cURL Ruby

List all purchase transactions

GET /purchase_transactions(.:format)

Returns a list of all purchase transactions in the administration.

The filter argument allows you to filter the list of invoices. Filters are a combination of keys and values, separated by a comma: period:this_year,state:open. The available options for filtering are:

Filter Type Default Description
state String all all, open, pending_payment, paid or cancelled
period String nil 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)
unbatched Boolean true true or false

You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:open|pending_payment.

Parameters

Parameter Type Description
filter String

Example: returns all purchase transactions of an administration

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "374313238055094234",
    "administration_id": 123,
    "financial_account_id": "374313238046705624",
    "state": "open",
    "sepa_iban": "NL69TEST0000000001",
    "sepa_iban_account_name": "Test Inc.",
    "sepa_bic": "TESTNL22",
    "date": "2022-12-16",
    "description": "FOOBAR-1",
    "end_to_end_id": "FOOBAR-1",
    "amount": "121.0",
    "created_at": "2022-12-16T12:15:43.145Z",
    "updated_at": "2022-12-16T12:15:43.145Z",
    "payable_type": "Document",
    "payable_id": "374313238039365590",
    "payment_method": null
  }
]

Example: returns all purchase transactions filtered on period

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "374313238167291875",
    "administration_id": 123,
    "financial_account_id": "374313238159951841",
    "state": "open",
    "sepa_iban": "NL42TEST0000000002",
    "sepa_iban_account_name": "Test Inc.",
    "sepa_bic": "TESTNL22",
    "date": "2022-12-16",
    "description": "FOOBAR-2",
    "end_to_end_id": "FOOBAR-2",
    "amount": "121.0",
    "created_at": "2022-12-16T12:15:43.251Z",
    "updated_at": "2022-12-16T12:15:43.251Z",
    "payable_type": "Document",
    "payable_id": "374313238151563231",
    "payment_method": null
  }
]