Etsy · Schema

PaymentAccountLedgerEntry

Represents an entry in a shop's ledger.

MarketplaceEcommerceHandmadeListingsOrdersPaymentsReviewsShippingTaxonomyOAuth2

Properties

Name	Type	Description
entry_id	integer	The ledger entry's numeric ID.
ledger_id	integer	The ledger's numeric ID.
sequence_number	integer	The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry.
amount	integer	The amount of money credited to the ledger.
currency	string	The currency of the entry on the ledger.
description	string	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.
balance	integer	The amount of money in the shop's ledger the moment after this entry was applied.
create_date	integer	The date and time the ledger entry was created in Epoch seconds.
created_timestamp	integer	The date and time the ledger entry was created in Epoch seconds.
ledger_type	string	The original reference type for the ledger entry.
reference_type	string	The object type the ledger entry refers to.
reference_id	string	The object id the ledger entry refers to.
parent_entry_id	integer	The parent ledger entry ID used to match related entries (e.g., vat_seller_services to originating seller fees).
payment_adjustments	array	List of refund objects on an Etsy Payments transaction. All monetary amounts are in USD pennies unless otherwise specified.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PaymentAccountLedgerEntry",
  "description": "Represents an entry in a shop's ledger.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/etsy/refs/heads/main/json-schema/open-api-v3-payment-account-ledger-entry-schema.json",
  "type": "object",
  "properties": {
    "entry_id": {
      "type": "integer",
      "description": "The ledger entry's numeric ID.",
      "format": "int64",
      "minimum": 1,
      "example": 1
    },
    "ledger_id": {
      "type": "integer",
      "description": "The ledger's numeric ID.",
      "format": "int64",
      "minimum": 1,
      "example": 1
    },
    "sequence_number": {
      "type": "integer",
      "description": "The sequence allows ledger entries to be sorted chronologically. The higher the sequence, the more recent the entry.",
      "example": 1
    },
    "amount": {
      "type": "integer",
      "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": "integer",
      "description": "The amount of money in the shop's ledger the moment after this entry was applied.",
      "example": 1
    },
    "create_date": {
      "type": "integer",
      "description": "The date and time the ledger entry was created in Epoch seconds.",
      "minimum": 0,
      "example": 1
    },
    "created_timestamp": {
      "type": "integer",
      "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": "integer",
      "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"
          }
        ]
      }
    }
  }
}