Documents: Receipts

List ids and versions of receipts

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.

Parameters

Parameter Type Description
filter String

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

Example: retrieves all ids for synchronization

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts/synchronization.json?
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546219609916920",
    "version": 1727681916
  },
  {
    "id": "433546219713725950",
    "version": 1727681916
  },
  {
    "id": "433546219787126273",
    "version": 1727681916
  }
]
      

Example: retrieves all ids for synchronization using a filter

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts/synchronization.json?filter=period%3Athis_month
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546219955947017",
    "version": 1727681916
  },
  {
    "id": "433546220063950351",
    "version": 1727681916
  },
  {
    "id": "433546220106941970",
    "version": 1727681916
  }
]
      

Fetch receipts with given ids

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.

Parameters

Parameter Type Description
ids Array[integer]

Required

Example: retrieves documents for given ids

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"ids":[433546220399494688,433546220504352291]}' \
  https://moneybird.com/api/v2/123/documents/receipts/synchronization.json
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546220399494688",
    "administration_id": 123,
    "contact_id": "433546220234868247",
    "contact": {
      "id": "433546220234868247",
      "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": "2024-09-30T07:38:36.903Z",
      "updated_at": "2024-09-30T07:38:36.903Z",
      "version": 1727681916,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e45d366ffb3933a4388592dfac3899eea3f5a1ea1c253fe6a1a471fdad092724/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "reference": "Lunch supermarket",
    "date": "2024-09-30",
    "due_date": null,
    "entry_number": 3,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": true,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "247.93",
    "total_price_excl_tax_base": "247.93",
    "total_price_incl_tax": "300.0",
    "total_price_incl_tax_base": "300.0",
    "created_at": "2024-09-30T07:38:37.061Z",
    "updated_at": "2024-09-30T07:38:37.064Z",
    "version": 1727681917,
    "details": [
      {
        "id": "433546220401591841",
        "administration_id": 123,
        "tax_rate_id": "433546158523025226",
        "ledger_account_id": "433546158461159222",
        "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": "247.93",
        "total_price_excl_tax_with_discount_base": "247.93",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:38:37.063Z",
        "updated_at": "2024-09-30T07:38:37.063Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1727681857838,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-09-30T07:38:37.066Z",
        "updated_at": "2024-09-30T07:38:37.066Z"
      }
    ]
  },
  {
    "id": "433546220504352291",
    "administration_id": 123,
    "contact_id": "433546220234868247",
    "contact": {
      "id": "433546220234868247",
      "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": "2024-09-30T07:38:36.903Z",
      "updated_at": "2024-09-30T07:38:36.903Z",
      "version": 1727681916,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e45d366ffb3933a4388592dfac3899eea3f5a1ea1c253fe6a1a471fdad092724/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "reference": "Lunch supermarket",
    "date": "2024-09-30",
    "due_date": null,
    "entry_number": 4,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": true,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "247.93",
    "total_price_excl_tax_base": "247.93",
    "total_price_incl_tax": "300.0",
    "total_price_incl_tax_base": "300.0",
    "created_at": "2024-09-30T07:38:37.161Z",
    "updated_at": "2024-09-30T07:38:37.164Z",
    "version": 1727681917,
    "details": [
      {
        "id": "433546220506449444",
        "administration_id": 123,
        "tax_rate_id": "433546158523025226",
        "ledger_account_id": "433546158461159222",
        "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": "247.93",
        "total_price_excl_tax_with_discount_base": "247.93",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:38:37.163Z",
        "updated_at": "2024-09-30T07:38:37.163Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1727681857838,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-09-30T07:38:37.166Z",
        "updated_at": "2024-09-30T07:38:37.166Z"
      }
    ]
  }
]
      

Get receipts

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.

Parameters

Parameter Type Description
filter String

Required

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

new_filter String

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

page Integer
per_page Integer
exclude_new_general_journal_documents Boolean

Example: returns a list of receipts

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts.json?
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546214818972930",
    "administration_id": 123,
    "contact_id": "433546214614500595",
    "contact": {
      "id": "433546214614500595",
      "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": "2024-09-30T07:38:31.544Z",
      "updated_at": "2024-09-30T07:38:31.544Z",
      "version": 1727681911,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/cdcfc2fff1ff34a83b4d5e7e5ccb85f71261fb7e827175ccca55664dfb022b8b/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "reference": "Lunch supermarket",
    "date": "2024-09-30",
    "due_date": null,
    "entry_number": 5,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": true,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "247.93",
    "total_price_excl_tax_base": "247.93",
    "total_price_incl_tax": "300.0",
    "total_price_incl_tax_base": "300.0",
    "created_at": "2024-09-30T07:38:31.738Z",
    "updated_at": "2024-09-30T07:38:31.742Z",
    "version": 1727681911,
    "details": [
      {
        "id": "433546214820021507",
        "administration_id": 123,
        "tax_rate_id": "433546158523025226",
        "ledger_account_id": "433546158461159222",
        "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": "247.93",
        "total_price_excl_tax_with_discount_base": "247.93",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:38:31.740Z",
        "updated_at": "2024-09-30T07:38:31.740Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1727681857838,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-09-30T07:38:31.743Z",
        "updated_at": "2024-09-30T07:38:31.743Z"
      }
    ]
  },
  {
    "id": "433546214780175615",
    "administration_id": 123,
    "contact_id": "433546214614500595",
    "contact": {
      "id": "433546214614500595",
      "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": "2024-09-30T07:38:31.544Z",
      "updated_at": "2024-09-30T07:38:31.544Z",
      "version": 1727681911,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/cdcfc2fff1ff34a83b4d5e7e5ccb85f71261fb7e827175ccca55664dfb022b8b/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "reference": "Lunch supermarket",
    "date": "2024-09-30",
    "due_date": null,
    "entry_number": 4,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": true,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "247.93",
    "total_price_excl_tax_base": "247.93",
    "total_price_incl_tax": "300.0",
    "total_price_incl_tax_base": "300.0",
    "created_at": "2024-09-30T07:38:31.702Z",
    "updated_at": "2024-09-30T07:38:31.706Z",
    "version": 1727681911,
    "details": [
      {
        "id": "433546214783321344",
        "administration_id": 123,
        "tax_rate_id": "433546158523025226",
        "ledger_account_id": "433546158461159222",
        "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": "247.93",
        "total_price_excl_tax_with_discount_base": "247.93",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:38:31.704Z",
        "updated_at": "2024-09-30T07:38:31.704Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1727681857838,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-09-30T07:38:31.708Z",
        "updated_at": "2024-09-30T07:38:31.708Z"
      }
    ]
  },
  {
    "id": "433546214739281148",
    "administration_id": 123,
    "contact_id": "433546214614500595",
    "contact": {
      "id": "433546214614500595",
      "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": "2024-09-30T07:38:31.544Z",
      "updated_at": "2024-09-30T07:38:31.544Z",
      "version": 1727681911,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/cdcfc2fff1ff34a83b4d5e7e5ccb85f71261fb7e827175ccca55664dfb022b8b/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "reference": "Lunch supermarket",
    "date": "2024-09-30",
    "due_date": null,
    "entry_number": 3,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": true,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "247.93",
    "total_price_excl_tax_base": "247.93",
    "total_price_incl_tax": "300.0",
    "total_price_incl_tax_base": "300.0",
    "created_at": "2024-09-30T07:38:31.663Z",
    "updated_at": "2024-09-30T07:38:31.667Z",
    "version": 1727681911,
    "details": [
      {
        "id": "433546214741378301",
        "administration_id": 123,
        "tax_rate_id": "433546158523025226",
        "ledger_account_id": "433546158461159222",
        "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": "247.93",
        "total_price_excl_tax_with_discount_base": "247.93",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:38:31.664Z",
        "updated_at": "2024-09-30T07:38:31.664Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1727681857838,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-09-30T07:38:31.668Z",
        "updated_at": "2024-09-30T07:38:31.668Z"
      }
    ]
  }
]
      

Example: returns paginated receipts on page 1

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts.json?per_page=1
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546215148225814",
    "administration_id": 123,
    "contact_id": "433546214931170567",
    "contact": {
      "id": "433546214931170567",
      "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": "2024-09-30T07:38:31.845Z",
      "updated_at": "2024-09-30T07:38:31.845Z",
      "version": 1727681911,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/03bcb33aad102c9d885012ca302886ca9089dc266e83663f75deeb0a6c5ff655/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "reference": "Lunch supermarket",
    "date": "2024-09-30",
    "due_date": null,
    "entry_number": 5,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": true,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "247.93",
    "total_price_excl_tax_base": "247.93",
    "total_price_incl_tax": "300.0",
    "total_price_incl_tax_base": "300.0",
    "created_at": "2024-09-30T07:38:32.053Z",
    "updated_at": "2024-09-30T07:38:32.056Z",
    "version": 1727681912,
    "details": [
      {
        "id": "433546215150322967",
        "administration_id": 123,
        "tax_rate_id": "433546158523025226",
        "ledger_account_id": "433546158461159222",
        "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": "247.93",
        "total_price_excl_tax_with_discount_base": "247.93",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:38:32.054Z",
        "updated_at": "2024-09-30T07:38:32.054Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1727681857838,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-09-30T07:38:32.058Z",
        "updated_at": "2024-09-30T07:38:32.058Z"
      }
    ]
  }
]
      

Example: returns paginated receipts on page 2

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts.json?page=2&per_page=1
    

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546215446021415",
    "administration_id": 123,
    "contact_id": "433546215276152091",
    "contact": {
      "id": "433546215276152091",
      "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": "2024-09-30T07:38:32.174Z",
      "updated_at": "2024-09-30T07:38:32.174Z",
      "version": 1727681912,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/da99140e0056171731e26654323664670acf9f5d3d02f3d8055dad6756bd7d02/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "reference": "Lunch supermarket",
    "date": "2024-09-30",
    "due_date": null,
    "entry_number": 4,
    "state": "open",
    "currency": "EUR",
    "exchange_rate": "1.0",
    "revenue_invoice": false,
    "prices_are_incl_tax": true,
    "origin": null,
    "paid_at": null,
    "tax_number": "",
    "total_price_excl_tax": "247.93",
    "total_price_excl_tax_base": "247.93",
    "total_price_incl_tax": "300.0",
    "total_price_incl_tax_base": "300.0",
    "created_at": "2024-09-30T07:38:32.337Z",
    "updated_at": "2024-09-30T07:38:32.341Z",
    "version": 1727681912,
    "details": [
      {
        "id": "433546215448118568",
        "administration_id": 123,
        "tax_rate_id": "433546158523025226",
        "ledger_account_id": "433546158461159222",
        "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": "247.93",
        "total_price_excl_tax_with_discount_base": "247.93",
        "tax_report_reference": [
          "NL/5b"
        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:38:32.339Z",
        "updated_at": "2024-09-30T07:38:32.339Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 1727681857838,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": {
        },
        "created_at": "2024-09-30T07:38:32.342Z",
        "updated_at": "2024-09-30T07:38:32.342Z"
      }
    ]
  }
]
      

Example: returns an error when too many receipts are requested

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts.json?per_page=101
    

Response

        
          
          Status: 400 Bad Request
        
      
{
  "error": "Per Page is too big",
  "symbolic": {
    "per_page": "max"
  }
}
      

Get receipts

Example: returns the wanted receipt

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts/433546216380302691.json?
    

Response

        
          
          Status: 200 OK
        
      
{
  "id": "433546216380302691",
  "administration_id": 123,
  "contact_id": "433546216341505376",
  "contact": {
    "id": "433546216341505376",
    "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": "2024-09-30T07:38:33.190Z",
    "updated_at": "2024-09-30T07:38:33.190Z",
    "version": 1727681913,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/98999a4bda3bfa836f68717a3e597d659340756078b564fc68d3c2f8ca70086f/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "reference": "Lunch supermarket",
  "date": "2024-09-30",
  "due_date": null,
  "entry_number": 1,
  "state": "open",
  "currency": "EUR",
  "exchange_rate": "1.0",
  "revenue_invoice": false,
  "prices_are_incl_tax": true,
  "origin": null,
  "paid_at": null,
  "tax_number": "",
  "total_price_excl_tax": "247.93",
  "total_price_excl_tax_base": "247.93",
  "total_price_incl_tax": "300.0",
  "total_price_incl_tax_base": "300.0",
  "created_at": "2024-09-30T07:38:33.228Z",
  "updated_at": "2024-09-30T07:38:33.232Z",
  "version": 1727681913,
  "details": [
    {
      "id": "433546216382399844",
      "administration_id": 123,
      "tax_rate_id": "433546158523025226",
      "ledger_account_id": "433546158461159222",
      "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": "247.93",
      "total_price_excl_tax_with_discount_base": "247.93",
      "tax_report_reference": [
        "NL/5b"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:38:33.230Z",
      "updated_at": "2024-09-30T07:38:33.230Z"
    }
  ],
  "payments": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:38:33.233Z",
      "updated_at": "2024-09-30T07:38:33.233Z"
    }
  ]
}
      

Example: only returns receipts

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/documents/receipts/433546216639300977.json?
    

Response

        
          
          Status: 404 Not Found
        
      
{
  "error": "record not found",
  "symbolic": {
    "id": "not_found"
  }
}
      

Create a new receipts

Parameters

Parameter Type Description
receipt[contact_id] Integer

Required. Should be a valid contact id.

receipt[reference] String

Required.

receipt[date] String

Required

Required.

receipt[currency] String

ISO three-character currency code, e.g. EUR or USD.

receipt[prices_are_incl_tax] Boolean
receipt[origin] String

Can be api, upload, endpoint, si, si_local, si_peppol, email or moneybird_bv.

receipt[details_attributes][id] Integer
receipt[details_attributes][description] String
receipt[details_attributes][period] String

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.

receipt[details_attributes][price] Decimal

Both a decimal and a string ‘10,95’ are accepted.

receipt[details_attributes][amount] String
receipt[details_attributes][tax_rate_id] Integer

Should be a valid tax rate id.

receipt[details_attributes][ledger_account_id] Integer

Should be a valid ledger account id.

receipt[details_attributes][project_id] Integer

Should be a valid project id.

receipt[details_attributes][row_order] Integer
receipt[details_attributes][_destroy] Boolean
payment[financial_account_id] Integer

Should be a valid financial account id.

Example: creates the receipt

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"receipt":{"reference":"foobar","contact_id":433546216732624246,"details_attributes":{"0":{"description":"Lunch","price":20,"tax_rate_id":433546158523025226,"ledger_account_id":433546158461159222}}}}' \
  https://moneybird.com/api/v2/123/documents/receipts.json
    

Response

        
          
          Status: 201 Created
        
      
{
  "id": "433546216900396415",
  "administration_id": 123,
  "contact_id": "433546216732624246",
  "contact": {
    "id": "433546216732624246",
    "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": "2024-09-30T07:38:33.563Z",
    "updated_at": "2024-09-30T07:38:33.563Z",
    "version": 1727681913,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/6a74f4d86b573703c5c6bb1906fddf5fb65a0b191b8c3045dc1ee757250a3876/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "reference": "foobar",
  "date": "2024-09-30",
  "due_date": null,
  "entry_number": 3,
  "state": "open",
  "currency": "EUR",
  "exchange_rate": "1.0",
  "revenue_invoice": false,
  "prices_are_incl_tax": true,
  "origin": null,
  "paid_at": null,
  "tax_number": "",
  "total_price_excl_tax": "16.53",
  "total_price_excl_tax_base": "16.53",
  "total_price_incl_tax": "20.0",
  "total_price_incl_tax_base": "20.0",
  "created_at": "2024-09-30T07:38:33.723Z",
  "updated_at": "2024-09-30T07:38:33.727Z",
  "version": 1727681913,
  "details": [
    {
      "id": "433546216902493568",
      "administration_id": 123,
      "tax_rate_id": "433546158523025226",
      "ledger_account_id": "433546158461159222",
      "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": "16.53",
      "total_price_excl_tax_with_discount_base": "16.53",
      "tax_report_reference": [
        "NL/5b"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:38:33.725Z",
      "updated_at": "2024-09-30T07:38:33.725Z"
    }
  ],
  "payments": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:38:33.728Z",
      "updated_at": "2024-09-30T07:38:33.728Z"
    }
  ]
}
      

Example: requires all input

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/receipts.json
    

Response

        
          
          Status: 400 Bad Request
        
      
{
  "error": "Receipt is required",
  "symbolic": {
    "receipt": "required"
  }
}
      

Delete a receipts

Parameters

Parameter Type Description
refresh_journal_entries Boolean

Example: deletes the receipt

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/receipts/433546218097870261.json
    

Response

Update a receipts

Parameters

Parameter Type Description
receipt[contact_id] Integer

Required. Should be a valid contact id.

receipt[reference] String

Required.

receipt[date] String

Required

Required.

receipt[currency] String

ISO three-character currency code, e.g. EUR or USD.

receipt[prices_are_incl_tax] Boolean
receipt[origin] String

Can be api, upload, endpoint, si, si_local, si_peppol, email or moneybird_bv.

receipt[details_attributes][id] Integer
receipt[details_attributes][description] String
receipt[details_attributes][period] String

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.

receipt[details_attributes][price] Decimal

Both a decimal and a string ‘10,95’ are accepted.

receipt[details_attributes][amount] String
receipt[details_attributes][tax_rate_id] Integer

Should be a valid tax rate id.

receipt[details_attributes][ledger_account_id] Integer

Should be a valid ledger account id.

receipt[details_attributes][project_id] Integer

Should be a valid project id.

receipt[details_attributes][row_order] Integer
receipt[details_attributes][_destroy] Boolean
payment[financial_account_id] Integer

Should be a valid financial account id.

Example: updates the receipt

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"receipt":{"reference":"updated reference"}}' \
  https://moneybird.com/api/v2/123/documents/receipts/433546217234892178.json
    

Response

        
          
          Status: 200 OK
        
      
{
  "id": "433546217234892178",
  "administration_id": 123,
  "contact_id": "433546217186657679",
  "contact": {
    "id": "433546217186657679",
    "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": "2024-09-30T07:38:33.996Z",
    "updated_at": "2024-09-30T07:38:33.996Z",
    "version": 1727681913,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1368f4cce8fdd94d3d2cd93823e96fc88d08b36d01f9b824bd40836a1c134570/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "reference": "updated reference",
  "date": "2024-09-30",
  "due_date": null,
  "entry_number": 1,
  "state": "open",
  "currency": "EUR",
  "exchange_rate": "1.0",
  "revenue_invoice": false,
  "prices_are_incl_tax": true,
  "origin": null,
  "paid_at": null,
  "tax_number": "",
  "total_price_excl_tax": "247.93",
  "total_price_excl_tax_base": "247.93",
  "total_price_incl_tax": "300.0",
  "total_price_incl_tax_base": "300.0",
  "created_at": "2024-09-30T07:38:34.043Z",
  "updated_at": "2024-09-30T07:38:34.163Z",
  "version": 1727681914,
  "details": [
    {
      "id": "433546217236989331",
      "administration_id": 123,
      "tax_rate_id": "433546158523025226",
      "ledger_account_id": "433546158461159222",
      "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": "247.93",
      "total_price_excl_tax_with_discount_base": "247.93",
      "tax_report_reference": [
        "NL/5b"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:38:34.045Z",
      "updated_at": "2024-09-30T07:38:34.045Z"
    }
  ],
  "payments": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:38:34.048Z",
      "updated_at": "2024-09-30T07:38:34.048Z"
    },
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "document_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "reference": [
            "Lunch supermarket",
            "updated reference"
          ],
          "updated_at": [
            "2024-09-30T09:38:34.046+02:00",
            "2024-09-30T09:38:34.163+02:00"
          ]
        }
      },
      "created_at": "2024-09-30T07:38:34.167Z",
      "updated_at": "2024-09-30T07:38:34.167Z"
    }
  ]
}
      

Example: updates the receipt details

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"receipt":{"details_attributes":{"0":{"id":433546217480258975,"description":"updated description","price":20}}}}' \
  https://moneybird.com/api/v2/123/documents/receipts/433546217478161822.json
    

Response

        
          
          Status: 200 OK
        
      
{
  "id": "433546217478161822",
  "administration_id": 123,
  "contact_id": "433546217440413083",
  "contact": {
    "id": "433546217440413083",
    "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": "2024-09-30T07:38:34.238Z",
    "updated_at": "2024-09-30T07:38:34.238Z",
    "version": 1727681914,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/301ce475b07245774147c857cefb015608156fca29d59bae029c008ff96f6790/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "reference": "Lunch supermarket",
  "date": "2024-09-30",
  "due_date": null,
  "entry_number": 1,
  "state": "open",
  "currency": "EUR",
  "exchange_rate": "1.0",
  "revenue_invoice": false,
  "prices_are_incl_tax": true,
  "origin": null,
  "paid_at": null,
  "tax_number": "",
  "total_price_excl_tax": "16.53",
  "total_price_excl_tax_base": "16.53",
  "total_price_incl_tax": "20.0",
  "total_price_incl_tax_base": "20.0",
  "created_at": "2024-09-30T07:38:34.275Z",
  "updated_at": "2024-09-30T07:38:34.401Z",
  "version": 1727681914,
  "details": [
    {
      "id": "433546217480258975",
      "administration_id": 123,
      "tax_rate_id": "433546158523025226",
      "ledger_account_id": "433546158461159222",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "updated description",
      "price": "20.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "16.53",
      "total_price_excl_tax_with_discount_base": "16.53",
      "tax_report_reference": [
        "NL/5b"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:38:34.277Z",
      "updated_at": "2024-09-30T07:38:34.400Z"
    }
  ],
  "payments": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:38:34.280Z",
      "updated_at": "2024-09-30T07:38:34.280Z"
    },
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "document_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
        "changes": {
          "total_price_excl_tax": [
            "247.93",
            "16.53"
          ],
          "total_price_excl_tax_base": [
            "247.93",
            "16.53"
          ],
          "total_price_incl_tax": [
            "300.0",
            "20.0"
          ],
          "total_price_incl_tax_base": [
            "300.0",
            "20.0"
          ],
          "cached_taxes": [
            [
              {
                "tax_rate_id": "433546158523025226",
                "report_reference": "NL/5b",
                "payable": false,
                "debit": "52.07",
                "credit": 0
              }
            ],
            [
              {
                "tax_rate_id": "433546158523025226",
                "report_reference": "NL/5b",
                "payable": false,
                "debit": "3.47",
                "credit": 0
              }
            ]
          ],
          "updated_at": [
            "2024-09-30T09:38:34.278+02:00",
            "2024-09-30T09:38:34.398+02:00"
          ]
        }
      },
      "created_at": "2024-09-30T07:38:34.402Z",
      "updated_at": "2024-09-30T07:38:34.402Z"
    }
  ]
}
      

DEPRECATED: Register a payment for a receipt

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

Parameters

Parameter Type Description
payment[payment_date] String

Required

payment[price] Decimal

Required

Both a decimal and a string ‘10,95’ are accepted. Should be a number -1,000,000,000 <= n <= 1,000,000,000.

payment[price_base] Decimal

Amount paid expressed in the base currency. Required for foreign currencies. Should be a number -1,000,000,000 <= n <= 1,000,000,000.

payment[financial_account_id] Integer

Should be a valid financial account id.

payment[financial_mutation_id] Integer

Should be a valid financial mutation id.

payment[transaction_identifier] String
payment[manual_payment_action] String

Can be private_payment, payment_without_proof, cash_payment, rounding_error, bank_transfer, balance_settlement or invoices_settlement.

payment[ledger_account_id] Integer

Should be a valid ledger account id.

payment[invoice_id] Integer

Example: registers payments

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"payment":{"payment_date":"2024-09-30 07:38:35 UTC","price":"300.0"}}' \
  https://moneybird.com/api/v2/123/documents/receipts/433546218326459841/register_payment.json
    

Response

Create a payment

Parameters

Parameter Type Description
payment[payment_date] String

Required

payment[price] Decimal

Required

Both a decimal and a string ‘10,95’ are accepted. Should be a number -1,000,000,000 <= n <= 1,000,000,000.

payment[price_base] Decimal

Amount paid expressed in the base currency. Required for foreign currencies. Should be a number -1,000,000,000 <= n <= 1,000,000,000.

payment[financial_account_id] Integer

Should be a valid financial account id.

payment[financial_mutation_id] Integer

Should be a valid financial mutation id.

payment[transaction_identifier] String
payment[manual_payment_action] String

Can be private_payment, payment_without_proof, cash_payment, rounding_error, bank_transfer, balance_settlement or invoices_settlement.

payment[ledger_account_id] Integer

Should be a valid ledger account id.

payment[invoice_id] Integer

Delete a payment

Add attachment to receipt

Example: uploads an attachment

Request

curl -s -H "Content-Type: multipart/mixed" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -F file=@/tmp/upload.pdf \
  https://moneybird.com/api/v2/123/documents/receipts/433546219063608812/attachments.json
    

Response

Download attachment

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.

Delete an attachment

Deletes an attachment of an attachable.

Example: destroys an attachment

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/receipts/433546220683658795/attachments/433546220844090929.json
    

Response

Adds note to entity

Parameters

Parameter Type Description
note[note] String

Required. Text for the note or to-do.

note[todo] Boolean

If true the note is a to-do.

note[assignee_id] Integer

Assign to-do to user. Should be a valid user id. If assignee_id is provided the note will be a to-do.

Example: create a note

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"note":{"note":"Text of the note","assignee_id":433546216031126860,"todo":true}}' \
  https://moneybird.com/api/v2/123/documents/receipts/433546215958775110/notes.json
    

Response

        
          
          Status: 201 Created
        
      
{
  "id": "433546216080409934",
  "administration_id": 123,
  "entity_id": "433546215958775110",
  "entity_type": "Document",
  "user_id": 1727681857838,
  "assignee_id": "433546216031126860",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {
  },
  "created_at": "2024-09-30T07:38:32.941Z",
  "updated_at": "2024-09-30T07:38:32.941Z"
}
      

Destroys note from entity

Example: destroy a note

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XDELETE \
  -d '{}' \
  https://moneybird.com/api/v2/123/documents/receipts/433546216176878933/notes/433546216241890651.json
    

Response