Class: Dolibarr::Api::Supplierinvoices

Inherits:
Object
  • Object
show all
Defined in:
lib/dolibarr-api/api/supplierinvoices.rb

Defined Under Namespace

Classes: Lines, Payments

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ Supplierinvoices

Returns a new instance of Supplierinvoices.



5
6
7
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 5

def initialize(connection)
  @connection = connection
end

Instance Method Details

#create(create_supplierinvoices_model: nil) ⇒ Object 



9
10
11
12
13
14
15
16
17
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 9

def create(create_supplierinvoices_model: nil)
  @connection.call(
    :POST,
    '/supplierinvoices',
    type: nil,
    auth: ['api_key'],
    body: create_supplierinvoices_model
  )
end

#delete(id:) ⇒ Object

Raises:

  • (ArgumentError) 


19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 19

def delete(id:)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :DELETE,
    '/supplierinvoices/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key']
  )
end

#get(id:) ⇒ Object

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 31

def get(id:)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :GET,
    '/supplierinvoices/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key']
  )
end

#list(sortfield: nil, sortorder: nil, limit: nil, page: nil, thirdparty_ids: nil, status: nil, sqlfilters: nil, properties: nil, pagination_data: nil) ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 43

def list(sortfield: nil, sortorder: nil, limit: nil, page: nil, thirdparty_ids: nil, status: nil, sqlfilters: nil, properties: nil, pagination_data: nil)
  @connection.call(
    :GET,
    '/supplierinvoices',
    type: nil,
    auth: ['api_key'],
    query: { 'sortfield' => sortfield, 'sortorder' => sortorder, 'limit' => limit, 'page' => page, 'thirdparty_ids' => thirdparty_ids, 'status' => status, 'sqlfilters' => sqlfilters, 'properties' => properties, 'pagination_data' => pagination_data }
  )
end

#settodraft(id:, supplierinvoices_settodraft_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 53

def settodraft(id:, supplierinvoices_settodraft_model: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :POST,
    '/supplierinvoices/{id}/settodraft'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key'],
    body: supplierinvoices_settodraft_model
  )
end

#settopaid(id:, supplierinvoices_settopaid_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 66

def settopaid(id:, supplierinvoices_settopaid_model: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :POST,
    '/supplierinvoices/{id}/settopaid'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key'],
    body: supplierinvoices_settopaid_model
  )
end

#settounpaid(id:) ⇒ Object

Raises:

  • (ArgumentError) 


79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 79

def settounpaid(id:)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :POST,
    '/supplierinvoices/{id}/settounpaid'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: Dolibarr::Api::Models::Obj,
    auth: ['api_key']
  )
end

#update(id:, update_supplierinvoices_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 91

def update(id:, update_supplierinvoices_model: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :PUT,
    '/supplierinvoices/{id}'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    body: update_supplierinvoices_model
  )
end

#validate(id:, supplierinvoices_validate_model: nil) ⇒ Object

Raises:

  • (ArgumentError) 


104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/dolibarr-api/api/supplierinvoices.rb', line 104

def validate(id:, supplierinvoices_validate_model: nil)
  raise ArgumentError, 'id is required' if id.nil?

  @connection.call(
    :POST,
    '/supplierinvoices/{id}/validate'
      .gsub('{id}', ERB::Util.url_encode(id.to_s)),
    type: nil,
    auth: ['api_key'],
    body: supplierinvoices_validate_model
  )
end