Etsy · JSON Structure

Open Api V3 Payment Account Ledger Entry Structure

Represents an entry in a shop's ledger.

Type: object Properties: 14
MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

PaymentAccountLedgerEntry is a JSON Structure definition published by Etsy, describing 14 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

entry_id ledger_id sequence_number amount currency description balance create_date created_timestamp ledger_type reference_type reference_id parent_entry_id payment_adjustments

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-structure/open-api-v3-payment-account-ledger-entry-structure.json",
  "name": "PaymentAccountLedgerEntry",
  "description": "Represents an entry in a shop's ledger.",
  "type": "object",
  "properties": {
    "entry_id": {
      "type": "int64",
      "description": "The ledger entry's numeric ID.",
      "minimum": 1,
      "example": 1
    },
    "ledger_id": {
      "type": "int64",
      "description": "The ledger's numeric ID.",
      "minimum": 1,
      "example": 1
    },
    "sequence_number": {
      "type": "int32",
      "description": "The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry.",
      "example": 1
    },
    "amount": {
      "type": "int32",
      "description": "The amount of money credited to the ledger.",
      "example": 2500
    },
    "currency": {
      "type": "string",
      "description": "The currency of the entry on the ledger.",
      "example": "example string"
    },
    "description": {
      "type": "string",
      "description": "Details what kind of ledger entry this is: a payment, refund, reversal of a failed refund, disbursement, returned disbursement, recoupment, miscellaneous credit, miscellaneous debit, or bill payment.",
      "example": "Beautifully crafted handmade ceramic mug, kiln-fired in our Brooklyn studio."
    },
    "balance": {
      "type": "int32",
      "description": "The amount of money in the shop's ledger the moment after this entry was applied.",
      "example": 1
    },
    "create_date": {
      "type": "int32",
      "description": "The date and time the ledger entry was created in Epoch seconds.",
      "minimum": 0,
      "example": 1
    },
    "created_timestamp": {
      "type": "int32",
      "description": "The date and time the ledger entry was created in Epoch seconds.",
      "minimum": 0,
      "example": 1758153645
    },
    "ledger_type": {
      "type": "string",
      "description": "The original reference type for the ledger entry.",
      "example": "example string"
    },
    "reference_type": {
      "type": "string",
      "description": "The object type the ledger entry refers to.",
      "example": "example string"
    },
    "reference_id": {
      "type": "string",
      "description": "The object id the ledger entry refers to.",
      "nullable": true,
      "example": "example string"
    },
    "parent_entry_id": {
      "type": "int32",
      "description": "The parent ledger entry ID used to match related entries (e.g., vat_seller_services to originating seller fees).",
      "minimum": 0,
      "example": 1
    },
    "payment_adjustments": {
      "type": "array",
      "description": "List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.",
      "items": {
        "description": "List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.",
        "oneOf": [
          {
            "$ref": "#/components/schemas/PaymentAdjustment"
          }
        ]
      }
    }
  }
}