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
per_page Integer

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": "446241636268115807",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.141Z",
    "updated_at": "2025-02-17T10:46:49.141Z",
    "version": 1739789209,
    "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": "446241636257630044",
    "administration_id": 123,
    "contact_id": "446241636246095706",
    "contact": {
      "id": "446241636246095706",
      "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": "be87ed4253644b365d8d0f5d48db6688356bb015a5f003fc64e3437fca35150b",
      "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": "2025-02-17T10:46:49.119Z",
      "updated_at": "2025-02-17T10:46:49.119Z",
      "version": 1739789209,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b1ca1b6794317a2be3fdc9fe5e645509d7a48277cb71f145e1026931d14b47cb/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.131Z",
    "updated_at": "2025-02-17T10:46:49.134Z",
    "version": 1739789209,
    "details": [
      {
        "id": "446241636259727197",
        "administration_id": 123,
        "tax_rate_id": "446241636241901400",
        "ledger_account_id": "446241636250290011",
        "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": "2025-02-17T10:46:49.132Z",
        "updated_at": "2025-02-17T10:46:49.132Z",
        "time_entries": []
      }
    ],
    "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": "446241636241901400",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "446241636235609942",
    "administration_id": 123,
    "contact_id": "446241636225124180",
    "contact": {
      "id": "446241636225124180",
      "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": "a8d01a510ff8766249ce614f7956c523039cd0242669595f31f42e8aeadec6cd",
      "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": "2025-02-17T10:46:49.100Z",
      "updated_at": "2025-02-17T10:46:49.100Z",
      "version": 1739789209,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b3c2996c1ce6086a901d16809e942bf0caf7f7e41e16f5f86bfcdd73c4bb1bb4/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.110Z",
    "updated_at": "2025-02-17T10:46:49.113Z",
    "version": 1739789209,
    "details": [
      {
        "id": "446241636237707095",
        "administration_id": 123,
        "tax_rate_id": "446241636220929874",
        "ledger_account_id": "446241636229318485",
        "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": "2025-02-17T10:46:49.112Z",
        "updated_at": "2025-02-17T10:46:49.112Z",
        "time_entries": []
      }
    ],
    "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": "446241636220929874",
        "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": "446241636498802547",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.360Z",
    "updated_at": "2025-02-17T10:46:49.360Z",
    "version": 1739789209,
    "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": "446241636482025328",
    "administration_id": 123,
    "contact_id": "446241636465248110",
    "contact": {
      "id": "446241636465248110",
      "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": "9e3c283f3327739ed9f82ff01db6893ea32816c01a9a37fb8d2716551fcfc334",
      "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": "2025-02-17T10:46:49.328Z",
      "updated_at": "2025-02-17T10:46:49.328Z",
      "version": 1739789209,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/06d0971409aa4cebd657b9f7fdccb6163ef96d8601604c0e7fd76e0d270bca57/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.345Z",
    "updated_at": "2025-02-17T10:46:49.349Z",
    "version": 1739789209,
    "details": [
      {
        "id": "446241636484122481",
        "administration_id": 123,
        "tax_rate_id": "446241636457908076",
        "ledger_account_id": "446241636473636719",
        "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": "2025-02-17T10:46:49.347Z",
        "updated_at": "2025-02-17T10:46:49.347Z",
        "time_entries": []
      }
    ],
    "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": "446241636457908076",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "446241636448470890",
    "administration_id": 123,
    "contact_id": "446241636429596520",
    "contact": {
      "id": "446241636429596520",
      "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": "bbd977814d964c3a82d6363c790dadc88a0f513596b1e1b888fd3b8ba480f139",
      "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": "2025-02-17T10:46:49.294Z",
      "updated_at": "2025-02-17T10:46:49.294Z",
      "version": 1739789209,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/442238839335cae19c5ce86c5b4a2ce12d25e6fd36681036f60b78cf37d0133f/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.312Z",
    "updated_at": "2025-02-17T10:46:49.317Z",
    "version": 1739789209,
    "details": [
      {
        "id": "446241636450568043",
        "administration_id": 123,
        "tax_rate_id": "446241636423305062",
        "ledger_account_id": "446241636439033705",
        "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": "2025-02-17T10:46:49.315Z",
        "updated_at": "2025-02-17T10:46:49.315Z",
        "time_entries": []
      }
    ],
    "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": "446241636423305062",
        "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": "446241636878387076",
    "administration_id": 123,
    "contact_id": "446241636862658434",
    "contact": {
      "id": "446241636862658434",
      "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": "8682c229e20fddcc36abf8e7c36423e33c52b7244950e6ab3a27d6d3aa947ae1",
      "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": "2025-02-17T10:46:49.707Z",
      "updated_at": "2025-02-17T10:46:49.707Z",
      "version": 1739789209,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/a4323fce73bd8f57e5ed7536cb5c7389fd0af5fb0730763abcf634c1923087e6/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.722Z",
    "updated_at": "2025-02-17T10:46:49.727Z",
    "version": 1739789209,
    "details": [
      {
        "id": "446241636880484229",
        "administration_id": 123,
        "tax_rate_id": "446241636857415552",
        "ledger_account_id": "446241636869998467",
        "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": "2025-02-17T10:46:49.725Z",
        "updated_at": "2025-02-17T10:46:49.725Z",
        "time_entries": []
      }
    ],
    "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": "446241636857415552",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "446241636846929790",
    "administration_id": 123,
    "contact_id": "446241636829103996",
    "contact": {
      "id": "446241636829103996",
      "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": "485ad90980c4061a0bede785ece15ea019346bf177c436559bed7de958329e69",
      "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": "2025-02-17T10:46:49.675Z",
      "updated_at": "2025-02-17T10:46:49.675Z",
      "version": 1739789209,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c52b9dfbb02748b20b06d5ec88227e3de93667cba13ab41f1bf03caaf2200a96/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.692Z",
    "updated_at": "2025-02-17T10:46:49.699Z",
    "version": 1739789209,
    "details": [
      {
        "id": "446241636849026943",
        "administration_id": 123,
        "tax_rate_id": "446241636822812538",
        "ledger_account_id": "446241636837492605",
        "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": "2025-02-17T10:46:49.694Z",
        "updated_at": "2025-02-17T10:46:49.694Z",
        "time_entries": []
      }
    ],
    "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": "446241636822812538",
        "taxable_amount": "100.0",
        "taxable_amount_base": "100.0",
        "tax_amount": "21.0",
        "tax_amount_base": "21.0"
      }
    ]
  },
  {
    "id": "446241636808132472",
    "administration_id": 123,
    "contact_id": "446241636776675190",
    "contact": {
      "id": "446241636776675190",
      "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": "e6d8c7377e600b6003a26bfa318a699d6725bf29bd0e2aaac8e7415d5926fd27",
      "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": "2025-02-17T10:46:49.625Z",
      "updated_at": "2025-02-17T10:46:49.625Z",
      "version": 1739789209,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/87cdef26375735d1b705bd8ac251b03b5291f2922b5a4e3555453677285b31f5/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.655Z",
    "updated_at": "2025-02-17T10:46:49.662Z",
    "version": 1739789209,
    "details": [
      {
        "id": "446241636812326777",
        "administration_id": 123,
        "tax_rate_id": "446241636769335156",
        "ledger_account_id": "446241636795549559",
        "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": "2025-02-17T10:46:49.658Z",
        "updated_at": "2025-02-17T10:46:49.658Z",
        "time_entries": []
      }
    ],
    "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": "446241636769335156",
        "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": "446241637095442331",
    "administration_id": 123,
    "contact_id": null,
    "contact": null,
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:49.930Z",
    "updated_at": "2025-02-17T10:46:49.930Z",
    "version": 1739789209,
    "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": "446241637275797420",
    "administration_id": 123,
    "contact_id": "446241637264263082",
    "contact": {
      "id": "446241637264263082",
      "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": "1a2ca3927cb297759df3504621f70bd0baba2d92ae8f7890cd0f4e9f7446f9f0",
      "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": "2025-02-17T10:46:50.089Z",
      "updated_at": "2025-02-17T10:46:50.089Z",
      "version": 1739789210,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/72f5bd01edae13f09a619060e44e41349536148fe00c2f2ce948271591821d69/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "date": "2025-02-17",
    "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": "2025-02-17T10:46:50.101Z",
    "updated_at": "2025-02-17T10:46:50.105Z",
    "version": 1739789210,
    "details": [
      {
        "id": "446241637276845997",
        "administration_id": 123,
        "tax_rate_id": "446241637257971624",
        "ledger_account_id": "446241637268457387",
        "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": "2025-02-17T10:46:50.103Z",
        "updated_at": "2025-02-17T10:46:50.103Z",
        "time_entries": []
      }
    ],
    "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": "446241637257971624",
        "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 does not have a valid value"
}

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

Response

        
          
          Status: 200 OK
        
      
{
  "id": "446241637741365212",
  "administration_id": 123,
  "contact_id": "446241637720393690",
  "contact": {
    "id": "446241637720393690",
    "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": "aac5e00bee942bf02a11bf0b6cf9287d18ef062f65fd8911d7b941db351cb98b",
    "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": "2025-02-17T10:46:50.525Z",
    "updated_at": "2025-02-17T10:46:50.525Z",
    "version": 1739789210,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/cf248ae63772b5dbe11fd135e662da6d415b9502e0bfc9b2c706fd43fb8d60f3/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "date": "2025-02-17",
  "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": "2025-02-17T10:46:50.545Z",
  "updated_at": "2025-02-17T10:46:50.550Z",
  "version": 1739789210,
  "details": [
    {
      "id": "446241637743462365",
      "administration_id": 123,
      "tax_rate_id": "446241637713053656",
      "ledger_account_id": "446241637727733723",
      "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": "2025-02-17T10:46:50.548Z",
      "updated_at": "2025-02-17T10:46:50.548Z",
      "time_entries": []
    }
  ],
  "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": "446241637713053656",
      "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":446241638023432171,"details_attributes":[{"description":"Rocking Chair","price":129.95}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices

Response

        
          
          Status: 201 Created
        
      
{
  "id": "446241638097881069",
  "administration_id": 123,
  "contact_id": "446241638023432171",
  "contact": {
    "id": "446241638023432171",
    "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": "75349cc9267e1a45df96cb39fb7a4d410b07befe71124b9ca8ef14e642d2794a",
    "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": "2025-02-17T10:46:50.810Z",
    "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": "2025-02-17T10:46:50.814Z",
    "updated_at": "2025-02-17T10:46:50.814Z",
    "version": 1739789210,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c266e4e5936dc473c522be0e75c6a45eb25e2a532cb3f363e644222746761ee7/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "date": "2025-02-17",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2025-02-17T10:46:50.886Z",
  "updated_at": "2025-02-17T10:46:50.890Z",
  "version": 1739789210,
  "details": [
    {
      "id": "446241638099978222",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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": "2025-02-17T10:46:50.887Z",
      "updated_at": "2025-02-17T10:46:50.887Z",
      "time_entries": []
    }
  ],
  "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": 17397890963220,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:46:50.891Z",
      "updated_at": "2025-02-17T10:46:50.891Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "446241518957626516",
      "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":446241638419792906,"currency":"USD","details_attributes":[{"description":"Rocking Chair","price":159.99,"tax_rate_id":446241638413501448}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices

Response

        
          
          Status: 201 Created
        
      
{
  "id": "446241638500533260",
  "administration_id": 123,
  "contact_id": "446241638419792906",
  "contact": {
    "id": "446241638419792906",
    "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": "4e25d7ae08a005e35c4bd127cdfeece35acc8e4a96bc0d516fbe9d21b5cccbcc",
    "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": "2025-02-17T10:46:51.190Z",
    "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": "2025-02-17T10:46:51.192Z",
    "updated_at": "2025-02-17T10:46:51.192Z",
    "version": 1739789211,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/27cc9e373b8d8991c1cedff819f80a4201686ef0c19571b138898b95cceeda48/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "date": "2025-02-17",
  "state": "open",
  "due_date": null,
  "reference": "30052",
  "entry_number": 1,
  "origin": "api",
  "source": null,
  "source_url": null,
  "currency": "USD",
  "paid_at": null,
  "created_at": "2025-02-17T10:46:51.269Z",
  "updated_at": "2025-02-17T10:46:51.275Z",
  "version": 1739789211,
  "details": [
    {
      "id": "446241638503678989",
      "administration_id": 123,
      "tax_rate_id": "446241638413501448",
      "ledger_account_id": "446241518911489156",
      "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": "2025-02-17T10:46:51.272Z",
      "updated_at": "2025-02-17T10:46:51.272Z",
      "time_entries": []
    }
  ],
  "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": 17397890963220,
      "action": "external_sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:46:51.277Z",
      "updated_at": "2025-02-17T10:46:51.277Z"
    }
  ],
  "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/446241648458859563/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/446241648968467506

Response

        
          
          Status: 200 OK
        
      
{
  "id": "446241648968467506",
  "administration_id": 123,
  "contact_id": "446241648953787440",
  "contact": {
    "id": "446241648953787440",
    "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": "5b36f53c170e0a7882a55b986bc6c9c318ec4fb9a15cf65447d4b1cd7aec1892",
    "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": "2025-02-17T10:47:01.238Z",
    "updated_at": "2025-02-17T10:47:01.238Z",
    "version": 1739789221,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/572dc2322fac954f074cd9f99832b6a6e26039445202b924b56305494c1d18e1/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "date": "2025-02-17",
  "state": "open",
  "due_date": null,
  "reference": "30053",
  "entry_number": 1,
  "origin": null,
  "source": null,
  "source_url": null,
  "currency": "EUR",
  "paid_at": null,
  "created_at": "2025-02-17T10:47:01.252Z",
  "updated_at": "2025-02-17T10:47:01.324Z",
  "version": 1739789221,
  "details": [
    {
      "id": "446241648969516083",
      "administration_id": 123,
      "tax_rate_id": "446241648948544558",
      "ledger_account_id": "446241648961127473",
      "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": "2025-02-17T10:47:01.254Z",
      "updated_at": "2025-02-17T10:47:01.323Z",
      "time_entries": []
    }
  ],
  "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": 17397890963220,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:47:01.326Z",
      "updated_at": "2025-02-17T10:47:01.326Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "446241648948544558",
      "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":446241649211737150,"_destroy":true}]}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/446241649209639997

Response

        
          
          Status: 200 OK
        
      
{
  "id": "446241649209639997",
  "administration_id": 123,
  "contact_id": "446241649196008507",
  "contact": {
    "id": "446241649196008507",
    "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": "e32ec52631ed98f235cb6e4d99e44a99c932a7550f09f153b8821915fa544797",
    "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": "2025-02-17T10:47:01.469Z",
    "updated_at": "2025-02-17T10:47:01.469Z",
    "version": 1739789221,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/3129e25296435392a06322343a290b330059a1b3708d9d48b3a2afed99d75d18/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "date": "2025-02-17",
  "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": "2025-02-17T10:47:01.483Z",
  "updated_at": "2025-02-17T10:47:01.577Z",
  "version": 1739789221,
  "details": [
    {
      "id": "446241649307157568",
      "administration_id": 123,
      "tax_rate_id": "446241518957626516",
      "ledger_account_id": "446241518911489156",
      "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": "2025-02-17T10:47:01.575Z",
      "updated_at": "2025-02-17T10:47:01.575Z",
      "time_entries": []
    }
  ],
  "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": 17397890963220,
      "action": "external_sales_invoice_updated",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-02-17T10:47:01.579Z",
      "updated_at": "2025-02-17T10:47:01.579Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "446241518957626516",
      "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/446241649385800777.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":446241650377753720,"todo":true}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/446241650369365110/notes.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "446241650438571130",
  "administration_id": 123,
  "entity_id": "446241650369365110",
  "entity_type": "ExternalSalesInvoice",
  "user_id": 17397890963220,
  "assignee_id": "446241650377753720",
  "todo": true,
  "note": "Text of the note",
  "completed_at": null,
  "completed_by_id": null,
  "todo_type": null,
  "data": {},
  "created_at": "2025-02-17T10:47:02.653Z",
  "updated_at": "2025-02-17T10:47:02.653Z"
}

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/446241650504631424/notes/446241650515117186.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":"2025-02-17 10:47:02 UTC","price":"121.0"}}' \
  https://moneybird.com/api/v2/123/external_sales_invoices/446241650670306441/payments.json

Response

        
          
          Status: 201 Created
        
      
{
  "id": "446241650743706763",
  "administration_id": 123,
  "invoice_type": "ExternalSalesInvoice",
  "invoice_id": "446241650670306441",
  "financial_account_id": null,
  "user_id": 17397890963220,
  "payment_transaction_id": null,
  "transaction_identifier": null,
  "price": "121.0",
  "price_base": "121.0",
  "payment_date": "2025-02-17",
  "credit_invoice_id": null,
  "financial_mutation_id": null,
  "ledger_account_id": "446241518935606413",
  "linked_payment_id": null,
  "manual_payment_action": null,
  "created_at": "2025-02-17T10:47:02.945Z",
  "updated_at": "2025-02-17T10:47:02.945Z"
}

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/446241650839127186/payments/446241650853807252.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/446241651025773724/attachments/446241651135874206.json

Response

        
          
          Status: 204 No Content