Class: Dodopayments::Resources::Payouts::Breakup::Details

Inherits:
Object
  • Object
show all
Defined in:
lib/dodopayments/resources/payouts/breakup/details.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Details

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Details.

Parameters:



65
66
67
 
# File 'lib/dodopayments/resources/payouts/breakup/details.rb', line 65

def initialize(client:)
  @client = client
end

Instance Method Details

#download_csv(payout_id, request_options: {}) ⇒ nil

Downloads the complete payout breakup as a CSV file. Each row represents a balance ledger entry with columns: Ledger ID, Event Type, Original Amount, Original Currency, Reference Object ID, Description, Created At, USD Equivalent Amount, and Payout Currency Amount.

Parameters:

Returns:

  • (nil)

See Also:



53
54
55
56
57
58
59
60
 
# File 'lib/dodopayments/resources/payouts/breakup/details.rb', line 53

def download_csv(payout_id, params = {})
  @client.request(
    method: :get,
    path: ["payouts/%1$s/breakup/details/csv", payout_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(payout_id, page_number: nil, page_size: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Payouts::Breakup::DetailListResponse>

Returns paginated individual balance ledger entries for a payout, with each entry’s amount pro-rated into the payout’s currency. Supports pagination via ‘page_size` (default 10, max 100) and `page_number` (default 0) query parameters.

Parameters:

  • payout_id (String) —

    Id of the Payout to get breakup for

  • page_number (Integer) —

    Page number (0-indexed). Default: 0.

  • page_size (Integer) —

    Number of items per page. Default: 10, Max: 100.

  • request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/dodopayments/resources/payouts/breakup/details.rb', line 26

def list(payout_id, params = {})
  parsed, options = Dodopayments::Payouts::Breakup::DetailListParams.dump_request(params)
  query = Dodopayments::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["payouts/%1$s/breakup/details", payout_id],
    query: query,
    page: Dodopayments::Internal::DefaultPageNumberPagination,
    model: Dodopayments::Models::Payouts::Breakup::DetailListResponse,
    options: options
  )
end