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.
Identifier for the estimate, unique to the business in the accounting service provider.
Reference to the customer the estimate has been issued to.
Reference to the account to which the estimate is linked to.
Date of the estimate as recorded in the accounting service provider.
Date the estimate is due to be paid by.
Date the estimate expired as recorded in the accounting service provider.
Date the estimate was accepted by the customer as recorded in the accounting service provider.
Currency 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.
Rate between the currency of the estimate and the base currency of the business. Not applicable when multi-currency is not supported.
An array of estimate lines.
Value of the estimate, including discounts and excluding tax.
Any tax applied to the estimate amount.
Numerical value of any discounts applied.
Percentage rate (from 0 to 100) of any discounts applied to the unit amount.
Amount of the estimate, inclusive of tax.
Current status of an estimate.
User-friendly reference for the estimate.
Delivery for any goods that have been ordered.
Date the record was last changed in the accounting service provider.
|description||string||Friendly name of the goods or services received.|
|unitAmount||decimal||Price of each unit of goods or services.|
|quantity||integer||Number of units of goods or services.|
|discountAmount||decimal||Numerical value of any discounts applied.|
|discountPercentage||decimal||Percentage rate (from 0 to 100) of any discounts applied to the unit amount.|
|subTotal||decimal||Amount of the line, inclusive of discounts but exclusive of tax.|
|taxAmount||decimal||Amount of tax for the line.|
|totalAmount||decimal||Total amount of the line, inclusive of discounts and tax.|
|accountRef||Reference Types||Reference to the account to which the line item is linked to.|
|taxRateRef||Reference Types||Reference to the tax rate to which the line item is linked to.|
|inventoryRef||Reference Types||Reference to the product or inventory item to which the line item is linked to.|
|trackingCategoryRef||Reference Types||Reference to the tracking category to which the line item is linked to.|
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.