Documents: Receipts
List ids and versions of receipts
Returns all documents in the administration. The list contains the document id and the version of the document.
Check if the version of the document is newer than the version you have stored locally, use the POST
variant for fetching documents with the given ids.
Parameters
| Parameter | Type | Description |
|---|---|---|
filter |
String |
String terms, example: key1:value1,key2:value2. |
Example: retrieves all ids for synchronization
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts/synchronization.json?
Response
Status: 200 OK
[
{
"id": "426664123055473844",
"version": 1721118637
},
{
"id": "426664123160331450",
"version": 1721118637
},
{
"id": "426664123210663101",
"version": 1721118637
}
]
Example: retrieves all ids for synchronization using a filter
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts/synchronization.json?filter=period%3Athis_month
Response
Status: 200 OK
[
{
"id": "426664123358512325",
"version": 1721118637
},
{
"id": "426664123438204107",
"version": 1721118637
},
{
"id": "426664123473855694",
"version": 1721118638
}
]
Fetch receipts with given ids
Given a list of document ids, returns the document information belonging to the documents. Returns a maximum of 100 documents, even if more ids are provided.
Parameters
| Parameter | Type | Description |
|---|---|---|
ids |
Array[integer] |
Required |
Example: retrieves documents for given ids
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"ids":[426664123655259356,426664123691959519]}' \
https://moneybird.com/api/v2/123/documents/receipts/synchronization.json
Response
Status: 200 OK
[
{
"id": "426664123691959519",
"administration_id": 123,
"contact_id": "426664123559838931",
"contact": {
"id": "426664123559838931",
"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-07-16T08:30:38.091Z",
"updated_at": "2024-07-16T08:30:38.091Z",
"version": 1721118638,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f04543a52e205ebfd2ffd0818561552735e390e43c41c6d39776d7c924ae6e22/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 4,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:38.217Z",
"updated_at": "2024-07-16T08:30:38.222Z",
"version": 1721118638,
"details": [
{
"id": "426664123694056672",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:38.219Z",
"updated_at": "2024-07-16T08:30:38.219Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:38.227Z",
"updated_at": "2024-07-16T08:30:38.227Z"
}
]
},
{
"id": "426664123655259356",
"administration_id": 123,
"contact_id": "426664123559838931",
"contact": {
"id": "426664123559838931",
"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-07-16T08:30:38.091Z",
"updated_at": "2024-07-16T08:30:38.091Z",
"version": 1721118638,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/f04543a52e205ebfd2ffd0818561552735e390e43c41c6d39776d7c924ae6e22/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 3,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:38.183Z",
"updated_at": "2024-07-16T08:30:38.186Z",
"version": 1721118638,
"details": [
{
"id": "426664123657356509",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:38.184Z",
"updated_at": "2024-07-16T08:30:38.184Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:38.187Z",
"updated_at": "2024-07-16T08:30:38.187Z"
}
]
}
]
Get receipts
Returns a paginated list of documents of this type in the administration.
The filter argument allows you to filter on the list of documents. Filters are a combination of keys and values,
separated by a comma: key:value,key2:value2. The most common filter method will be period: period:this_month.
Filtering works the same as in the web application, for more advanced examples, change the filtering in the web
application and learn from the resulting URI.
Parameters
| Parameter | Type | Description |
|---|---|---|
filter |
String |
Required String terms, example: |
new_filter |
String |
String terms, example: |
page |
Integer |
|
per_page |
Integer |
|
exclude_new_general_journal_documents |
Boolean |
Example: returns a list of receipts
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts.json?
Response
Status: 200 OK
[
{
"id": "426664118346319806",
"administration_id": 123,
"contact_id": "426664118136604591",
"contact": {
"id": "426664118136604591",
"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-07-16T08:30:32.919Z",
"updated_at": "2024-07-16T08:30:32.919Z",
"version": 1721118632,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e2b2e600aa520a9a7a92e44baa8cf4358a9cf31cd08e553407cd5ada809de2cf/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 5,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:33.119Z",
"updated_at": "2024-07-16T08:30:33.126Z",
"version": 1721118633,
"details": [
{
"id": "426664118349465535",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:33.122Z",
"updated_at": "2024-07-16T08:30:33.122Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:33.130Z",
"updated_at": "2024-07-16T08:30:33.130Z"
}
]
},
{
"id": "426664118290745275",
"administration_id": 123,
"contact_id": "426664118136604591",
"contact": {
"id": "426664118136604591",
"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-07-16T08:30:32.919Z",
"updated_at": "2024-07-16T08:30:32.919Z",
"version": 1721118632,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e2b2e600aa520a9a7a92e44baa8cf4358a9cf31cd08e553407cd5ada809de2cf/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 4,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:33.066Z",
"updated_at": "2024-07-16T08:30:33.070Z",
"version": 1721118633,
"details": [
{
"id": "426664118291793852",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:33.068Z",
"updated_at": "2024-07-16T08:30:33.068Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:33.072Z",
"updated_at": "2024-07-16T08:30:33.072Z"
}
]
},
{
"id": "426664118249850808",
"administration_id": 123,
"contact_id": "426664118136604591",
"contact": {
"id": "426664118136604591",
"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-07-16T08:30:32.919Z",
"updated_at": "2024-07-16T08:30:32.919Z",
"version": 1721118632,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/e2b2e600aa520a9a7a92e44baa8cf4358a9cf31cd08e553407cd5ada809de2cf/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 3,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:33.027Z",
"updated_at": "2024-07-16T08:30:33.031Z",
"version": 1721118633,
"details": [
{
"id": "426664118251947961",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:33.029Z",
"updated_at": "2024-07-16T08:30:33.029Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:33.033Z",
"updated_at": "2024-07-16T08:30:33.033Z"
}
]
}
]
Example: returns paginated receipts on page 1
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts.json?per_page=1
Response
Status: 200 OK
[
{
"id": "426664118728001490",
"administration_id": 123,
"contact_id": "426664118497314755",
"contact": {
"id": "426664118497314755",
"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-07-16T08:30:33.264Z",
"updated_at": "2024-07-16T08:30:33.264Z",
"version": 1721118633,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/91328f8d98cc6952efeeb651392daccdd705c4a3997e3bbde22ad6536bdf33be/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 5,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:33.483Z",
"updated_at": "2024-07-16T08:30:33.489Z",
"version": 1721118633,
"details": [
{
"id": "426664118731147219",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:33.486Z",
"updated_at": "2024-07-16T08:30:33.486Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:33.496Z",
"updated_at": "2024-07-16T08:30:33.496Z"
}
]
}
]
Example: returns paginated receipts on page 2
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts.json?page=2&per_page=1
Response
Status: 200 OK
[
{
"id": "426664119126460387",
"administration_id": 123,
"contact_id": "426664118927230935",
"contact": {
"id": "426664118927230935",
"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-07-16T08:30:33.673Z",
"updated_at": "2024-07-16T08:30:33.673Z",
"version": 1721118633,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/5c26a7d2009906c88d63f1f0a11d7a3b4a12bc412679cddb754cca728f90479e/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 4,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:33.861Z",
"updated_at": "2024-07-16T08:30:33.871Z",
"version": 1721118633,
"details": [
{
"id": "426664119130654692",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:33.866Z",
"updated_at": "2024-07-16T08:30:33.866Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:33.875Z",
"updated_at": "2024-07-16T08:30:33.875Z"
}
]
}
]
Example: returns an error when too many receipts are requested
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts.json?per_page=101
Response
Status: 400 Bad Request
{
"error": "Per Page is too big",
"symbolic": {
"per_page": "max"
}
}
Get receipts
Example: returns the wanted receipt
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts/426664120220124191.json?
Response
Status: 200 OK
{
"id": "426664120220124191",
"administration_id": 123,
"contact_id": "426664120192861212",
"contact": {
"id": "426664120192861212",
"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-07-16T08:30:34.881Z",
"updated_at": "2024-07-16T08:30:34.881Z",
"version": 1721118634,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/04a3f5a8190ff9565ff0391083c241a1d1dcdf64843c9aaac54a090d169251b8/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 1,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:34.907Z",
"updated_at": "2024-07-16T08:30:34.909Z",
"version": 1721118634,
"details": [
{
"id": "426664120221172768",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:34.908Z",
"updated_at": "2024-07-16T08:30:34.908Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:34.911Z",
"updated_at": "2024-07-16T08:30:34.911Z"
}
]
}
Example: only returns receipts
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XGET \
https://moneybird.com/api/v2/123/documents/receipts/426664120406770733.json?
Response
Status: 404 Not Found
{
"error": "record not found",
"symbolic": {
"id": "not_found"
}
}
Create a new receipts
Parameters
| Parameter | Type | Description |
|---|---|---|
receipt[contact_id] |
Integer |
Required. Should be a valid contact id. |
receipt[reference] |
String |
Required. |
receipt[date] |
String |
Required Required. |
receipt[currency] |
String |
ISO three-character currency code, e.g. EUR or USD. |
receipt[prices_are_incl_tax] |
Boolean |
|
receipt[origin] |
String |
Can be |
receipt[details_attributes][id] |
Integer |
|
receipt[details_attributes][description] |
String |
|
receipt[details_attributes][period] |
String |
String with a date range: |
receipt[details_attributes][price] |
Decimal |
Both a decimal and a string ‘10,95’ are accepted. |
receipt[details_attributes][amount] |
String |
|
receipt[details_attributes][tax_rate_id] |
Integer |
Should be a valid tax rate id. |
receipt[details_attributes][ledger_account_id] |
Integer |
Should be a valid ledger account id. |
receipt[details_attributes][project_id] |
Integer |
Should be a valid project id. |
receipt[details_attributes][row_order] |
Integer |
|
receipt[details_attributes][_destroy] |
Boolean |
|
payment[financial_account_id] |
Integer |
Should be a valid financial account id. |
Example: creates the receipt
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{"receipt":{"reference":"foobar","contact_id":426664120485413938,"details_attributes":{"0":{"description":"Lunch","price":20,"tax_rate_id":426664036227089970,"ledger_account_id":426664036164175388}}}}' \
https://moneybird.com/api/v2/123/documents/receipts.json
Response
Status: 201 Created
{
"id": "426664120699323451",
"administration_id": 123,
"contact_id": "426664120485413938",
"contact": {
"id": "426664120485413938",
"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-07-16T08:30:35.160Z",
"updated_at": "2024-07-16T08:30:35.160Z",
"version": 1721118635,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1be8c6c8253c4caebe32e90405ce58dc7ad9f44c233a3ac49a7b410bd17f731e/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "foobar",
"date": "2024-07-16",
"due_date": null,
"entry_number": 3,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "16.53",
"total_price_excl_tax_base": "16.53",
"total_price_incl_tax": "20.0",
"total_price_incl_tax_base": "20.0",
"created_at": "2024-07-16T08:30:35.363Z",
"updated_at": "2024-07-16T08:30:35.368Z",
"version": 1721118635,
"details": [
{
"id": "426664120702469180",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Lunch",
"price": "20.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "16.53",
"total_price_excl_tax_with_discount_base": "16.53",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:35.366Z",
"updated_at": "2024-07-16T08:30:35.366Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:35.371Z",
"updated_at": "2024-07-16T08:30:35.371Z"
}
]
}
Example: requires all input
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-d '{}' \
https://moneybird.com/api/v2/123/documents/receipts.json
Response
Status: 400 Bad Request
{
"error": "Receipt is required",
"symbolic": {
"receipt": "required"
}
}
Delete a receipts
Parameters
| Parameter | Type | Description |
|---|---|---|
refresh_journal_entries |
Boolean |
Example: deletes the receipt
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/documents/receipts/426664121583273073.json
Response
Status: 200 OK
200
Update a receipts
Parameters
| Parameter | Type | Description |
|---|---|---|
receipt[contact_id] |
Integer |
Required. Should be a valid contact id. |
receipt[reference] |
String |
Required. |
receipt[date] |
String |
Required Required. |
receipt[currency] |
String |
ISO three-character currency code, e.g. EUR or USD. |
receipt[prices_are_incl_tax] |
Boolean |
|
receipt[origin] |
String |
Can be |
receipt[details_attributes][id] |
Integer |
|
receipt[details_attributes][description] |
String |
|
receipt[details_attributes][period] |
String |
String with a date range: |
receipt[details_attributes][price] |
Decimal |
Both a decimal and a string ‘10,95’ are accepted. |
receipt[details_attributes][amount] |
String |
|
receipt[details_attributes][tax_rate_id] |
Integer |
Should be a valid tax rate id. |
receipt[details_attributes][ledger_account_id] |
Integer |
Should be a valid ledger account id. |
receipt[details_attributes][project_id] |
Integer |
Should be a valid project id. |
receipt[details_attributes][row_order] |
Integer |
|
receipt[details_attributes][_destroy] |
Boolean |
|
payment[financial_account_id] |
Integer |
Should be a valid financial account id. |
Example: updates the receipt
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"receipt":{"reference":"updated reference"}}' \
https://moneybird.com/api/v2/123/documents/receipts/426664121000264782.json
Response
Status: 200 OK
{
"id": "426664121000264782",
"administration_id": 123,
"contact_id": "426664120968807499",
"contact": {
"id": "426664120968807499",
"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-07-16T08:30:35.621Z",
"updated_at": "2024-07-16T08:30:35.621Z",
"version": 1721118635,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1b182a7683741ab5c32630bf19b3f4d09d80dbf89b1a48020939e10022adcfa4/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "updated reference",
"date": "2024-07-16",
"due_date": null,
"entry_number": 1,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "247.93",
"total_price_excl_tax_base": "247.93",
"total_price_incl_tax": "300.0",
"total_price_incl_tax_base": "300.0",
"created_at": "2024-07-16T08:30:35.651Z",
"updated_at": "2024-07-16T08:30:35.749Z",
"version": 1721118635,
"details": [
{
"id": "426664121001313359",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "Delivery Apple iPad",
"price": "300.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "247.93",
"total_price_excl_tax_with_discount_base": "247.93",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:35.652Z",
"updated_at": "2024-07-16T08:30:35.652Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:35.655Z",
"updated_at": "2024-07-16T08:30:35.655Z"
},
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_updated",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"changes": {
"reference": [
"Lunch supermarket",
"updated reference"
],
"updated_at": [
"2024-07-16T10:30:35.654+02:00",
"2024-07-16T10:30:35.749+02:00"
]
}
},
"created_at": "2024-07-16T08:30:35.751Z",
"updated_at": "2024-07-16T08:30:35.751Z"
}
]
}
Example: updates the receipt details
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"receipt":{"details_attributes":{"0":{"id":426664121206834267,"description":"updated description","price":20}}}}' \
https://moneybird.com/api/v2/123/documents/receipts/426664121205785690.json
Response
Status: 200 OK
{
"id": "426664121205785690",
"administration_id": 123,
"contact_id": "426664121171182679",
"contact": {
"id": "426664121171182679",
"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-07-16T08:30:35.814Z",
"updated_at": "2024-07-16T08:30:35.814Z",
"version": 1721118635,
"sales_invoices_url": "https://moneybird.dev/123/sales_invoices/1421cc7e497d738abca61b3fc3ef2a5d56c9edef5e6e97c76960c3ed59c2bef8/all",
"notes": [
],
"custom_fields": [
],
"contact_people": [
],
"archived": false
},
"reference": "Lunch supermarket",
"date": "2024-07-16",
"due_date": null,
"entry_number": 1,
"state": "open",
"currency": "EUR",
"exchange_rate": "1.0",
"revenue_invoice": false,
"prices_are_incl_tax": true,
"origin": null,
"paid_at": null,
"tax_number": "",
"total_price_excl_tax": "16.53",
"total_price_excl_tax_base": "16.53",
"total_price_incl_tax": "20.0",
"total_price_incl_tax_base": "20.0",
"created_at": "2024-07-16T08:30:35.846Z",
"updated_at": "2024-07-16T08:30:35.951Z",
"version": 1721118635,
"details": [
{
"id": "426664121206834267",
"administration_id": 123,
"tax_rate_id": "426664036227089970",
"ledger_account_id": "426664036164175388",
"project_id": null,
"product_id": null,
"amount": null,
"amount_decimal": "1.0",
"description": "updated description",
"price": "20.0",
"period": null,
"row_order": 0,
"total_price_excl_tax_with_discount": "16.53",
"total_price_excl_tax_with_discount_base": "16.53",
"tax_report_reference": [
"NL/5b"
],
"mandatory_tax_text": null,
"created_at": "2024-07-16T08:30:35.848Z",
"updated_at": "2024-07-16T08:30:35.950Z"
}
],
"payments": [
],
"notes": [
],
"attachments": [
],
"events": [
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_saved",
"link_entity_id": null,
"link_entity_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:35.850Z",
"updated_at": "2024-07-16T08:30:35.850Z"
},
{
"administration_id": 123,
"user_id": 17211185545521,
"action": "document_updated",
"link_entity_id": null,
"link_entity_type": null,
"data": {
"changes": {
"total_price_excl_tax": [
"247.93",
"16.53"
],
"total_price_excl_tax_base": [
"247.93",
"16.53"
],
"total_price_incl_tax": [
"300.0",
"20.0"
],
"total_price_incl_tax_base": [
"300.0",
"20.0"
],
"cached_taxes": [
[
{
"tax_rate_id": "426664036227089970",
"report_reference": "NL/5b",
"payable": false,
"debit": "52.07",
"credit": 0
}
],
[
{
"tax_rate_id": "426664036227089970",
"report_reference": "NL/5b",
"payable": false,
"debit": "3.47",
"credit": 0
}
]
],
"updated_at": [
"2024-07-16T10:30:35.849+02:00",
"2024-07-16T10:30:35.948+02:00"
]
}
},
"created_at": "2024-07-16T08:30:35.952Z",
"updated_at": "2024-07-16T08:30:35.952Z"
}
]
}
DEPRECATED: Register a payment for a receipt
This endpoint is deprecated and should no longer be used. It has been replaced by Create a payment.
Parameters
| Parameter | Type | Description |
|---|---|---|
payment[payment_date] |
String |
Required |
payment[price] |
Decimal |
Required Both a decimal and a string ‘10,95’ are accepted. Should be a number -1,000,000,000 <= n <= 1,000,000,000. |
payment[price_base] |
Decimal |
Amount paid expressed in the base currency. Required for foreign currencies. Should be a number -1,000,000,000 <= n <= 1,000,000,000. |
payment[financial_account_id] |
Integer |
Should be a valid financial account id. |
payment[financial_mutation_id] |
Integer |
Should be a valid financial mutation id. |
payment[transaction_identifier] |
String |
|
payment[manual_payment_action] |
String |
Can be |
payment[ledger_account_id] |
Integer |
Should be a valid ledger account id. |
payment[invoice_id] |
Integer |
Example: registers payments
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPATCH \
-d '{"payment":{"payment_date":"2024-07-16 08:30:36 UTC","price":"300.0"}}' \
https://moneybird.com/api/v2/123/documents/receipts/426664121763628157/register_payment.json
Response
Status: 200 OK
200
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 |
Delete a payment
Add attachment to receipt
Example: uploads an attachment
Request
curl -s -H "Content-Type: multipart/mixed" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XPOST \
-F file=@/tmp/upload.pdf \
https://moneybird.com/api/v2/123/documents/receipts/426664122418988200/attachments.json
Response
Status: 200 OK
200
Download attachment
Download the attachment. The response will be a redirect to a temporarily available URL
where the attachment can be downloaded. Use the Location header in the response
to download the attachment.
Delete an attachment
Deletes an attachment of an attachable.
Example: destroys an attachment
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/documents/receipts/426664123820934375/attachments/426664123968783597.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":426664119921280008,"todo":true}}' \
https://moneybird.com/api/v2/123/documents/receipts/426664119859414018/notes.json
Response
Status: 201 Created
{
"id": "426664119974757386",
"administration_id": 123,
"entity_id": "426664119859414018",
"entity_type": "Document",
"user_id": 17211185545521,
"assignee_id": "426664119921280008",
"todo": true,
"note": "Text of the note",
"completed_at": null,
"completed_by_id": null,
"todo_type": null,
"data": {
},
"created_at": "2024-07-16T08:30:34.673Z",
"updated_at": "2024-07-16T08:30:34.673Z"
}
Destroys note from entity
Example: destroy a note
Request
curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
-XDELETE \
-d '{}' \
https://moneybird.com/api/v2/123/documents/receipts/426664120058643473/notes/426664120107926551.json