Class: Bloomerang::SoftCredit

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

Overview

Bloomerang::SoftCredit bloomerang.co/product/integrations-data-management/api/rest-api/#/Soft%20Credits Id integer($int64), The ID of the soft credit DesignationId integer($int64), The ID of the designation used in the API (not to be confused with designationNumber) TransactionId integer($int64), The ID of the transaction used in the API (not to be confused with transactionNumber) Amount number($currency) AccountId integer($int64), The ID of the constituent used in the API (not to be confused with accountNumber) AuditTrail AuditTrail (object)

Class Method Summary collapse

Methods inherited from Base

get, post, put

Class Method Details

.create(body) ⇒ Object

Create a soft credit bloomerang.co/product/integrations-data-management/api/rest-api/#/Soft%20Credits/post_softcredit

Params: body JSON object, see API for fields



32
33
34
 
# File 'lib/bloomerang/soft_credit.rb', line 32

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

.delete(id) ⇒ Object

Delete soft credit bloomerang.co/product/integrations-data-management/api/rest-api/#/Soft%20Credits/delete_softcredit_id

Params: id integer



60
61
62
 
# File 'lib/bloomerang/soft_credit.rb', line 60

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

.fetch(params = {}) ⇒ Object

Fetch all soft credits bloomerang.co/product/integrations-data-management/api/rest-api/#/Soft%20Credits/get_softcredits

Params: skip integer, default: 0, simple paging system take integer, default: 50, simple paging system constituent array, separated by pipes: “1|2|3” id array, separated by pipes: “1|2|3” orderBy string, Available values : Id (default), CreatedDate, LastModifiedDate orderDirection string, Available values : Asc, Desc



23
24
25
 
# File 'lib/bloomerang/soft_credit.rb', line 23

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

.show(id) ⇒ Object

Fetch a soft credit by ID bloomerang.co/product/integrations-data-management/api/rest-api/#/Soft%20Credits/get_softcredit_id

Params id integer



41
42
43
 
# File 'lib/bloomerang/soft_credit.rb', line 41

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

.update(id, body) ⇒ Object

Update soft credit bloomerang.co/product/integrations-data-management/api/rest-api/#/Soft%20Credits/put_softcredit_id

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



51
52
53
 
# File 'lib/bloomerang/soft_credit.rb', line 51

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