Skip to content

Latest commit

 

History

History
169 lines (116 loc) · 6.62 KB

LedgerEntryApi.md

File metadata and controls

169 lines (116 loc) · 6.62 KB

EtsyApi::LedgerEntryApi

All URIs are relative to https://openapi.etsy.com

Method HTTP request Description
get_shop_payment_account_ledger_entries GET /v3/application/shops/{shop_id}/payment-account/ledger-entries
get_shop_payment_account_ledger_entry GET /v3/application/shops/{shop_id}/payment-account/ledger-entries/{ledger_entry_id}

get_shop_payment_account_ledger_entries

get_shop_payment_account_ledger_entries(shop_id, min_created, max_created, opts)

General ReleaseReport bug

This endpoint is ready for production use.

Get a Shop Payment Account Ledger's Entries

Examples

require 'time'
require 'etsy_api'
# setup authorization
EtsyApi.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['api_key'] = 'Bearer'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = EtsyApi::LedgerEntryApi.new
shop_id = 56 # Integer | The unique positive non-zero numeric ID for an Etsy Shop.
min_created = 56 # Integer | The earliest unix timestamp for when a record was created.
max_created = 56 # Integer | The latest unix timestamp for when a record was created.
opts = {
  limit: 56, # Integer | The maximum number of results to return.
  offset: 56 # Integer | The number of records to skip before selecting the first result.
}

begin
  
  result = api_instance.get_shop_payment_account_ledger_entries(shop_id, min_created, max_created, opts)
  p result
rescue EtsyApi::ApiError => e
  puts "Error when calling LedgerEntryApi->get_shop_payment_account_ledger_entries: #{e}"
end

Using the get_shop_payment_account_ledger_entries_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_shop_payment_account_ledger_entries_with_http_info(shop_id, min_created, max_created, opts)

begin
  
  data, status_code, headers = api_instance.get_shop_payment_account_ledger_entries_with_http_info(shop_id, min_created, max_created, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaymentAccountLedgerEntries>
rescue EtsyApi::ApiError => e
  puts "Error when calling LedgerEntryApi->get_shop_payment_account_ledger_entries_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
shop_id Integer The unique positive non-zero numeric ID for an Etsy Shop.
min_created Integer The earliest unix timestamp for when a record was created.
max_created Integer The latest unix timestamp for when a record was created.
limit Integer The maximum number of results to return. [optional][default to 25]
offset Integer The number of records to skip before selecting the first result. [optional][default to 0]

Return type

PaymentAccountLedgerEntries

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

get_shop_payment_account_ledger_entry

get_shop_payment_account_ledger_entry(shop_id, ledger_entry_id)

General ReleaseReport bug

This endpoint is ready for production use.

Get a single Shop Payment Account Ledger's Entry

Examples

require 'time'
require 'etsy_api'
# setup authorization
EtsyApi.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['api_key'] = 'Bearer'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = EtsyApi::LedgerEntryApi.new
shop_id = 56 # Integer | The unique positive non-zero numeric ID for an Etsy Shop.
ledger_entry_id = 56 # Integer | The unique ID of the shop owner ledger entry.

begin
  
  result = api_instance.get_shop_payment_account_ledger_entry(shop_id, ledger_entry_id)
  p result
rescue EtsyApi::ApiError => e
  puts "Error when calling LedgerEntryApi->get_shop_payment_account_ledger_entry: #{e}"
end

Using the get_shop_payment_account_ledger_entry_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_shop_payment_account_ledger_entry_with_http_info(shop_id, ledger_entry_id)

begin
  
  data, status_code, headers = api_instance.get_shop_payment_account_ledger_entry_with_http_info(shop_id, ledger_entry_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaymentAccountLedgerEntry>
rescue EtsyApi::ApiError => e
  puts "Error when calling LedgerEntryApi->get_shop_payment_account_ledger_entry_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
shop_id Integer The unique positive non-zero numeric ID for an Etsy Shop.
ledger_entry_id Integer The unique ID of the shop owner ledger entry.

Return type

PaymentAccountLedgerEntry

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json