Class: Maventa::Invoices

Inherits:
Resource show all
Defined in:
lib/maventa/invoices.rb

Instance Method Summary collapse

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from Maventa::Resource

Instance Method Details

#actions(id, type: [:received, :created, :sent, :delivered, :info, :error], channel_details_version: 1) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/maventa/invoices.rb', line 82

def actions(
	id,
	type: [:received, :created, :sent, :delivered, :info, :error],
	channel_details_version: 1
)
	payload = {
		type: type.map { |t| t.to_s.upcase },
		channel_details_version:
	}
	
	request(:get, "/v1/invoices/#{id}/actions", payload:)
end

#create(filename, format: :finvoice30, recipient_eia: nil, recipient_email: nil, recipient_operator: nil, disabled_routes: [], sender_comment: nil, uuid: nil, route_order: [], recipient_phone_number: nil, prevent_routing: false) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/maventa/invoices.rb', line 48

def create(
	filename,
	format: :finvoice30,
	recipient_eia: nil,
	recipient_email: nil,
	recipient_operator: nil,
	disabled_routes: [],
	sender_comment: nil,
	uuid: nil,
	route_order: [],
	recipient_phone_number: nil,
	prevent_routing: false
)
	payload = {
		format: format.to_s.upcase,
		recipient_eia:,
		recipient_email:,
		recipient_operator:,
		disabled_routes:,
		sender_comment:,
		uuid:,
		route_order:,
		recipient_phone_number:,
		prevent_routing:
	}
	payload[:file] = Faraday::Multipart::FilePart.new(
		File.open(filename),
		"text/xml",
		"invoice.xml"
	)
	
	request(:post, "/v1/invoices", payload:, multipart: true)
end

#list(direction: :sent, status: [], ids: nil, number: nil, reference: nil, received_at_start: nil, received_at_end: nil, sort: nil, channel_details_version: 1, page: 1, per_page: 10) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/maventa/invoices.rb', line 3

def list(
	direction: :sent,
	status: [],
	ids: nil,
	number: nil,
	reference: nil,
	received_at_start: nil,
	received_at_end: nil,
	sort: nil,
	channel_details_version: 1,
	page: 1,
	per_page: 10
)
	payload = {
		direction: direction.to_s.upcase,
		status:,
		ids:,
		number:,
		reference:,
		received_at_start:,
		received_at_end:,
		sort:,
		channel_details_version:,
		page:,
		per_page:
	}
	
	request(:get, "/v1/invoices", payload:)
end

#reports_definitions ⇒ Object 



95
96
97
 
# File 'lib/maventa/invoices.rb', line 95

def reports_definitions
	request(:get, "/v1/invoices/reports/definitions")
end

#show(id, return_format: nil, channel_details_version: 1) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/maventa/invoices.rb', line 33

def show(id, return_format: nil, channel_details_version: 1)
	payload = {
		return_format: return_format.to_s.upcase,
		channel_details_version:
	}
	expected_response_format = case return_format
	when :finvoice30
		:xml
	else
		:json
	end
	
	request(:get, "v1/invoices/#{id}", payload:, expected_response_format:)
end