The Estimates 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.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the estimate, unique for the business in the accounting service. |
| customerRef | Reference Types | Reference to the customer the estimate was sent to. |
| postedDate sortable, filterable | string See Date | Date on which the estimate was posted to the accounting service, and had an impact on the general ledger. This may be different from the creation date. |
| dueDate sortable, filterable | string See Date | Date the customer is due to pay. |
| acceptedDate sortable, filterable | string See Date | Date the estimate was accepted. |
| expiryDate sortable, filterable | string See Date | Date by which estimate must be accepted before invalidation. |
| currency | string | ISO-4217 currency code of the estimate. |
| currencyRate | decimal | Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction. |
| lines | array | An array of estimate lines. |
| status sortable, filterable | string | Current status of an estimate. |
| totalDiscount sortable, filterable | decimal | Total amount of discounts applied to the estimate. |
| discountPercentage sortable, filterable | decimal | Discount percentage applied to the estimate. |
| subTotal sortable, filterable | decimal | Amount of the estimate, inclusive of discounts but exclusive of tax. |
| taxAmount sortable, filterable | decimal | Amount of tax on the estimate. |
| totalAmount sortable, filterable | decimal | Total amount of the estimate, inclusive of tax. |
| memo | string | Any additional information or business notes about the estimate. |
| shippingAddress | Reference Types | Delivery details for any goods that have been ordered. |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |
Lines
| Field | Type | Description |
|---|---|---|
| description | string | Description of the line item. |
| unitAmount sortable, filterable | decimal | Line item unit amount. |
| quantity sortable, filterable | integer | Line item quantity. |
| discountAmount sortable, filterable | decimal | Line item discount amount. |
| discountPercentage sortable, filterable | decimal | Line item discount percentage. |
| taxAmount sortable, _filterable | decimal | Line item tax amount. |
| amount sortable, _filterable | decimal | Line item total amount, inclusive of discounts & tax. |
| accountRef | Reference Types | Reference to the account the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate the line item is linked to. |
| inventoryRef | Reference Types | Reference to the product or inventory the line item is linked to. |
| trackingCategoryRefs | Reference Types | "Reference to the tracking categories associated with this line item, e.g. classes or departments. " |
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.