Moneybird API

Documents: Purchase invoices

Endpointhttps://moneybird.com/api/v2

Purchase invoices are invoices you receive from your suppliers.

List ids and versions of purchase invoices

GET

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/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 purchase invoices › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

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

List ids and versions of purchase invoices › query Parameters

filter

string

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

List ids and versions of purchase invoices › Responses

200

IDs and versions of records

object[]

id

integer | string

version

integer | string

GET/{administration_id}/documents/purchase_invoices/synchronization{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/synchronization:format

shell

Example Responses

[
  {
    "id": "471699927338058928",
    "version": 1764068127
  },
  {
    "id": "471699927407264962",
    "version": 1764068127
  },
  {
    "id": "471699927443965131",
    "version": 1764068127
  }
]

json

application/json

Fetch purchase invoices with given ids

POST

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/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 purchase invoices with given ids › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

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

Fetch purchase invoices with given ids › Request Body

ids

(integer | string)[] · required

Fetch purchase invoices with given ids › Responses

200

A list of purchase invoices

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer | null · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

currency

string

ISO 4217 currency code

exchange_rate

string | null

revenue_invoice

boolean | null

prices_are_incl_tax

boolean | null

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

paid_at

string | null · date

tax_number

string | null

total_price_excl_tax

string | null

total_price_excl_tax_base

string | null

total_price_incl_tax

string | null

total_price_incl_tax_base

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

POST/{administration_id}/documents/purchase_invoices/synchronization{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/synchronization:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    471699927197549700,
    471699927234249900
  ]
}
'

shell

Example Request Body

{
  "ids": [
    471699927197549700,
    471699927234249900
  ]
}

json

application/json

Example Responses

[
  {
    "id": "471699927197549721",
    "administration_id": 123,
    "contact_id": "471699927091643524",
    "contact": {
      "id": "471699927091643524",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:55:27.238Z",
      "updated_at": "2025-11-25T10:55:27.238Z",
      "version": 1764068127,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1f72ca189161dc9f38192e8560551cae532059b8d66f26eb4da5f30ca4c68a7e/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "reference": "2013-01234",
    "date": "2025-11-25",
    "due_date": "2025-12-09",
    "entry_number": 3,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": false,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "created_at": "2025-11-25T10:55:27.339Z",
    "updated_at": "2025-11-25T10:55:27.342Z",
    "version": 1764068127,
    "details": [
      {
        "id": "471699927198598298",
        "administration_id": 123,
        "tax_rate_id": "471699736836965514",
        "ledger_account_id": "471699736746787958",
        "project_id": null,
        "product_id": null,
        "amount": null,
        "amount_decimal": "1.0",
        "description": "Delivery Apple iPad",
        "price": "300.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:55:27.341Z",
        "updated_at": "2025-11-25T10:55:27.341Z"
      }
    ],
    "payments": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:55:27.344Z",
        "updated_at": "2025-11-25T10:55:27.344Z"
      }
    ]
  },
  {
    "id": "471699927234249890",
    "administration_id": 123,
    "contact_id": "471699927091643524",
    "contact": {
      "id": "471699927091643524",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:55:27.238Z",
      "updated_at": "2025-11-25T10:55:27.238Z",
      "version": 1764068127,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1f72ca189161dc9f38192e8560551cae532059b8d66f26eb4da5f30ca4c68a7e/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "reference": "2013-01234",
    "date": "2025-11-25",
    "due_date": "2025-12-09",
    "entry_number": 4,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": false,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "created_at": "2025-11-25T10:55:27.374Z",
    "updated_at": "2025-11-25T10:55:27.377Z",
    "version": 1764068127,
    "details": [
      {
        "id": "471699927235298467",
        "administration_id": 123,
        "tax_rate_id": "471699736836965514",
        "ledger_account_id": "471699736746787958",
        "project_id": null,
        "product_id": null,
        "amount": null,
        "amount_decimal": "1.0",
        "description": "Delivery Apple iPad",
        "price": "300.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:55:27.376Z",
        "updated_at": "2025-11-25T10:55:27.376Z"
      }
    ],
    "payments": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:55:27.379Z",
        "updated_at": "2025-11-25T10:55:27.379Z"
      }
    ]
  }
]

json

application/json

Download attachment

GET

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{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_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

attachment_id

string | integer · 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

Download attachment › Responses

Found

string

GET/{administration_id}/documents/purchase_invoices/{id}/attachments/{attachment_id}/download{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id/attachments/:attachment_id/download:format

shell

Example Responses

{"message":"Use the Location header to download the attachment"}

plain

text/plain

Delete an attachment

DELETE

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{id}/attachments/{attachment_id}{format}

Deletes an attachment of an attachable.

Delete an attachment › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

attachment_id

string | integer · 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

Delete an attachment › Responses

Attachment deleted

No data returned

DELETE/{administration_id}/documents/purchase_invoices/{id}/attachments/{attachment_id}{format}

curl --request DELETE \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id/attachments/:attachment_id:format

shell

Example Responses

No example specified for this content type

Add attachment to purchase invoice

POST

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{id}/attachments{format}

Add an attachment to a purchase invoice.

Add attachment to purchase invoice › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

Add attachment to purchase invoice › Request Body

file

string · binary

Add attachment to purchase invoice › Responses

Status code

integer

POST/{administration_id}/documents/purchase_invoices/{id}/attachments{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id/attachments:format \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "file"
}'

shell

Example Request Body

{
  "file": "file"
}

json

Example Responses

json

application/json

Delete a payment

DELETE

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{id}/payments/{payment_id}{format}

Deletes a payment from a purchase invoice.

Delete a payment › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

payment_id

string | integer · 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

Delete a payment › Responses

Payment deleted

No data returned

DELETE/{administration_id}/documents/purchase_invoices/{id}/payments/{payment_id}{format}

curl --request DELETE \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id/payments/:payment_id:format

shell

Example Responses

No example specified for this content type

Create a payment

POST

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{id}/payments{format}

Registers a payment for a purchase invoice.

Create a payment › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

Create a payment › Request Body

object

Create a payment › Responses

Payment created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

invoice_type

string · enum

Enum values:

SalesInvoice

Document

ExternalSalesInvoice

VatDocument

invoice_id

string | integer · pattern: ^\d+$

A unique record identifier

financial_account_id

string | integer | null · pattern: ^\d+$

A unique record identifier

user_id

string | integer · pattern: ^\d+$

A unique record identifier

payment_transaction_id

string | integer | null · pattern: ^\d+$

A unique record identifier

transaction_identifier

string | null

payment_date

string · date

credit_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

financial_mutation_id

string | integer | null · pattern: ^\d+$

A unique record identifier

ledger_account_id

string | integer | null · pattern: ^\d+$

A unique record identifier

linked_payment_id

string | integer | null · pattern: ^\d+$

A unique record identifier

manual_payment_action

string | null

created_at

string · date-time

updated_at

string · date-time

POST/{administration_id}/documents/purchase_invoices/{id}/payments{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id/payments:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment": {
    "payment_date": "2025-11-25T10:55:28.112Z",
    "price": "363.0"
  }
}
'

shell

Example Request Body

{
  "payment": {
    "payment_date": "2025-11-25T10:55:28.112Z",
    "price": "363.0"
  }
}

json

application/json

Example Responses

{
  "id": "471699928024876354",
  "administration_id": 123,
  "invoice_type": "Document",
  "invoice_id": "471699927923164464",
  "financial_account_id": null,
  "user_id": 17640679459010,
  "payment_transaction_id": null,
  "transaction_identifier": null,
  "price": "363.0",
  "price_base": "363.0",
  "payment_date": "2025-11-25",
  "credit_invoice_id": null,
  "financial_mutation_id": null,
  "ledger_account_id": "471699736780342399",
  "linked_payment_id": null,
  "manual_payment_action": null,
  "created_at": "2025-11-25T10:55:28.128Z",
  "updated_at": "2025-11-25T10:55:28.128Z"
}

json

application/json

deprecated

Register a payment for a purchase invoice

PATCH

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{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 purchase invoice › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

Register a payment for a purchase invoice › Request Body

object

Register a payment for a purchase invoice › Responses

Status code

integer

PATCH/{administration_id}/documents/purchase_invoices/{id}/register_payment{format}

curl --request PATCH \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id/register_payment:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "payment": {
    "payment_date": "2025-11-25T10:55:29.879Z",
    "price": "363.0"
  }
}
'

shell

Example Request Body

{
  "payment": {
    "payment_date": "2025-11-25T10:55:29.879Z",
    "price": "363.0"
  }
}

json

application/json

Example Responses

json

application/json

Get purchase invoice

GET

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{id}{format}

Returns a purchase invoice by id.

Get purchase invoice › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

Get purchase invoice › Responses

A purchase invoice

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer | null · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

currency

string

ISO 4217 currency code

exchange_rate

string | null

revenue_invoice

boolean | null

prices_are_incl_tax

boolean | null

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

paid_at

string | null · date

tax_number

string | null

total_price_excl_tax

string | null

total_price_excl_tax_base

string | null

total_price_incl_tax

string | null

total_price_incl_tax_base

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

GET/{administration_id}/documents/purchase_invoices/{id}{format}

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

shell

Example Responses

{
  "id": "471699928321623415",
  "administration_id": 123,
  "contact_id": "471699928287020404",
  "contact": {
    "id": "471699928287020404",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:28.378Z",
    "updated_at": "2025-11-25T10:55:28.378Z",
    "version": 1764068128,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d789de576cd33d915f7cabb343b27781479f02c0f45d55913246333d18f189d4/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "reference": "2013-01234",
  "date": "2025-11-25",
  "due_date": "2025-12-09",
  "entry_number": 1,
  "state": "open",
  "currency": "EUR",
  "exchange_rate": "1.0",
  "revenue_invoice": false,
  "prices_are_incl_tax": false,
  "origin": null,
  "paid_at": null,
  "tax_number": "",
  "total_price_excl_tax": "300.0",
  "total_price_excl_tax_base": "300.0",
  "total_price_incl_tax": "363.0",
  "total_price_incl_tax_base": "363.0",
  "created_at": "2025-11-25T10:55:28.412Z",
  "updated_at": "2025-11-25T10:55:28.415Z",
  "version": 1764068128,
  "details": [
    {
      "id": "471699928323720568",
      "administration_id": 123,
      "tax_rate_id": "471699736836965514",
      "ledger_account_id": "471699736746787958",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "Delivery Apple iPad",
      "price": "300.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "300.0",
      "total_price_excl_tax_with_discount_base": "300.0",
      "tax_report_reference": [
        "NL/5b"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:55:28.413Z",
      "updated_at": "2025-11-25T10:55:28.413Z"
    }
  ],
  "payments": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:55:28.416Z",
      "updated_at": "2025-11-25T10:55:28.416Z"
    }
  ]
}

json

application/json

Delete a purchase invoices

DELETE

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{id}{format}

Deletes a purchase invoice.

Delete a purchase invoices › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

Delete a purchase invoices › Responses

Status code

integer

DELETE/{administration_id}/documents/purchase_invoices/{id}{format}

curl --request DELETE \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id:format

shell

Example Responses

json

application/json

Update purchase invoice

PATCH

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{id}{format}

Updates a purchase invoice.

Update purchase invoice › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · 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

Update purchase invoice › Request Body

object

Update purchase invoice › Responses

Purchase invoice updated

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer | null · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

currency

string

ISO 4217 currency code

exchange_rate

string | null

revenue_invoice

boolean | null

prices_are_incl_tax

boolean | null

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

paid_at

string | null · date

tax_number

string | null

total_price_excl_tax

string | null

total_price_excl_tax_base

string | null

total_price_incl_tax

string | null

total_price_incl_tax_base

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

PATCH/{administration_id}/documents/purchase_invoices/{id}{format}

curl --request PATCH \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:id:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchase_invoice": {
    "details_attributes": {
      "0": {
        "description": "New detail",
        "price": 99,
        "amount": 1,
        "tax_rate_id": 471699736836965500,
        "ledger_account_id": 471699736746788000
      },
      "1": {
        "id": 471699922744247900,
        "_destroy": true
      }
    }
  }
}
'

shell

Example Request Body

{
  "purchase_invoice": {
    "details_attributes": {
      "0": {
        "description": "New detail",
        "price": 99,
        "amount": 1,
        "tax_rate_id": 471699736836965500,
        "ledger_account_id": 471699736746788000
      },
      "1": {
        "id": 471699922744247900,
        "_destroy": true
      }
    }
  }
}

json

application/json

Example Responses

{
  "id": "471699922742150712",
  "administration_id": 123,
  "contact_id": "471699922702304821",
  "contact": {
    "id": "471699922702304821",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:23.052Z",
    "updated_at": "2025-11-25T10:55:23.052Z",
    "version": 1764068123,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8ef1e79c53a8f4f74b9f0661164c20e58673ff1a86f6ed95f6446f6fbb581191/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "reference": "2013-01234",
  "date": "2025-11-25",
  "due_date": "2025-12-09",
  "entry_number": 1,
  "state": "open",
  "currency": "EUR",
  "exchange_rate": "1.0",
  "revenue_invoice": false,
  "prices_are_incl_tax": false,
  "origin": null,
  "paid_at": null,
  "tax_number": "",
  "total_price_excl_tax": "99.0",
  "total_price_excl_tax_base": "99.0",
  "total_price_incl_tax": "119.79",
  "total_price_incl_tax_base": "119.79",
  "created_at": "2025-11-25T10:55:23.090Z",
  "updated_at": "2025-11-25T10:55:23.175Z",
  "version": 1764068123,
  "details": [
    {
      "id": "471699922829182538",
      "administration_id": 123,
      "tax_rate_id": "471699736836965514",
      "ledger_account_id": "471699736746787958",
      "project_id": null,
      "product_id": null,
      "amount": "1",
      "amount_decimal": "1.0",
      "description": "New detail",
      "price": "99.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "99.0",
      "total_price_excl_tax_with_discount_base": "99.0",
      "tax_report_reference": [
        "NL/5b"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:55:23.173Z",
      "updated_at": "2025-11-25T10:55:23.173Z"
    }
  ],
  "payments": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:55:23.096Z",
      "updated_at": "2025-11-25T10:55:23.096Z"
    },
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "document_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "total_price_excl_tax": [
            "300.0",
            "99.0"
          ],
          "total_price_excl_tax_base": [
            "300.0",
            "99.0"
          ],
          "total_price_incl_tax": [
            "363.0",
            "119.79"
          ],
          "total_price_incl_tax_base": [
            "363.0",
            "119.79"
          ],
          "cached_taxes": [
            [
              {
                "tax_rate_id": "471699736836965514",
                "report_reference": "NL/5b",
                "payable": false,
                "debit": "63.0",
                "credit": 0
              }
            ],
            [
              {
                "tax_rate_id": "471699736836965514",
                "report_reference": "NL/5b",
                "payable": false,
                "debit": "20.79",
                "credit": 0
              }
            ]
          ],
          "updated_at": [
            "2025-11-25T11:55:23.094+01:00",
            "2025-11-25T11:55:23.167+01:00"
          ]
        }
      },
      "created_at": "2025-11-25T10:55:23.176Z",
      "updated_at": "2025-11-25T10:55:23.176Z"
    }
  ]
}

json

application/json

Destroys note from entity

DELETE

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{purchase_invoice_id}/notes/{id}{format}

Deletes a note from the purchase invoice.

Destroys note from entity › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

purchase_invoice_id

string | integer · pattern: ^\d+$ · required

A unique record identifier

id

string | integer · 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

Destroys note from entity › Responses

Note deleted

No data returned

DELETE/{administration_id}/documents/purchase_invoices/{purchase_invoice_id}/notes/{id}{format}

curl --request DELETE \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:purchase_invoice_id/notes/:id:format

shell

Example Responses

No example specified for this content type

Adds note to entity

POST

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices/{purchase_invoice_id}/notes{format}

Adds a note to the purchase invoice.

Adds note to entity › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

purchase_invoice_id

string | integer · 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

Adds note to entity › Request Body

object

Adds note to entity › Responses

Note created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

entity_id

string | integer | null · pattern: ^\d+$

A unique record identifier

entity_type

string

user_id

string | integer · pattern: ^\d+$

A unique record identifier

assignee_id

string | integer | null · pattern: ^\d+$

A unique record identifier

todo

boolean | string | null

Default: false

note

string | null

completed_at

string | null · date-time

completed_by_id

string | integer | null · pattern: ^\d+$

A unique record identifier

todo_type

string | 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

data

object | null

created_at

string · date-time

updated_at

string · date-time

POST/{administration_id}/documents/purchase_invoices/{purchase_invoice_id}/notes{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices/:purchase_invoice_id/notes:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": {
    "note": "Text of the note",
    "assignee_id": 471699928616273340,
    "todo": true
  }
}
'

shell

Example Request Body

{
  "note": {
    "note": "Text of the note",
    "assignee_id": 471699928616273340,
    "todo": true
  }
}

json

application/json

Example Responses

{
  "id": "471699928634099129",
  "administration_id": 123,
  "entity_id": "471699928565941669",
  "entity_type": "Document",
  "user_id": 17640679459010,
  "assignee_id": "471699928616273335",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {},
  "created_at": "2025-11-25T10:55:28.710Z",
  "updated_at": "2025-11-25T10:55:28.710Z"
}

json

application/json

Get purchase invoices

GET

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices{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.

Get purchase invoices › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

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

Get purchase invoices › query Parameters

filter

string

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

new_filter

string

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

page

integer | string

per_page

integer | string · min: 1 · max: 100 · pattern: ^\d+$

exclude_new_general_journal_documents

boolean | string

Get purchase invoices › Responses

A list of purchase invoices

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer | null · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

currency

string

ISO 4217 currency code

exchange_rate

string | null

revenue_invoice

boolean | null

prices_are_incl_tax

boolean | null

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

paid_at

string | null · date

tax_number

string | null

total_price_excl_tax

string | null

total_price_excl_tax_base

string | null

total_price_incl_tax

string | null

total_price_incl_tax_base

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

GET/{administration_id}/documents/purchase_invoices{format}

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

shell

Example Responses

[
  {
    "id": "471699923695306504",
    "administration_id": 123,
    "contact_id": "471699923514951393",
    "contact": {
      "id": "471699923514951393",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:55:23.828Z",
      "updated_at": "2025-11-25T10:55:23.828Z",
      "version": 1764068123,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/478b6c964733b60830ab5fe1368261b6faaf924e9db999aed8608bf54d70fcdf/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "reference": "2013-01234",
    "date": "2025-11-25",
    "due_date": "2025-12-09",
    "entry_number": 5,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": false,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "300.0",
    "total_price_excl_tax_base": "300.0",
    "total_price_incl_tax": "363.0",
    "total_price_incl_tax_base": "363.0",
    "created_at": "2025-11-25T10:55:23.999Z",
    "updated_at": "2025-11-25T10:55:24.003Z",
    "version": 1764068124,
    "details": [
      {
        "id": "471699923697403657",
        "administration_id": 123,
        "tax_rate_id": "471699736836965514",
        "ledger_account_id": "471699736746787958",
        "project_id": null,
        "product_id": null,
        "amount": null,
        "amount_decimal": "1.0",
        "description": "Delivery Apple iPad",
        "price": "300.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "300.0",
        "total_price_excl_tax_with_discount_base": "300.0",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2025-11-25T10:55:24.001Z",
        "updated_at": "2025-11-25T10:55:24.001Z"
      }
    ],
    "payments": [],
    "notes": [],
    "attachments": [],
    "events": [
      {
        "administration_id": 123,
        "user_id": 17640679459010,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {},
        "created_at": "2025-11-25T10:55:24.004Z",
        "updated_at": "2025-11-25T10:55:24.004Z"
      }
    ]
  }
]

json

application/json

Create a new purchase invoice

POST

https://moneybird.com/api/v2

/{administration_id}/documents/purchase_invoices{format}

Creates a new purchase invoice.

Create a new purchase invoice › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

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

Create a new purchase invoice › Request Body

object

Create a new purchase invoice › Responses

Purchase invoice created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer | null · pattern: ^\d+$

A unique record identifier

reference

string | null

date

string · date

due_date

string | null · date

entry_number

integer | null

state

string · enum

Enum values:

new

open

late

paid

saved

pending_payment

currency

string

ISO 4217 currency code

exchange_rate

string | null

revenue_invoice

boolean | null

prices_are_incl_tax

boolean | null

origin

string | null · enum

Enum values:

upload

endpoint

si_local

si_peppol

api

moneybird_bv

paid_at

string | null · date

tax_number

string | null

total_price_excl_tax

string | null

total_price_excl_tax_base

string | null

total_price_incl_tax

string | null

total_price_incl_tax_base

string | null

created_at

string · date-time

updated_at

string · date-time

version

integer

object[]

POST/{administration_id}/documents/purchase_invoices{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/documents/purchase_invoices:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "purchase_invoice": {
    "reference": "foobar",
    "contact_id": 471699929162581500,
    "details_attributes": {
      "0": {
        "description": "Lunch",
        "price": 20,
        "tax_rate_id": 471699736836965500,
        "ledger_account_id": 471699736746788000
      }
    }
  }
}
'

shell

Example Request Body

{
  "purchase_invoice": {
    "reference": "foobar",
    "contact_id": 471699929162581500,
    "details_attributes": {
      "0": {
        "description": "Lunch",
        "price": 20,
        "tax_rate_id": 471699736836965500,
        "ledger_account_id": 471699736746788000
      }
    }
  }
}

json

application/json

Example Responses

{
  "id": "471699929276876339",
  "administration_id": 123,
  "contact_id": "471699929162581534",
  "contact": {
    "id": "471699929162581534",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:29.213Z",
    "updated_at": "2025-11-25T10:55:29.213Z",
    "version": 1764068129,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0738d1ac7d2e019270f0a830e889a2246c2fd4fdbb5682c1a1f9cb3adcdc9860/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "reference": "foobar",
  "date": "2025-11-25",
  "due_date": null,
  "entry_number": 3,
  "state": "open",
  "currency": "EUR",
  "exchange_rate": "1.0",
  "revenue_invoice": false,
  "prices_are_incl_tax": false,
  "origin": "api",
  "paid_at": null,
  "tax_number": "",
  "total_price_excl_tax": "20.0",
  "total_price_excl_tax_base": "20.0",
  "total_price_incl_tax": "24.2",
  "total_price_incl_tax_base": "24.2",
  "created_at": "2025-11-25T10:55:29.323Z",
  "updated_at": "2025-11-25T10:55:29.326Z",
  "version": 1764068129,
  "details": [
    {
      "id": "471699929278973492",
      "administration_id": 123,
      "tax_rate_id": "471699736836965514",
      "ledger_account_id": "471699736746787958",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "Lunch",
      "price": "20.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "20.0",
      "total_price_excl_tax_with_discount_base": "20.0",
      "tax_report_reference": [
        "NL/5b"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:55:29.324Z",
      "updated_at": "2025-11-25T10:55:29.324Z"
    }
  ],
  "payments": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:55:29.327Z",
      "updated_at": "2025-11-25T10:55:29.327Z"
    }
  ]
}

json

application/json

Documents: General journal documents Documents: Receipts