The Budget object
A Budget is an assigned dollar amount for a specific account or Customer. This amount represents how much should be spent against that account or customer in the given time period. From the Budgets endpoint, you can retrieve a list of all budgets for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the budget object, unique for the business in the accounting service |
| name sortable, filterable | string | Name of the budget as recorded in the accounting service, typically the company name. |
| type | string | Type of the budget in the accounting service |
| startDate sortable, filterable | string See Date | The start date of the budget |
| endDate sortable, filterable | string See Date | The end date of the budget |
| lines | array | An array of budgets line items. |
| status sortable, filterable | string | Current status of the budget. |
| createdDate | string See Date | The date on which this record was created in the accounting service. |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |
Lines
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | The Id of the line item. |
| balances | array | An array of historical budgets balances . |
| accountRef | Reference Types | Reference to the account associated with this budget line item |
| customerRef | Reference Types | Reference to the customer associated with this budget line item |
| trackingCategoryRefs | Reference Types | Reference to the tracking categories associated with this line item, e.g. classes or departments. |
Balances
| Field | Type | Description |
|---|---|---|
| amount sortable, filterable | decimal | he amount assigned to a budget line item |
| date sortable, filterable | string See Date. | The date of the budget line item |
Budget Status
active- This is a current active budget for the business.archived- This is no longer an active budget.unknown- Railz was not able to recognize the status of the budget. This can be due to missing values in the accounting service provider or unavailable in the data we receive