Skip to main content

Ledger

Represents a financial ledger account.

type Ledger implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  accountType: LedgerAccountTypeEnum!
  balance: Money!
  seller: Seller
  type: LedgerTypeEnum!
  version: BigInt!
  buyer: User
}

Fields

`Ledger.id` ● `ID!` non-null scalar

The Globally Unique ID of this object

`Ledger.metadata` ● `[MetadataItem!]!` non-null object

List of public metadata items. Can be accessed without permissions.

`Ledger.privateMetadata` ● `[MetadataItem!]!` non-null object

List of private metadata items. Requires proper staff permissions to access.

`Ledger.accountType` ● `LedgerAccountTypeEnum!` non-null enum

Ledger account type

`Ledger.balance` ● `Money!` non-null object

Balance of the ledger

`Ledger.seller` ● `Seller` object

Seller associated with this ledger

`Ledger.type` ● `LedgerTypeEnum!` non-null enum

Type of the ledger

`Ledger.version` ● `BigInt!` non-null scalar

Ledger version for optimistic locking

`Ledger.buyer` ● `User` object

Buyer for this ledger

Interfaces

`Node` interface

An object with a Globally Unique ID

`ObjectWithMetadata` interface

An object that supports metadata.

Member Of

LedgerCountableEdge object ● LedgerEntry object

Fields
Interfaces
Member Of