Purchase transactions
List all purchase transactions
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": "395773952105907464",
"administration_id": 123,
"financial_account_id": "395773952092275974",
"payment_instrument_id": null,
"state": "open",
"sepa_iban": "NL69TEST0000000001",
"sepa_iban_account_name": "Test Inc.",
"sepa_bic": "TESTNL22",
"source_sepa_iban": "NL28INGB0000000001",
"source_sepa_iban_account_name": "ING NL28INGB0000000001",
"date": "2023-08-10",
"description": "FOOBAR-1",
"end_to_end_id": "FOOBAR-1",
"amount": "121.0",
"created_at": "2023-08-10T09:24:34.946Z",
"updated_at": "2023-08-10T09:24:34.946Z",
"payable_type": "Document",
"payable_id": "395773952077595908",
"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": "395773952285213969",
"administration_id": 123,
"financial_account_id": "395773952266339599",
"payment_instrument_id": null,
"state": "open",
"sepa_iban": "NL69TEST0000000001",
"sepa_iban_account_name": "Test Inc.",
"sepa_bic": "TESTNL22",
"source_sepa_iban": "NL28INGB0000000001",
"source_sepa_iban_account_name": "ING NL28INGB0000000001",
"date": "2023-08-10",
"description": "FOOBAR-1",
"end_to_end_id": "FOOBAR-1",
"amount": "121.0",
"created_at": "2023-08-10T09:24:35.116Z",
"updated_at": "2023-08-10T09:24:35.116Z",
"payable_type": "Document",
"payable_id": "395773952252708109",
"payment_method": null
}
]