Purchase transactions

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`
`per_page`	`Integer`

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": "453386411968562335",
    "administration_id": 123,
    "financial_account_id": "453386411962270877",
    "payment_instrument_id": null,
    "state": "open",
    "sepa_iban": "NL47TEST9876543210",
    "sepa_iban_account_name": "Test Inc.",
    "sepa_bic": "TESTNL22",
    "source_sepa_iban": "NL28INGB0000000001",
    "source_sepa_iban_account_name": "ING NL28INGB0000000001",
    "date": "2025-05-07",
    "description": "FOOBAR-1",
    "end_to_end_id": "FOOBAR-1",
    "contact": {
      "id": "453386411935007896",
      "administration_id": 123,
      "company_name": "Relation 1",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "abfeae71386aece64a77db417b941fb60ece6e4c86a5e044ce2285cfbcbecfa0",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-05-07T07:29:58.190Z",
      "updated_at": "2025-05-07T07:29:58.190Z",
      "version": 1746602998,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/006b562937c79525b27833f7c5fd647ad746f58656729dda74ce364fec7b1b39/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "amount": "121.0",
    "created_at": "2025-05-07T07:29:58.223Z",
    "updated_at": "2025-05-07T07:29:58.223Z",
    "payable_type": "Document",
    "payable_id": "453386411951785115",
    "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": "453386412080759976",
    "administration_id": 123,
    "financial_account_id": "453386412075517094",
    "payment_instrument_id": null,
    "state": "open",
    "sepa_iban": "NL47TEST9876543210",
    "sepa_iban_account_name": "Test Inc.",
    "sepa_bic": "TESTNL22",
    "source_sepa_iban": "NL28INGB0000000001",
    "source_sepa_iban_account_name": "ING NL28INGB0000000001",
    "date": "2025-05-07",
    "description": "FOOBAR-1",
    "end_to_end_id": "FOOBAR-1",
    "contact": {
      "id": "453386412050351265",
      "administration_id": 123,
      "company_name": "Relation 1",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "9d510035ef41ea554acb38a7b98b2d1239ce0957717311520442bfbdf2cb8a8c",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-05-07T07:29:58.300Z",
      "updated_at": "2025-05-07T07:29:58.300Z",
      "version": 1746602998,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/19ae3bc303e9414d365d61ba2b24b3d8f5b18a8273ceebd81f0c871be401c821/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "amount": "121.0",
    "created_at": "2025-05-07T07:29:58.330Z",
    "updated_at": "2025-05-07T07:29:58.330Z",
    "payable_type": "Document",
    "payable_id": "453386412067128484",
    "payment_method": null
  }
]

Get a purchase transaction by id

GET /purchase_transactions/:id(.:format)

Delete a purchase transaction (legacy)

DELETE /purchase_transactions/:id/delete(.:format)

Delete a purchase transaction

DELETE /purchase_transactions/:id(.:format)

Bulk delete purchase transactions

POST /purchase_transactions/cancellations(.:format)

Parameters

Parameter	Type	Description
`ids`	`[integer]`	Required