Class: Bloomerang::Transaction

Inherits:
Base
  • Object
show all
Defined in:
lib/bloomerang/transaction.rb

Overview

Bloomerang::Transaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions Id integer($int64), The ID of the transaction used in the API (not to be confused with TransactionNumber) TransactionNumber integer($int64), A user-friendly transaction number used in the Bloomerang CRM UI (not to be confused with ID). In Bloomerang CRM Reporting, this is known as the Payment Number. NonDeductibleAmount number($currency) AccountId integer($int64), The ID of the constituent used in the API (not to be confused with accountNumber) Date string($date) Amount number($currency) Method PaymentMethodType, string, Enum: [ None, Cash, Check, CreditCard, Eft, InKind ] CheckNumber string CheckDate string($date) CreditCardType CreditCardType, string, Enum: [ Visa, MasterCard, Discover, AmericanExpress, DinersClub, JCB ] CreditCardLastFourDigits string CreditCardExpMonth number CreditCardExpYear number EftAccountType EftAccountType, string, Enum: [ Checking, Savings ] EftLastFourDigits string EftRoutingNumber string InKindDescription string InKindType InKindType, string Enum: [ Goods, Services ] InKindMarketValue number($currency) IntegrationUrl string, The deep URL when a transaction is created by qgiv Designations array[one of multiple potential objects] see API for options AttachmentIds array, The ID of the attachments on this interaction IsRefunded string, Enum: [ Yes, No ] RefundIds array, The IDs of the refunds on this transaction. Currently, there will be zero or one refunds. This is an array to allow partial and multiple refunds in the future if needed. AuditTrail AuditTrail (object)

Class Method Summary collapse

Methods inherited from Base

get, post, put

Class Method Details

.create(body) ⇒ Object

Create a transaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions/post_transaction

Params: body JSON object, see API for fiends



57
58
59
 
# File 'lib/bloomerang/transaction.rb', line 57

def self.create(body)
  post("transaction", {}, body)
end

.delete(id) ⇒ Object

Delete transaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions/delete_transaction_id

Params: id integer



85
86
87
 
# File 'lib/bloomerang/transaction.rb', line 85

def self.delete(id)
  delete("transaction/#{id}")
end

.fetch(params = {}) ⇒ Object

Fetch all transactions bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions/get_transactions

Params: skip integer, default: 0, simple paging system take integer, default: 50, simple paging system transactionNumber array, Filters results based on the transaction’s transactionNumber (called Payment Number in Bloomerang CRM Reporting). accountID array, separated by pipes: “1|2|3” id array, separated by pipes: “1|2|3” type array, separated by pipes: “one|two|three”, Available values : Donation, Pledge, PledgePayment, RecurringDonation, RecurringDonationPayment minAmount number, Filters results based on the transaction’s amount (inclusive). maxAmount number, Filters results based on the transaction’s amount (inclusive). orderBy string, Available values : Id (default), CreatedDate, LastModifiedDate orderDirection string, Available values : Asc, Desc



48
49
50
 
# File 'lib/bloomerang/transaction.rb', line 48

def self.fetch(params = {})
  get("transactions", params)
end

.fetch_designations(params = {}) ⇒ Object

Fetch all designations bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions/get_transactions_designations

Params: skip integer, default: 0, simple paging system take integer, default: 50, simple paging system designationNumbers array, separated by pipes: “1|2|3”, Filters results based on the designation’s designationNumber. transactionIds array, separated by pipes: “1|2|3”, Filters results based on the transaction ID for the designation. id array, separated by pipes: “1|2|3” orderBy string, Available values : Id (default), CreatedDate, LastModifiedDate orderDirection string, Available values : Asc, Desc



100
101
102
 
# File 'lib/bloomerang/transaction.rb', line 100

def self.fetch_designations(params = {})
  get("transactions/designations", params)
end

.get_designation(id) ⇒ Object

Fetch a designation by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions/get_transactions_designation_id

Params: id integer



109
110
111
 
# File 'lib/bloomerang/transaction.rb', line 109

def self.get_designation(id)
  get("transactions/designation/#{id}")
end

.show(id) ⇒ Object

Fetch a transaction by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions/get_transaction_id

Params: id integer



66
67
68
 
# File 'lib/bloomerang/transaction.rb', line 66

def self.show(id)
  get("transaction/#{id}")
end

.update(id, body) ⇒ Object

Update transaction bloomerang.co/product/integrations-data-management/api/rest-api/#/Transactions/put_transaction_id

Params: id integer body JSON object, see API for fields



76
77
78
 
# File 'lib/bloomerang/transaction.rb', line 76

def self.update(id, body)
  put("transaction/#{id}", {}, body)
end