External sales invoices are invoices created in other systems that you want to import into Moneybird for a complete overview of your revenue.
Create external sales invoice from attachment
Creates an external sales invoice from an attachment.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Create external sales invoice from attachment › Responses
Status code
List all ids and versions
Returns all external sales invoices in the administration. The list contains the id and the version of the external sales invoice.
Check if the version of an external sales invoice is newer than the version you have stored locally, use the POST
variant for fetching external sales invoices with the given ids.
The filter argument allows you to filter the list of external invoices. Filters are a combination of keys and values,
separated by a comma: period:this_year,state:all. The available options for filtering are:
| Filter | Type | Default | Description |
|---|---|---|---|
| state | String | all | all, new, open, late, or paid |
| period | String | this_year | This can either be the description of a period (this_month, prev_month, next_month, this_quarter, prev_quarter, next_quarter, this_year, prev_year, next_year) or a custom period (201301..201302, 20130101..20130131) |
| contact_id | Integer | Select invoices belonging to a certain contact |
You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:new|open.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterList all ids and versions › Responses
IDs and versions of records
idversionFetch external sales invoices with given ids
Given a list of external sales invoice ids, returns the external sales invoice information belonging to the external sales invoice. Returns a maximum of 100 external sales invoices, even if more ids are provided.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Fetch external sales invoices with given ids › Request Body
idsFetch external sales invoices with given ids › Responses
A list of external sales invoices
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
datestatedue_datereferenceentry_numberoriginsourcesource_urlcurrencyISO 4217 currency code
paid_atcreated_atupdated_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basemarked_dubious_onmarked_uncollectible_onDownload 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.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
external_sales_invoice_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Download attachment › Responses
Found
Delete an attachment
Deletes an attachment of an attachable.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
external_sales_invoice_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete an attachment › Responses
Attachment deleted
Destroys note from entity
Deletes a note from the external sales invoice
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
external_sales_invoice_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Destroys note from entity › Responses
Note deleted
Adds note to entity
Adds a note to the external sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
external_sales_invoice_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Adds note to entity › Responses
Note created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
entity_id^\d+$A unique record identifier
entity_typeuser_id^\d+$A unique record identifier
assignee_id^\d+$A unique record identifier
todonotecompleted_atcompleted_by_id^\d+$A unique record identifier
todo_typedatacreated_atupdated_atDelete a payment
Deletes a payment from an external sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
external_sales_invoice_id^\d+$ · requiredA unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete a payment › Responses
Payment deleted
Create a payment
Registers a payment for a external sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
external_sales_invoice_id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Create a payment › Responses
Payment created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
invoice_typeinvoice_id^\d+$A unique record identifier
financial_account_id^\d+$A unique record identifier
user_id^\d+$A unique record identifier
payment_transaction_id^\d+$A unique record identifier
transaction_identifierpayment_datecredit_invoice_id^\d+$A unique record identifier
financial_mutation_id^\d+$A unique record identifier
ledger_account_id^\d+$A unique record identifier
linked_payment_id^\d+$A unique record identifier
manual_payment_actioncreated_atupdated_atAdd attachment to external sales invoice
Add an attachment to an external sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Add attachment to external sales invoice › Responses
Status code
Mark as dubious
This endpoint marks an external sales invoice as dubious.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Mark as dubious › Responses
External sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
datestatedue_datereferenceentry_numberoriginsourcesource_urlcurrencyISO 4217 currency code
paid_atcreated_atupdated_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basemarked_dubious_onmarked_uncollectible_onMark as uncollectible
This endpoint marks an external sales invoice as uncollectible.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Mark as uncollectible › Request Body
uncollectible_datebook_methodCan be revenue.
Mark as uncollectible › Responses
External sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
datestatedue_datereferenceentry_numberoriginsourcesource_urlcurrencyISO 4217 currency code
paid_atcreated_atupdated_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basemarked_dubious_onmarked_uncollectible_onGet an external sales invoice by id
Returns an external sales invoice in the administration.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Get an external sales invoice by id › Responses
An external sales invoice
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
datestatedue_datereferenceentry_numberoriginsourcesource_urlcurrencyISO 4217 currency code
paid_atcreated_atupdated_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basemarked_dubious_onmarked_uncollectible_onDelete an external sales invoice
Deletes an external sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Delete an external sales invoice › Responses
External sales invoice deleted
Update an external sales invoice
When updating an external sales invoice, provide only the attributes you want to update. The other attributes will not be changed.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
id^\d+$ · requiredA unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Update an external sales invoice › Responses
External sales invoice updated
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
datestatedue_datereferenceentry_numberoriginsourcesource_urlcurrencyISO 4217 currency code
paid_atcreated_atupdated_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basemarked_dubious_onmarked_uncollectible_onList all external invoices
Returns a paginated list of all external sales invoices in the administration.
The filter argument allows you to filter the list of external invoices. Filters are a combination of keys and values,
separated by a comma: period:this_year,state:all. The available options for filtering are:
| Filter | Type | Default | Description |
|---|---|---|---|
| state | String | all | all, new, open, late, or paid |
| period | String | this_year | This can either be the description of a period (this_month, prev_month, next_month, this_quarter, prev_quarter, next_quarter, this_year, prev_year, next_year) or a custom period (201301..201302, 20130101..20130131) |
| contact_id | Integer | Select invoices belonging to a certain contact |
You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:new|open.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
query Parameters
filterpageper_page^\d+$List all external invoices › Responses
A list of external sales invoices
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
datestatedue_datereferenceentry_numberoriginsourcesource_urlcurrencyISO 4217 currency code
paid_atcreated_atupdated_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basemarked_dubious_onmarked_uncollectible_onCreate an external sales invoice
Creates a new external sales invoice.
path Parameters
administration_id^\d+$ · requiredThe unique identifier of the administration
A unique record identifier
format^(.(json|xml))?$ · requiredThe format in which the response is given, can be empty to use the default format
Create an external sales invoice › Responses
External sales invoice created
id^\d+$A unique record identifier
administration_id^\d+$A unique record identifier
contact_id^\d+$A unique record identifier
datestatedue_datereferenceentry_numberoriginsourcesource_urlcurrencyISO 4217 currency code
paid_atcreated_atupdated_atversiontotal_paidtotal_unpaidtotal_unpaid_baseprices_are_incl_taxtotal_price_excl_taxtotal_price_excl_tax_basetotal_price_incl_taxtotal_price_incl_tax_basemarked_dubious_onmarked_uncollectible_on