Moneybird logo
Moneybird API
Moneybird API

Recurring sales invoices

Recurring sales invoices are templates for invoices that are sent automatically at a recurring interval.

List all IDs and versions

GET
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices/synchronization{format}

Returns all recurring sales invoices in the administration. The list contains the invoice id and the version of the recurring invoice. Check if the version of the recurring invoice is newer than the version you have stored locally, use the POST variant for fetching recurring invoices with the given IDs.

Required scope(s)

sales_invoices

List all IDs and versions › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all IDs and versions › query Parameters

filter
​string

Comma-separated key:value filter terms. Same syntax as GET /recurring_sales_invoices — see that operation's description for the available keys.

List all IDs and versions › Responses

200

IDs and versions of records

​object[]
id
​integer | string
version
​integer | string

Fetch recurring sales invoices with given IDs

POST
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices/synchronization{format}

Given a list of recurring sales invoice IDs, returns the details of the recurring invoices. Returns a maximum of 100 recurring invoices, even if more IDs are provided.

Required scope(s)

sales_invoices

Fetch recurring sales invoices with given IDs › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Fetch recurring sales invoices with given IDs › Request Body

ids
​(integer | string)[] · required

Fetch recurring sales invoices with given IDs › Responses

A list of recurring sales invoices

recurring_sales_invoice_response
id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

start_date
​string · date
invoice_date
​string · date
last_date
​string | null · date
active
​boolean | null
payment_conditions
​string | null
reference
​string | null
language
​string
currency
​string
discount
​string | null
first_due_interval
​integer
auto_send
​boolean | null
sending_scheduled_at
​string | null · date-time
sending_scheduled_user_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

frequency_type
​string · enum
Enum values:
day
week
month
quarter
year
frequency
​integer
created_at
​string | null · date-time
updated_at
​string | null · date-time
version
​version
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
​detail_response[]
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​

Get a recurring sales invoice by id

GET
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices/{id}{format}

Get a recurring sales invoice by id.

Required scope(s)

sales_invoices

Get a recurring sales invoice by id › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Get a recurring sales invoice by id › Responses

A recurring sales invoice

recurring_sales_invoice_response
id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

start_date
​string · date
invoice_date
​string · date
last_date
​string | null · date
active
​boolean | null
payment_conditions
​string | null
reference
​string | null
language
​string
currency
​string
discount
​string | null
first_due_interval
​integer
auto_send
​boolean | null
sending_scheduled_at
​string | null · date-time
sending_scheduled_user_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

frequency_type
​string · enum
Enum values:
day
week
month
quarter
year
frequency
​integer
created_at
​string | null · date-time
updated_at
​string | null · date-time
version
​version
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
​detail_response[]
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​

Destroy or deactivate a recurring sales invoice

DELETE
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices/{id}{format}

A recurring sales invoice will be destroyed if it has not created any sales invoices. If it has created sales invoices, it will be deactivated.

Required scope(s)

sales_invoices

Destroy or deactivate a recurring sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Destroy or deactivate a recurring sales invoice › Responses

Recurring sales invoice deleted

No data returned

Updates a recurring sales invoice

PATCH
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices/{id}{format}

Updates a recurring sales invoice. Only possible if the recurring sales invoice has no active subscription.

Required scope(s)

sales_invoices

Updates a recurring sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Updates a recurring sales invoice › Request Body

​object

Updates a recurring sales invoice › Responses

Recurring sales invoice updated

recurring_sales_invoice_response
id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

start_date
​string · date
invoice_date
​string · date
last_date
​string | null · date
active
​boolean | null
payment_conditions
​string | null
reference
​string | null
language
​string
currency
​string
discount
​string | null
first_due_interval
​integer
auto_send
​boolean | null
sending_scheduled_at
​string | null · date-time
sending_scheduled_user_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

frequency_type
​string · enum
Enum values:
day
week
month
quarter
year
frequency
​integer
created_at
​string | null · date-time
updated_at
​string | null · date-time
version
​version
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
​detail_response[]
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​

Destroys note from entity

DELETE
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes/{id}{format}

Deletes a note from the recurring sales invoice.

Required scope(s)

sales_invoices

Destroys note from entity › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

recurring_sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Destroys note from entity › Responses

Note deleted

No data returned

Adds note to entity

POST
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices/{recurring_sales_invoice_id}/notes{format}

Adds a note to the recurring sales invoice.

Required scope(s)

sales_invoices

Adds note to entity › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

recurring_sales_invoice_id
​identifier · pattern: ^\d+$ · required

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Adds note to entity › Request Body

​object

Adds note to entity › Responses

Note created

note_response
id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

entity_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

entity_type
​string
user_id
​identifier · pattern: ^\d+$

A unique record identifier

assignee_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

todo
​boolean | string | null
Default: false
note
​string | null
completed_at
​string | null · date-time
completed_by_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

todo_type
​string | null · enum
Enum values:
sales_invoice_due
purchase_invoice_due
general_document_reminder
general_document_due
new_document_awaiting_processing
new_financial_mutation_awaiting_processing
financial_mutations_not_updated
sales_invoice_payment_not_linked_to_financial_mutation
data
​object | null
created_at
​timestamp · date-time
updated_at
​timestamp · date-time

List all recurring sales invoices

GET
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices{format}

Returns a paginated list of recurring sales invoices in the administration.

Required scope(s)

sales_invoices

List all recurring sales invoices › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all recurring sales invoices › query Parameters

filter
​string

Filters are key:value terms separated by commas (e.g. state:active,contact_id:123). Any filter you pass replaces the defaults below entirely, so include every key you need. Available filters:

FilterTypeDefaultDescription
stateStringactiveactive or inactive
frequencyStringallall, day, week, month, quarter or year
auto_sendBooleannullnull, true or false
contact_idIntegerFilters recurring invoices by a single contact
workflow_idIntegerFilters recurring invoices by a single workflow
Default: state:active
page
​integer | string
per_page
​integer | string · min: 1 · max: 100 · pattern: ^\d+$

List all recurring sales invoices › Responses

A list of recurring sales invoices

recurring_sales_invoice_response
id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

start_date
​string · date
invoice_date
​string · date
last_date
​string | null · date
active
​boolean | null
payment_conditions
​string | null
reference
​string | null
language
​string
currency
​string
discount
​string | null
first_due_interval
​integer
auto_send
​boolean | null
sending_scheduled_at
​string | null · date-time
sending_scheduled_user_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

frequency_type
​string · enum
Enum values:
day
week
month
quarter
year
frequency
​integer
created_at
​string | null · date-time
updated_at
​string | null · date-time
version
​version
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
​detail_response[]
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​

Creates a new recurring sales invoice

POST
https://moneybird.com/api/v2
/{administration_id}/recurring_sales_invoices{format}

A recurring sales invoice will create new sales invoices on set intervals. To create a new recurring sales invoice, you need to provide at least a contact and details for the invoice. Furthermore you need to determine the planning. The following fields will influence the planning:

  1. invoice_date: the date in which the first invoice should be created
  2. frequency_type: the type of frequency you want to use, for example month
  3. frequency: defines the actual frequency, e.g. frequency=2 and frequency_type=month will create an invoice every 2 months
  4. has_desired_count: whether or not the desired count should take effect
  5. desired_count: maximum number of sales invoices to create

Required scope(s)

sales_invoices

Creates a new recurring sales invoice › path Parameters

administration_id
​administration_id · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format
​string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Creates a new recurring sales invoice › Request Body

​object

Creates a new recurring sales invoice › Responses

Recurring sales invoice created

recurring_sales_invoice_response
id
​identifier · pattern: ^\d+$

A unique record identifier

administration_id
​administration_id · pattern: ^\d+$

A unique record identifier

contact_id
​identifier · pattern: ^\d+$

A unique record identifier

contact_person_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

​
workflow_id
​identifier · pattern: ^\d+$

A unique record identifier

start_date
​string · date
invoice_date
​string · date
last_date
​string | null · date
active
​boolean | null
payment_conditions
​string | null
reference
​string | null
language
​string
currency
​string
discount
​string | null
first_due_interval
​integer
auto_send
​boolean | null
sending_scheduled_at
​string | null · date-time
sending_scheduled_user_id
​identifier_nullable · pattern: ^\d+$

A unique record identifier

frequency_type
​string · enum
Enum values:
day
week
month
quarter
year
frequency
​integer
created_at
​string | null · date-time
updated_at
​string | null · date-time
version
​version
prices_are_incl_tax
​boolean
total_price_excl_tax
​string
total_price_excl_tax_base
​string
total_price_incl_tax
​string
total_price_incl_tax_base
​string
​detail_response[]
​custom_field_value_response[]
​note_response[]
​attachment_response[]
​event_response[]
​
Purchase transactionsReports