Class: HaloMspApi::Resources::Invoices

Inherits:
Base
  • Object
show all
Defined in:
lib/halo_msp_api/resources/invoices.rb

Overview

Resource class for Invoices

Instance Attribute Summary

Attributes inherited from Base

#client_instance

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from HaloMspApi::Resources::Base

Instance Method Details

#changes(params = {}) ⇒ Object

Invoice Change methods GET /InvoiceChange - List Invoice changes



54
55
56
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 54

def changes(params = {})
  list_resource('InvoiceChange', params)
end

#create_change(data) ⇒ Object

POST /InvoiceChange - Create Invoice change



59
60
61
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 59

def create_change(data)
  create_resource('InvoiceChange', data)
end

#create_detail_pro_rata(data) ⇒ Object

POST /InvoiceDetailProRata - Create Invoice detail pro rata



70
71
72
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 70

def create_detail_pro_rata(data)
  create_resource('InvoiceDetailProRata', data)
end

#create_invoice(data) ⇒ Object

POST /Invoice - Create a new Invoice



18
19
20
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 18

def create_invoice(data)
  create_resource('Invoice', data)
end

#create_payment(data) ⇒ Object

POST /InvoicePayment - Create Invoice payment



86
87
88
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 86

def create_payment(data)
  create_resource('InvoicePayment', data)
end

#create_recurring_invoice(data) ⇒ Object

POST /RecurringInvoice - Create Recurring invoice



112
113
114
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 112

def create_recurring_invoice(data)
  create_resource('RecurringInvoice', data)
end

#delete_invoice(id) ⇒ Object

DELETE /Invoice/id - Delete an Invoice



28
29
30
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 28

def delete_invoice(id)
  delete_resource('Invoice', id)
end

#delete_payment(id) ⇒ Object

DELETE /InvoicePayment/id - Delete Invoice payment



96
97
98
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 96

def delete_payment(id)
  delete_resource('InvoicePayment', id)
end

#delete_recurring_invoice(id) ⇒ Object

DELETE /RecurringInvoice/id - Delete Recurring invoice



122
123
124
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 122

def delete_recurring_invoice(id)
  delete_resource('RecurringInvoice', id)
end

#detail_pro_rata(params = {}) ⇒ Object

Invoice Detail Pro Rata methods GET /InvoiceDetailProRata - List Invoice detail pro rata



65
66
67
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 65

def detail_pro_rata(params = {})
  list_resource('InvoiceDetailProRata', params)
end

#invoice(id, params = {}) ⇒ Object

GET /Invoice/id - Get a specific Invoice



13
14
15
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 13

def invoice(id, params = {})
  get_resource('Invoice', id, params)
end

#invoices(params = {}) ⇒ Object

GET /Invoice - List of Invoices



8
9
10
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 8

def invoices(params = {})
  list_resource('Invoice', params)
end

#payment(id, params = {}) ⇒ Object

GET /InvoicePayment/id - Get specific Invoice payment



81
82
83
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 81

def payment(id, params = {})
  get_resource('InvoicePayment', id, params)
end

#payments(params = {}) ⇒ Object

Invoice Payment methods GET /InvoicePayment - List Invoice payments



76
77
78
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 76

def payments(params = {})
  list_resource('InvoicePayment', params)
end

#pdf(id, params = {}) ⇒ Object

GET /Invoice/PDF/id - Get Invoice PDF



38
39
40
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 38

def pdf(id, params = {})
  get_resource('Invoice', "#{id}/PDF", params)
end

#process_recurring_invoices(data) ⇒ Object

POST /RecurringInvoice/process - Process Recurring invoices



132
133
134
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 132

def process_recurring_invoices(data)
  post('RecurringInvoice/process', data)
end

#recurring_invoice(id, params = {}) ⇒ Object

GET /RecurringInvoice/id - Get specific Recurring invoice



107
108
109
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 107

def recurring_invoice(id, params = {})
  get_resource('RecurringInvoice', id, params)
end

#recurring_invoice_lines(params = {}) ⇒ Object

GET /RecurringInvoice/Lines - Get Recurring invoice lines



127
128
129
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 127

def recurring_invoice_lines(params = {})
  get_resource('RecurringInvoice', 'Lines', params)
end

#recurring_invoices(params = {}) ⇒ Object

Recurring Invoice methods GET /RecurringInvoice - List Recurring invoices



102
103
104
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 102

def recurring_invoices(params = {})
  list_resource('RecurringInvoice', params)
end

#update_invoice(id, data) ⇒ Object

PUT /Invoice/id - Update an Invoice



23
24
25
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 23

def update_invoice(id, data)
  update_resource('Invoice', id, data)
end

#update_lines(data) ⇒ Object

POST /Invoice/updatelines - Update Invoice lines



43
44
45
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 43

def update_lines(data)
  post(resource_path('Invoice', nil, 'updatelines'), data)
end

#update_payment(id, data) ⇒ Object

PUT /InvoicePayment/id - Update Invoice payment



91
92
93
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 91

def update_payment(id, data)
  update_resource('InvoicePayment', id, data)
end

#update_recurring_invoice(id, data) ⇒ Object

PUT /RecurringInvoice/id - Update Recurring invoice



117
118
119
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 117

def update_recurring_invoice(id, data)
  update_resource('RecurringInvoice', id, data)
end

#update_recurring_invoice_lines(data) ⇒ Object

POST /RecurringInvoice/updatelines - Update Recurring invoice lines



137
138
139
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 137

def update_recurring_invoice_lines(data)
  post('RecurringInvoice/updatelines', data)
end

#view(params = {}) ⇒ Object

GET /Invoice/View - Get Invoice view



48
49
50
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 48

def view(params = {})
  get_resource('Invoice', 'View', params)
end

#void(id, data = {}) ⇒ Object

POST /Invoice/id/void - Void an Invoice



33
34
35
 
# File 'lib/halo_msp_api/resources/invoices.rb', line 33

def void(id, data = {})
  post(resource_path('Invoice', "#{id}/void"), data)
end