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": "451599590707169140",
    "administration_id": 123,
    "financial_account_id": "451599590698780530",
    "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-04-17",
    "description": "FOOBAR-1",
    "end_to_end_id": "FOOBAR-1",
    "contact": {
      "id": "451599590664177517",
      "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": "379337d1949de781113f4c8446981bb5939bd361e916bcebec1a9d4b671fbf2b",
      "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-04-17T14:09:12.637Z",
      "updated_at": "2025-04-17T14:09:12.637Z",
      "version": 1744898952,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/08f681fee3cbc7b94d6e88791363021901fab69934fe5db19c941609e89c94d8/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "amount": "121.0",
    "created_at": "2025-04-17T14:09:12.678Z",
    "updated_at": "2025-04-17T14:09:12.678Z",
    "payable_type": "Document",
    "payable_id": "451599590685149040",
    "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": "451599590853969789",
    "administration_id": 123,
    "financial_account_id": "451599590844532603",
    "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-04-17",
    "description": "FOOBAR-1",
    "end_to_end_id": "FOOBAR-1",
    "contact": {
      "id": "451599590815172470",
      "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": "4d14bdc2a4065fdf1156fd46297b579919c3f364653634a8fcd6854c93e82093",
      "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-04-17T14:09:12.781Z",
      "updated_at": "2025-04-17T14:09:12.781Z",
      "version": 1744898952,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/10b1cfe4a81115a0f965e8c977f1a640cd706030d0b14f8e3f0352a57b453f79/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "amount": "121.0",
    "created_at": "2025-04-17T14:09:12.818Z",
    "updated_at": "2025-04-17T14:09:12.818Z",
    "payable_type": "Document",
    "payable_id": "451599590834046841",
    "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