Estimates

Overview

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. See Estimates endpoint for more details.

Data Model

Field	Type	Description
id	string	Identifier for the estimate, unique to the business in the accounting service provider.
customerRef	Reference Types	Reference to the customer the estimate has been issued to.
accountRef	Reference Types	Reference 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 Types	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.
currencyRate	decimal	Rate between the currency of the estimate and the base currency of the business. Not applicable when multi-currency is not supported.
lines	array	An array of estimate lines.
subTotal sortable, filterable	decimal	Value of the estimate, including discounts and excluding tax.
taxAmount sortable, filterable	decimal	Any tax applied to the estimate amount.
discountAmount	decimal	Numerical value of any discounts applied.
discountPercentage	decimal	Percentage rate (from 0 to 100) of any discounts applied to the unit amount.
totalAmount sortable, filterable	decimal	Amount of the estimate, inclusive of tax.
status sortable, filterable	string	Current status of an estimate.
memo	string	User-friendly reference for the estimate.
shippingAddress	Reference Types	Delivery for any goods that have been ordered.
sourceModifiedData	string See Date	Date the record was last changed in the accounting service provider.

Lines

Field	Type	Description
description	string	Friendly name of the goods or services received.
unitAmount	decimal	Price of each unit of goods or services.
quantity	decimal	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.

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.

Example Data

{
  "data": [
    {
      "id": "1",
      "customerRef": {
        "id": "1",
        "name": "Railz Financial"
      },
      "postedDate": "2021-03-09T10:18:29.985Z",
      "dueDate": "2021-03-09T10:18:29.985Z",
      "acceptedDate": "2021-03-09T10:18:29.985Z",
      "expiryDate": "2021-03-09T10:18:29.985Z",
      "currencyRef": {
        "id": "CAD",
        "name": "Canadian Dollar"
      },
      "currencyRate": 1.13,
      "lines": [
        {
          "description": "Services rendered.",
          "unitAmount": 100.5,
          "quantity": 3,
          "discountAmount": 0,
          "subTotal": 301.5,
          "taxAmount": 20.5,
          "totalAmount": 322,
          "discountPercentage": 10.5,
          "taxRateRef": {
            "id": "1",
            "name": "HST",
            "effectiveTaxRate": 13
          },
          "inventoryRef": {
            "id": "1",
            "name": "Digital Services"
          },
          "accountRef": {
            "id": "145",
            "name": "Depreciation Expense"
          }
        }
      ],
      "totalDiscount": 322,
      "discountPercentage": 322,
      "subTotal": 301.5,
      "taxAmount": 20.5,
      "totalAmount": 322,
      "status": "open",
      "memo": "Example estimate memo.",
      "shippingAddress": {
        "line1": "1234 Park Street",
        "line2": "Suite 1000",
        "city": "Toronto",
        "region": "ON",
        "country": "CAN",
        "postalCode": "A0B1C2"
      },
      "sourceModifiedDate": "2021-03-09T10:18:29.985Z"
    }
  ]
}