# Class: BalanceDoc\ Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:962](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L962) ## Extends - [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class)\<`BalanceDoc`\<`T`\>\> ## Type Parameters ### T `T` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) ## Implements - [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc)\<`T`\> ## Constructors ### Constructor > **new BalanceDoc**\<`T`\>(`data`): `BalanceDoc`\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:977](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L977) #### Parameters ##### data [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc)\<`T`\> & [`Doc`](https://docs.bitbadges.io/sdk/reference/interfaces/doc) & [`iUserBalanceStore`](https://docs.bitbadges.io/sdk/reference/interfaces/i-user-balance-store)\<`T`\> #### Returns `BalanceDoc`\<`T`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`constructor`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#constructor) ## Properties ### \_docId > **\_docId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:963](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L963) A unique stringified document ID #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`_docId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#_docid) *** ### \_id? > `optional` **\_id?**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:964](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L964) A unique document ID (Mongo DB ObjectID) #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`_id`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#_id) *** ### autoApproveAllIncomingTransfers > **autoApproveAllIncomingTransfers**: `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:974](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L974) Whether the user's all incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals. #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`autoApproveAllIncomingTransfers`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#autoapproveallincomingtransfers) *** ### autoApproveSelfInitiatedIncomingTransfers > **autoApproveSelfInitiatedIncomingTransfers**: `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:972](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L972) Whether the user's self-initiated incoming transfers are auto-approved. If not, they must be explicitly approved using the incoming approvals. #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`autoApproveSelfInitiatedIncomingTransfers`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#autoapproveselfinitiatedincomingtransfers) *** ### autoApproveSelfInitiatedOutgoingTransfers > **autoApproveSelfInitiatedOutgoingTransfers**: `boolean` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:973](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L973) Whether the user's self-initiated outgoing transfers are auto-approved. If not, they must be explicitly approved using the outgoing approvals. #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`autoApproveSelfInitiatedOutgoingTransfers`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#autoapproveselfinitiatedoutgoingtransfers) *** ### balances > **balances**: [`BalanceArray`](https://docs.bitbadges.io/sdk/reference/classes/balance-array)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:968](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L968) The user's balances. #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`balances`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#balances) *** ### bitbadgesAddress > **bitbadgesAddress**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:966](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L966) The BitBadges address of the user #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`bitbadgesAddress`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#bitbadgesaddress) *** ### collectionId > **collectionId**: `string` Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:965](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L965) The collection ID #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`collectionId`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#collectionid) *** ### incomingApprovals > **incomingApprovals**: [`UserIncomingApproval`](https://docs.bitbadges.io/sdk/reference/classes/user-incoming-approval)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:969](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L969) The user's incoming approvals. #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`incomingApprovals`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#incomingapprovals) *** ### outgoingApprovals > **outgoingApprovals**: [`UserOutgoingApproval`](https://docs.bitbadges.io/sdk/reference/classes/user-outgoing-approval)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:970](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L970) The user's outgoing approvals. #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`outgoingApprovals`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#outgoingapprovals) *** ### tags? > `optional` **tags?**: `string`[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:975](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L975) Optional tags for this balance #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`tags`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#tags) *** ### updateHistory > **updateHistory**: [`UpdateHistory`](https://docs.bitbadges.io/sdk/reference/classes/update-history)\<`T`\>[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:967](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L967) The update history of this balance #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`updateHistory`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#updatehistory) *** ### userPermissions > **userPermissions**: [`UserPermissions`](https://docs.bitbadges.io/sdk/reference/classes/user-permissions)\<`T`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:971](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L971) The user's permissions. #### Implementation of [`iBalanceDoc`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc).[`userPermissions`](https://docs.bitbadges.io/sdk/reference/interfaces/i-balance-doc#userpermissions) ## Methods ### clone() > **clone**(): `BalanceDoc` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:151](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L151) Deep copies the object and returns a new instance. #### Returns `BalanceDoc` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`clone`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#clone) *** ### convert() > **convert**\<`U`\>(`convertFunction`, `options?`): `BalanceDoc`\<`U`\> Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:998](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L998) Converts the object to a different NumberType equivalent. #### Type Parameters ##### U `U` *extends* [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) #### Parameters ##### convertFunction (`item`) => `U` ##### options? [`ConvertOptions`](https://docs.bitbadges.io/sdk/reference/interfaces/convert-options) #### Returns `BalanceDoc`\<`U`\> #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`convert`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#convert) *** ### equals() > **equals**\<`U`\>(`other`, `normalizeNumberTypes?`): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:147](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L147) Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects. If `normalizeNumberTypes` is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1"). #### Type Parameters ##### U `U` *extends* [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> #### Parameters ##### other [`CustomType`](https://docs.bitbadges.io/sdk/reference/interfaces/custom-type)\<`U`\> \| `null` \| `undefined` ##### normalizeNumberTypes? `boolean` #### Returns `boolean` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`equals`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#equals) *** ### getNumberFieldNames() > **getNumberFieldNames**(): `string`[] Defined in: [packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts:994](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/api-indexer/docs-types/docs.ts#L994) Internal helper method to convert the number fields of the object to a different NumberType equivalent. #### Returns `string`[] #### Overrides [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`getNumberFieldNames`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#getnumberfieldnames) *** ### hasNumberFields() > **hasNumberFields**(): `boolean` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:161](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L161) Checks if the object has number fields. #### Returns `boolean` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`hasNumberFields`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#hasnumberfields) *** ### toJson() > **toJson**(): `JsonObject` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:139](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L139) Converts the object to a JSON object with all primitive types. #### Returns `JsonObject` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJson`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojson) *** ### toJsonString() > **toJsonString**(): `string` Defined in: [packages/bitbadgesjs-sdk/src/common/base.ts:143](https://github.com/BitBadges/bitbadgesjs/blob/master/packages/bitbadgesjs-sdk/src/common/base.ts#L143) Converts the object to a JSON string. #### Returns `string` #### Inherited from [`BaseNumberTypeClass`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class).[`toJsonString`](https://docs.bitbadges.io/sdk/reference/classes/base-number-type-class#tojsonstring)