Moneybird logo
Moneybird API

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_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · 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

id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

invoice_type
​string · enum
Enum values:
SalesInvoice
Document
ExternalSalesInvoice
VatDocument
invoice_id
​identifier · pattern: ^\d+$

A unique record identifier

financial_account_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

user_id
​identifier · pattern: ^\d+$

A unique record identifier

payment_transaction_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

transaction_identifier
​string | null
​number
​number
payment_date
​string · date
credit_invoice_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

financial_mutation_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

ledger_account_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

linked_payment_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

manual_payment_action
​string | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time