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
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": "440890473887826945",
    "administration_id": 123,
    "financial_account_id": "440890473871050751",
    "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": "2024-12-20",
    "description": "FOOBAR-1",
    "end_to_end_id": "FOOBAR-1",
    "contact": {
      "id": "440890473817573370",
      "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": "558e2e8cb92c4c785e6ddfc14aeafee6df1f0ad2a0a47ba740983bb71e2c0504",
      "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": "2024-12-20T09:12:22.948Z",
      "updated_at": "2024-12-20T09:12:22.948Z",
      "version": 1734685942,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3e1d5b0ec4fa3b6e48b1db0dc3daa59b3c2ee3c0ecb3393300442f76ea6ad372/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "amount": "121.0",
    "created_at": "2024-12-20T09:12:23.015Z",
    "updated_at": "2024-12-20T09:12:23.015Z",
    "payable_type": "Document",
    "payable_id": "440890473855322109",
    "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": "440890474075522058",
    "administration_id": 123,
    "financial_account_id": "440890474066084872",
    "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": "2024-12-20",
    "description": "FOOBAR-1",
    "end_to_end_id": "FOOBAR-1",
    "contact": {
      "id": "440890474028336131",
      "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": "53dc595468625f3789edb638476f95d07fa945f3fa936503ad970bd11687174f",
      "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": "2024-12-20T09:12:23.147Z",
      "updated_at": "2024-12-20T09:12:23.147Z",
      "version": 1734685943,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3fa772631f409de762690b3bca0b6da85f37f0ee51d90a2bff3a9b184b418ddb/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "amount": "121.0",
    "created_at": "2024-12-20T09:12:23.194Z",
    "updated_at": "2024-12-20T09:12:23.194Z",
    "payable_type": "Document",
    "payable_id": "440890474052453382",
    "payment_method": null
  }
]
      

Get a purchase transaction by id

Delete a purchase transaction