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_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Status code
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.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
external_sales_invoice_idstring | integer · pattern:^\d+$· requiredA unique record identifier
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Found
Delete an attachment
Deletes an attachment of an attachable.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
external_sales_invoice_idstring | integer · pattern:^\d+$· requiredA unique record identifier
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Attachment deleted
Destroys note from entity
Deletes a note from the external sales invoice
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
external_sales_invoice_idstring | integer · pattern:^\d+$· requiredA unique record identifier
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Note deleted
Adds note to entity
Adds a note to the external sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
external_sales_invoice_idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Note created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
entity_idstring | integer | null · pattern:^\d+$A unique record identifier
entity_typestringuser_idstring | integer · pattern:^\d+$A unique record identifier
assignee_idstring | integer | null · pattern:^\d+$A unique record identifier
todoboolean | string | nullDefault: falsenotestring | nullcompleted_atstring | null · date-timecompleted_by_idstring | integer | null · pattern:^\d+$A unique record identifier
todo_typestring | null · enumEnum values:sales_invoice_duepurchase_invoice_duegeneral_document_remindergeneral_document_duenew_document_awaiting_processingnew_financial_mutation_awaiting_processingfinancial_mutations_not_updatedsales_invoice_payment_not_linked_to_financial_mutationdataobject | nullcreated_atstring · date-timeupdated_atstring · date-time
Delete a payment
Deletes a payment from an external sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
external_sales_invoice_idstring | integer · pattern:^\d+$· requiredA unique record identifier
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Payment deleted
Create a payment
Registers a payment for a external sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
external_sales_invoice_idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Payment created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
invoice_typestring · enumEnum values:SalesInvoiceDocumentExternalSalesInvoiceVatDocumentinvoice_idstring | integer · pattern:^\d+$A unique record identifier
financial_account_idstring | integer | null · pattern:^\d+$A unique record identifier
user_idstring | integer · pattern:^\d+$A unique record identifier
payment_transaction_idstring | integer | null · pattern:^\d+$A unique record identifier
transaction_identifierstring | nullpriceprice_basepayment_datestring · datecredit_invoice_idstring | integer | null · pattern:^\d+$A unique record identifier
financial_mutation_idstring | integer | null · pattern:^\d+$A unique record identifier
ledger_account_idstring | integer | null · pattern:^\d+$A unique record identifier
linked_payment_idstring | integer | null · pattern:^\d+$A unique record identifier
manual_payment_actionstring | nullcreated_atstring · date-timeupdated_atstring · date-time
Add attachment to external sales invoice
Add an attachment to an external sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
Status code
Mark as dubious
This endpoint marks an external sales invoice as dubious.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
External sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactdatestring · datestatestring · enumEnum values:newopenlatepaiduncollectiblepending_paymentdue_datestring | null · datereferencestring | nullentry_numberintegeroriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvsourcestring | nullsource_urlstring | nullcurrencystringISO 4217 currency code
paid_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datenotesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]
Mark as uncollectible
This endpoint marks an external sales invoice as uncollectible.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
External sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactdatestring · datestatestring · enumEnum values:newopenlatepaiduncollectiblepending_paymentdue_datestring | null · datereferencestring | nullentry_numberintegeroriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvsourcestring | nullsource_urlstring | nullcurrencystringISO 4217 currency code
paid_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datenotesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]
Get an external sales invoice by id
Returns an external sales invoices in the administration.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
A external sales invoice
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactdatestring · datestatestring · enumEnum values:newopenlatepaiduncollectiblepending_paymentdue_datestring | null · datereferencestring | nullentry_numberintegeroriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvsourcestring | nullsource_urlstring | nullcurrencystringISO 4217 currency code
paid_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datenotesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]
Delete an external sales invoice
Deletes an external sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
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_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern:^\d+$· requiredA unique record identifier
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
External sales invoice updated
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactdatestring · datestatestring · enumEnum values:newopenlatepaiduncollectiblepending_paymentdue_datestring | null · datereferencestring | nullentry_numberintegeroriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvsourcestring | nullsource_urlstring | nullcurrencystringISO 4217 currency code
paid_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datenotesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]
List all external invoices
Returns a paginated list of all sales invoices in the administration.
The filter argument allows you to filter the list of external invoices. Filters are a combination of keys and values,
separated by a comma: period:this_year,state:all. The available options for filtering are:
| Filter | Type | Default | Description |
|---|---|---|---|
| state | String | all | all, new, open, late, or paid |
| period | String | this_year | This can either be the description of a period (this_month, prev_month, next_month, this_quarter, prev_quarter, next_quarter, this_year, prev_year, next_year) or a custom period (201301..201302, 20130101..20130131) |
| contact_id | Integer | Select invoices belonging to a certain contact |
You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:new|open.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
query Parameters
filterstringpageinteger | stringper_pageinteger | string · min: 1 · max: 100 · pattern:^\d+$
Responses
A list of external sales invoices
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactdatestring · datestatestring · enumEnum values:newopenlatepaiduncollectiblepending_paymentdue_datestring | null · datereferencestring | nullentry_numberintegeroriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvsourcestring | nullsource_urlstring | nullcurrencystringISO 4217 currency code
paid_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datenotesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]
Create an external sales invoice
Creates a new external sales invoice.
path Parameters
administration_idstring | integer · pattern:^\d+$· requiredThe unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern:^(.(json|xml))?$· requiredThe format in which the response is given, can be empty to use the default format
Default: .json
Responses
External sales invoice created
idstring | integer · pattern:^\d+$A unique record identifier
administration_idstring | integer · pattern:^\d+$A unique record identifier of an administration
contact_idstring | integer | null · pattern:^\d+$A unique record identifier
contactdatestring · datestatestring · enumEnum values:newopenlatepaiduncollectiblepending_paymentdue_datestring | null · datereferencestring | nullentry_numberintegeroriginstring | null · enumEnum values:uploadendpointsiemailsi_localsi_peppolapimoneybird_bvsourcestring | nullsource_urlstring | nullcurrencystringISO 4217 currency code
paid_atstring | null · datecreated_atstring · date-timeupdated_atstring · date-timeversionintegerdetailsobject[]paymentsobject[]total_paidstringtotal_unpaidstringtotal_unpaid_basestringprices_are_incl_taxbooleantotal_price_excl_taxstringtotal_price_excl_tax_basestringtotal_price_incl_taxstringtotal_price_incl_tax_basestringmarked_dubious_onstring | null · datemarked_uncollectible_onstring | null · datenotesobject[]attachmentsobject[]eventsobject[]tax_totalsobject[]