A Budget represents a gift card or budget that customers may use as a payment method for orders.
Properties
| Name | Type | Description |
|---|---|---|
| Id | int | The ID of the budget. |
| AccountId | int | The ID of the Liftoff account that the budget belongs to. (Note: This account ID will always correspond to the account code you use in your authentication credentials.) |
| Account (via $expand) | Account | The Liftoff account that the budget belongs to. |
| CreateDate | datetimeoffset | The date the budget was created. |
| Code | string | The code for the budget. Must be unique across all budgets for the account. |
| IsDeleted | boolean | Flag that indicates whether the budget has been deleted. (Note: Once deleted, a budget may not be updated.) |
| Balance | decimal(18,2) | The current balance of the budget. |
| StartDate | date | Optional. The earliest date the budget may be applied. |
| ExpiresDate | date | Optional. The latest date the budget may be applied. If not specified, the budget does not expire. |
| CustomerId | int | Optional. The ID of the customer assigned to the budget. If not specified, the budget may be used by any customer. |
| ApplyAutomatically | boolean | Flag that indicates whether the budget should be applied automatically at checkout. If this flag is not set, the customer must manually enter the budget code. |
| AllowClaiming | boolean | Flag that indicates whether a budget that is not assigned to a customer will be mapped to the first customer who applies the budget. If this flag is not set, the budget will remain available to any customer with the code. |
| Description | string | The description of the budget that is displayed to customers. |
| CategoryId | int | Optional. The ID of the category whose products the budget may be applied to. |
| ProductId | int | Optional. The ID of the product the budget may be applied to. |
| ProductVariantFieldCode | string | Optional. Only product variants with the specified ProductVariantFieldValue for the specified ProductVariantFieldCode qualify for the budget. |
| ProductVariantFieldValue | string | Optional. Only product variants with the specified ProductVariantFieldValue for the specified ProductVariantFieldCode qualify for the budget. |
| CustomerFieldCode | string | Optional. Only customers with the specified CustomerFieldValue for the specified CustomerFieldCode may use the budget. |
| CustomerFieldValue | string | Optional. Only customers with the specified CustomerFieldValue for the specified CustomerFieldCode may use the budget. |
| BudgetTransactions (via $expand) | BudgetTransaction array | The collection of transactions that have been issued for the budget. |