everyaction.services.FinancialBatches

class everyaction.services.FinancialBatches(ea: EAClient)

Represents the Financial Batches service.

Methods

create(**kwargs)	See POST /financialBatches.
get(batch_id, /)	See GET /financialBatches/{financialBatchId}.
list(**kwargs)	See GET /financialBatches.

create(**kwargs: EAValue) → FinancialBatch

See POST /financialBatches.

Parameters

kwargs – The applicable query arguments and JSON data for the request. A FinancialBatch is appropriate to unpack here.

Returns

The created FinancialBatch object.

Keyword Arguments

• bankAccountId (bank_account_id, bank_account, account)

• checkDate (check_date)

• checkNumber (check_number)

• dateClosed (date_closed, closed)

• dateDeposited (date_deposited, deposited)

• dateOpened (date_opened, opened)

• depositNumber (deposit_number)

• designationId (designation_id, designation)

• expectedContributionCount (expected_contribution_count, expected_count)

• expectedContributionTotalAmount (expected_contribution_total_amount, expected_amount, expected_total)

• financialBatchId (financial_batch_id, id)

• financialBatchName (financial_batch_name, name)

• financialBatchNumber (financial_batch_number, number)

• isAutoGenerated (is_auto_generated, auto_generated, generated)

• isOpen (is_open, open)

get(batch_id: int, /) → FinancialBatch

See GET /financialBatches/{financialBatchId}.

Parameters

batch_id – The financialBatchId path parameter.

Returns

The resulting FinancialBatch object.

list(**kwargs: EAValue) → List[FinancialBatch]

See GET /financialBatches.

Parameters

kwargs – The applicable query arguments and JSON data for the request.

Returns

List of the resulting FinancialBatch objects.

Keyword Arguments

• includeAllAutoGenerated (include_all_auto_generated, include_auto_generated, include_generated)

• includeAllStatuses (include_all_statuses, include_statuses, include_closed)

• includeUnassigned (include_unassigned)

• searchKeyword (search_keyword, keyword, search)