Sales invoices
List all invoices
Returns a paginated list of all sales invoices in the administration.
The filter argument allows you to filter the list of 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, draft, open, scheduled, pending_payment, late, reminded, paid or uncollectible |
| 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) |
| reference | String |
Select invoices with a certain reference | |
| contact_id | Integer |
Select invoices belonging to a certain contact | |
| recurring_sales_invoice_id | Integer |
Select invoices created by a certain recurring invoice | |
| workflow_id | Integer |
Select invoices that use a certain workflow | |
| created_after | String |
Select invoices created after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone | |
| updated_after | String |
Select invoices updated after the given time (exclusive). ISO 8601 formatted string. The time to compare with is in UTC timezone |
You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:draft|scheduled. This also holds for the reference.
Parameters
| Parameter | Type | Description |
|---|---|---|
filter |
String |
Example: returns all invoices of an administration
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices.json?
Response
Status: 200 OK
[
{
"id": "416087643568211129",
"administration_id": 123,
"contact_id": "416087642884539559",
"contact": {
"id": "416087642884539559",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:00.113Z",
"updated_at": "2024-03-21T14:42:00.113Z",
"version": 1711032120,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0003",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF300000000000000PPU26FPK",
"short_payment_reference": "RF30PPU26FPK",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:00.762Z",
"updated_at": "2024-03-21T14:42:00.950Z",
"public_view_code": "601285",
"public_view_code_expires_at": "2024-06-21T14:42:00.866Z",
"version": 1711032120,
"details": [
{
"id": "416087643572405434",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:00.768Z",
"updated_at": "2024-03-21T14:42:00.947Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/0ca31d65b31501a1efc204a7fd77118fee4d7eb5c9438f69673389bdb29bd284/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/0ca31d65b31501a1efc204a7fd77118fee4d7eb5c9438f69673389bdb29bd284/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:00.775Z",
"updated_at": "2024-03-21T14:42:00.775Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:00.893Z",
"updated_at": "2024-03-21T14:42:00.893Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:00.975Z",
"updated_at": "2024-03-21T14:42:00.975Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087643303969971",
"administration_id": 123,
"contact_id": "416087642884539559",
"contact": {
"id": "416087642884539559",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:00.113Z",
"updated_at": "2024-03-21T14:42:00.113Z",
"version": 1711032120,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0002",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF570000000000000ZPF9CY2K",
"short_payment_reference": "RF57ZPF9CY2K",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:00.512Z",
"updated_at": "2024-03-21T14:42:00.655Z",
"public_view_code": "436461",
"public_view_code_expires_at": "2024-06-21T14:42:00.604Z",
"version": 1711032120,
"details": [
{
"id": "416087643307115700",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:00.516Z",
"updated_at": "2024-03-21T14:42:00.653Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/e5a02a8c5db62511e6cb8a54020b5fa63d79a3ff79e73ee699d6955b89a5508e/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/e5a02a8c5db62511e6cb8a54020b5fa63d79a3ff79e73ee699d6955b89a5508e/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:00.523Z",
"updated_at": "2024-03-21T14:42:00.523Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:00.622Z",
"updated_at": "2024-03-21T14:42:00.622Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:00.673Z",
"updated_at": "2024-03-21T14:42:00.673Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087642983105708",
"administration_id": 123,
"contact_id": "416087642884539559",
"contact": {
"id": "416087642884539559",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:00.113Z",
"updated_at": "2024-03-21T14:42:00.113Z",
"version": 1711032120,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087642909705386",
"contact_person": {
"id": null,
"contact_id": "416087642884539559",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:00.136Z",
"updated_at": "2024-03-21T14:42:00.136Z",
"version": 1711032120
},
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF190000000000000JVU9R6UC",
"short_payment_reference": "RF19JVU9R6UC",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:00.206Z",
"updated_at": "2024-03-21T14:42:00.350Z",
"public_view_code": "690054",
"public_view_code_expires_at": "2024-06-21T14:42:00.291Z",
"version": 1711032120,
"details": [
{
"id": "416087642987300013",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": "20240301..20240331",
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:00.211Z",
"updated_at": "2024-03-21T14:42:00.348Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/6f6429ef7b8d315e008bb82aa37989152e787e1d9118c32568a3c009beb74de6/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/6f6429ef7b8d315e008bb82aa37989152e787e1d9118c32568a3c009beb74de6/b8322ed786a6b1aebda6f8414ba3461e08455a96cd6b55e8a66283c6d473a4e1/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:00.216Z",
"updated_at": "2024-03-21T14:42:00.216Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:00.313Z",
"updated_at": "2024-03-21T14:42:00.313Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:00.378Z",
"updated_at": "2024-03-21T14:42:00.378Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.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/sales_invoices.json?filter=period%3Athis_month
Response
Status: 200 OK
[
{
"id": "416087644520318163",
"administration_id": 123,
"contact_id": "416087643977155777",
"contact": {
"id": "416087643977155777",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:01.154Z",
"updated_at": "2024-03-21T14:42:01.154Z",
"version": 1711032121,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0003",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF450000000000000HPW42VER",
"short_payment_reference": "RF45HPW42VER",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:01.672Z",
"updated_at": "2024-03-21T14:42:01.785Z",
"public_view_code": "271275",
"public_view_code_expires_at": "2024-06-21T14:42:01.736Z",
"version": 1711032121,
"details": [
{
"id": "416087644523463892",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:01.675Z",
"updated_at": "2024-03-21T14:42:01.783Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/e326453c608a31abbd1ab4d96c2f6b66aa9a50ad19aaf06272058eab85919f80/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/e326453c608a31abbd1ab4d96c2f6b66aa9a50ad19aaf06272058eab85919f80/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:01.679Z",
"updated_at": "2024-03-21T14:42:01.679Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:01.754Z",
"updated_at": "2024-03-21T14:42:01.754Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:01.804Z",
"updated_at": "2024-03-21T14:42:01.804Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087644298020045",
"administration_id": 123,
"contact_id": "416087643977155777",
"contact": {
"id": "416087643977155777",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:01.154Z",
"updated_at": "2024-03-21T14:42:01.154Z",
"version": 1711032121,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0002",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF960000000000000WA2SDJDS",
"short_payment_reference": "RF96WA2SDJDS",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:01.460Z",
"updated_at": "2024-03-21T14:42:01.582Z",
"public_view_code": "031739",
"public_view_code_expires_at": "2024-06-21T14:42:01.524Z",
"version": 1711032121,
"details": [
{
"id": "416087644300117198",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:01.463Z",
"updated_at": "2024-03-21T14:42:01.580Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/698dcfd3c694fa7d360bacc8962392d939f41de9556c09d54e533634ba2f9782/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/698dcfd3c694fa7d360bacc8962392d939f41de9556c09d54e533634ba2f9782/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:01.466Z",
"updated_at": "2024-03-21T14:42:01.466Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:01.543Z",
"updated_at": "2024-03-21T14:42:01.543Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:01.601Z",
"updated_at": "2024-03-21T14:42:01.601Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087644052653254",
"administration_id": 123,
"contact_id": "416087643977155777",
"contact": {
"id": "416087643977155777",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:01.154Z",
"updated_at": "2024-03-21T14:42:01.154Z",
"version": 1711032121,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087643990787268",
"contact_person": {
"id": null,
"contact_id": "416087643977155777",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:01.167Z",
"updated_at": "2024-03-21T14:42:01.167Z",
"version": 1711032121
},
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF860000000000000Z69235Z6",
"short_payment_reference": "RF86Z69235Z6",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:01.226Z",
"updated_at": "2024-03-21T14:42:01.376Z",
"public_view_code": "247321",
"public_view_code_expires_at": "2024-06-21T14:42:01.299Z",
"version": 1711032121,
"details": [
{
"id": "416087644055798983",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": "20240301..20240331",
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:01.229Z",
"updated_at": "2024-03-21T14:42:01.374Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/ffb11a5ded372c500245e90da40bde3175c3f41a1169824b6f682fac6a0b3c8e/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/ffb11a5ded372c500245e90da40bde3175c3f41a1169824b6f682fac6a0b3c8e/c0548ae9c817cb0ac7e97616fce109c8311b692653c5d82d52943c9f007a53e6/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:01.233Z",
"updated_at": "2024-03-21T14:42:01.233Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:01.328Z",
"updated_at": "2024-03-21T14:42:01.328Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:01.396Z",
"updated_at": "2024-03-21T14:42:01.396Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.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/sales_invoices.json?filter=state%3Alate
Response
Status: 200 OK
[
]
Example: returns paginated sales invoices on page 1
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices.json?per_page=1
Response
Status: 200 OK
[
{
"id": "416087646115202311",
"administration_id": 123,
"contact_id": "416087645613982965",
"contact": {
"id": "416087645613982965",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:02.715Z",
"updated_at": "2024-03-21T14:42:02.715Z",
"version": 1711032122,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ff04fbf2df202bd2215cf58bb28d40eed6ce91e3fde403aa2141739af6c0d6f0/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0003",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF9300000000000004KFYVDRY",
"short_payment_reference": "RF934KFYVDRY",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:03.193Z",
"updated_at": "2024-03-21T14:42:03.346Z",
"public_view_code": "961502",
"public_view_code_expires_at": "2024-06-21T14:42:03.288Z",
"version": 1711032123,
"details": [
{
"id": "416087646117299464",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:03.196Z",
"updated_at": "2024-03-21T14:42:03.344Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/d9972ed9cab316347e5fa0c01797fbadfc94f79e39e98935eafbdc7fcf2c3f00/ff04fbf2df202bd2215cf58bb28d40eed6ce91e3fde403aa2141739af6c0d6f0",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/d9972ed9cab316347e5fa0c01797fbadfc94f79e39e98935eafbdc7fcf2c3f00/ff04fbf2df202bd2215cf58bb28d40eed6ce91e3fde403aa2141739af6c0d6f0/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:03.202Z",
"updated_at": "2024-03-21T14:42:03.202Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:03.307Z",
"updated_at": "2024-03-21T14:42:03.307Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:03.375Z",
"updated_at": "2024-03-21T14:42:03.375Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns paginated sales invoices on page 2
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices.json?page=2&per_page=1
Response
Status: 200 OK
[
{
"id": "416087646734910747",
"administration_id": 123,
"contact_id": "416087646467523855",
"contact": {
"id": "416087646467523855",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:03.529Z",
"updated_at": "2024-03-21T14:42:03.529Z",
"version": 1711032123,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/4cd189320fe92a32e50fd5a8f6ab46cf701de3f616d01ad181ea8d468922cd7a/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0002",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF660000000000000MNUH3PV4",
"short_payment_reference": "RF66MNUH3PV4",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:03.785Z",
"updated_at": "2024-03-21T14:42:03.894Z",
"public_view_code": "776398",
"public_view_code_expires_at": "2024-06-21T14:42:03.845Z",
"version": 1711032123,
"details": [
{
"id": "416087646738056476",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:03.787Z",
"updated_at": "2024-03-21T14:42:03.892Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/268d05bdedf186966a7308ec3f2790abb2b91effa37fd5020077e8b4efeb95a7/4cd189320fe92a32e50fd5a8f6ab46cf701de3f616d01ad181ea8d468922cd7a",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/268d05bdedf186966a7308ec3f2790abb2b91effa37fd5020077e8b4efeb95a7/4cd189320fe92a32e50fd5a8f6ab46cf701de3f616d01ad181ea8d468922cd7a/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:03.791Z",
"updated_at": "2024-03-21T14:42:03.791Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:03.862Z",
"updated_at": "2024-03-21T14:42:03.862Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:03.910Z",
"updated_at": "2024-03-21T14:42:03.910Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns an error when too many sales invoices are requested
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/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/sales_invoices.json?filter=contact_id%3A123
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"contact_id": "not_found"
}
}
Example: returns all sales invoices created after given datetime
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices.json?filter=created_after%3A2024-03-20+14%3A42%3A06+UTC
Response
Status: 200 OK
[
{
"id": "416087649529365871",
"administration_id": 123,
"contact_id": "416087648985154909",
"contact": {
"id": "416087648985154909",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:05.930Z",
"updated_at": "2024-03-21T14:42:05.930Z",
"version": 1711032125,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0003",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF780000000000000GJ4ZJ6K2",
"short_payment_reference": "RF78GJ4ZJ6K2",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:06.449Z",
"updated_at": "2024-03-21T14:42:06.568Z",
"public_view_code": "941159",
"public_view_code_expires_at": "2024-06-21T14:42:06.513Z",
"version": 1711032126,
"details": [
{
"id": "416087649531463024",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:06.452Z",
"updated_at": "2024-03-21T14:42:06.566Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/25db8758c8f3bcec13687baf906f6f02e01964d23b001dc70d44324256a70fb3/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/25db8758c8f3bcec13687baf906f6f02e01964d23b001dc70d44324256a70fb3/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:06.455Z",
"updated_at": "2024-03-21T14:42:06.455Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:06.538Z",
"updated_at": "2024-03-21T14:42:06.538Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:06.585Z",
"updated_at": "2024-03-21T14:42:06.585Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087649324893545",
"administration_id": 123,
"contact_id": "416087648985154909",
"contact": {
"id": "416087648985154909",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:05.930Z",
"updated_at": "2024-03-21T14:42:05.930Z",
"version": 1711032125,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0002",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF480000000000000U5VDZPPQ",
"short_payment_reference": "RF48U5VDZPPQ",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:06.253Z",
"updated_at": "2024-03-21T14:42:06.367Z",
"public_view_code": "197463",
"public_view_code_expires_at": "2024-06-21T14:42:06.318Z",
"version": 1711032126,
"details": [
{
"id": "416087649326990698",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:06.257Z",
"updated_at": "2024-03-21T14:42:06.365Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/ee464179f9207645ca71a16b7d1e263e00b413d47d5b993e00f32a6e13e8babc/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/ee464179f9207645ca71a16b7d1e263e00b413d47d5b993e00f32a6e13e8babc/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:06.260Z",
"updated_at": "2024-03-21T14:42:06.260Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:06.336Z",
"updated_at": "2024-03-21T14:42:06.336Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:06.385Z",
"updated_at": "2024-03-21T14:42:06.385Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087649086866786",
"administration_id": 123,
"contact_id": "416087648985154909",
"contact": {
"id": "416087648985154909",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:05.930Z",
"updated_at": "2024-03-21T14:42:05.930Z",
"version": 1711032125,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087649022903648",
"contact_person": {
"id": null,
"contact_id": "416087648985154909",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:05.966Z",
"updated_at": "2024-03-21T14:42:05.966Z",
"version": 1711032125
},
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF370000000000000RVJ6TCUV",
"short_payment_reference": "RF37RVJ6TCUV",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:06.027Z",
"updated_at": "2024-03-21T14:42:06.160Z",
"public_view_code": "948880",
"public_view_code_expires_at": "2024-06-21T14:42:06.100Z",
"version": 1711032126,
"details": [
{
"id": "416087649090012515",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": "20240301..20240331",
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:06.030Z",
"updated_at": "2024-03-21T14:42:06.159Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/15418021e9502b764ed016a4efde7471a0cc2e1bacc6285424d37ea765dfecd8/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/15418021e9502b764ed016a4efde7471a0cc2e1bacc6285424d37ea765dfecd8/c2deae30520bbbcd641bafb560cd3b8c09df6c8f2700a76623a12941e036f7fe/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:06.034Z",
"updated_at": "2024-03-21T14:42:06.034Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:06.127Z",
"updated_at": "2024-03-21T14:42:06.127Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:06.178Z",
"updated_at": "2024-03-21T14:42:06.178Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Example: returns only sales invoices updated after given datetime
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices.json?filter=updated_after%3A2024-03-21+14%3A42%3A13+UTC
Response
Status: 200 OK
[
{
"id": "416087650652390806",
"administration_id": 123,
"contact_id": "416087650588427665",
"contact": {
"id": "416087650588427665",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:07.459Z",
"updated_at": "2024-03-21T14:42:07.459Z",
"version": 1711032127,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e5aa7fc0023564ef2f240c309cfa40e781f4906915f90fe5f40a701d75860507/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087650601010580",
"contact_person": {
"id": null,
"contact_id": "416087650588427665",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:07.471Z",
"updated_at": "2024-03-21T14:42:07.471Z",
"version": 1711032127
},
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF6400000000000002T5RWKWN",
"short_payment_reference": "RF642T5RWKWN",
"reference": "foo",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:07.521Z",
"updated_at": "2024-03-21T14:43:13.159Z",
"public_view_code": "444132",
"public_view_code_expires_at": "2024-06-21T14:42:07.585Z",
"version": 1711032193,
"details": [
{
"id": "416087650655536535",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": "20240301..20240331",
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:07.523Z",
"updated_at": "2024-03-21T14:42:07.632Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/5468ad444897ecab1a40da4128a583723fdbb48859a22092db8f0780cef5e74e/e5aa7fc0023564ef2f240c309cfa40e781f4906915f90fe5f40a701d75860507",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/5468ad444897ecab1a40da4128a583723fdbb48859a22092db8f0780cef5e74e/e5aa7fc0023564ef2f240c309cfa40e781f4906915f90fe5f40a701d75860507/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:07.527Z",
"updated_at": "2024-03-21T14:42:07.527Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:07.602Z",
"updated_at": "2024-03-21T14:42:07.602Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:07.653Z",
"updated_at": "2024-03-21T14:42:07.653Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
List all ids and versions
Returns all sales invoices in the administration. The list contains the invoice id and the version of the invoice.
Check if the version of the invoice is newer than the version you have stored locally, use the POST
variant for fetching invoices with the given ids.
Parameters
| Parameter | Type | Description |
|---|---|---|
filter |
String |
Example: retrieves the id's for synchronization
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/synchronization.json?
Response
Status: 200 OK
[
{
"id": "416087678817141990",
"version": 1711032154
},
{
"id": "416087678413440224",
"version": 1711032154
},
{
"id": "416087678127178970",
"version": 1711032153
}
]
Example: retrieves the id's for synchronization with a filter
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/synchronization.json?filter=state%3Aopen
Response
Status: 200 OK
[
{
"id": "416087679043634416",
"version": 1711032154
},
{
"id": "416087679303681271",
"version": 1711032154
},
{
"id": "416087679521785085",
"version": 1711032155
}
]
Fetch sales invoices with given ids
Given a list of sales invoice ids, returns the sales invoice information belonging to the invoices. Returns a maximum of 100 invoice, even if more ids are provided.
Parameters
| Parameter | Type | Description |
|---|---|---|
ids |
Array[integer] |
Required |
Example: retrieves recurring sales invoices given by IDs
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"ids":[416087641024365689,416087641070503037]}' \
https://moneybird.com/api/v2/123/recurring_sales_invoices/synchronization.json
Response
Status: 200 OK
[
{
"id": "416087641070503037",
"administration_id": 123,
"contact_id": "416087640978228343",
"contact": {
"id": "416087640978228343",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "2",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:41:58.295Z",
"updated_at": "2024-03-21T14:41:58.295Z",
"version": 1711032118,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8cec1666e559266fa5a96eb2a85bc25680777482297f71a1f3ee3c73d6cf5152/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "416087461393860486",
"start_date": "2024-03-22",
"invoice_date": "2024-03-22",
"last_date": "2024-03-22",
"active": true,
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"first_due_interval": 14,
"auto_send": false,
"sending_scheduled_at": null,
"sending_scheduled_user_id": null,
"frequency_type": "month",
"frequency": 1,
"created_at": "2024-03-21T14:41:58.383Z",
"updated_at": "2024-03-21T14:41:58.389Z",
"version": 1711032118,
"prices_are_incl_tax": false,
"total_price_excl_tax": "2.91",
"total_price_excl_tax_base": "2.91",
"total_price_incl_tax": "3.52",
"total_price_incl_tax_base": "3.52",
"details": [
{
"id": "416087641072600190",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "5 stuks",
"amount_decimal": "5.0",
"description": "Appels",
"price": "0.45",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "2.25",
"total_price_excl_tax_with_discount_base": "2.25",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:41:58.385Z",
"updated_at": "2024-03-21T14:41:58.385Z"
},
{
"id": "416087641074697343",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "2 stuks",
"amount_decimal": "2.0",
"description": "Peren",
"price": "0.33",
"period": null,
"row_order": 2,
"total_price_excl_tax_with_discount": "0.66",
"total_price_excl_tax_with_discount_base": "0.66",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:41:58.387Z",
"updated_at": "2024-03-21T14:41:58.387Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:41:58.391Z",
"updated_at": "2024-03-21T14:41:58.391Z"
}
],
"subscription": null
},
{
"id": "416087641024365689",
"administration_id": 123,
"contact_id": "416087640978228343",
"contact": {
"id": "416087640978228343",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "2",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:41:58.295Z",
"updated_at": "2024-03-21T14:41:58.295Z",
"version": 1711032118,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8cec1666e559266fa5a96eb2a85bc25680777482297f71a1f3ee3c73d6cf5152/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"workflow_id": "416087461393860486",
"start_date": "2024-03-22",
"invoice_date": "2024-03-22",
"last_date": "2024-03-22",
"active": true,
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"first_due_interval": 14,
"auto_send": false,
"sending_scheduled_at": null,
"sending_scheduled_user_id": null,
"frequency_type": "year",
"frequency": 1,
"created_at": "2024-03-21T14:41:58.338Z",
"updated_at": "2024-03-21T14:41:58.344Z",
"version": 1711032118,
"prices_are_incl_tax": false,
"total_price_excl_tax": "2.91",
"total_price_excl_tax_base": "2.91",
"total_price_incl_tax": "3.52",
"total_price_incl_tax_base": "3.52",
"details": [
{
"id": "416087641025414266",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "5 stuks",
"amount_decimal": "5.0",
"description": "Appels",
"price": "0.45",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "2.25",
"total_price_excl_tax_with_discount_base": "2.25",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:41:58.340Z",
"updated_at": "2024-03-21T14:41:58.340Z"
},
{
"id": "416087641027511419",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "2 stuks",
"amount_decimal": "2.0",
"description": "Peren",
"price": "0.33",
"period": null,
"row_order": 2,
"total_price_excl_tax_with_discount": "0.66",
"total_price_excl_tax_with_discount_base": "0.66",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:41:58.342Z",
"updated_at": "2024-03-21T14:41:58.342Z"
}
],
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "recurring_sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:41:58.346Z",
"updated_at": "2024-03-21T14:41:58.346Z"
}
],
"subscription": null
}
]
Example: retrieves sales invoices given by ids
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"ids":[416087680204408084,416087680420414746]}' \
https://moneybird.com/api/v2/123/sales_invoices/synchronization.json
Response
Status: 200 OK
[
{
"id": "416087680420414746",
"administration_id": 123,
"contact_id": "416087679934924040",
"contact": {
"id": "416087679934924040",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:35.447Z",
"updated_at": "2024-03-21T14:42:35.447Z",
"version": 1711032155,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/79c96468dd40e7d78606b5480b4126411945031d08714a3d85a0299ad174e375/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0003",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF750000000000000US5AAD3N",
"short_payment_reference": "RF75US5AAD3N",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:35.909Z",
"updated_at": "2024-03-21T14:42:36.104Z",
"public_view_code": "325235",
"public_view_code_expires_at": "2024-06-21T14:42:36.027Z",
"version": 1711032156,
"details": [
{
"id": "416087680422511899",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:35.912Z",
"updated_at": "2024-03-21T14:42:36.102Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/0d69982fa7aa6b8c93cfdfca86a7db7f48f66b74bb90a1fecb9def6a21fb27b1/79c96468dd40e7d78606b5480b4126411945031d08714a3d85a0299ad174e375",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/0d69982fa7aa6b8c93cfdfca86a7db7f48f66b74bb90a1fecb9def6a21fb27b1/79c96468dd40e7d78606b5480b4126411945031d08714a3d85a0299ad174e375/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:35.918Z",
"updated_at": "2024-03-21T14:42:35.918Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:36.058Z",
"updated_at": "2024-03-21T14:42:36.058Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0003 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:36.126Z",
"updated_at": "2024-03-21T14:42:36.126Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
},
{
"id": "416087680204408084",
"administration_id": 123,
"contact_id": "416087679934924040",
"contact": {
"id": "416087679934924040",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:35.447Z",
"updated_at": "2024-03-21T14:42:35.447Z",
"version": 1711032155,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/79c96468dd40e7d78606b5480b4126411945031d08714a3d85a0299ad174e375/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0002",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF220000000000000YCDUJXJX",
"short_payment_reference": "RF22YCDUJXJX",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:35.703Z",
"updated_at": "2024-03-21T14:42:35.816Z",
"public_view_code": "311323",
"public_view_code_expires_at": "2024-06-21T14:42:35.767Z",
"version": 1711032155,
"details": [
{
"id": "416087680206505237",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:35.706Z",
"updated_at": "2024-03-21T14:42:35.814Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/421515a275e25b208115ba0a65f10beedc281339624305e93f323fa8940f9144/79c96468dd40e7d78606b5480b4126411945031d08714a3d85a0299ad174e375",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/421515a275e25b208115ba0a65f10beedc281339624305e93f323fa8940f9144/79c96468dd40e7d78606b5480b4126411945031d08714a3d85a0299ad174e375/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:35.710Z",
"updated_at": "2024-03-21T14:42:35.710Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:35.785Z",
"updated_at": "2024-03-21T14:42:35.785Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:35.834Z",
"updated_at": "2024-03-21T14:42:35.834Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
]
Get an invoice by id
Returns a sales invoices in the administration.
Note that the link in the url attribute will only work if viewing invoices online has been enabled and the invoice is not a draft.
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/sales_invoices/416087652860691914.json?
Response
Status: 200 OK
{
"id": "416087652860691914",
"administration_id": 123,
"contact_id": "416087652794631621",
"contact": {
"id": "416087652794631621",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:09.564Z",
"updated_at": "2024-03-21T14:42:09.564Z",
"version": 1711032129,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b84c9875391df63abb50687d2900c70b1d1acc47081be96ad79ab4186c25b38f/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087652808263112",
"contact_person": {
"id": null,
"contact_id": "416087652794631621",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:09.576Z",
"updated_at": "2024-03-21T14:42:09.576Z",
"version": 1711032129
},
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF070000000000000C99N9AAZ",
"short_payment_reference": "RF07C99N9AAZ",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:09.626Z",
"updated_at": "2024-03-21T14:42:09.759Z",
"public_view_code": "651493",
"public_view_code_expires_at": "2024-06-21T14:42:09.689Z",
"version": 1711032129,
"details": [
{
"id": "416087652863837643",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": "20240301..20240331",
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:09.629Z",
"updated_at": "2024-03-21T14:42:09.757Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/fa9260844f2228350572590cd137049cb81174db095cd5a7601d78ab3df3af9d/b84c9875391df63abb50687d2900c70b1d1acc47081be96ad79ab4186c25b38f",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/fa9260844f2228350572590cd137049cb81174db095cd5a7601d78ab3df3af9d/b84c9875391df63abb50687d2900c70b1d1acc47081be96ad79ab4186c25b38f/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:09.633Z",
"updated_at": "2024-03-21T14:42:09.633Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:09.714Z",
"updated_at": "2024-03-21T14:42:09.714Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:09.778Z",
"updated_at": "2024-03-21T14:42:09.778Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.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/sales_invoices/34123123.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Get an invoice by invoice_id
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/sales_invoices/find_by_invoice_id/2024-0001.json?
Response
Status: 200 OK
{
"id": "416087658863789614",
"administration_id": 123,
"contact_id": "416087658785146409",
"contact": {
"id": "416087658785146409",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:15.276Z",
"updated_at": "2024-03-21T14:42:15.276Z",
"version": 1711032135,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e81745dad4ca3f72dcfa4fab13f42533cecae936208bf87ed23c37e7cc63324b/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087658797729324",
"contact_person": {
"id": null,
"contact_id": "416087658785146409",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:15.288Z",
"updated_at": "2024-03-21T14:42:15.288Z",
"version": 1711032135
},
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF450000000000000D9KMHFF2",
"short_payment_reference": "RF45D9KMHFF2",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:15.351Z",
"updated_at": "2024-03-21T14:42:15.478Z",
"public_view_code": "797977",
"public_view_code_expires_at": "2024-06-21T14:42:15.415Z",
"version": 1711032135,
"details": [
{
"id": "416087658866935343",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:15.354Z",
"updated_at": "2024-03-21T14:42:15.476Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/9653f79b3aec4264599ee0b9d981d756c7d9b88458bf97d180d0fa407c8b0b2b/e81745dad4ca3f72dcfa4fab13f42533cecae936208bf87ed23c37e7cc63324b",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/9653f79b3aec4264599ee0b9d981d756c7d9b88458bf97d180d0fa407c8b0b2b/e81745dad4ca3f72dcfa4fab13f42533cecae936208bf87ed23c37e7cc63324b/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:15.358Z",
"updated_at": "2024-03-21T14:42:15.358Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:15.432Z",
"updated_at": "2024-03-21T14:42:15.432Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:15.497Z",
"updated_at": "2024-03-21T14:42:15.497Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: returns 404 when the given invoice_id does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/find_by_invoice_id/1337.json?
Response
Status: 404 Not Found
{
"error": "Sales invoice with invoice_id: 1337 was not found",
"symbolic": {
"invoice_id": "not_found"
}
}
Get an invoice by reference
Example: returns invoice by given reference
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/find_by_reference/invoice-123.json?
Response
Status: 200 OK
{
"id": "416087659555849802",
"administration_id": 123,
"contact_id": "416087659493983813",
"contact": {
"id": "416087659493983813",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:15.952Z",
"updated_at": "2024-03-21T14:42:15.952Z",
"version": 1711032135,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/c1d3ee66ba994e847e600826799bd7c92109f2f94758c16bca733d3c1589f879/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": "416087659506566728",
"contact_person": {
"id": null,
"contact_id": "416087659493983813",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:15.964Z",
"updated_at": "2024-03-21T14:42:15.964Z",
"version": 1711032135
},
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF090000000000000ZW4ZGF7X",
"short_payment_reference": "RF09ZW4ZGF7X",
"reference": "invoice-123",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:16.012Z",
"updated_at": "2024-03-21T14:42:16.133Z",
"public_view_code": "281945",
"public_view_code_expires_at": "2024-06-21T14:42:16.078Z",
"version": 1711032136,
"details": [
{
"id": "416087659558995531",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:16.014Z",
"updated_at": "2024-03-21T14:42:16.132Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/e6342dbb2db23de58b5a09e0ec1b8c25994f9c84fd44b2e30a2d3317944675f7/c1d3ee66ba994e847e600826799bd7c92109f2f94758c16bca733d3c1589f879",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/e6342dbb2db23de58b5a09e0ec1b8c25994f9c84fd44b2e30a2d3317944675f7/c1d3ee66ba994e847e600826799bd7c92109f2f94758c16bca733d3c1589f879/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:16.018Z",
"updated_at": "2024-03-21T14:42:16.018Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:16.099Z",
"updated_at": "2024-03-21T14:42:16.099Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com; janjanssen@dev.null.moneybird.net",
"email_message": "Geachte Jan Janssen,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:16.151Z",
"updated_at": "2024-03-21T14:42:16.151Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: returns 404 when the given reference does not exist
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/find_by_reference/1337.json?
Response
Status: 404 Not Found
{
"error": "Sales invoice with reference: 1337 was not found",
"symbolic": {
"reference": "not_found"
}
}
Download sales invoice PDF by id
Redirects to the download URL of the sales invoice as PDF. The link is valid for 30 seconds.
Parameters
| Parameter | Type | Description |
|---|---|---|
media |
String |
In case you want to hide sender address and logo you can set this to ‘stationery’. |
Example: returns invoice by given id as PDF
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/416087653571626468/download_pdf.json?
Response
Status: 302 Found
"This resource has been moved temporarily to https://storage.moneybird.dev/ebe85c7ae88d39a703f8e518a50ba0b95cc02f1e7585b7fb9f36524b3f8572ff/3ddb50aa23a568c918c050de24efa1623176664967f7976daf469bd03517af73/download."
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/sales_invoices/1234321/download_pdf.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Download sales invoice UBL by id
Download the sales invoice as UBL.
Example: returns invoice by given id as UBL
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/416087656117569020/download_ubl.json?
Response
Status: 200 OK
<?xml version="1.0" encoding="UTF-8"?>
<Invoice xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2 UBL-Invoice-2.1.xsd" xmlns="urn:oasis:names:specification:ubl:schema:xsd:Invoice-2">
<cbc:UBLVersionID>2.1</cbc:UBLVersionID>
<cbc:ID>2019-0001</cbc:ID>
<cbc:IssueDate>2019-10-01</cbc:IssueDate>
<cbc:DueDate>2019-10-15</cbc:DueDate>
<cbc:InvoiceTypeCode listID="UNCL1001" listAgencyID="6">380</cbc:InvoiceTypeCode>
<cbc:DocumentCurrencyCode listID="ISO4217" listAgencyID="6">EUR</cbc:DocumentCurrencyCode>
<cac:OrderReference>
<cbc:ID>Project X</cbc:ID>
</cac:OrderReference>
<cac:AdditionalDocumentReference>
<cbc:ID>2019-0001.pdf</cbc:ID>
<cbc:DocumentType>PrimaryImage</cbc:DocumentType>
<cac:Attachment>
<cbc:EmbeddedDocumentBinaryObject mimeCode="application/pdf" filename="2019-0001.pdf">JVBERi0xLjMK/////woxIDAgb2JqCjw8IC9DcmVhdG9yIChQcmF3bikKL1By
b2R1Y2VyIChQcmF3bikKPj4KZW5kb2JqCjIgMCBvYmoKPDwgL0tpZHMgWzUg
MCBSXQovVHlwZSAvUGFnZXMKL0NvdW50IDEKPj4KZW5kb2JqCjMgMCBvYmoK
PDwgL1BhZ2VzIDIgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9iago0IDAg
b2JqCjw8IC9MZW5ndGggMzg4Nwo+PgpzdHJlYW0KMC4wMDAgMC4wMDAgMC4w
MDAgcmcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKcQpCVAoxLjAwMCAwLjAwMCAt
MC4wMDAgMS4wMDAgNDA5LjI4MCA4MTUuODkwIFRtCjAgLTUuNzQ0IFRkCjAu
MDAwIDAuMDAwIDAuMDAwIHJnCjAgVHMKL0YxLjAgOCBUZgpbPDU1NzcyMDQy
NjU2NDcyPiAtMTUgPDY5NmE2NjczMmQ0ZTYxNjE2ZDIwNDI+IDIwIDwyZTU2
PiAxMjUgPDJlPl0gVEoKMCAtOS4yNDggVGQKWzw0NzcyNmY3NDY1MjA0ZDYx
NzI+IC0xNSA8NmI3NDIwMzEzMDMwPl0gVEoKMCAtOS4yNDggVGQKWzwzMTMx
MzIzMjIwNDE0MTIwNDU2ZTczNjM2ODY1NjQ2NT5dIFRKCjAgLTkuMjQ4IFRk
CjAgLTkuMjQ4IFRkCls8NmI3NjZiMmU+IDYwIDwyMDMxMzIzMzM0MzUzOTM4
MzczNj5dIFRKCjAgLTkuMjQ4IFRkCls8NjI3NDc3PiA2MCA8MmU+IDYwIDwy
MDM4MzIzMzM5MzMzNjM1MzMzOD5dIFRKCjAgLTkuMjQ4IFRkCjAgLTkuMjQ4
IFRkCi9GMi4wIDggVGYKWzw0NTJkNmQ2MTY5NmMzYT5dIFRKCi9GMS4wIDgg
VGYKWzwyMDY5NmU2Nj4gMzAgPDZmNDA3NTc3NjI2NTY0NzI+IC0xNSA8Njk2
YTY2NzMyZDJkNmU2MTYxNmQyZTZlNmM+XSBUSgpFVAoKcQoyMDAuMDAwIDAg
MCA4MC4wMDAgMzYuMDAwIDczNS44OTAgY20KL0kxIERvClEKCkJUCjY2IDY5
OS40MjggVGQKL0YxLjAgOSBUZgpbPDQyNmY2ZjZiNzM2ODZmNzAwYT5dIFRK
CkVUCgoKQlQKNjYgNjg5LjAyNCBUZAovRjEuMCA5IFRmCls8NTQ+IDEyMCA8
MmU2MTJlNzY+IDgwIDwyZT4gNjAgPDIwNGE2ZjczMjA3Nj4gMjUgPDYxNmUy
MDY0NjU3MjIwNGQ2ZjZjNjU2ZTBhPl0gVEoKRVQKCgpCVAo2NiA2NzguNjIg
VGQKL0YxLjAgOSBUZgpbPDRmNzg2Nj4gMzAgPDZmNzI2NDBhPl0gVEoKRVQK
CgpCVAo2NiA2NjguMjE2IFRkCi9GMS4wIDkgVGYKWzwwYT5dIFRKCkVUCgoK
QlQKNjYgNjU3LjgxMiBUZAovRjEuMCA5IFRmCls8MGE+XSBUSgpFVAoKCkJU
CjM2IDU4MC45NDYgVGQKL0YxLjAgMTggVGYKWzw0Nj4gNTAgPDYxNjM3NDc1
NzU3MjIwMzIzMDMxMzAyZDMwMzEzMTMyPl0gVEoKRVQKCgpCVAo0MDguNjQg
NTkxLjk3MiBUZAovRjEuMCA5IFRmCls8NDY+IDUwIDw2MTYzNzQ3NTc1NzI2
NDYxNzQ3NTZkM2E+IDUwIDwyMD5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAw
MCByZwoKQlQKNTA1LjYxNCA1OTEuOTcyIFRkCi9GMS4wIDkgVGYKWzwzMTM4
MmQzMDM5MmQzMjMwMzEzMD5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCBy
ZwoKQlQKNDA4LjY0IDU3OC4xIFRkCi9GMS4wIDkgVGYKWzw1Nj4gODAgPDY1
NzI+IC0zMCA8NzY+IDI1IDw2MTZjNjQ2MTc0NzU2ZDNhPiA1MCA8MjA+XSBU
SgpFVAoKMC4wMDAgMC4wMDAgMC4wMDAgcmcKCkJUCjUwNS42MTQgNTc4LjEg
VGQKL0YxLjAgOSBUZgpbPDMwMzIyZDMxMzAyZDMyMzAzMTMwPl0gVEoKRVQK
CjAuMDAwIDAuMDAwIDAuMDAwIHJnCjAuNSB3CjAuMDAwIDAuMDAwIDAuMDAw
IFJHCjEgdwowLjAwMCAwLjAwMCAwLjAwMCBSRwowLjUgdwowLjAwMCAwLjAw
MCAwLjAwMCByZwoxIHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcKCkJU
Cjk2IDUzMC4wMjQgVGQKL0YyLjAgOSBUZgpbPDRmNmQ3MzYzPiAxMCA8Njg3
MjY5NmE3NjY5NmU2Nz5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwox
IHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcKCkJUCjM4NC41NjUgNTMw
LjAyNCBUZAovRjIuMCA5IFRmCls8NDI2NTY0NzI2MT4gMTAgPDY3Pl0gVEoK
RVQKCjAuMDAwIDAuMDAwIDAuMDAwIHJnCjEgdwowLjAwMCAwLjAwMCAwLjAw
MCBSRwowLjUgdwoKQlQKNDg5LjY5NSA1MzAuMDI0IFRkCi9GMi4wIDkgVGYK
Wzw1ND4gODAgPDZmNzQ2MTYxNmM+XSBUSgpFVAoKMC4wMDAgMC4wMDAgMC4w
MDAgcmcKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJHCjAuNSB3CgpCVAo1MzQu
OTg3IDUzMC4wMjQgVGQKL0YyLjAgOSBUZgpbPDQyNTQ1Nz5dIFRKCkVUCgow
LjAwMCAwLjAwMCAwLjAwMCByZwozNi4wMDAgNTI2LjAzOCBtCjU1OS4yODAg
NTI2LjAzOCBsClMKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJHCjAuNSB3CgpC
VAo0MCA1MTIuOTQ4IFRkCi9GMS4wIDkgVGYKWzwzMTIwNzg+XSBUSgpFVAoK
MC4wMDAgMC4wMDAgMC4wMDAgcmcKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJH
CjAuNSB3CgpCVAo5NiA1MTIuOTQ4IFRkCi9GMS4wIDkgVGYKWzw3NDY1NzM3
ND5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwoxIHcKMC4wMDAgMC4w
MDAgMC4wMDAgUkcKMC41IHcKCkJUCjM3Mi45NDYgNTEyLjk0OCBUZAovRjEu
MCA5IFRmCls8ODAyMDMxMmUzMjMzMzQyYzMwMzA+XSBUSgpFVAoKMC4wMDAg
MC4wMDAgMC4wMDAgcmcKMSB3CjAuMDAwIDAuMDAwIDAuMDAwIFJHCjAuNSB3
CgpCVAo0NzIuOTQ2IDUxMi45NDggVGQKL0YxLjAgOSBUZgpbPDgwMjAzMTJl
MzIzMzM0MmMzMDMwPl0gVEoKRVQKCjAuMDAwIDAuMDAwIDAuMDAwIHJnCjEg
dwowLjAwMCAwLjAwMCAwLjAwMCBSRwowLjUgdwoKQlQKNTM3LjQ3MSA1MTIu
OTQ4IFRkCi9GMS4wIDkgVGYKWzwzMTM5MjU+XSBUSgpFVAoKMC4wMDAgMC4w
MDAgMC4wMDAgcmcKMzYuMDAwIDUwNS42MzQgbQo1NTkuMjgwIDUwNS42MzQg
bApTCjAuMDAwIDAuMDAwIDAuMDAwIFJHCjEgdwowLjAwMCAwLjAwMCAwLjAw
MCBSRwowLjUgdwoKQlQKMzcxLjQ3OSA0OTIuMzQgVGQKL0YyLjAgOSBUZgpb
PDUzNzU2Mjc0NmY3NDYxNjE2YzNhPl0gVEoKRVQKCjAuMDAwIDAuMDAwIDAu
MDAwIHJnCjEgdwowLjAwMCAwLjAwMCAwLjAwMCBSRwowLjUgdwoKQlQKNDcy
Ljk0NiA0OTIuNTQ0IFRkCi9GMS4wIDkgVGYKWzw4MDIwMzEyZTMyMzMzNDJj
MzAzMD5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwoxIHcKMC4wMDAg
MC4wMDAgMC4wMDAgUkcKMC41IHcKCkJUCjM3MS40NzkgNDcwLjQ2OCBUZAov
RjIuMCA5IFRmCls8NDI1NDU3MjAzMTM5MjUzYT5dIFRKCkVUCgowLjAwMCAw
LjAwMCAwLjAwMCByZwoxIHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcK
CkJUCjQ4MC40NTIgNDcwLjY3MiBUZAovRjEuMCA5IFRmCls8ODAyMDMyMzMz
NDJjMzQzNj5dIFRKCkVUCgowLjAwMCAwLjAwMCAwLjAwMCByZwozMTkuNDgw
IDQ2MS44OTAgbQo1MTkuNDgwIDQ2MS44OTAgbApTCjEgdwowLjAwMCAwLjAw
MCAwLjAwMCBSRwowLjUgdwoKQlQKMzg2LjY5OCA0NDguNTk2IFRkCi9GMi4w
IDkgVGYKWzw1ND4gODAgPDZmNzQ2MTYxNmMzYT5dIFRKCkVUCgowLjAwMCAw
LjAwMCAwLjAwMCByZwoxIHcKMC4wMDAgMC4wMDAgMC4wMDAgUkcKMC41IHcK
CkJUCjQ3Mi45NDYgNDQ4LjggVGQKL0YxLjAgOSBUZgpbPDgwMjAzMTJlMzQz
NjM4MmMzNDM2Pl0gVEoKRVQKCjAuMDAwIDAuMDAwIDAuMDAwIHJnCjM2LjAw
MCA2My43NDQgbQo1NTkuMjgwIDYzLjc0NCBsClMKCkJUCjM2IDUyLjI4MiBU
ZAovRjEuMCA5IFRmCls8NTc+IDMwIDw2NTIwNzY+IDI1IDw2NTcyN2E+IDE1
IDw2ZjY1NmI+IDIwIDw2NTZlMjA3NTIwNzY3Mj4gLTE1IDw2OTY1NmU2NDY1
NmM2OTZhNmIyMDY4NjU3NDIwNjI2Zj4gMTUgPDc2PiAyNSA8NjU2ZTczNzQ2
MTYxNmU2NDY1MjA2MjY1NjQ3Mj4gMTAgPDYxNjcyMDYyNjk2ZTZlNjU2ZTIw
NjQ2NTIwNjc2NTczNzQ2NTZjNjQ2NTIwNjI2NTc0NjE2YzY5NmU2NzczNzQ2
NTcyPiAtMjUgPDZkNjk2YTZlMjA3NDY1MjA3Nj4gMjUgPDZmNmM2NDZmNjU2
ZTIwNmY3MDIwNmY2ZTdhPiAxNSA8NjUyMDYyNjE2ZTZiNzI2NTZiPiAyMCA8
NjU2ZTY5NmU2NzJlPiA2MCA8MjA+IDUwIDw1Nj4gODAgPDZmNmY3MjBhPl0g
VEoKRVQKCgpCVAozNiA0MS44NzggVGQKL0YxLjAgOSBUZgpbPDc2NzI+IDEw
IDw2MTY3NjU2ZTIwNmI3NTZlNzQyMDc1MjA2MzZmNmU3NDYxNjM3NDIwNmY3
MDZlNjU2ZDY1NmUyMDcwNjU3MjIwNjUyZDZkNjE2OTZjMmU+XSBUSgpFVAoK
UQoKZW5kc3RyZWFtCmVuZG9iago1IDAgb2JqCjw8IC9Db250ZW50cyA0IDAg
UgovUHJvY1NldCA2IDAgUgovTWVkaWFCb3ggWzAgMCA1OTUuMjggODQxLjg5
XQovUGFyZW50IDIgMCBSCi9SZXNvdXJjZXMgPDwgL0ZvbnQgPDwgL0YxLjAg
NyAwIFIKL0YyLjAgOCAwIFIKPj4KL1hPYmplY3QgPDwgL0kxIDkgMCBSCj4+
Cj4+Ci9UeXBlIC9QYWdlCj4+CmVuZG9iago2IDAgb2JqClsvUERGIC9UZXh0
IC9JbWFnZUNdCmVuZG9iago3IDAgb2JqCjw8IC9CYXNlRm9udCAvSGVsdmV0
aWNhCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9UeXBlIC9Gb250Ci9T
dWJ0eXBlIC9UeXBlMQo+PgplbmRvYmoKOCAwIG9iago8PCAvQmFzZUZvbnQg
L0hlbHZldGljYS1Cb2xkCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCi9U
eXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQo+PgplbmRvYmoKOSAwIG9iago8
PCAvTGVuZ3RoIDM3MjkKL1dpZHRoIDIwMAovQ29sb3JTcGFjZSAvRGV2aWNl
R3JheQovRmlsdGVyIC9EQ1REZWNvZGUKL0hlaWdodCA4MAovVHlwZSAvWE9i
amVjdAovQml0c1BlckNvbXBvbmVudCA4Ci9TdWJ0eXBlIC9JbWFnZQo+Pgpz
dHJlYW0K/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAEBAQEBAQEBAQEBAQEB
AQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB
AQEBAQH/wAALCABQAMgBAREA/8QAHAABAAIDAQEBAAAAAAAAAAAAAAgJBgcK
AgUD/8QALBAAAQQDAQABBAIBAwUAAAAABAMFBgcAAggBCRITFBURFhcKGSIh
Q1mX2P/aAAgBAQAAPwDv4xjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGM
YxjGMhd0p2/WvP8AIWepo8xya+unZkFuXX3MtQpCPVkPQ+30ppSOXrrrpMNU
1wOqpqo7WLYR7KwCBJGrNv7kwJRv2rptu8/lblFm8yc5SWEe8avdv288qvPU
HO7XA+nafErhCo7GmA1ZytK4oOsvCrSZpS1RVjLPLYAo7O9x3t2hD/qCOoyK
2LfHVa9hXnw9zJbtryH2W2PP6sY5DMpL60sbD69PZW5WhR/rPGm1nYW71b7W
nvorU1ghp/8AaQ1/6/zNHGMYxjGMYxjGMYxjGMoX7s707GQniVK88cr9XV/V
JBZjbPOsI/TcSk1hmgi+e6mA89Vnac7ruPJEmebJCJ2RYbirsz6krHNdcuKi
DY5k/B5q6yojlKPvDXVnxpfJWtJped49WXa02gtETS4rak2317ESazbHeunV
pBKHRZdQhdEZVcdjZ9iSB4+ztASn4vkl/wDdpG/8efyO/wDq7n7/AOm8rJiP
TN7crT5p34G4q76cqGkUg9UmHF9+Q6sla+imjoSsW6PnNFmR+97DnNTlblqK
GbVgdF5jW7iWe4rtokUU2H3R6Wagsr226+YJ0rArHrAx3G+pxgVsRZeIzmMO
CfnnhLY8tuyxreRuhtt54m5sTo8MZunv1guZH0q6p7MxjGMYxjGMYxjGMYxn
Pt84DVCSZHQknnFbQG2BKv5m+Rq2mCGWcyryGFGzCvapqmQxkl7aBXBqJMFF
chdN1Eh3IJbdPZTVMlLbbzfWt/4IIJyt8kwvUa3QXCPGrZvTZFLpRP8AxrVT
zHNV9bATtXd8/c+PUzk/5nqfsLaP1/o3oP4/ihv3vCfvJfYlp8yPK3EvBPGh
d+0lwxyg4TdCzoLD9B59W576wetUk/cfsN9gGmSx4v0zX8BD8Zbxx8TT/lT6
0Vfq8+mJnBcWo+4ub+C+wg+YeeaavAv5Sa4q5aQUlBnCHj7Q5uFfiPwPEXSR
SQz+TlvsqH7en+pL7Cje6Ipfb9+rskVU+0kor9Cin2091Ptpa/Wqp9Gvu30J
6fz59Sm38fTpr/Pn1be+efz5/P8AOQOrj5LuP7So2/Oh4zYziNXPMTjJGe7f
ZNDpXFJVCnaLtiTme2FQ5/aQJEWcX939WzIAAE7PL+iUwt/q7sIUIjJihbvg
nSNRQe8awUfSa9sdp9f4efI467xRzdWPcskUN3/QvwwTuIA6eDbGtK5giHjm
1LBuofireaIQtt3GMre6v+WTh/jWfC1LbloOLjbpIqB6tXVrDpLY8yawCRP2
CBT+JGm8puj+6zd7o5jtr05gvJbUqm6htpDbt+V5MKg70rnpen4LelSObi8V
1YrWu7xhxdmF6jDiQKK5GtBXhTJIAm91D3QcW40fz1cXxAvRLQ0BYtvIFLX2
/jGMYxjGMYxlb/Sjc3u/yEfHi1uoIbm2OFdd0huDa4CoGgHCEQqlklxTAyU1
RyRl09tk1kFk90ldNttN9NtfffM+r289yTnWkY2XzH5BKWntpdH8vUrvMW+t
Iw9BtTbb12xKtHB5Mi3ujSDIiGVrlriW3CGmDfwtsomiWJ6vut5inLjld0k6
C675n6qsuFdMs1Nx3mSYQ57KpKI14MkvbDdbxb2MdGAXKTgmqh7w5p1BOXN3
VR8/I9RTQ++p5t+/dsajkUG4SaYswMkbavPka51I8bGBqBZ2/wAIWb7A+8v4
G3IDDeLK/Rr91X7X17/Tr9e3v0+ZZfnHp8iXHKCXy013zBCJodB+efljdINY
vU8BZ/CkP30goCTSKcSQgAlInX8Aqb/gquKTgl9SoMskD66KIqDbIDbbAlEo
vHq/pn5Q4I2dkXLw5VXxg1s1NnOdTUFMW+qYgSDEopNfty6ywhRdFZhXoG0D
bVnBoXXDEb2SXx1tbjmoUFJJwwGn/kX6uuScfApL7HtSVwcDoCQ3zCrrEa3V
eFQe7y67sYSv4i9yBnHWDZnU978SbNCBEUkwSpQ6HItLeKG4BN2vm7ezul2+
Q/6g/wAifRVlpNvPWlHpUdszzpzVEqg10tIZhlSEFUHMUTjy5HmhjO7It+yO
yfqS4C2ifqWyWt4fxP1/e4/OMV6K6A6dsPoOX9aVlS10jx2U7EDw2mm2Rwna
RNsNrtpUczkgxvWWUM4cmcvERzZG9MX7pzVNLJ2X8ri+DN4hCXV3yot9uFNI
fabt1tNlXwCVbhjzsyrRnmQkNyMPTcPfHMmKhvX7ZZwHj2yrQO0awlZfXVt8
j2+bH7gta4uivlQ5z+OGJdK2nytREsoORXfJpxz5Lm6B2xbEpFcbBQTjEQsP
wFxJaxmXyDFKEitqZaZO6Ev3eWw9QFt3bqsJ/wDID2fFfjg7zjQvSM9lEx4t
71i1F1R1K2Om4U4sWv8Aaay5rUGkcmb1thpd9wWPCuay5yRShbRJW0RxIcR0
Qt093s8A7ddPkr04HX+UDrbSE9E8oMPSE7nqLm1pzGOyhQR6KXYKe88U/Epe
NqyEfUn8WuvWNTaNbeRgncpZAR+Gis5/If22N8ONdzz3p6es1xVV8sSPMat4
EPqqkkk9aNFGSWxEhrFcnFRTeWs6L89oKugsrKdNHNsj7Ug9Fl6De7eWR+2X
cnxwfKpz9T0h7evzq2g+iudbPte8GK9ZSLYLlXXtdQmyJsXZ0BbWQMUCDQ4n
eBEGtDBHGkcXyPiSdqJLkpA7Qc217RbubqmGXLwZ0vTdh9tuXMnTHTYdOqvP
XnT1Z2ey32wp2MPCp2jH+a4fExkaP1jqh722t8iFfnfdE1Bl0S3LWaRnh93L
M5J2h0bYnzsnNXfXS9Nwz4932dWpVkFreXEMyDqW1Nt0yNriRskEXFk7RAwW
mnl2jSKMjmI1EmSFJ1NHI/Vfhm5qy959O1NHvhz+RS57usBy5vu+JySg+too
o8K6V6rOmkqfxaIWy6xwdMRiCkT+AgrLnQlvGbBtDK3W2U2TRcS91rYPg9kX
RVs8gunTfSljTibSbpe157YsDj0rkTk8Ndb1UI9Ex6LxeLtzh79DQ2EOjdI3
kP0PRFA6Onxn6UE0xEvdrk8YxjIIdc8p3Pedlc+XBQvSTNzjYVCCW82iur9R
oF5N8ja7ebIY1ugu7M5WJABWpVuRiGuyRXu7ruRsf/w0D9F+omPcm4V7ttV2
qwW9PkXglh1zXt5UpdrpCGLh6OQBxlBlKWZGrLaWNKYN1+OpTDo5uEbQCVcd
Gp01FTX2W3bTtU/RVdg2pxp1WZ0tbPQvNXasV5/RuaIVLF5jC5LyqzXbsqrU
IcuDYXIOSO1wwv0TwjSaO+y4SDEn5576j4qUV9pP3TD1+He3J9P6Mf8AoL5B
oTa0Cpa7oReGkCj/ABbHqxPkT7BtXRNuA9mbZer8S0jrIPBqaiv6V0T823TU
3CW9T18y2LI6WByZz9aN7U/0vO4B+9u2hBXsKppr/apq2f1QWRjGCPKX9bZ5
I3xJ9/MHPLT+uSsLwoP936xN0N009tI7dNfFFwX19ZY9v3tRYsisX0FuaXuS
R+YzyBEzJlatk9gWmbjwWTR4OVIIajiDpnOw5D0mAA3tiTom2giiJZX0P8a3
FHUVSVlR9uUZHza4pbVJGpGaKHvkBXrwLUMJuKaoy5QtzYzxGZ1b28IV4Z1l
yGxz3Cb3EsVR3a2twCwyL/Ej8eEJhFzVvEOb2mNQfoSKwCFW/HGSe2y3AS+P
VisIVDh/fRZ4muwnhnBJObu/RlZlfpY7qnO8uc3xzcnEsqdNcV9EKkryB1VX
zR/X4DWUMi9fQhh/PdHX9JEIYxgxyNNH7R7Ncnpy/WsraEF+e7uJ7oZ9n8g8
0otRVdSDfV3xPcEdpy3/ACFflCtT5Yu6Agpc/i8ilkBlTsKAgmIGhIToY9sq
Mm/FCRQBDIkQroWACOgIAQMOlonr4s74muBbbqGoqRmFEIKQqg24pnpoprnV
jtc2gDSabu4mNTZYg8t/vDm1kmKKEKNcjfntu8X+2SmKmSMKshlBfxj8Lmcv
IcZ70CyC84JSICXr18zymfx1d1lraogoNJ3+aR6WNc+kD/t6KIkW6PUoOLOF
DCBMUXCCEHR2yJx3zkD0Qw9XC119q/oxWI9Nsc9/t063/BrcXwnxCOf1ZST7
wsn7fhZHn7guOEP233P+bpt9On01CfIx8ODDMeOYNzPwVVkYibWt3LGep7Rj
MrsqYFgPXilWziATZ5GerBfpY4aODiOVDm9GOt5rez6ojEliCiL7Gqk2Hc6/
FlwlyvMJhPqcohqbJfNmRyijo+SuSzKxSwYW7DJBnwqPeT+QyRGPxokJL8Ak
JqSGXNbNv1J5RTWkOGjqKF/B78YsBkbHLI9zbsk/RSxmm0oaaRbN1LaQ6UsL
im7s+kdD1sRIIRiEdUkz1o8uMU0Oy6AWr4K5otjUkFKRj4L5Pja/WpLNVP4a
/dALk3dT7/3mySP8pBu7bNmhxR+guYr6Qj8hvsaZD/crrWIqo/ufuoKJLt7U
qDWR8gXxtW9cVJ82fG1yHX1ZVTwwG86yO17MlMnepjN6nFisv9kjfH4G3TCS
PEufnaTqyKQHiOKi7n4oqMTHniRRJgM/h0u/rSu4nUVdQSqoG16MsJraHxuC
xFpT2+vVujkUaBGNmD9U9812W3QbwR9FV9/PuLq+brKe+777e5m+MYxjGMYx
jGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjGMYxjP//Z
CmVuZHN0cmVhbQplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUg
ZiAKMDAwMDAwMDAxNCAwMDAwMCBuIAowMDAwMDAwMDcwIDAwMDAwIG4gCjAw
MDAwMDAxMjcgMDAwMDAgbiAKMDAwMDAwMDE3NiAwMDAwMCBuIAowMDAwMDA0
MTE1IDAwMDAwIG4gCjAwMDAwMDQzMDEgMDAwMDAgbiAKMDAwMDAwNDMzNyAw
MDAwMCBuIAowMDAwMDA0NDM0IDAwMDAwIG4gCjAwMDAwMDQ1MzYgMDAwMDAg
biAKdHJhaWxlcgo8PCAvUm9vdCAzIDAgUgovU2l6ZSAxMAovSW5mbyAxIDAg
Ugo+PgpzdGFydHhyZWYKODQzMwolJUVPRgo=
</cbc:EmbeddedDocumentBinaryObject>
</cac:Attachment>
</cac:AdditionalDocumentReference>
<cac:AccountingSupplierParty>
<cac:Party>
<cbc:EndpointID schemeID="0106">08155914</cbc:EndpointID>
<cac:PartyName>
<cbc:Name>Parkietje B.V.</cbc:Name>
</cac:PartyName>
<cac:PostalAddress>
<cbc:StreetName>Brouwerijstraat 26</cbc:StreetName>
<cbc:CityName>Enschede</cbc:CityName>
<cbc:PostalZone>7523XD</cbc:PostalZone>
<cac:Country>
<cbc:IdentificationCode listID="ISO3166-1:Alpha2" listAgencyID="6">NL</cbc:IdentificationCode>
</cac:Country>
</cac:PostalAddress>
<cac:PartyTaxScheme>
<cbc:CompanyID schemeID="NL:VAT">NL817575546B01</cbc:CompanyID>
<cac:TaxScheme>
<cbc:ID schemeID="UN/ECE 5153">VAT</cbc:ID>
</cac:TaxScheme>
</cac:PartyTaxScheme>
<cac:PartyLegalEntity>
<cbc:RegistrationName>Parkietje B.V.</cbc:RegistrationName>
<cbc:CompanyID schemeID="0106">08155914</cbc:CompanyID>
</cac:PartyLegalEntity>
<cac:Contact>
<cbc:ElectronicMail>info@dev.null.moneybird.net</cbc:ElectronicMail>
</cac:Contact>
</cac:Party>
</cac:AccountingSupplierParty>
<cac:AccountingCustomerParty>
<cac:Party>
<cac:PartyName>
<cbc:Name>Foobar Holding B.V.</cbc:Name>
</cac:PartyName>
<cac:PostalAddress>
<cbc:StreetName>Hoofdstraat 12</cbc:StreetName>
<cbc:CityName>Amsterdam</cbc:CityName>
<cbc:PostalZone>1234AB</cbc:PostalZone>
<cac:Country>
<cbc:IdentificationCode listID="ISO3166-1:Alpha2" listAgencyID="6">NL</cbc:IdentificationCode>
</cac:Country>
</cac:PostalAddress>
<cac:PartyLegalEntity>
<cbc:RegistrationName>Foobar Holding B.V.</cbc:RegistrationName>
</cac:PartyLegalEntity>
<cac:Contact>
<cbc:ElectronicMail>info@example.com</cbc:ElectronicMail>
</cac:Contact>
</cac:Party>
</cac:AccountingCustomerParty>
<cac:PaymentMeans>
<cbc:PaymentMeansCode listID="UNCL4461" listAgencyID="6">30</cbc:PaymentMeansCode>
<cbc:PaymentDueDate>2019-10-15</cbc:PaymentDueDate>
<cbc:PaymentID>RF840000000000000ER93M6TN</cbc:PaymentID>
<cac:PayeeFinancialAccount>
<cbc:ID schemeID="IBAN">NL50TEST0166567191</cbc:ID>
<cac:FinancialInstitutionBranch>
<cac:FinancialInstitution>
<cbc:ID schemeID="BIC">TESTNL00</cbc:ID>
</cac:FinancialInstitution>
</cac:FinancialInstitutionBranch>
</cac:PayeeFinancialAccount>
</cac:PaymentMeans>
<cac:PaymentTerms>
<cbc:Note>We verzoeken u vriendelijk het bovenstaande bedrag van € 363,00 voor 15-10-2019 te voldoen op onze bankrekening onder vermelding van de omschrijving RF84ER93M6TN. Voor vragen kunt u contact opnemen per e-mail.</cbc:Note>
</cac:PaymentTerms>
<cac:TaxTotal>
<cbc:TaxAmount currencyID="EUR">63.0</cbc:TaxAmount>
<cac:TaxSubtotal>
<cbc:TaxableAmount currencyID="EUR">300.0</cbc:TaxableAmount>
<cbc:TaxAmount currencyID="EUR">63.0</cbc:TaxAmount>
<cac:TaxCategory>
<cbc:ID schemeID="UNCL5305">S</cbc:ID>
<cbc:Percent>21.0</cbc:Percent>
<cac:TaxScheme>
<cbc:ID schemeID="UN/ECE 5153">VAT</cbc:ID>
</cac:TaxScheme>
</cac:TaxCategory>
</cac:TaxSubtotal>
</cac:TaxTotal>
<cac:LegalMonetaryTotal>
<cbc:LineExtensionAmount currencyID="EUR">300.0</cbc:LineExtensionAmount>
<cbc:TaxExclusiveAmount currencyID="EUR">300.0</cbc:TaxExclusiveAmount>
<cbc:TaxInclusiveAmount currencyID="EUR">363.0</cbc:TaxInclusiveAmount>
<cbc:AllowanceTotalAmount currencyID="EUR">0</cbc:AllowanceTotalAmount>
<cbc:PayableAmount currencyID="EUR">363.0</cbc:PayableAmount>
</cac:LegalMonetaryTotal>
<cac:InvoiceLine>
<cbc:ID>1</cbc:ID>
<cbc:InvoicedQuantity unitCode="ZZ" unitCodeListID="UNECERec20">1.0</cbc:InvoicedQuantity>
<cbc:LineExtensionAmount currencyID="EUR">300.0</cbc:LineExtensionAmount>
<cac:Item>
<cbc:Description>Project X</cbc:Description>
<cbc:Name>Project X</cbc:Name>
<cac:ClassifiedTaxCategory>
<cbc:ID schemeID="UNCL5305">S</cbc:ID>
<cbc:Percent>21.0</cbc:Percent>
<cac:TaxScheme>
<cbc:ID schemeID="UN/ECE 5153">VAT</cbc:ID>
</cac:TaxScheme>
</cac:ClassifiedTaxCategory>
</cac:Item>
<cac:Price>
<cbc:PriceAmount currencyID="EUR">300.0</cbc:PriceAmount>
</cac:Price>
</cac:InvoiceLine>
</Invoice>
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/sales_invoices/1234321/download_ubl.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Download sales invoice packing slip PDF by id
Redirects to the download URL of the sales invoice as packing slip PDF. The link is valid for 30 seconds.
Parameters
| Parameter | Type | Description |
|---|---|---|
media |
String |
In case you want to hide sender address and logo you can set this to ‘stationery’. |
Example: returns invoice by given id as packing slip PDF
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/sales_invoices/416087656873592340/download_packing_slip_pdf.json?
Response
Status: 302 Found
"This resource has been moved temporarily to https://storage.moneybird.dev/91283719be80bb66f48c35b56a2213bd43f5c0270852d970eb109794ad926907/51fb5c307181533bd24c945c8a8da6075d748e4b8ddf79b53eb5a913dcf702af/download."
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/sales_invoices/1234321/download_packing_slip_pdf.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Create a sales invoice
Parameters
| Parameter | Type | Description |
|---|---|---|
sales_invoice[contact_id] |
Integer |
Should be a valid contact id. |
sales_invoice[contact_person_id] |
Integer |
Should be a valid contact person id. |
sales_invoice[original_estimate_id] |
Integer |
|
sales_invoice[document_style_id] |
Integer |
Default document style is used if value is not provided. Should be a valid document style id. |
sales_invoice[workflow_id] |
Integer |
If value is not provided, the workflow saved in the contact is used. If the contact doesn’t have a default workflow, the administration’s default workflow is used. Should be a valid workflow id. |
sales_invoice[reference] |
String |
|
sales_invoice[invoice_sequence_id] |
String |
|
sales_invoice[invoice_date] |
String |
|
sales_invoice[first_due_interval] |
Integer |
|
sales_invoice[currency] |
String |
ISO three-character currency code, e.g. EUR or USD. |
sales_invoice[prices_are_incl_tax] |
Boolean |
|
sales_invoice[payment_conditions] |
String |
|
sales_invoice[discount] |
Decimal |
Discount percentage, e.g. 10,0%. |
sales_invoice[details_attributes][id] |
Integer |
|
sales_invoice[details_attributes][description] |
String |
|
sales_invoice[details_attributes][period] |
String |
String with a date range: |
sales_invoice[details_attributes][price] |
Decimal |
Both a decimal and a string ‘10,95’ are accepted. |
sales_invoice[details_attributes][amount] |
String |
|
sales_invoice[details_attributes][tax_rate_id] |
Integer |
Should be a valid tax rate id. |
sales_invoice[details_attributes][ledger_account_id] |
Integer |
Should be a valid ledger account id. |
sales_invoice[details_attributes][project_id] |
Integer |
Should be a valid project id. |
sales_invoice[details_attributes][product_id] |
Integer |
Should be a valid product id. |
sales_invoice[details_attributes][time_entry_ids] |
Array[integer] |
|
sales_invoice[details_attributes][row_order] |
Integer |
|
sales_invoice[details_attributes][_destroy] |
Boolean |
|
sales_invoice[details_attributes][automated_tax_enabled] |
Boolean |
|
sales_invoice[custom_fields_attributes][id] |
Integer |
Required |
sales_invoice[custom_fields_attributes][value] |
String |
Required |
from_checkout |
Boolean |
Example: create a basic sales invoice
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice":{"reference":"30052","contact_id":416087660175558241,"details_attributes":[{"description":"Rocking Chair","price":129.95}]}}' \
https://moneybird.com/api/v2/123/sales_invoices
Response
Status: 201 Created
{
"id": "416087660495373933",
"administration_id": 123,
"contact_id": "416087660175558241",
"contact": {
"id": "416087660175558241",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:16.602Z",
"updated_at": "2024-03-21T14:42:16.602Z",
"version": 1711032136,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/35615179fc73f60b659e5754ec95bb07eb2a325d9639040a296a63c33bb7ac3d/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087660187092580",
"contact_id": "416087660175558241",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:16.614Z",
"updated_at": "2024-03-21T14:42:16.614Z",
"version": 1711032136
}
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": null,
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 2,
"state": "draft",
"invoice_date": null,
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": null,
"short_payment_reference": null,
"reference": "30052",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": null,
"created_at": "2024-03-21T14:42:16.907Z",
"updated_at": "2024-03-21T14:42:16.912Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032136,
"details": [
{
"id": "416087660497471086",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"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-03-21T14:42:16.910Z",
"updated_at": "2024-03-21T14:42:16.910Z"
}
],
"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",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": null,
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/b815ac4f32e148339a3bb7a1f4ea46de214c43126b40bee6903352b3e6706bfc/35615179fc73f60b659e5754ec95bb07eb2a325d9639040a296a63c33bb7ac3d",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/b815ac4f32e148339a3bb7a1f4ea46de214c43126b40bee6903352b3e6706bfc/35615179fc73f60b659e5754ec95bb07eb2a325d9639040a296a63c33bb7ac3d/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:16.914Z",
"updated_at": "2024-03-21T14:42:16.914Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "129.95",
"taxable_amount_base": "129.95",
"tax_amount": "27.29",
"tax_amount_base": "27.29"
}
]
}
Example: create a sales invoice in a foreign currency
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice":{"reference":"30052","contact_id":416087660993447555,"currency":"USD","details_attributes":[{"description":"Rocking Chair","price":159.99,"tax_rate_id":416087661210502799}]}}' \
https://moneybird.com/api/v2/123/sales_invoices
Response
Status: 201 Created
{
"id": "416087661305923216",
"administration_id": 123,
"contact_id": "416087660993447555",
"contact": {
"id": "416087660993447555",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:17.383Z",
"updated_at": "2024-03-21T14:42:17.383Z",
"version": 1711032137,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/04b19011abb846c84c53fb90cc4415214c35d86109975c766ca875216e6b04f5/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
{
"id": "416087661004981894",
"contact_id": "416087660993447555",
"administration_id": 123,
"firstname": "Jan",
"lastname": "Janssen",
"phone": "123-456-2346",
"email": "janjanssen@dev.null.moneybird.net",
"department": "Sales",
"created_at": "2024-03-21T14:42:17.393Z",
"updated_at": "2024-03-21T14:42:17.393Z",
"version": 1711032137
}
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": null,
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 2,
"state": "draft",
"invoice_date": null,
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": null,
"short_payment_reference": null,
"reference": "30052",
"language": "nl",
"currency": "USD",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": null,
"created_at": "2024-03-21T14:42:17.680Z",
"updated_at": "2024-03-21T14:42:17.685Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032137,
"details": [
{
"id": "416087661308020369",
"administration_id": 123,
"tax_rate_id": "416087661210502799",
"ledger_account_id": "416087461088724843",
"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": "Intra-Community supply, article 138(1), VAT Directive 2006/112",
"created_at": "2024-03-21T14:42:17.683Z",
"updated_at": "2024-03-21T14:42:17.683Z"
}
],
"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",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": null,
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/f3318a6b59b7bd3c16b4430f2a8fe441ee837ece5b92e0d3739b975cb45ebb3d/04b19011abb846c84c53fb90cc4415214c35d86109975c766ca875216e6b04f5",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/f3318a6b59b7bd3c16b4430f2a8fe441ee837ece5b92e0d3739b975cb45ebb3d/04b19011abb846c84c53fb90cc4415214c35d86109975c766ca875216e6b04f5/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:17.687Z",
"updated_at": "2024-03-21T14:42:17.687Z"
}
],
"tax_totals": [
]
}
Example: exceeding the monthly sales invoice limit on a free plan results in an error
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice":{"reference":"30052","contact_id":416087661389809301,"details_attributes":[{"description":"Rocking Chair","price":129.95}]}}' \
https://moneybird.com/api/v2/123/sales_invoices
Response
Status: 402 Payment Required
{
"error": "creating sales invoices is limited",
"symbolic": {
"administration": "limit_reached"
}
}
Example: creating an invoice with an unknown custom field ID results in an error
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice":{"reference":"30052","contact_id":416087661863765673,"details_attributes":[{"description":"Rocking Chair","price":129.95}],"custom_fields_attributes":[{"id":123456,"value":"https://example.com"}]}}' \
https://moneybird.com/api/v2/123/sales_invoices
Response
Status: 404 Not Found
{
"error": "Custom field with id 123456 not found for administration",
"symbolic": {
"custom_fields_attributes": "not_found"
}
}
Update a sales invoice
When updating a sales invoice, provide only the attributes you want to update. The other attributes will not be changed.
Parameters
| Parameter | Type | Description |
|---|---|---|
sales_invoice[contact_id] |
Integer |
Should be a valid contact id. |
sales_invoice[contact_person_id] |
Integer |
Should be a valid contact person id. |
sales_invoice[update_contact] |
Boolean |
|
sales_invoice[original_estimate_id] |
Integer |
|
sales_invoice[document_style_id] |
Integer |
Default document style is used if value is not provided. Should be a valid document style id. |
sales_invoice[workflow_id] |
Integer |
If value is not provided, the workflow saved in the contact is used. If the contact doesn’t have a default workflow, the administration’s default workflow is used. Should be a valid workflow id. |
sales_invoice[reference] |
String |
|
sales_invoice[invoice_sequence_id] |
String |
|
sales_invoice[remove_invoice_sequence_id] |
Boolean |
|
sales_invoice[invoice_date] |
String |
|
sales_invoice[first_due_interval] |
Integer |
|
sales_invoice[currency] |
String |
ISO three-character currency code, e.g. EUR or USD. |
sales_invoice[prices_are_incl_tax] |
Boolean |
|
sales_invoice[payment_conditions] |
String |
|
sales_invoice[discount] |
Decimal |
Discount percentage, e.g. 10,0%. |
sales_invoice[details_attributes][id] |
Integer |
|
sales_invoice[details_attributes][description] |
String |
|
sales_invoice[details_attributes][period] |
String |
String with a date range: |
sales_invoice[details_attributes][price] |
Decimal |
Both a decimal and a string ‘10,95’ are accepted. |
sales_invoice[details_attributes][amount] |
String |
|
sales_invoice[details_attributes][tax_rate_id] |
Integer |
Should be a valid tax rate id. |
sales_invoice[details_attributes][ledger_account_id] |
Integer |
Should be a valid ledger account id. |
sales_invoice[details_attributes][project_id] |
Integer |
Should be a valid project id. |
sales_invoice[details_attributes][product_id] |
Integer |
Should be a valid product id. |
sales_invoice[details_attributes][time_entry_ids] |
Array[integer] |
|
sales_invoice[details_attributes][row_order] |
Integer |
|
sales_invoice[details_attributes][_destroy] |
Boolean |
|
sales_invoice[details_attributes][automated_tax_enabled] |
Boolean |
|
sales_invoice[custom_fields_attributes][id] |
Integer |
Required |
sales_invoice[custom_fields_attributes][value] |
String |
Required |
Example: updating the sales invoice reference
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"sales_invoice":{"reference":"30053"}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087662681654987
Response
Status: 200 OK
{
"id": "416087662681654987",
"administration_id": 123,
"contact_id": "416087662620837576",
"contact": {
"id": "416087662620837576",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:18.935Z",
"updated_at": "2024-03-21T14:42:18.935Z",
"version": 1711032138,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/8d6c09b1e23df90c33930ad8d79cea5c3780b8df7d2aa5991b590574a325aebb/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": null,
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 1,
"state": "draft",
"invoice_date": null,
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": null,
"short_payment_reference": null,
"reference": "30053",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": null,
"created_at": "2024-03-21T14:42:18.992Z",
"updated_at": "2024-03-21T14:42:19.071Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032139,
"details": [
{
"id": "416087662683752140",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:18.995Z",
"updated_at": "2024-03-21T14:42:18.995Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": null,
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/4980a808230e4b7f3db23c4e82a93c024bf9043418734edccb795204a64dc822/8d6c09b1e23df90c33930ad8d79cea5c3780b8df7d2aa5991b590574a325aebb",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/4980a808230e4b7f3db23c4e82a93c024bf9043418734edccb795204a64dc822/8d6c09b1e23df90c33930ad8d79cea5c3780b8df7d2aa5991b590574a325aebb/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:18.999Z",
"updated_at": "2024-03-21T14:42:18.999Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: adding and removing a sales invoice detail
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"sales_invoice":{"details_attributes":[{"description":"Sofa","price":199.99},{"id":416087662914438868,"_destroy":true}]}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087662911293139
Response
Status: 200 OK
{
"id": "416087662911293139",
"administration_id": 123,
"contact_id": "416087662853621456",
"contact": {
"id": "416087662853621456",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:19.156Z",
"updated_at": "2024-03-21T14:42:19.156Z",
"version": 1711032139,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f6f299e394b6031e710c44b98ad0d04fbd35cf3946d76ffb16296aa8722fc5dd/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": null,
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 1,
"state": "draft",
"invoice_date": null,
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": null,
"short_payment_reference": null,
"reference": "30052",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": null,
"created_at": "2024-03-21T14:42:19.212Z",
"updated_at": "2024-03-21T14:42:19.311Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032139,
"details": [
{
"id": "416087663014053590",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"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-03-21T14:42:19.309Z",
"updated_at": "2024-03-21T14:42:19.309Z"
}
],
"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",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": null,
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/193a4543f33048a124aa78d07bba08c5dd0011ec0ac44d8540fef77e06e589f8/f6f299e394b6031e710c44b98ad0d04fbd35cf3946d76ffb16296aa8722fc5dd",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/193a4543f33048a124aa78d07bba08c5dd0011ec0ac44d8540fef77e06e589f8/f6f299e394b6031e710c44b98ad0d04fbd35cf3946d76ffb16296aa8722fc5dd/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:19.219Z",
"updated_at": "2024-03-21T14:42:19.219Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "199.99",
"taxable_amount_base": "199.99",
"tax_amount": "42.0",
"tax_amount_base": "42.0"
}
]
}
Delete a sales invoice
Parameters
| Parameter | Type | Description |
|---|---|---|
explain_destroy |
Boolean |
Example: deletes given invoice
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087665764468536.json
Response
Adds note to entity
Parameters
| Parameter | Type | Description |
|---|---|---|
note[note] |
String |
Required. Text for the note or to-do. |
note[todo] |
Boolean |
If |
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":416087681040123182,"todo":true}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087680870253863/notes.json
Response
Status: 201 Created
{
"id": "416087681099892016",
"administration_id": 123,
"entity_id": "416087680870253863",
"entity_type": "SalesInvoice",
"user_id": 17110319469471,
"assignee_id": "416087681040123182",
"todo": true,
"note": "Text of the note",
"completed_at": null,
"completed_by_id": null,
"todo_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:36.557Z",
"updated_at": "2024-03-21T14:42:36.557Z"
}
Destroys note from entity
Example: destroy a note
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087681226769721/notes/416087681394541888.json
Response
Create a payment
Parameters
| Parameter | Type | Description |
|---|---|---|
payment[payment_date] |
String |
Required |
payment[price] |
Decimal |
Required Both a decimal and a string ‘10,95’ are accepted. Should be a number -1,000,000,000 <= n <= 1,000,000,000. |
payment[price_base] |
Decimal |
Amount paid expressed in the base currency. Required for foreign currencies. Should be a number -1,000,000,000 <= n <= 1,000,000,000. |
payment[financial_account_id] |
Integer |
Should be a valid financial account id. |
payment[financial_mutation_id] |
Integer |
Should be a valid financial mutation id. |
payment[transaction_identifier] |
String |
|
payment[manual_payment_action] |
String |
Can be |
payment[ledger_account_id] |
Integer |
Should be a valid ledger account id. |
payment[invoice_id] |
Integer |
Required |
Example: create a payment
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"payment":{"payment_date":"2024-03-21 14:42:23 UTC","price":"363.0"}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087667087771497/payments.json
Response
Status: 201 Created
{
"id": "416087667336284016",
"administration_id": 123,
"invoice_type": "SalesInvoice",
"invoice_id": "416087667087771497",
"financial_account_id": null,
"user_id": 17110319469471,
"payment_transaction_id": null,
"transaction_identifier": null,
"price": "363.0",
"price_base": "363.0",
"payment_date": "2024-03-21",
"credit_invoice_id": null,
"financial_mutation_id": null,
"ledger_account_id": "416087461152687990",
"linked_payment_id": null,
"manual_payment_action": null,
"created_at": "2024-03-21T14:42:23.432Z",
"updated_at": "2024-03-21T14:42:23.432Z"
}
Delete a payment
Example: destroy a payment
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087667699091329/payments/416087667870009223.json
Response
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL
where the attachment can be downloaded. Use the Location header in the response
to download the attachment.
Delete an attachment
Deletes an attachment of an attachable.
Sends an invoice
This endpoint provides two options: sending the invoice and scheduling sending in the future. When sending now, you can provide a send method, email address and message. If you don’t provide any arguments, the defaults from the contact and workflow will be used.
When scheduling sending, set the boolean sending_scheduled to true and provide an invoice_date.
Parameters
| Parameter | Type | Description |
|---|---|---|
sales_invoice_sending[delivery_method] |
String |
Can be |
sales_invoice_sending[sending_scheduled] |
Boolean |
|
sales_invoice_sending[deliver_ubl] |
Boolean |
|
sales_invoice_sending[mergeable] |
Boolean |
|
sales_invoice_sending[email_address] |
String |
|
sales_invoice_sending[email_message] |
String |
|
sales_invoice_sending[invoice_date] |
String |
Example: sends an invoice
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087663150368476/send_invoice.json
Response
Status: 200 OK
{
"id": "416087663150368476",
"administration_id": 123,
"contact_id": "416087663093745369",
"contact": {
"id": "416087663093745369",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:19.385Z",
"updated_at": "2024-03-21T14:42:19.385Z",
"version": 1711032139,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e124e2d974cfc3438bdea979543c07629ede4238fa24e7ad1e8f7b653c8c1f99/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF2900000000000006H3JWV5U",
"short_payment_reference": "RF296H3JWV5U",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:19.439Z",
"updated_at": "2024-03-21T14:42:19.582Z",
"public_view_code": "485847",
"public_view_code_expires_at": "2024-06-21T13:42:19.539Z",
"version": 1711032139,
"details": [
{
"id": "416087663152465629",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:19.442Z",
"updated_at": "2024-03-21T14:42:19.580Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/6c44e4716b20d4425f5b62e91fa8e53a2da4c61600ad0032369b25fd0171694b/e124e2d974cfc3438bdea979543c07629ede4238fa24e7ad1e8f7b653c8c1f99",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/6c44e4716b20d4425f5b62e91fa8e53a2da4c61600ad0032369b25fd0171694b/e124e2d974cfc3438bdea979543c07629ede4238fa24e7ad1e8f7b653c8c1f99/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:19.445Z",
"updated_at": "2024-03-21T14:42:19.445Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:19.553Z",
"updated_at": "2024-03-21T14:42:19.553Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:19.601Z",
"updated_at": "2024-03-21T14:42:19.601Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: returns error when sending invalid invoice without details
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087663495349992/send_invoice.json
Response
Status: 400 Bad Request
{
"error": "details cannot be empty",
"symbolic": {
"sales_invoice": "details_cannot_be_empty"
}
}
Example: returns error when sending invoice from identity without email
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087663745959664/send_invoice.json
Response
Status: 422 Unprocessable Entity
{
"error": {
"delivery_method": [
"The sender address must contain an email address"
]
}
}
Example: returns error when sending invoice to contact without email address
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087663955674873/send_invoice.json
Response
Status: 422 Unprocessable Entity
{
"error": {
"email_address": [
"can't be blank"
]
}
}
Example: sends an invoice with alternative information
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"sales_invoice_sending":{"delivery_method":"Email","email_address":"alternative@example.com","email_message":"Hi, this is my invoice with id {invoice_id}!"}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087664168535810/send_invoice.json
Response
Status: 200 OK
{
"id": "416087664168535810",
"administration_id": 123,
"contact_id": "416087664112961279",
"contact": {
"id": "416087664112961279",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:20.358Z",
"updated_at": "2024-03-21T14:42:20.358Z",
"version": 1711032140,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/ea65e797092be8595c090f27bee9ecec04e66d45b56aa3b288a11534f5306611/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF030000000000000Z5ZNWWAC",
"short_payment_reference": "RF03Z5ZNWWAC",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:20.411Z",
"updated_at": "2024-03-21T14:42:20.553Z",
"public_view_code": "858247",
"public_view_code_expires_at": "2024-06-21T13:42:20.510Z",
"version": 1711032140,
"details": [
{
"id": "416087664171681539",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:20.413Z",
"updated_at": "2024-03-21T14:42:20.551Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/1da7b09539bd5386b7306397072798b7a4a8ca65728cb4687d9b195ddc7eec86/ea65e797092be8595c090f27bee9ecec04e66d45b56aa3b288a11534f5306611",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/1da7b09539bd5386b7306397072798b7a4a8ca65728cb4687d9b195ddc7eec86/ea65e797092be8595c090f27bee9ecec04e66d45b56aa3b288a11534f5306611/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:20.418Z",
"updated_at": "2024-03-21T14:42:20.418Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:20.524Z",
"updated_at": "2024-03-21T14:42:20.524Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "alternative@example.com",
"email_message": "Hi, this is my invoice with id {invoice_id}!"
},
"created_at": "2024-03-21T14:42:20.575Z",
"updated_at": "2024-03-21T14:42:20.575Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: sends an invoice via mail with an UBL attachment
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"sales_invoice_sending":{"delivery_method":"Email","deliver_ubl":true,"email_address":"alternative@example.com"}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087664514565902/send_invoice.json
Response
Status: 200 OK
{
"id": "416087664514565902",
"administration_id": 123,
"contact_id": "416087664452699915",
"contact": {
"id": "416087664452699915",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:20.681Z",
"updated_at": "2024-03-21T14:42:20.681Z",
"version": 1711032140,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/b1e5d0b119af872c2d4a887e1acd5490bffe63709faccd023c763309b436c27f/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0001",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "open",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF330000000000000YEA293W5",
"short_payment_reference": "RF33YEA293W5",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:20.741Z",
"updated_at": "2024-03-21T14:42:20.892Z",
"public_view_code": "006230",
"public_view_code_expires_at": "2024-06-21T13:42:20.842Z",
"version": 1711032140,
"details": [
{
"id": "416087664517711631",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:20.743Z",
"updated_at": "2024-03-21T14:42:20.890Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/99b7013426d8e396710c60d6c3fff56ca38e9a9473eed6263c03d502ff168695/b1e5d0b119af872c2d4a887e1acd5490bffe63709faccd023c763309b436c27f",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/99b7013426d8e396710c60d6c3fff56ca38e9a9473eed6263c03d502ff168695/b1e5d0b119af872c2d4a887e1acd5490bffe63709faccd023c763309b436c27f/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:20.748Z",
"updated_at": "2024-03-21T14:42:20.748Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:20.856Z",
"updated_at": "2024-03-21T14:42:20.856Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "alternative@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0001 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:20.914Z",
"updated_at": "2024-03-21T14:42:20.914Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
Example: schedule sending
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"sales_invoice_sending":{"sending_scheduled":true,"invoice_date":"2024-03-22"}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087664843818778/send_invoice.json
Response
Status: 200 OK
{
"id": "416087664843818778",
"administration_id": 123,
"contact_id": "416087664784049943",
"contact": {
"id": "416087664784049943",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:20.997Z",
"updated_at": "2024-03-21T14:42:20.997Z",
"version": 1711032140,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/fe52de26eff30a55237b07cbb20853de3698627c011ebac2e4aef2c4cf757ef5/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": null,
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": 1,
"state": "scheduled",
"invoice_date": "2024-03-22",
"due_date": "2024-04-05",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": null,
"short_payment_reference": null,
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": null,
"paused": false,
"paid_at": null,
"sent_at": null,
"created_at": "2024-03-21T14:42:21.054Z",
"updated_at": "2024-03-21T14:42:21.165Z",
"public_view_code": null,
"public_view_code_expires_at": null,
"version": 1711032141,
"details": [
{
"id": "416087664846964507",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "1 x",
"amount_decimal": "1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "300.0",
"total_price_excl_tax_with_discount_base": "300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:21.058Z",
"updated_at": "2024-03-21T14:42:21.163Z"
}
],
"payments": [
],
"total_paid": "0.0",
"total_unpaid": "363.0",
"total_unpaid_base": "363.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "300.0",
"total_price_excl_tax_base": "300.0",
"total_price_incl_tax": "363.0",
"total_price_incl_tax_base": "363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": null,
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/33edf2e71818c9933414486c554cee5c1aad436c7db70ebab13b91087f43f061/fe52de26eff30a55237b07cbb20853de3698627c011ebac2e4aef2c4cf757ef5",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/33edf2e71818c9933414486c554cee5c1aad436c7db70ebab13b91087f43f061/fe52de26eff30a55237b07cbb20853de3698627c011ebac2e4aef2c4cf757ef5/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_created",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:21.062Z",
"updated_at": "2024-03-21T14:42:21.062Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_scheduled",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:21.148Z",
"updated_at": "2024-03-21T14:42:21.148Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "300.0",
"taxable_amount_base": "300.0",
"tax_amount": "63.0",
"tax_amount_base": "63.0"
}
]
}
DEPRECATED: Register a payment
This endpoint is deprecated and should no longer be used. It has been replaced by Create a payment.
Parameters
| Parameter | Type | Description |
|---|---|---|
payment[payment_date] |
String |
Required |
payment[price] |
Decimal |
Required Both a decimal and a string ‘10,95’ are accepted. Should be a number -1,000,000,000 <= n <= 1,000,000,000. |
payment[price_base] |
Decimal |
Amount paid expressed in the base currency. Required for foreign currencies. Should be a number -1,000,000,000 <= n <= 1,000,000,000. |
payment[financial_account_id] |
Integer |
Should be a valid financial account id. |
payment[financial_mutation_id] |
Integer |
Should be a valid financial mutation id. |
payment[transaction_identifier] |
String |
|
payment[manual_payment_action] |
String |
Can be |
payment[ledger_account_id] |
Integer |
Should be a valid ledger account id. |
payment[invoice_id] |
Integer |
Required |
Example: registers payments
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"payment":{"payment_date":"2024-03-21 14:42:22 UTC","price":"363.0"}}' \
https://moneybird.com/api/v2/123/sales_invoices/416087665995155265/register_payment.json
Response
Status: 200 OK
{
"id": "416087666218501960",
"administration_id": 123,
"invoice_type": "SalesInvoice",
"invoice_id": "416087665995155265",
"financial_account_id": null,
"user_id": 17110319469471,
"payment_transaction_id": null,
"transaction_identifier": null,
"price": "363.0",
"price_base": "363.0",
"payment_date": "2024-03-21",
"credit_invoice_id": null,
"financial_mutation_id": null,
"ledger_account_id": "416087461152687990",
"linked_payment_id": null,
"manual_payment_action": null,
"created_at": "2024-03-21T14:42:22.366Z",
"updated_at": "2024-03-21T14:42:22.366Z"
}
Register a payment for a creditinvoice
Example: registers payments for a credit invoice
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{}' \
https://moneybird.com/api/v2/123/sales_invoices/416087666586552151/register_payment_creditinvoice.json
Response
Status: 200 OK
{
"id": "416087666586552151",
"administration_id": 123,
"contact_id": "416087666306582349",
"contact": {
"id": "416087666306582349",
"administration_id": 123,
"company_name": "Foobar Holding B.V.",
"firstname": "",
"lastname": "",
"address1": "Hoofdstraat 12",
"address2": "",
"zipcode": "1234AB",
"city": "Amsterdam",
"country": "NL",
"phone": "",
"delivery_method": "Email",
"customer_id": "1",
"tax_number": "",
"chamber_of_commerce": "",
"bank_account": "",
"attention": "",
"email": "info@example.com",
"email_ubl": true,
"send_invoices_to_attention": "",
"send_invoices_to_email": "info@example.com",
"send_estimates_to_attention": "",
"send_estimates_to_email": "info@example.com",
"sepa_active": false,
"sepa_iban": "",
"sepa_iban_account_name": "",
"sepa_bic": "",
"sepa_mandate_id": "",
"sepa_mandate_date": null,
"sepa_sequence_type": "RCUR",
"credit_card_number": "",
"credit_card_reference": "",
"credit_card_type": null,
"tax_number_validated_at": null,
"tax_number_valid": null,
"invoice_workflow_id": null,
"estimate_workflow_id": null,
"si_identifier": "",
"si_identifier_type": null,
"moneybird_payments_mandate": false,
"created_at": "2024-03-21T14:42:22.450Z",
"updated_at": "2024-03-21T14:42:22.450Z",
"version": 1711032142,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5078dbaae7bd6f9cbfd37b592d068e8f6a2a6ecfa8f5adfa77fba826caaa971c/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"contact_person_id": null,
"contact_person": null,
"invoice_id": "2024-0002",
"recurring_sales_invoice_id": null,
"workflow_id": "416087461393860486",
"document_style_id": "416087461533321104",
"identity_id": "416087461234476933",
"draft_id": null,
"state": "paid",
"invoice_date": "2024-03-21",
"due_date": "2024-04-04",
"payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
"payment_reference": "RF6500000000000009Q66E7JG",
"short_payment_reference": "RF659Q66E7JG",
"reference": "Project X",
"language": "nl",
"currency": "EUR",
"discount": "0.0",
"original_sales_invoice_id": "416087666373691216",
"paused": false,
"paid_at": "2024-03-21",
"sent_at": "2024-03-21",
"created_at": "2024-03-21T14:42:22.716Z",
"updated_at": "2024-03-21T14:42:22.977Z",
"public_view_code": "841524",
"public_view_code_expires_at": "2024-06-21T14:42:22.787Z",
"version": 1711032142,
"details": [
{
"id": "416087666589697880",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "**Creditfactuur voor factuur 2024-0001**",
"price": "0.0",
"period": null,
"row_order": 1,
"total_price_excl_tax_with_discount": "0.0",
"total_price_excl_tax_with_discount_base": "0.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": "",
"created_at": "2024-03-21T14:42:22.719Z",
"updated_at": "2024-03-21T14:42:22.839Z"
},
{
"id": "416087666590746457",
"administration_id": 123,
"tax_rate_id": "416087461198825343",
"ledger_account_id": "416087461088724843",
"project_id": null,
"product_id": null,
"amount": "-1 x",
"amount_decimal": "-1.0",
"description": "Project X",
"price": "300.0",
"period": null,
"row_order": 2,
"total_price_excl_tax_with_discount": "-300.0",
"total_price_excl_tax_with_discount_base": "-300.0",
"tax_report_reference": [
"NL/1a"
],
"mandatory_tax_text": null,
"created_at": "2024-03-21T14:42:22.721Z",
"updated_at": "2024-03-21T14:42:22.841Z"
}
],
"payments": [
{
"id": "416087666834016094",
"administration_id": 123,
"invoice_type": "SalesInvoice",
"invoice_id": "416087666586552151",
"financial_account_id": null,
"user_id": 17110319469471,
"payment_transaction_id": null,
"transaction_identifier": null,
"price": "-363.0",
"price_base": "-363.0",
"payment_date": "2024-03-21",
"credit_invoice_id": null,
"financial_mutation_id": null,
"ledger_account_id": "416087461152687989",
"linked_payment_id": null,
"manual_payment_action": null,
"created_at": "2024-03-21T14:42:22.953Z",
"updated_at": "2024-03-21T14:42:22.953Z"
}
],
"total_paid": "-363.0",
"total_unpaid": "0.0",
"total_unpaid_base": "0.0",
"prices_are_incl_tax": false,
"total_price_excl_tax": "-300.0",
"total_price_excl_tax_base": "-300.0",
"total_price_incl_tax": "-363.0",
"total_price_incl_tax_base": "-363.0",
"total_discount": "0.0",
"marked_dubious_on": null,
"marked_uncollectible_on": null,
"reminder_count": 0,
"next_reminder": "2024-04-04",
"original_estimate_id": null,
"url": "http://moneybird.dev/123/sales_invoices/59d86e884842bc67765eed0b0fb4692e19bd61f5d19a1662b7e006ac122406ec/5078dbaae7bd6f9cbfd37b592d068e8f6a2a6ecfa8f5adfa77fba826caaa971c",
"payment_url": "http://moneybird.dev/123/online_sales_invoices/59d86e884842bc67765eed0b0fb4692e19bd61f5d19a1662b7e006ac122406ec/5078dbaae7bd6f9cbfd37b592d068e8f6a2a6ecfa8f5adfa77fba826caaa971c/pay_invoice",
"custom_fields": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "credit_invoice_created_from_original",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"original_invoice": "2024-0001"
},
"created_at": "2024-03-21T14:42:22.725Z",
"updated_at": "2024-03-21T14:42:22.725Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_open",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:22.804Z",
"updated_at": "2024-03-21T14:42:22.804Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_send_email",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"email_address": "info@example.com",
"email_message": "Geachte Foobar Holding B.V.,\n\nIn de bijlage kunt u factuur 2024-0002 voor onze diensten vinden. Wij verzoeken u vriendelijk de factuur voor 04-04-2024 te voldoen.\n\nMet vriendelijke groet,\n\nParkietje B.V."
},
"created_at": "2024-03-21T14:42:22.861Z",
"updated_at": "2024-03-21T14:42:22.861Z"
},
{
"administration_id": 123,
"user_id": 17110319469471,
"action": "sales_invoice_state_changed_to_paid",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-03-21T14:42:22.957Z",
"updated_at": "2024-03-21T14:42:22.957Z"
}
],
"tax_totals": [
{
"tax_rate_id": "416087461198825343",
"taxable_amount": "-300.0",
"taxable_amount_base": "-300.0",
"tax_amount": "-63.0",
"tax_amount_base": "-63.0"
}
]
}
Sends a reminder
This endpoint sends a reminder to a contact. A reminder can contain multiple sales invoices. Reminders are grouped by workflow, identity and document style, so a contact with sales invoices with different workflows, will receive multiple reminders. Only by grouping reminders like this, we can assure the right content and layout of a reminder.
Parameters
| Parameter | Type | Description |
|---|---|---|
sales_invoice_reminders |
Array |
Required |
sales_invoice_reminders[contact_id] |
Integer |
Required |
sales_invoice_reminders[workflow_id] |
Integer |
Required |
sales_invoice_reminders[identity_id] |
Integer |
Required |
sales_invoice_reminders[document_style_id] |
Integer |
Required |
sales_invoice_reminders[sales_invoice_ids] |
Array |
Required |
sales_invoice_reminders[reminder_text] |
String |
|
sales_invoice_reminders[delivery_method] |
String |
|
sales_invoice_reminders[email_address] |
String |
Example: sends reminders for given invoices
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice_reminders":[{"contact_id":416087668275808155,"workflow_id":416087668310411165,"document_style_id":416087461533321104,"identity_id":416087461234476933,"sales_invoice_ids":[416087668388005795]},{"contact_id":416087668275808155,"workflow_id":416087668590380969,"document_style_id":416087461533321104,"identity_id":416087461234476933,"sales_invoice_ids":[416087668678461359]},{"contact_id":416087668876642230,"workflow_id":416087668310411165,"document_style_id":416087461533321104,"identity_id":416087461234476933,"sales_invoice_ids":[416087668938508216,416087669361084350]}]}' \
https://moneybird.com/api/v2/123/sales_invoices/send_reminders.json
Response
Status: 200 OK
200
Example: returns an error when invalid parameters are given
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice_reminders":[{"contact_id":416087670153807835,"workflow_id":416087670194702301,"document_style_id":416087461533321104,"identity_id":416087461234476933,"sales_invoice_ids":[416087670296414179],"email_address":"invalid.email"}]}' \
https://moneybird.com/api/v2/123/sales_invoices/send_reminders.json
Response
Status: 422 Unprocessable Entity
{
"errors": [
{
"email_address": [
"is not a valid email address"
]
}
]
}
Example: returns an error if delivery_method Simplerinvoicing is given
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice_reminders":[{"contact_id":416087671922754579,"workflow_id":416087671963649045,"document_style_id":416087461533321104,"identity_id":416087461234476933,"sales_invoice_ids":[416087672066409499],"delivery_method":"Simplerinvoicing"}]}' \
https://moneybird.com/api/v2/123/sales_invoices/send_reminders.json
Response
Status: 400 Bad Request
{
"error": "Delivery Method isn't an option",
"symbolic": {
"sales_invoice_reminders": {
"reminders_for_contacts_attributes": {
"0": {
"delivery_method": "in"
}
}
}
}
}
Example: sends via Email if contact has delivery_method Simplerinvoicing
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"sales_invoice_reminders":[{"contact_id":416087673499812939,"workflow_id":416087673534415949,"document_style_id":416087461533321104,"identity_id":416087461234476933,"sales_invoice_ids":[416087673609913427]}]}' \
https://moneybird.com/api/v2/123/sales_invoices/send_reminders.json
Response
Status: 200 OK
200
Pause sales invoice
This endpoint pauses a sales invoice. The automatic workflow steps will not be executed while the sales invoice is paused.
Resume sales invoice
This endpoint resumes the sales invoice. The automatic workflow steps will execute again after resuming.
Duplicate to credit invoice
Mark as dubious
This endpoint marks a sales invoice as dubious.
Parameters
| Parameter | Type | Description |
|---|---|---|
dubious_date |
Date |
Mark as uncollectible
This endpoint marks a sales invoice as uncollectible.
Parameters
| Parameter | Type | Description |
|---|---|---|
uncollectible_date |
Date |
|
book_method |
String |
Can be |
Add attachment to sales invoice
Example: uploads an attachment
Request
curl -s -H "Content-Type: multipart/mixed" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-F file=@/tmp/upload.pdf \
https://moneybird.com/api/v2/123/sales_invoices/416087681565459786/attachments.json
Response
Status: 200 OK
200