Documents: Receipts

Show examples in: cURL Ruby

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": "190119481242027197",
    "version": 1495532088
  },
  {
    "id": "190119481523045571",
    "version": 1495532088
  },
  {
    "id": "190119481628951750",
    "version": 1495532088
  }
]

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": "190119481869075662",
    "version": 1495532088
  },
  {
    "id": "190119482141705428",
    "version": 1495532088
  },
  {
    "id": "190119482245514455",
    "version": 1495532088
  }
]

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":[190119482710033637,190119482810696936]}' \
  https://moneybird.com/api/v2/123/documents/receipts/synchronization.json

Response

Status: 200 OK
[
  {
    "id": "190119482710033637",
    "administration_id": 123,
    "contact_id": "190119482373440732",
    "contact": {
      "id": "190119482373440732",
      "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": "",
      "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": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "created_at": "2017-05-23T09:34:49.107Z",
      "updated_at": "2017-05-23T09:34:49.107Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/68aa6315fea2d44b922497a9039ad269429619c8641ee457605aecb4d0611303/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "reference": "Lunch supermarket",
    "date": "2017-05-23",
    "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": "2017-05-23T09:34:49.428Z",
    "updated_at": "2017-05-23T09:34:49.435Z",
    "details": [
      {
        "id": "190119482713179366",
        "administration_id": 123,
        "tax_rate_id": "190119429771626316",
        "ledger_account_id": "190119429568202551",
        "product_id": null,
        "amount": null,
        "amount_decimal": 1,
        "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"
        ],
        "created_at": "2017-05-23T09:34:49.432Z",
        "updated_at": "2017-05-23T09:34:49.432Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14955320389696,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-05-23T09:34:49.439Z",
        "updated_at": "2017-05-23T09:34:49.439Z"
      }
    ]
  },
  {
    "id": "190119482810696936",
    "administration_id": 123,
    "contact_id": "190119482373440732",
    "contact": {
      "id": "190119482373440732",
      "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": "",
      "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": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "created_at": "2017-05-23T09:34:49.107Z",
      "updated_at": "2017-05-23T09:34:49.107Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/68aa6315fea2d44b922497a9039ad269429619c8641ee457605aecb4d0611303/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "reference": "Lunch supermarket",
    "date": "2017-05-23",
    "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": "2017-05-23T09:34:49.524Z",
    "updated_at": "2017-05-23T09:34:49.531Z",
    "details": [
      {
        "id": "190119482812794089",
        "administration_id": 123,
        "tax_rate_id": "190119429771626316",
        "ledger_account_id": "190119429568202551",
        "product_id": null,
        "amount": null,
        "amount_decimal": 1,
        "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"
        ],
        "created_at": "2017-05-23T09:34:49.527Z",
        "updated_at": "2017-05-23T09:34:49.527Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14955320389696,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-05-23T09:34:49.535Z",
        "updated_at": "2017-05-23T09:34:49.535Z"
      }
    ]
  }
]

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.

page Integer
per_page Integer

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": "190119474487100429",
    "administration_id": 123,
    "contact_id": "190119473909336062",
    "contact": {
      "id": "190119473909336062",
      "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": "",
      "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": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "created_at": "2017-05-23T09:34:41.035Z",
      "updated_at": "2017-05-23T09:34:41.035Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/398167e2535cebe7c25adda9368958bfe959823ae02d76fadfc7dbf467892d5d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "reference": "Lunch supermarket",
    "date": "2017-05-23",
    "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": "2017-05-23T09:34:41.587Z",
    "updated_at": "2017-05-23T09:34:41.594Z",
    "details": [
      {
        "id": "190119474492343310",
        "administration_id": 123,
        "tax_rate_id": "190119429771626316",
        "ledger_account_id": "190119429568202551",
        "product_id": null,
        "amount": null,
        "amount_decimal": 1,
        "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"
        ],
        "created_at": "2017-05-23T09:34:41.591Z",
        "updated_at": "2017-05-23T09:34:41.591Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14955320389696,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-05-23T09:34:41.598Z",
        "updated_at": "2017-05-23T09:34:41.598Z"
      }
    ]
  },
  {
    "id": "190119474359174154",
    "administration_id": 123,
    "contact_id": "190119473909336062",
    "contact": {
      "id": "190119473909336062",
      "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": "",
      "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": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "created_at": "2017-05-23T09:34:41.035Z",
      "updated_at": "2017-05-23T09:34:41.035Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/398167e2535cebe7c25adda9368958bfe959823ae02d76fadfc7dbf467892d5d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "reference": "Lunch supermarket",
    "date": "2017-05-23",
    "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": "2017-05-23T09:34:41.464Z",
    "updated_at": "2017-05-23T09:34:41.501Z",
    "details": [
      {
        "id": "190119474392728587",
        "administration_id": 123,
        "tax_rate_id": "190119429771626316",
        "ledger_account_id": "190119429568202551",
        "product_id": null,
        "amount": null,
        "amount_decimal": 1,
        "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"
        ],
        "created_at": "2017-05-23T09:34:41.493Z",
        "updated_at": "2017-05-23T09:34:41.493Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14955320389696,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-05-23T09:34:41.505Z",
        "updated_at": "2017-05-23T09:34:41.505Z"
      }
    ]
  },
  {
    "id": "190119474259559431",
    "administration_id": 123,
    "contact_id": "190119473909336062",
    "contact": {
      "id": "190119473909336062",
      "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": "",
      "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": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "created_at": "2017-05-23T09:34:41.035Z",
      "updated_at": "2017-05-23T09:34:41.035Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/398167e2535cebe7c25adda9368958bfe959823ae02d76fadfc7dbf467892d5d/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "reference": "Lunch supermarket",
    "date": "2017-05-23",
    "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": "2017-05-23T09:34:41.369Z",
    "updated_at": "2017-05-23T09:34:41.377Z",
    "details": [
      {
        "id": "190119474263753736",
        "administration_id": 123,
        "tax_rate_id": "190119429771626316",
        "ledger_account_id": "190119429568202551",
        "product_id": null,
        "amount": null,
        "amount_decimal": 1,
        "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"
        ],
        "created_at": "2017-05-23T09:34:41.373Z",
        "updated_at": "2017-05-23T09:34:41.373Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14955320389696,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-05-23T09:34:41.383Z",
        "updated_at": "2017-05-23T09:34:41.383Z"
      }
    ]
  }
]

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": "190119475234735137",
    "administration_id": 123,
    "contact_id": "190119474715690002",
    "contact": {
      "id": "190119474715690002",
      "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": "",
      "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": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "created_at": "2017-05-23T09:34:41.804Z",
      "updated_at": "2017-05-23T09:34:41.804Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/d0bf51087d61d306558a363c3a6aacd6364a01b09ac230bb7cb85871fef02707/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "reference": "Lunch supermarket",
    "date": "2017-05-23",
    "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": "2017-05-23T09:34:42.299Z",
    "updated_at": "2017-05-23T09:34:42.305Z",
    "details": [
      {
        "id": "190119475236832290",
        "administration_id": 123,
        "tax_rate_id": "190119429771626316",
        "ledger_account_id": "190119429568202551",
        "product_id": null,
        "amount": null,
        "amount_decimal": 1,
        "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"
        ],
        "created_at": "2017-05-23T09:34:42.302Z",
        "updated_at": "2017-05-23T09:34:42.302Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14955320389696,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-05-23T09:34:42.309Z",
        "updated_at": "2017-05-23T09:34:42.309Z"
      }
    ]
  }
]

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": "190119475845006386",
    "administration_id": 123,
    "contact_id": "190119475393070118",
    "contact": {
      "id": "190119475393070118",
      "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": "",
      "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": "FRST",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "created_at": "2017-05-23T09:34:42.450Z",
      "updated_at": "2017-05-23T09:34:42.450Z",
      "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/0a84df36a5e987811f4cd2e9d6de29f473a3023bb4271538d07f3abcad6df642/all",
      "notes": [

      ],
      "custom_fields": [

      ]
    },
    "reference": "Lunch supermarket",
    "date": "2017-05-23",
    "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": "2017-05-23T09:34:42.880Z",
    "updated_at": "2017-05-23T09:34:42.889Z",
    "details": [
      {
        "id": "190119475849200691",
        "administration_id": 123,
        "tax_rate_id": "190119429771626316",
        "ledger_account_id": "190119429568202551",
        "product_id": null,
        "amount": null,
        "amount_decimal": 1,
        "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"
        ],
        "created_at": "2017-05-23T09:34:42.885Z",
        "updated_at": "2017-05-23T09:34:42.885Z"
      }
    ],
    "payments": [

    ],
    "notes": [

    ],
    "attachments": [

    ],
    "events": [
      {
        "administration_id": 123,
        "user_id": 14955320389696,
        "action": "document_saved",
        "link_entity_id": null,
        "link_entity_type": null,
        "data": null,
        "created_at": "2017-05-23T09:34:42.897Z",
        "updated_at": "2017-05-23T09:34:42.897Z"
      }
    ]
  }
]

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/190119476826473553.json?

Response

Status: 200 OK
{
  "id": "190119476826473553",
  "administration_id": 123,
  "contact_id": "190119476726858830",
  "contact": {
    "id": "190119476726858830",
    "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": "",
    "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": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "created_at": "2017-05-23T09:34:43.722Z",
    "updated_at": "2017-05-23T09:34:43.722Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/745574d971022400396bf7ad48fe8f9a2dd48523e70be09b83d1ddd2b4697696/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "reference": "Lunch supermarket",
  "date": "2017-05-23",
  "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": "2017-05-23T09:34:43.816Z",
  "updated_at": "2017-05-23T09:34:43.827Z",
  "details": [
    {
      "id": "190119476831716434",
      "administration_id": 123,
      "tax_rate_id": "190119429771626316",
      "ledger_account_id": "190119429568202551",
      "product_id": null,
      "amount": null,
      "amount_decimal": 1,
      "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"
      ],
      "created_at": "2017-05-23T09:34:43.821Z",
      "updated_at": "2017-05-23T09:34:43.821Z"
    }
  ],
  "payments": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14955320389696,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-05-23T09:34:43.832Z",
      "updated_at": "2017-05-23T09:34:43.832Z"
    }
  ]
}

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/190119477471347807.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 upload, endpoint, si or email.

receipt[details_attributes][*][id] Integer

Should be a valid detail id.

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][*][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":190119477594031204,"details_attributes":{"0":{"description":"Lunch","price":20,"tax_rate_id":190119429771626316,"ledger_account_id":190119429568202551}}}}' \
  https://moneybird.com/api/v2/123/documents/receipts.json

Response

Status: 201 Created
{
  "id": "190119478081619053",
  "administration_id": 123,
  "contact_id": "190119477594031204",
  "contact": {
    "id": "190119477594031204",
    "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": "",
    "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": "FRST",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "created_at": "2017-05-23T09:34:44.549Z",
    "updated_at": "2017-05-23T09:34:44.549Z",
    "sales_invoices_url": "http://moneybird.dev/123/sales_invoices/6c9a7c417ef42410835fd1071ffc3a6cadb1a34e44fcc845507d827e75f9190c/all",
    "notes": [

    ],
    "custom_fields": [

    ]
  },
  "reference": "foobar",
  "date": "2017-05-23",
  "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": "2017-05-23T09:34:45.014Z",
  "updated_at": "2017-05-23T09:34:45.021Z",
  "details": [
    {
      "id": "190119478084764782",
      "administration_id": 123,
      "tax_rate_id": "190119429771626316",
      "ledger_account_id": "190119429568202551",
      "product_id": null,
      "amount": null,
      "amount_decimal": 1,
      "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"
      ],
      "created_at": "2017-05-23T09:34:45.017Z",
      "updated_at": "2017-05-23T09:34:45.017Z"
    }
  ],
  "payments": [

  ],
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 14955320389696,
      "action": "document_saved",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": null,
      "created_at": "2017-05-23T09:34:45.025Z",
      "updated_at": "2017-05-23T09:34:45.025Z"
    }
  ]
}

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

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/190119479640851608.json

Response

Status: 200 OK
200

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 upload, endpoint, si or email.

receipt[details_attributes][*][id] Integer

Should be a valid detail id.

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][*][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/190119478675113088.json

Response

Status: 200 OK
200

Example: updates the receipt details

Request

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

Response

Status: 200 OK
200

Register a payment for a receipt

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 in base currency. 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.

linked_payment_id Integer
refresh_journal_entries Boolean

Example: registers payments

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"payment":{"payment_date":"2017-05-23 09:34:47 UTC","price":"300.0"}}' \
  https://moneybird.com/api/v2/123/documents/receipts/190119480114807972/register_payment.json

Response

Status: 200 OK
200

Add attachment to receipt

Example: uploads an attachment

Request

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

Response

Status: 200 OK
200

Top