Braintree v0.7.0 Braintree.SettlementBatchSummary

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

Summary

Functions

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

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

Types

t :: %Braintree.SettlementBatchSummary{records: [Braintree.SettlementBatchSummary.Record.t]}

Functions

construct(params)

Specs

construct(Map.t | [Map.t]) :: t | [t]

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

generate(settlement_date, custom_field \\ nil)

Specs

generate(binary, binary | nil) ::
  {: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

Braintree.SettlementBatchSummary("2016-9-5", "custom_field_1")