Braintree v0.13.0

Braintree.SettlementBatchSummary (Braintree v0.13.0)

The settlement batch summary displays the total sales and credits for each batch for a particular date. The transactions can be grouped by a single custom field's values.

https://developers.braintreepayments.com/reference/request/settlement-batch-summary/generate/ruby

Link to this section Summary

Types

t()

Functions

generate(settlement_date, custom_field \\ nil, opts \\ [])

Generate a report of all settlements for a particular date. The field used for custom grouping will always be set as custom_field, regardless of its name.

new(params)

Convert a map including records into a summary struct with a list of record structs.

Link to this section Types

Link to this type

t()

@type t() :: %Braintree.SettlementBatchSummary{
  records: [Braintree.SettlementBatchSummary.Record.t()]
}

Link to this section Functions

Link to this function

generate(settlement_date, custom_field \\ nil, opts \\ [])

@spec generate(binary(), binary() | nil, Keyword.t()) ::
  {:ok, [t()]} | {:error, Braintree.ErrorResponse.t()}

Generate a report of all settlements for a particular date. The field used for custom grouping will always be set as custom_field, regardless of its name.

example

 Example 

Braintree.SettlementBatchSummary("2016-9-5", "custom_field_1")
Link to this function

new(params)

Convert a map including records into a summary struct with a list of record structs.