Class: Yoomoney::Resources::Receipts

Inherits:
Object
  • Object
show all
Defined in:
lib/yoomoney/resources/receipts.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Receipts

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 Receipts.

Parameters:



106
107
108
 
# File 'lib/yoomoney/resources/receipts.rb', line 106

def initialize(client:)
  @client = client
end

Instance Method Details

#create(customer:, items:, send_:, settlements:, type:, idempotence_key:, additional_user_props: nil, internet: nil, on_behalf_of: nil, payment_id: nil, receipt_industry_details: nil, receipt_operational_details: nil, refund_id: nil, tax_system_code: nil, timezone: nil, request_options: {}) ⇒ Yoomoney::Models::Receipt

Создание чека

Parameters:

  • customer (Yoomoney::Models::ReceiptDataCustomer) —

    Body param: Данные покупателя.

  • items (Array<Yoomoney::Models::ReceiptCreateParams::Item>) —

    Body param: Позиции чека.

  • send_ (Boolean) —

    Body param: Признак отправки чека пользователю.

  • settlements (Array<Yoomoney::Models::Settlement>) —

    Body param: Данные расчетов.

  • type (Symbol, Yoomoney::Models::ReceiptType) —

    Body param: Тип чека.

  • idempotence_key (String) —

    Header param

  • additional_user_props (Yoomoney::Models::ReceiptCreateParams::AdditionalUserProps) —

    Body param: Дополнительный реквизит пользователя.

  • internet (Boolean) —

    Body param: Флаг расчета в интернете.

  • on_behalf_of (String) —

    Body param: Идентификатор магазина.

  • payment_id (String) —

    Body param: Идентификатор платежа.

  • receipt_industry_details (Array<Yoomoney::Models::IndustryDetails>) —

    Body param: Отраслевой реквизит чека.

  • receipt_operational_details (Yoomoney::Models::OperationalDetails) —

    Body param: Операционный реквизит чека.

  • refund_id (String) —

    Body param: Идентификатор возврата.

  • tax_system_code (Integer) —

    Body param: Код системы налогообложения.

  • timezone (String) —

    Body param: Часовой пояс.

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

Returns:

See Also:



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/yoomoney/resources/receipts.rb', line 45

def create(params)
  parsed, options = Yoomoney::ReceiptCreateParams.dump_request(params)
  header_params = {idempotence_key: "idempotence-key"}
  @client.request(
    method: :post,
    path: "receipts",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Yoomoney::Receipt,
    options: options
  )
end

#list(created_at: nil, cursor: nil, limit: nil, payment_id: nil, refund_id: nil, status: nil, request_options: {}) ⇒ Yoomoney::Models::ReceiptListResponse

Список чеков

Parameters:

Returns:

See Also:



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/yoomoney/resources/receipts.rb', line 92

def list(params = {})
  parsed, options = Yoomoney::ReceiptListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "receipts",
    query: parsed,
    model: Yoomoney::Models::ReceiptListResponse,
    options: options
  )
end

#retrieve(receipt_id, request_options: {}) ⇒ Yoomoney::Models::Receipt

Информация о чеке

Parameters:

Returns:

See Also:



68
69
70
71
72
73
74
75
 
# File 'lib/yoomoney/resources/receipts.rb', line 68

def retrieve(receipt_id, params = {})
  @client.request(
    method: :get,
    path: ["receipts/%1$s", receipt_id],
    model: Yoomoney::Receipt,
    options: params[:request_options]
  )
end