Moneybird logo
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 paymentpath 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