Moneybird API

Payments

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

Payments are records of money being transferred for invoices.

Returns information about a payment

GET

https://moneybird.com/api/v2

/{administration_id}/payments/{id}{format}

Returns information about a payment.

Returns information about a payment › 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

Returns information about a payment › Responses

A payment

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
invoice_typestring · enum
Enum values:
SalesInvoice
Document
ExternalSalesInvoice
VatDocument
invoice_idstring | integer · pattern: ^\d+$
A unique record identifier
financial_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
user_idstring | integer · pattern: ^\d+$
A unique record identifier
payment_transaction_idstring | integer | null · pattern: ^\d+$
A unique record identifier
transaction_identifierstring | null
price
price_base
payment_datestring · date
credit_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
financial_mutation_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
linked_payment_idstring | integer | null · pattern: ^\d+$
A unique record identifier
manual_payment_actionstring | null
created_atstring · date-time
updated_atstring · date-time

GET /{administration_id}/payments/{id}{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/payments/:id:format

shell

Show example in

Example Responses

{
  "id": "471150124114904299",
  "administration_id": 123,
  "invoice_type": "SalesInvoice",
  "invoice_id": "471150123957617883",
  "financial_account_id": "471150124105467111",
  "user_id": 1,
  "payment_transaction_id": null,
  "transaction_identifier": null,
  "price": "363.0",
  "price_base": "363.0",
  "payment_date": "2025-11-19",
  "credit_invoice_id": null,
  "financial_mutation_id": "471150124110709994",
  "ledger_account_id": "471150124098127078",
  "linked_payment_id": null,
  "manual_payment_action": null,
  "created_at": "2025-11-19T09:16:34.260Z",
  "updated_at": "2025-11-19T09:16:34.260Z"
}

json

application/json

Ledger accounts Products

Returns information about a payment

GET

https://moneybird.com/api/v2

/{administration_id}/payments/{id}{format}

Returns information about a payment.

Returns information about a payment › 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

Returns information about a payment › Responses

A payment

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
invoice_typestring · enum
Enum values:
SalesInvoice
Document
ExternalSalesInvoice
VatDocument
invoice_idstring | integer · pattern: ^\d+$
A unique record identifier
financial_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
user_idstring | integer · pattern: ^\d+$
A unique record identifier
payment_transaction_idstring | integer | null · pattern: ^\d+$
A unique record identifier
transaction_identifierstring | null
price
price_base
payment_datestring · date
credit_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
financial_mutation_idstring | integer | null · pattern: ^\d+$
A unique record identifier
ledger_account_idstring | integer | null · pattern: ^\d+$
A unique record identifier
linked_payment_idstring | integer | null · pattern: ^\d+$
A unique record identifier
manual_payment_actionstring | null
created_atstring · date-time
updated_atstring · date-time

{ "id": "471150124114904299", "administration_id": 123, "invoice_type": "SalesInvoice", "invoice_id": "471150123957617883", "financial_account_id": "471150124105467111", "user_id": 1, "payment_transaction_id": null, "transaction_identifier": null, "price": "363.0", "price_base": "363.0", "payment_date": "2025-11-19", "credit_invoice_id": null, "financial_mutation_id": "471150124110709994", "ledger_account_id": "471150124098127078", "linked_payment_id": null, "manual_payment_action": null, "created_at": "2025-11-19T09:16:34.260Z", "updated_at": "2025-11-19T09:16:34.260Z" }