Estimates

The Estimate Object

Estimates represent a proposal for a financial transaction from a business to a customer for goods or services proposed to be sold, including proposed pricing. From the Estimates endpoint, you can retrieve a list of all estimates for a specified business.

FieldTypeDescription
idstring Identifier for the estimate, unique to the business in the accounting service provider.
customerRefReference TypesReference to the customer the estimate has been issued to.
accountRefReference TypesReference to the account to which the estimate is linked to.
postedDate
sortable, filterable
string
See Date
Date of the estimate as recorded in the accounting service provider.
dueDate
sortable, filterable
string
See Date
Date the estimate is due to be paid by.
expiryDate
sortable, filterable
string
See Date
Date the estimate expired as recorded in the accounting service provider.
acceptedDate
sortable, filterable
string
See Date
Date the estimate was accepted by the customer as recorded in the accounting service provider.
currencyRef Reference TypesCurrency of the estimate.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.
currencyRate decimalRate between the currency of the estimate and the base currency of the business. Not applicable when multi-currency is not supported.
lines arrayAn array of estimate lines.
subTotal
sortable, filterable
decimalValue of the estimate, including discounts and excluding tax.
taxAmount
sortable, filterable
decimalAny tax applied to the estimate amount.
discountAmountdecimalNumerical value of any discounts applied.
discountPercentagedecimalPercentage rate (from 0 to 100) of any discounts applied to the unit amount.
totalAmount
sortable, filterable
decimalAmount of the estimate, inclusive of tax.
status
sortable, filterable
stringCurrent status of an estimate.
memo stringUser-friendly reference for the estimate.
shippingAddressReference TypesDelivery for any goods that have been ordered.
sourceModifiedDate
sortable, filterable
string
See Date
Date the record was last changed in the accounting service provider.

Lines

FieldTypeDescription
descriptionstringFriendly name of the goods or services received.
unitAmountdecimalPrice of each unit of goods or services.
quantityintegerNumber of units of goods or services.
discountAmountdecimalNumerical value of any discounts applied.
discountPercentagedecimalPercentage rate (from 0 to 100) of any discounts applied to the unit amount.
subTotaldecimalAmount of the line, inclusive of discounts but exclusive of tax.
taxAmountdecimalAmount of tax for the line.
totalAmountdecimalTotal amount of the line, inclusive of discounts and tax.
accountRefReference TypesReference to the account to which the line item is linked to.
taxRateRefReference TypesReference to the tax rate to which the line item is linked to.
inventoryRefReference TypesReference to the product or inventory item to which the line item is linked to.
trackingCategoryRefReference TypesReference to the tracking category to which the line item is linked to.

Estimate Status

  • open - Estimate is no longer a draft. It has been processed and/or sent to the customer. In this state, it will impact the ledger.
  • closed - Estimate has been closed.
  • void - An Estimate can become void by being deleted, refunded, written off, or cancelled.
  • draft - Estimate is yet to be authorized and sent to the customer, and will not be used in any reports. It may contain incomplete line items.
  • unknown - Railz was not able to recognize the status of the estimate. This can be due to missing values in the accounting service provider or unavailable in the data we received.