Purchase transactions are outgoing payments you initiate from Moneybird
Delete a purchase transaction
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.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Purchase transaction deleted
Get a purchase transaction by id
Get a purchase transaction by id.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
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 · enumEnum values:opencancelledpaidpending_paymenterrorawaiting_authorizationpreparingsepa_ibanstringsepa_iban_account_namestringsepa_bicstringsource_sepa_ibanstring | nullsource_sepa_iban_account_namestring | nulldatestring | null · datedescriptionstringend_to_end_idstringcontactobjectamountstringcreated_atstring · date-timeupdated_atstring · date-timepayable_typestring | nullpayable_idstring | integer | null · pattern:^\d+$A unique record identifier
payment_methodstring | null
Delete a purchase transaction
Delete a purchase transaction. Requires that the purchase transaction is pending and doesn't belong to a purchase transaction batch.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Purchase transaction deleted
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.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstringpageinteger | stringper_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$
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 · enumEnum values:opencancelledpaidpending_paymenterrorawaiting_authorizationpreparingsepa_ibanstringsepa_iban_account_namestringsepa_bicstringsource_sepa_ibanstring | nullsource_sepa_iban_account_namestring | nulldatestring | null · datedescriptionstringend_to_end_idstringcontactobjectamountstringcreated_atstring · date-timeupdated_atstring · date-timepayable_typestring | nullpayable_idstring | integer | null · pattern:^\d+$A unique record identifier
payment_methodstring | null
[Beta] Upload a SEPA credit transfer file to create purchase transaction batches
[Beta] Upload a SEPA credit transfer file (pain.001.001.09/Version 2019) to create purchase transaction batches.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Request Body
filestring · binary · requiredSEPA 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.
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 · enumEnum values:exportedcancelledopenidentifierstringcreated_atstring · date-timeupdated_atstring · date-time