Moneybird logo
Moneybird API

Documents: Receipts

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

Receipts are proofs of payment for expenses.

List ids and versions of receipts

GET
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/synchronization{format}

Returns all documents in the administration. The list contains the document id and the version of the document. Check if the version of the document is newer than the version you have stored locally, use the POST variant for fetching documents with the given ids.

List ids and versions of receipts › 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 ids and versions of receipts › query Parameters

  • filterstring

    String terms, example: key1:value1,key2:value2.

List ids and versions of receipts › Responses

IDs and versions of records

  • idinteger | string
  • versioninteger | string

Fetch receipts with given ids

POST
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/synchronization{format}

Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided.

Fetch receipts with given ids › 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

Fetch receipts with given ids › Request Body

  • ids(integer | string)[] · required

Fetch receipts with given ids › Responses

A list of receipts

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • currencystring | null
  • exchange_rate
  • revenue_invoiceboolean | null
  • prices_are_incl_taxboolean | null
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • paid_atstring | null · date
  • tax_numberstring | null
  • total_price_excl_taxstring | null
  • total_price_excl_tax_basestring | null
  • total_price_incl_taxstring | null
  • total_price_incl_tax_basestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Download attachment

GET
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{id}/attachments/{attachment_id}/download{format}

Download the attachment. The response will be a redirect to a temporarily available URL where the attachment can be downloaded. Use the Location header in the response to download the attachment.

Download attachment › 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

  • attachment_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

Download attachment › Responses

Found

string

Delete an attachment

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{id}/attachments/{attachment_id}{format}

Deletes an attachment of an attachable.

Delete an attachment › 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

  • attachment_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 an attachment › Responses

Attachment deleted

No data returned

Add attachment to receipt

POST
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{id}/attachments{format}

Add an attachment to a receipt.

Add attachment to receipt › 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

Add attachment to receipt › Request Body

  • filestring · binary

Add attachment to receipt › Responses

Status code

integer

Delete a payment

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{id}/payments/{payment_id}{format}

Deletes a payment from a receipt.

Delete 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

  • payment_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 payment › Responses

Payment deleted

No data returned

Create a payment

POST
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{id}/payments{format}

Registers a payment for a receipt.

Create 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

Create a payment › Request Body

  • paymentobject

Create a payment › Responses

Payment created

  • 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
deprecated

Register a payment for a receipt

PATCH
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{id}/register_payment{format}

This endpoint is deprecated and should no longer be used. It has been replaced by Create a payment.

Register a payment for a receipt › 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

Register a payment for a receipt › Request Body

  • paymentobject

Register a payment for a receipt › Responses

Status code

integer

Get a receipt

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

Returns a receipt by id.

Get a receipt › 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 receipt › Responses

A receipt

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • currencystring | null
  • exchange_rate
  • revenue_invoiceboolean | null
  • prices_are_incl_taxboolean | null
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • paid_atstring | null · date
  • tax_numberstring | null
  • total_price_excl_taxstring | null
  • total_price_excl_tax_basestring | null
  • total_price_incl_taxstring | null
  • total_price_incl_tax_basestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Delete a receipts

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

Deletes a receipt.

Delete a receipts › 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 receipts › Responses

Status code

integer

Update a receipt

PATCH
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{id}{format}

Updates a receipt.

Update a receipt › 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

Update a receipt › Request Body

  • receiptobject
  • paymentobject

Update a receipt › Responses

Receipt updated

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • currencystring | null
  • exchange_rate
  • revenue_invoiceboolean | null
  • prices_are_incl_taxboolean | null
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • paid_atstring | null · date
  • tax_numberstring | null
  • total_price_excl_taxstring | null
  • total_price_excl_tax_basestring | null
  • total_price_incl_taxstring | null
  • total_price_incl_tax_basestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Destroys note from entity

DELETE
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{receipt_id}/notes/{id}{format}

Deletes a note from the receipt.

Destroys note from entity › path Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

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

    A unique record identifier

  • 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

Destroys note from entity › Responses

Note deleted

No data returned

Adds note to entity

POST
https://moneybird.com/api/v2
/{administration_id}/documents/receipts/{receipt_id}/notes{format}

Adds a note to the receipt.

Adds note to entity › path Parameters

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

    The unique identifier of the administration

    A unique record identifier of an administration

  • receipt_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

Adds note to entity › Request Body

  • noteobject

Adds note to entity › Responses

Note created

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

  • entity_typestring
  • user_idstring | integer · pattern: ^\d+$

    A unique record identifier

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

    A unique record identifier

  • todoboolean | string | null
    Default: false
  • notestring | null
  • completed_atstring | null · date-time
  • completed_by_idstring | integer | null · pattern: ^\d+$

    A unique record identifier

  • todo_typestring | null · enum
    Enum values:
    sales_invoice_due
    purchase_invoice_due
    general_document_reminder
    general_document_due
    new_document_awaiting_processing
    new_financial_mutation_awaiting_processing
    financial_mutations_not_updated
    sales_invoice_payment_not_linked_to_financial_mutation
  • dataobject | null
  • created_atstring · date-time
  • updated_atstring · date-time

List receipts

GET
https://moneybird.com/api/v2
/{administration_id}/documents/receipts{format}

Returns a paginated list of documents of this type in the administration.

The filter argument allows you to filter on the list of documents. Filters are a combination of keys and values, separated by a comma: key:value,key2:value2. The most common filter method will be period: period:this_month. Filtering works the same as in the web application, for more advanced examples, change the filtering in the web application and learn from the resulting URI.

List receipts › 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 receipts › query Parameters

  • filterstring

    String terms, example: key1:value1,key2:value2.

  • new_filterstring

    String terms, example: key1:value1,key2:value2.

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

List receipts › Responses

A list of receipts

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • currencystring | null
  • exchange_rate
  • revenue_invoiceboolean | null
  • prices_are_incl_taxboolean | null
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • paid_atstring | null · date
  • tax_numberstring | null
  • total_price_excl_taxstring | null
  • total_price_excl_tax_basestring | null
  • total_price_incl_taxstring | null
  • total_price_incl_tax_basestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]

Create a new receipt

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

Creates a new receipt.

Create a new receipt › 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

Create a new receipt › Request Body

  • receiptobject
  • paymentobject

Create a new receipt › Responses

Receipt created

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

    A unique record identifier

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

    A unique record identifier of an administration

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

    A unique record identifier

  • contact
  • referencestring | null
  • datestring · date
  • due_datestring | null · date
  • entry_numberinteger | null
  • statestring · enum
    Enum values:
    new
    open
    late
    paid
    saved
    pending_payment
  • currencystring | null
  • exchange_rate
  • revenue_invoiceboolean | null
  • prices_are_incl_taxboolean | null
  • originstring | null · enum
    Enum values:
    upload
    endpoint
    si
    email
    si_local
    si_peppol
    api
    moneybird_bv
  • paid_atstring | null · date
  • tax_numberstring | null
  • total_price_excl_taxstring | null
  • total_price_excl_tax_basestring | null
  • total_price_incl_taxstring | null
  • total_price_incl_tax_basestring | null
  • created_atstring · date-time
  • updated_atstring · date-time
  • versioninteger
  • detailsobject[]
  • paymentsobject[]
  • notesobject[]
  • attachmentsobject[]
  • eventsobject[]
Documents: Purchase invoicesDocuments: Typeless documents