External sales invoices

cURL Ruby

List all external invoices

GET /external_sales_invoices(.:format)

Returns a paginated list of all sales invoices in the administration.

The filter argument allows you to filter the list of external invoices. Filters are a combination of keys and values, separated by a comma: period:this_year,state:all. The available options for filtering are:

Filter Type Default Description
state String all all, new, open, late, or paid
period String this_year This can either be the description of a period (this_month, prev_month, next_month, this_quarter, prev_quarter, next_quarter, this_year, prev_year, next_year) or a custom period (201301..201302, 20130101..20130131)
contact_id Integer   Select invoices belonging to a certain contact

You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:new|open.

Parameters

Parameter Type Description
filter String

Example: returns all external sales invoices of an administration

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546253630965403",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2024-09-30",
    "state": "new",
    "due_date": null,
    "reference": "Invoice 4",
    "entry_number": 104,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:08.752Z",
    "updated_at": "2024-09-30T07:39:08.752Z",
    "version": 1727681948,
    "details": [

    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  },
  {
    "id": "433546253618382488",
    "administration_id": 123,
    "contact_id": "433546253602653845",
    "contact": {
      "id": "433546253602653845",
      "administration_id": 123,
      "company_name": "Relation 3",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "8316482381073a83f8606cc939e537274dba4ccefafa4c4d44685d6115d2e309",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:08.725Z",
      "updated_at": "2024-09-30T07:39:08.725Z",
      "version": 1727681948,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/fffb96ee11f7a18e374fc69c99a09e58b54de2a4beb9b025e066183b51e2d29a/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 3",
    "entry_number": 103,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:08.741Z",
    "updated_at": "2024-09-30T07:39:08.745Z",
    "version": 1727681948,
    "details": [
      {
        "id": "433546253620479641",
        "administration_id": 123,
        "tax_rate_id": "433546253609993879",
        "ledger_account_id": "433546253606848150",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:08.743Z",
        "updated_at": "2024-09-30T07:39:08.743Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546253609993879",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "433546253591119505",
    "administration_id": 123,
    "contact_id": "433546253572245134",
    "contact": {
      "id": "433546253572245134",
      "administration_id": 123,
      "company_name": "Relation 2",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "1fa570f551776b8e2c31b8a4c241d2236b5eebead347ea2583d8c9eb654683e1",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:08.696Z",
      "updated_at": "2024-09-30T07:39:08.696Z",
      "version": 1727681948,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8397093f3215302f10d3e0a940997e9ad3cae8946441dbef736191995f41b7be/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 2",
    "entry_number": 102,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:08.714Z",
    "updated_at": "2024-09-30T07:39:08.718Z",
    "version": 1727681948,
    "details": [
      {
        "id": "433546253592168082",
        "administration_id": 123,
        "tax_rate_id": "433546253580633744",
        "ledger_account_id": "433546253577488015",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:08.716Z",
        "updated_at": "2024-09-30T07:39:08.716Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546253580633744",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]

Example: returns all invoices filtered on period

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546253835437746",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2024-09-30",
    "state": "new",
    "due_date": null,
    "reference": "Invoice 4",
    "entry_number": 104,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:08.947Z",
    "updated_at": "2024-09-30T07:39:08.947Z",
    "version": 1727681948,
    "details": [

    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  },
  {
    "id": "433546253824951983",
    "administration_id": 123,
    "contact_id": "433546253808174764",
    "contact": {
      "id": "433546253808174764",
      "administration_id": 123,
      "company_name": "Relation 3",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "74be0b93fca8e41671f08bcb302731b8c53cba622bf0e6190d3202e7ee7e7041",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:08.922Z",
      "updated_at": "2024-09-30T07:39:08.922Z",
      "version": 1727681948,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e3cc8264ac715416ccae8730d471f10a76a5e16ec5189aaf94621e9b397f7e75/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 3",
    "entry_number": 103,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:08.938Z",
    "updated_at": "2024-09-30T07:39:08.941Z",
    "version": 1727681948,
    "details": [
      {
        "id": "433546253827049136",
        "administration_id": 123,
        "tax_rate_id": "433546253817611950",
        "ledger_account_id": "433546253814466221",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:08.939Z",
        "updated_at": "2024-09-30T07:39:08.939Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546253817611950",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "433546253796640424",
    "administration_id": 123,
    "contact_id": "433546253779863205",
    "contact": {
      "id": "433546253779863205",
      "administration_id": 123,
      "company_name": "Relation 2",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "bb7706f1afc19593f7895343188bfaea9be49ad1a467ec0c15df080e41b8d7e7",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:08.894Z",
      "updated_at": "2024-09-30T07:39:08.894Z",
      "version": 1727681948,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/dff096dbde8123fcfb9dcda10658a9fa3174cf6c6e26908ef683490998c0c4b2/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 2",
    "entry_number": 102,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:08.911Z",
    "updated_at": "2024-09-30T07:39:08.914Z",
    "version": 1727681948,
    "details": [
      {
        "id": "433546253798737577",
        "administration_id": 123,
        "tax_rate_id": "433546253788251815",
        "ledger_account_id": "433546253785106086",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:08.912Z",
        "updated_at": "2024-09-30T07:39:08.912Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546253788251815",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]

Example: returns all invoices filtered on state

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/external_sales_invoices.json?filter=state%3Aopen

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546254021035718",
    "administration_id": 123,
    "contact_id": "433546254006355651",
    "contact": {
      "id": "433546254006355651",
      "administration_id": 123,
      "company_name": "Relation 3",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "5fe47a82ea79eb212b9dee666bd5f70f624643e44ef6e270346da8e8ae3a0dca",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:09.110Z",
      "updated_at": "2024-09-30T07:39:09.110Z",
      "version": 1727681949,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/bf4053f28fc58dfa304e389d2190c941678a7fbc3698740ed17cf597a3b14983/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 3",
    "entry_number": 103,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:09.125Z",
    "updated_at": "2024-09-30T07:39:09.128Z",
    "version": 1727681949,
    "details": [
      {
        "id": "433546254023132871",
        "administration_id": 123,
        "tax_rate_id": "433546254013695685",
        "ledger_account_id": "433546254010549956",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:09.126Z",
        "updated_at": "2024-09-30T07:39:09.126Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546254013695685",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "433546253993772735",
    "administration_id": 123,
    "contact_id": "433546253978044092",
    "contact": {
      "id": "433546253978044092",
      "administration_id": 123,
      "company_name": "Relation 2",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "e88416ee48d695fc46108f9442aee887801f0c599e9fca3ba8596906403b8480",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:09.083Z",
      "updated_at": "2024-09-30T07:39:09.083Z",
      "version": 1727681949,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/28cccf5c6565a2e717d2ed8278d9547c20f457cb9b530ef9bbbb5b93ab7f5e7f/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 2",
    "entry_number": 102,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:09.099Z",
    "updated_at": "2024-09-30T07:39:09.102Z",
    "version": 1727681949,
    "details": [
      {
        "id": "433546253995869888",
        "administration_id": 123,
        "tax_rate_id": "433546253986432702",
        "ledger_account_id": "433546253983286973",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:09.100Z",
        "updated_at": "2024-09-30T07:39:09.100Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546253986432702",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "433546253965461176",
    "administration_id": 123,
    "contact_id": "433546253947635381",
    "contact": {
      "id": "433546253947635381",
      "administration_id": 123,
      "company_name": "Relation 1",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "5132cff3d215935af4ce982cd3e514336dbe17253f7efd6b6bb94beba9c7c081",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:09.055Z",
      "updated_at": "2024-09-30T07:39:09.055Z",
      "version": 1727681949,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/372a90b67cdb400a1ce4565908942f148411d90772ec57171a23f2e83a1a1a0a/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 1",
    "entry_number": 101,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:09.071Z",
    "updated_at": "2024-09-30T07:39:09.075Z",
    "version": 1727681949,
    "details": [
      {
        "id": "433546253967558329",
        "administration_id": 123,
        "tax_rate_id": "433546253957072567",
        "ledger_account_id": "433546253953926838",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:09.073Z",
        "updated_at": "2024-09-30T07:39:09.073Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546253957072567",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]

Example: returns paginated external sales invoices on page 1

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546254255916768",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2024-09-30",
    "state": "new",
    "due_date": null,
    "reference": "Invoice 4",
    "entry_number": 104,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:09.349Z",
    "updated_at": "2024-09-30T07:39:09.349Z",
    "version": 1727681949,
    "details": [

    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [

    ]
  }
]

Example: returns paginated external sales invoices on page 2

Request

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

Response

        
          
          Status: 200 OK
        
      
[
  {
    "id": "433546254415300340",
    "administration_id": 123,
    "contact_id": "433546254397474545",
    "contact": {
      "id": "433546254397474545",
      "administration_id": 123,
      "company_name": "Relation 3",
      "firstname": null,
      "lastname": null,
      "address1": null,
      "address2": null,
      "zipcode": null,
      "city": null,
      "country": "NL",
      "phone": null,
      "delivery_method": "Email",
      "customer_id": "0bbc5287254a2ac1719bf9befcb9f00ce375183f882c723832fe2ac6e7b73b1b",
      "tax_number": null,
      "chamber_of_commerce": null,
      "bank_account": null,
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": null,
      "email": null,
      "email_ubl": false,
      "send_invoices_to_attention": null,
      "send_invoices_to_email": null,
      "send_estimates_to_attention": null,
      "send_estimates_to_email": null,
      "sepa_active": false,
      "sepa_iban": null,
      "sepa_iban_account_name": null,
      "sepa_bic": null,
      "sepa_mandate_id": null,
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": null,
      "credit_card_reference": null,
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": null,
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2024-09-30T07:39:09.484Z",
      "updated_at": "2024-09-30T07:39:09.484Z",
      "version": 1727681949,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/52a564e378d8a259dfbb69296bc02d3a868b24541afb8f6c9e57cb11da56ae62/all",
      "notes": [

      ],
      "custom_fields": [

      ],
      "contact_people": [

      ],
      "archived": false
    },
    "date": "2024-09-30",
    "state": "open",
    "due_date": null,
    "reference": "Invoice 3",
    "entry_number": 103,
    "origin": null,
    "source": null,
    "source_url": null,
    "currency": "EUR",
    "paid_at": null,
    "created_at": "2024-09-30T07:39:09.500Z",
    "updated_at": "2024-09-30T07:39:09.504Z",
    "version": 1727681949,
    "details": [
      {
        "id": "433546254417397493",
        "administration_id": 123,
        "tax_rate_id": "433546254406911731",
        "ledger_account_id": "433546254402717426",
        "project_id": null,
        "product_id": null,
        "amount": "1 x",
        "amount_decimal": "1.0",
        "description": "Invoice detail description",
        "price": "100.0",
        "period": null,
        "row_order": 0,
        "total_price_excl_tax_with_discount": "100.0",
        "total_price_excl_tax_with_discount_base": "100.0",
        "tax_report_reference": [

        ],
        "mandatory_tax_text": null,
        "created_at": "2024-09-30T07:39:09.502Z",
        "updated_at": "2024-09-30T07:39:09.502Z"
      }
    ],
    "payments": [

    ],
    "total_paid": "0.0",
    "total_unpaid": "121.0",
    "total_unpaid_base": "121.0",
    "prices_are_incl_tax": false,
    "total_price_excl_tax": "100.0",
    "total_price_excl_tax_base": "100.0",
    "total_price_incl_tax": "121.0",
    "total_price_incl_tax_base": "121.0",
    "marked_dubious_on": null,
    "marked_uncollectible_on": null,
    "notes": [

    ],
    "attachments": [

    ],
    "events": [

    ],
    "tax_totals": [
      {
        "tax_rate_id": "433546254406911731",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  }
]

Example: returns an error when too many external sales invoices are requested

Request

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

Response

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

Example: returns an error message if filter contact_id is not found

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/external_sales_invoices.json?filter=contact_id%3A123

Response

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

Get an external sales invoice by id

GET /external_sales_invoices/:id(.:format)

Returns an external sales invoices in the administration.

Example: returns invoice by given id

Request

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "433546254874576683",
  "administration_id": 123,
  "contact_id": "433546254856750888",
  "contact": {
    "id": "433546254856750888",
    "administration_id": 123,
    "company_name": "Relation 1",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "664461b3ecd23cfa7769dafcd5e333691e812c5fc9ccde92283907cf9c95a1f7",
    "tax_number": null,
    "chamber_of_commerce": null,
    "bank_account": null,
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": null,
    "email": null,
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": null,
    "send_estimates_to_attention": null,
    "send_estimates_to_email": null,
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-09-30T07:39:09.921Z",
    "updated_at": "2024-09-30T07:39:09.921Z",
    "version": 1727681949,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/0e44bc63682a3ea5a870f0aec22984691c4ff8344cdd0bffac7eb11270216789/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-09-30",
  "state": "open",
  "due_date": null,
  "reference": "Invoice 1",
  "entry_number": 101,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-09-30T07:39:09.939Z",
  "updated_at": "2024-09-30T07:39:09.943Z",
  "version": 1727681949,
  "details": [
    {
      "id": "433546254876673836",
      "administration_id": 123,
      "tax_rate_id": "433546254866188074",
      "ledger_account_id": "433546254863042345",
      "project_id": null,
      "product_id": null,
      "amount": "1 x",
      "amount_decimal": "1.0",
      "description": "Invoice detail description",
      "price": "100.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "100.0",
      "total_price_excl_tax_with_discount_base": "100.0",
      "tax_report_reference": [

      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:39:09.941Z",
      "updated_at": "2024-09-30T07:39:09.941Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "121.0",
  "total_unpaid_base": "121.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "100.0",
  "total_price_excl_tax_base": "100.0",
  "total_price_incl_tax": "121.0",
  "total_price_incl_tax_base": "121.0",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [

  ],
  "tax_totals": [
    {
      "tax_rate_id": "433546254866188074",
      "taxable_amount": "100.0",
      "taxable_amount_base": "100.0",
      "tax_amount": "21.0",
      "tax_amount_base": "21.0"
    }
  ]
}

Example: returns 404 when invoice does not exist

Request

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

Response

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

Create an external sales invoice

POST /external_sales_invoices(.:format)

Parameters

Parameter Type Description
external_sales_invoice[contact_id] Integer

Should be a valid contact id.
external_sales_invoice[reference] String
external_sales_invoice[date] String
external_sales_invoice[due_date] String
external_sales_invoice[currency] String

ISO three-character currency code, e.g. EUR or USD.
external_sales_invoice[prices_are_incl_tax] Boolean
external_sales_invoice[source] String
external_sales_invoice[source_url] String
external_sales_invoice[details_attributes][id] Integer
external_sales_invoice[details_attributes][description] String
external_sales_invoice[details_attributes][period] String

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.
external_sales_invoice[details_attributes][price] Decimal

Both a decimal and a string ‘10,95’ are accepted.
external_sales_invoice[details_attributes][amount] String
external_sales_invoice[details_attributes][tax_rate_id] Integer

Should be a valid tax rate id.
external_sales_invoice[details_attributes][ledger_account_id] Integer

Should be a valid ledger account id.
external_sales_invoice[details_attributes][project_id] Integer

Should be a valid project id.
external_sales_invoice[details_attributes][row_order] Integer
external_sales_invoice[details_attributes][_destroy] Boolean

Example: create a basic external sales invoice

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"external_sales_invoice":{"reference":"30052","contact_id":433546255117846332,"details_attributes":[{"description":"Rocking Chair","price":129.95}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices

Response

        
          
          Status: 201 Created
        
      
{
  "id": "433546255183906622",
  "administration_id": 123,
  "contact_id": "433546255117846332",
  "contact": {
    "id": "433546255117846332",
    "administration_id": 123,
    "company_name": "Relation 2",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "485af44c484c6ef966d2eaa8c974889aafed1cb05fb755974f13d7baf43aa01a",
    "tax_number": "BE0464995729",
    "chamber_of_commerce": null,
    "bank_account": null,
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": null,
    "email": "invoices@example.com",
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": "invoices@example.com",
    "send_estimates_to_attention": null,
    "send_estimates_to_email": "estimates@example.com",
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": "2024-09-30T07:39:10.167Z",
    "tax_number_valid": true,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-09-30T07:39:10.170Z",
    "updated_at": "2024-09-30T07:39:10.170Z",
    "version": 1727681950,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/887fa17796b69b04972b56b7c39899055c13716b4fe279f7ea3fc48e5c3f5fc5/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-09-30",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-09-30T07:39:10.234Z",
  "updated_at": "2024-09-30T07:39:10.237Z",
  "version": 1727681950,
  "details": [
    {
      "id": "433546255186003775",
      "administration_id": 123,
      "tax_rate_id": "433546158515685191",
      "ledger_account_id": "433546158461159223",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "Rocking Chair",
      "price": "129.95",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "129.95",
      "total_price_excl_tax_with_discount_base": "129.95",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:39:10.235Z",
      "updated_at": "2024-09-30T07:39:10.235Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "157.24",
  "total_unpaid_base": "157.24",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "129.95",
  "total_price_excl_tax_base": "129.95",
  "total_price_incl_tax": "157.24",
  "total_price_incl_tax_base": "157.24",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:39:10.238Z",
      "updated_at": "2024-09-30T07:39:10.238Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "433546158515685191",
      "taxable_amount": "129.95",
      "taxable_amount_base": "129.95",
      "tax_amount": "27.29",
      "tax_amount_base": "27.29"
    }
  ]
}

Example: create an external sales invoice in a foreign currency

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"external_sales_invoice":{"reference":"30052","contact_id":433546255506868055,"currency":"USD","details_attributes":[{"description":"Rocking Chair","price":159.99,"tax_rate_id":433546255501625173}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices

Response

        
          
          Status: 201 Created
        
      
{
  "id": "433546255572928345",
  "administration_id": 123,
  "contact_id": "433546255506868055",
  "contact": {
    "id": "433546255506868055",
    "administration_id": 123,
    "company_name": "Relation 2",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "b67ddea320f3236e10921c45ce92213e223834836afd727d5184f71a0f46e4e0",
    "tax_number": "BE0464995729",
    "chamber_of_commerce": null,
    "bank_account": null,
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": null,
    "email": "invoices@example.com",
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": "invoices@example.com",
    "send_estimates_to_attention": null,
    "send_estimates_to_email": "estimates@example.com",
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": "2024-09-30T07:39:10.539Z",
    "tax_number_valid": true,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-09-30T07:39:10.541Z",
    "updated_at": "2024-09-30T07:39:10.541Z",
    "version": 1727681950,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/539b8c85f24d18b54c79ea97daa838b38d35e7ea01f2facce761b77964a7e636/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-09-30",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "USD",
  "paid_at": null,
  "created_at": "2024-09-30T07:39:10.604Z",
  "updated_at": "2024-09-30T07:39:10.608Z",
  "version": 1727681950,
  "details": [
    {
      "id": "433546255575025498",
      "administration_id": 123,
      "tax_rate_id": "433546255501625173",
      "ledger_account_id": "433546158461159223",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "Rocking Chair",
      "price": "159.99",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "159.99",
      "total_price_excl_tax_with_discount_base": "127.99",
      "tax_report_reference": [
        "NL/3a"
      ],
      "mandatory_tax_text": "Intracommunautaire levering, artikel 138, lid 1, Richtlijn 2006/112",
      "created_at": "2024-09-30T07:39:10.606Z",
      "updated_at": "2024-09-30T07:39:10.606Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "159.99",
  "total_unpaid_base": "127.99",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "159.99",
  "total_price_excl_tax_base": "127.99",
  "total_price_incl_tax": "159.99",
  "total_price_incl_tax_base": "127.99",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:39:10.611Z",
      "updated_at": "2024-09-30T07:39:10.611Z"
    }
  ],
  "tax_totals": [

  ]
}

Create external sales invoice from attachment

POST /external_sales_invoices/attachment(.:format)

Example: creates a new external sales invoice when uploading 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/external_sales_invoices/attachment.json

Response

        
          
          Status: 200 OK
        
      
200

Add attachment to external sales invoice

POST /external_sales_invoices/:id/attachment(.:format)

Example: adds an attachment to an existing external sales invoice

Request

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

Response

        
          
          Status: 200 OK
        
      
200

Update an external sales invoice

PATCH /external_sales_invoices/:id(.:format)

When updating an external sales invoice, provide only the attributes you want to update. The other attributes will not be changed.

Parameters

Parameter Type Description
external_sales_invoice[contact_id] Integer

Should be a valid contact id.
external_sales_invoice[reference] String
external_sales_invoice[date] String
external_sales_invoice[due_date] String
external_sales_invoice[currency] String

ISO three-character currency code, e.g. EUR or USD.
external_sales_invoice[prices_are_incl_tax] Boolean
external_sales_invoice[source] String
external_sales_invoice[source_url] String
external_sales_invoice[details_attributes][id] Integer
external_sales_invoice[details_attributes][description] String
external_sales_invoice[details_attributes][period] String

String with a date range: 20140101..20141231, presets are also allowed: this_month, prev_month, next_month, etc.
external_sales_invoice[details_attributes][price] Decimal

Both a decimal and a string ‘10,95’ are accepted.
external_sales_invoice[details_attributes][amount] String
external_sales_invoice[details_attributes][tax_rate_id] Integer

Should be a valid tax rate id.
external_sales_invoice[details_attributes][ledger_account_id] Integer

Should be a valid ledger account id.
external_sales_invoice[details_attributes][project_id] Integer

Should be a valid project id.
external_sales_invoice[details_attributes][row_order] Integer
external_sales_invoice[details_attributes][_destroy] Boolean

Example: updating the invoice reference

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"external_sales_invoice":{"reference":"30053"}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/433546257748723585

Response

        
          
          Status: 200 OK
        
      
{
  "id": "433546257748723585",
  "administration_id": 123,
  "contact_id": "433546257729849214",
  "contact": {
    "id": "433546257729849214",
    "administration_id": 123,
    "company_name": "Relation 1",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "b7e2d8fe7dc3e6948a718c5da4e1292872e3cfa6ab2d33830faa220b928d18e9",
    "tax_number": null,
    "chamber_of_commerce": null,
    "bank_account": null,
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": null,
    "email": null,
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": null,
    "send_estimates_to_attention": null,
    "send_estimates_to_email": null,
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-09-30T07:39:12.661Z",
    "updated_at": "2024-09-30T07:39:12.661Z",
    "version": 1727681952,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/631df113ae69a82da8eb91d01983e66553079af33b91801553c757e7be162dbb/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-09-30",
  "state": "open",
  "due_date": null,
  "reference": "30053",
  "entry_number": 1,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-09-30T07:39:12.679Z",
  "updated_at": "2024-09-30T07:39:12.751Z",
  "version": 1727681952,
  "details": [
    {
      "id": "433546257749772162",
      "administration_id": 123,
      "tax_rate_id": "433546257739286400",
      "ledger_account_id": "433546257736140671",
      "project_id": null,
      "product_id": null,
      "amount": "1 x",
      "amount_decimal": "1.0",
      "description": "Invoice detail description",
      "price": "100.0",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "100.0",
      "total_price_excl_tax_with_discount_base": "100.0",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:39:12.681Z",
      "updated_at": "2024-09-30T07:39:12.749Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "121.0",
  "total_unpaid_base": "121.0",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "100.0",
  "total_price_excl_tax_base": "100.0",
  "total_price_incl_tax": "121.0",
  "total_price_incl_tax_base": "121.0",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:39:12.752Z",
      "updated_at": "2024-09-30T07:39:12.752Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "433546257739286400",
      "taxable_amount": "100.0",
      "taxable_amount_base": "100.0",
      "tax_amount": "21.0",
      "tax_amount_base": "21.0"
    }
  ]
}

Example: adding and removing an invoice detail

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPATCH \
  -d '{"external_sales_invoice":{"details_attributes":[{"description":"Sofa","price":199.99},{"id":433546257951098763,"_destroy":true}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/433546257947953034

Response

        
          
          Status: 200 OK
        
      
{
  "id": "433546257947953034",
  "administration_id": 123,
  "contact_id": "433546257926981511",
  "contact": {
    "id": "433546257926981511",
    "administration_id": 123,
    "company_name": "Relation 1",
    "firstname": null,
    "lastname": null,
    "address1": null,
    "address2": null,
    "zipcode": null,
    "city": null,
    "country": "NL",
    "phone": null,
    "delivery_method": "Email",
    "customer_id": "9074611a2f58fca812d86a7063d479e3082a5d5a06120379a094e4339470fcf9",
    "tax_number": null,
    "chamber_of_commerce": null,
    "bank_account": null,
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": null,
    "email": null,
    "email_ubl": false,
    "send_invoices_to_attention": null,
    "send_invoices_to_email": null,
    "send_estimates_to_attention": null,
    "send_estimates_to_email": null,
    "sepa_active": false,
    "sepa_iban": null,
    "sepa_iban_account_name": null,
    "sepa_bic": null,
    "sepa_mandate_id": null,
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": null,
    "credit_card_reference": null,
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": null,
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2024-09-30T07:39:12.849Z",
    "updated_at": "2024-09-30T07:39:12.849Z",
    "version": 1727681952,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/93e16d5fcdea62cbee118ea88daca3596422a42706c7dff5ed0e3f466db31851/all",
    "notes": [

    ],
    "custom_fields": [

    ],
    "contact_people": [

    ],
    "archived": false
  },
  "date": "2024-09-30",
  "state": "open",
  "due_date": null,
  "reference": "Invoice 1",
  "entry_number": 1,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2024-09-30T07:39:12.869Z",
  "updated_at": "2024-09-30T07:39:12.968Z",
  "version": 1727681952,
  "details": [
    {
      "id": "433546258048616333",
      "administration_id": 123,
      "tax_rate_id": "433546158515685191",
      "ledger_account_id": "433546158461159223",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "Sofa",
      "price": "199.99",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "199.99",
      "total_price_excl_tax_with_discount_base": "199.99",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2024-09-30T07:39:12.966Z",
      "updated_at": "2024-09-30T07:39:12.966Z"
    }
  ],
  "payments": [

  ],
  "total_paid": "0.0",
  "total_unpaid": "241.99",
  "total_unpaid_base": "241.99",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "199.99",
  "total_price_excl_tax_base": "199.99",
  "total_price_incl_tax": "241.99",
  "total_price_incl_tax_base": "241.99",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "notes": [

  ],
  "attachments": [

  ],
  "events": [
    {
      "administration_id": 123,
      "user_id": 1727681857838,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {
      },
      "created_at": "2024-09-30T07:39:12.970Z",
      "updated_at": "2024-09-30T07:39:12.970Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "433546158515685191",
      "taxable_amount": "199.99",
      "taxable_amount_base": "199.99",
      "tax_amount": "42.0",
      "tax_amount_base": "42.0"
    }
  ]
}

Delete an external sales invoice

DELETE /external_sales_invoices/:id(.:format)

Example: deletes given invoice

Request

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

Response

        
          
          Status: 204 No Content

Mark as dubious

PATCH /external_sales_invoices/:id/mark_as_dubious(.:format)

This endpoint marks an external sales invoice as dubious.

Parameters

Parameter Type Description
dubious_date Date

Mark as uncollectible

PATCH /external_sales_invoices/:id/mark_as_uncollectible(.:format)

This endpoint marks an external sales invoice as uncollectible.

Parameters

Parameter Type Description
uncollectible_date Date
book_method String

Can be revenue.

Adds note to entity

POST /external_sales_invoices/:external_sales_invoice_id/notes(.:format)

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":433546259224070075,"todo":true}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/433546259212535737/notes.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "433546259277547453",
  "administration_id": 123,
  "entity_id": "433546259212535737",
  "entity_type": "ExternalSalesInvoice",
  "user_id": 1727681857838,
  "assignee_id": "433546259224070075",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {
  },
  "created_at": "2024-09-30T07:39:14.137Z",
  "updated_at": "2024-09-30T07:39:14.137Z"
}

Destroys note from entity

DELETE /external_sales_invoices/:external_sales_invoice_id/notes/:id(.:format)

Example: destroy a note

Request

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

Response

        
          
          Status: 204 No Content

Create a payment

POST /external_sales_invoices/:external_sales_invoice_id/payments(.:format)

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: create a payment

Request

curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XPOST \
  -d '{"payment":{"payment_date":"2024-09-30 07:39:14 UTC","price":"121.0"}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/433546259464193998/payments.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "433546259519768528",
  "administration_id": 123,
  "invoice_type": "ExternalSalesInvoice",
  "invoice_id": "433546259464193998",
  "financial_account_id": null,
  "user_id": 1727681857838,
  "payment_transaction_id": null,
  "transaction_identifier": null,
  "price": "121.0",
  "price_base": "121.0",
  "payment_date": "2024-09-30",
  "credit_invoice_id": null,
  "financial_mutation_id": null,
  "ledger_account_id": "433546158492616512",
  "linked_payment_id": null,
  "manual_payment_action": null,
  "created_at": "2024-09-30T07:39:14.368Z",
  "updated_at": "2024-09-30T07:39:14.368Z"
}

Delete a payment

DELETE /external_sales_invoices/:external_sales_invoice_id/payments/:id(.:format)

Example: destroy a payment

Request

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

Response

        
          
          Status: 204 No Content

Download attachment

GET /external_sales_invoices/:external_sales_invoice_id/attachments/:id/download(.:format)

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

Delete an attachment

DELETE /external_sales_invoices/:external_sales_invoice_id/attachments/:id(.:format)

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/external_sales_invoices/433546259767232483/attachments/433546259860555749.json

Response

        
          
          Status: 204 No Content