Moneybird logo
Moneybird API

Purchase transactions

Endpoint:https://moneybird.com/api/v2

Purchase transactions are outgoing payments you initiate from Moneybird

deprecated

Delete a purchase transaction

DELETE
https://moneybird.com/api/v2
/{administration_id}/purchase_transactions/{id}/delete{format}

This endpoint is deprecated. Use the DELETE /purchase_transactions/{id} endpoint instead. Delete a purchase transaction. Requires that the purchase transaction is pending and doesn't belong to a purchase transaction batch.

Delete a purchase transaction › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Delete a purchase transaction › Responses

Purchase transaction deleted

No data returned

Get a purchase transaction by id

GET
https://moneybird.com/api/v2
/{administration_id}/purchase_transactions/{id}{format}

Get a purchase transaction by id.

Get a purchase transaction by id › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Get a purchase transaction by id › Responses

A purchase transaction

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • financial_account_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • payment_instrument_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • statestring · enum
    Enum values:
    open
    cancelled
    paid
    pending_payment
    error
    awaiting_authorization
    preparing
  • sepa_ibanstring
  • sepa_iban_account_namestring
  • sepa_bicstring
  • source_sepa_ibanstring | null
  • source_sepa_iban_account_namestring | null
  • datestring | null · date
  • descriptionstring
  • end_to_end_idstring
  • contactobject
  • amountstring
  • created_atstring · date-time
  • updated_atstring · date-time
  • payable_typestring | null
  • payable_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • payment_methodstring | null

Delete a purchase transaction

DELETE
https://moneybird.com/api/v2
/{administration_id}/purchase_transactions/{id}{format}

Delete a purchase transaction. Requires that the purchase transaction is pending and doesn't belong to a purchase transaction batch.

Delete a purchase transaction › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

Delete a purchase transaction › Responses

Purchase transaction deleted

No data returned

List all purchase transactions

GET
https://moneybird.com/api/v2
/{administration_id}/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:

FilterTypeDefaultDescription
stateStringallall, open, pending_payment, paid or cancelled
periodStringnilThis 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)
unbatchedBooleantruetrue 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.

List all purchase transactions › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

List all purchase transactions › query Parameters

  • filterstring
  • per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

List all purchase transactions › Responses

A list of purchase transactions

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • financial_account_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • payment_instrument_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • statestring · enum
    Enum values:
    open
    cancelled
    paid
    pending_payment
    error
    awaiting_authorization
    preparing
  • sepa_ibanstring
  • sepa_iban_account_namestring
  • sepa_bicstring
  • source_sepa_ibanstring | null
  • source_sepa_iban_account_namestring | null
  • datestring | null · date
  • descriptionstring
  • end_to_end_idstring
  • contactobject
  • amountstring
  • created_atstring · date-time
  • updated_atstring · date-time
  • payable_typestring | null
  • payable_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • payment_methodstring | null

[Beta] Upload a SEPA credit transfer file to create purchase transaction batches

POST
https://moneybird.com/api/v2
/{administration_id}/sepa_credit_transfer{format}

[Beta] Upload a SEPA credit transfer file (pain.001.001.09/Version 2019) to create purchase transaction batches.

[Beta] Upload a SEPA credit transfer file to create purchase transaction batches › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · pattern: ^(.(json|xml))?$ · required

    The format in which the response is given, can be empty to use the default format

    Default: .json

[Beta] Upload a SEPA credit transfer file to create purchase transaction batches › Request Body

  • filestring · binary · required

    SEPA credit transfer file (pain.001.001.09/Version 2019)

  • ledger_account_idstring | integer · pattern: ^\d+$

    The ID of the ledger account that will be linked to all the purchase transactions in the file

  • financial_account_idstring | integer · pattern: ^\d+$

    The ID of the financial account that will be linked to all the purchase transactions in the file, if not provided, the financial account will be determined based on the debtor account in the file.

[Beta] Upload a SEPA credit transfer file to create purchase transaction batches › Responses

Purchase transaction batches created successfully using the SEPA credit transfer file

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • financial_account_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • statestring · enum
    Enum values:
    exported
    cancelled
    open
  • identifierstring
  • created_atstring · date-time
  • updated_atstring · date-time
ProjectsRecurring sales invoices