Moneybird API

Estimates

Endpoint:https://moneybird.com/api/v2

Estimates (or quotes) are proposals for products or services that you can send to your clients.

Get an estimate by estimate_id

GET

https://moneybird.com/api/v2

/{administration_id}/estimates/find_by_estimate_id/{estimate_id}{format}

Returns all information about an estimate with the given estimate id

Get an estimate by estimate_id › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
estimate_idstring · required
Unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Get an estimate by estimate_id › Responses

An estimate

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

List all ids and versions

GET

https://moneybird.com/api/v2

/{administration_id}/estimates/synchronization{format}

Returns all estimates in the administration. The list contains the id and version of the estimate. If the version of the estimate is newer than the version you have stored locally, use the POST variant to fetch estimates with the given ids.

List all ids and versions › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · 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

filterstring

List all ids and versions › Responses

IDs and versions of records

idinteger | string
versioninteger | string

Fetch estimates with given ids

POST

https://moneybird.com/api/v2

/{administration_id}/estimates/synchronization{format}

Given a list of estimate ids, returns the estimate information belonging to the estimates. Returns a maximum of 100 estimates, even if more ids are provided.

Fetch estimates with given ids › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Fetch estimates with given ids › Request Body

ids(integer | string)[] · required

Fetch estimates with given ids › Responses

A list of estimates

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

Download attachment

GET

https://moneybird.com/api/v2

/{administration_id}/estimates/{estimate_id}/attachments/{id}/download{format}

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.

Download attachment › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
estimate_idstring | integer · pattern: ^\d+$ · required
A unique record identifier
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Download attachment › Responses

Found

string

Delete an attachment

DELETE

https://moneybird.com/api/v2

/{administration_id}/estimates/{estimate_id}/attachments/{id}{format}

Deletes an attachment of an attachable.

Delete an attachment › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
estimate_idstring | integer · pattern: ^\d+$ · required
A unique record identifier
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Delete an attachment › Responses

Attachment deleted

No data returned

Destroys note from entity

DELETE

https://moneybird.com/api/v2

/{administration_id}/estimates/{estimate_id}/notes/{id}{format}

Deletes a note from the estimate.

Destroys note from entity › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
estimate_idstring | integer · pattern: ^\d+$ · required
A unique record identifier
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · 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}/estimates/{estimate_id}/notes{format}

Adds a note to the estimate.

Adds note to entity › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
estimate_idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · 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

noteobject

Adds note to entity › 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_typestring
user_idstring | integer · pattern: ^\d+$
A unique record identifier
assignee_idstring | integer | null · pattern: ^\d+$
A unique record identifier
todoboolean | string | null
Default: false
notestring | null
completed_atstring | null · date-time
completed_by_idstring | integer | null · pattern: ^\d+$
A unique record identifier
todo_typestring | 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
dataobject | null
created_atstring · date-time
updated_atstring · date-time

Add attachment to estimate

POST

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}/attachments{format}

Add an attachment to an estimate.

Add attachment to estimate › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Add attachment to estimate › Request Body

filestring · binary

Add attachment to estimate › Responses

Status code

integer

Bills an estimate

PATCH

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}/bill_estimate{format}

An invoice is created based on the accepted estimate.

Bills an estimate › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Bills an estimate › Request Body

Bills an estimate › Responses

Estimate billed

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contactobject
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
invoice_idstring | null
recurring_sales_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
subscription_idstring | integer | null · pattern: ^\d+$
A unique record identifier
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
scheduled
open
pending_payment
reminded
late
paid
uncollectible
invoice_datestring | null · date
due_datestring · date
payment_conditionsstring | null
payment_referencestring | null
short_payment_referencestring | null
referencestring | null
languagestring | null
currencystring
discountstring | null
original_sales_invoice_idstring | integer | null · pattern: ^\d+$
A unique record identifier
pausedboolean
paid_atstring | null · date
sent_atstring | null · date
created_atstring · date-time
updated_atstring · date-time
public_view_codestring | null
public_view_code_expires_atstring | null · date-time
versioninteger
detailsobject[]
paymentsobject[]
total_paidstring
total_unpaidstring
total_unpaid_basestring
prices_are_incl_taxboolean
total_price_excl_taxstring
total_price_excl_tax_basestring
total_price_incl_taxstring
total_price_incl_tax_basestring
total_discountstring
marked_dubious_onstring | null · date
marked_uncollectible_onstring | null · date
reminder_countinteger | null
next_reminderstring | null · date
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
urlstring
payment_urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]
time_entriesobject[]

Changes the state of an estimate

PATCH

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}/change_state{format}

Not every state change is allowed. e.g. open to billed is accepted, draft to open is not. Note: this only changes the state and does not perform other actions like sending or billing the estimate.

Changes the state of an estimate › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Changes the state of an estimate › Request Body

statestring · required
Can be accepted, rejected, open, late, billed or archived.

Changes the state of an estimate › Responses

Estimate updated

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

Download estimate PDF by id

GET

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}/download_pdf{format}

Redirects to the download URL of the estimate as PDF. The link is valid for 30 seconds.

Download estimate PDF by id › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Download estimate PDF by id › query Parameters

mediastring
In case you want to hide sender address and logo you can set this to 'stationery'.

Download estimate PDF by id › Responses

Found

string

Sends an estimate

PATCH

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}/send_estimate{format}

You can provide a send method, email address and message. If you don't provide any arguments, the defaults from the contact and workflow will be used.

Sends an estimate › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Sends an estimate › Request Body

estimate_sendingobject
senderboolean | string
signature_outputstring
audit_trailstring
ip_addressstring

Sends an estimate › Responses

Estimate updated

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

Get an estimate by id

GET

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}{format}

Returns all information about an estimate.

Get an estimate by id › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Get an estimate by id › query Parameters

includesstring[]

Get an estimate by id › Responses

A estimate

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

Deletes an estimate

DELETE

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}{format}

Deletes an estimate.

Deletes an estimate › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Deletes an estimate › Responses

Estimate deleted

No data returned

Updates an estimate

PATCH

https://moneybird.com/api/v2

/{administration_id}/estimates/{id}{format}

When updating an estimate, provide only the attributes you want to update. The other attributes will not be changed.

Updates an estimate › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
idstring | integer · pattern: ^\d+$ · required
A unique record identifier
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

Updates an estimate › Request Body

estimateobject

Updates an estimate › Responses

Estimate updated

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

List all estimates

GET

https://moneybird.com/api/v2

/{administration_id}/estimates{format}

Returns a paginated list of all estimates in the administration.

The filter argument allows you to filter on the list of estimates. Filters are a combination of keys and values, separated by a comma: period:this_year,state:all. The available options for filtering are:

Filter	Type	Default	Description
state	`String`	`all`	`all`, `draft`, `open`, `late`, `accepted`, `rejected`, `billed` or `archived`
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`		Filters estimates by a single contact
workflow_id	`Integer`		Filters estimates by a single workflow

You can filter by multiple states at the same time as well. To do this, separate the state values by a pipe: state:draft|scheduled.

List all estimates › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · pattern: ^(.(json|xml))?$ · required
The format in which the response is given, can be empty to use the default format
Default: .json

List all estimates › query Parameters

filterstring
See table above for detailed options.
pageinteger | string
per_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$

List all estimates › Responses

A list of estimates

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

Creates a new estimate

POST

https://moneybird.com/api/v2

/{administration_id}/estimates{format}

Creates a new estimate.

Creates a new estimate › path Parameters

administration_idstring | integer · pattern: ^\d+$ · required
The unique identifier of the administration
A unique record identifier of an administration
formatstring · 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 estimate › Request Body

estimateobject

Creates a new estimate › Responses

Estimate created

idstring | integer · pattern: ^\d+$
A unique record identifier
administration_idstring | integer · pattern: ^\d+$
A unique record identifier of an administration
contact_idstring | integer · pattern: ^\d+$
A unique record identifier
contact
contact_person_idstring | integer | null · pattern: ^\d+$
A unique record identifier
contact_person
estimate_idstring | null
estimate_sequence_idstring | null
workflow_idstring | integer · pattern: ^\d+$
A unique record identifier
document_style_idstring | integer · pattern: ^\d+$
A unique record identifier
identity_idstring | integer · pattern: ^\d+$
A unique record identifier
draft_idinteger | null
statestring · enum
Enum values:
draft
open
late
accepted
rejected
billed
archived
estimate_datestring | null · date
due_datestring · date
referencestring | null
languagestring | null
currencystring
exchange_rate
discount
original_estimate_idstring | integer | null · pattern: ^\d+$
A unique record identifier
show_taxboolean
Default: true
sign_onlineboolean
Default: true
sent_atstring | null · date
accepted_atstring | null · date
rejected_atstring | null · date
archived_atstring | null · date
created_atstring | null · date-time
updated_atstring | null · date-time
public_view_codestring | null · pattern: ^\d+$
public_view_code_expires_atstring | null · date-time
versioninteger
pre_textstring | null
post_textstring | null
detailsobject[]
prices_are_incl_taxboolean
Default: false
total_price_excl_tax
total_price_excl_tax_base
total_price_incl_tax
total_price_incl_tax_base
total_discount
urlstring
custom_fieldsobject[]
notesobject[]
attachmentsobject[]
eventsobject[]
tax_totalsobject[]

Documents: Typeless documents External sales invoices