Class: MergeAccountingClient::InvoicesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/api/invoices_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvoicesApi

Returns a new instance of InvoicesApi.



19
20
21
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#invoices_create(x_account_token, invoice_endpoint_request, opts = {}) ⇒ InvoiceResponse

Creates an ‘Invoice` object with the given values.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • invoice_endpoint_request (InvoiceEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:



29
30
31
32
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 29

def invoices_create(, invoice_endpoint_request, opts = {})
  data, _status_code, _headers = invoices_create_with_http_info(, invoice_endpoint_request, opts)
  data
end

#invoices_create_with_http_info(x_account_token, invoice_endpoint_request, opts = {}) ⇒ Array<(InvoiceResponse, Integer, Hash)>

Creates an &#x60;Invoice&#x60; object with the given values.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • invoice_endpoint_request (InvoiceEndpointRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_debug_mode (Boolean) —

    Whether to include debug fields (such as log file links) in the response.

  • :run_async (Boolean) —

    Whether or not third-party updates should be run asynchronously.

Returns:

  • (Array<(InvoiceResponse, Integer, Hash)>) —

    InvoiceResponse data, response status code and response headers



41
42
43
44
45
46
47
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 41

def invoices_create_with_http_info(, invoice_endpoint_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoices_create ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling InvoicesApi.invoices_create"
  end
  # verify the required parameter 'invoice_endpoint_request' is set
  if @api_client.config.client_side_validation && invoice_endpoint_request.nil?
    fail ArgumentError, "Missing the required parameter 'invoice_endpoint_request' when calling InvoicesApi.invoices_create"
  end
  # resource path
  local_var_path = '/invoices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'is_debug_mode'] = opts[:'is_debug_mode'] if !opts[:'is_debug_mode'].nil?
  query_params[:'run_async'] = opts[:'run_async'] if !opts[:'run_async'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(invoice_endpoint_request)

  # return_type
  return_type = opts[:debug_return_type] || 'InvoiceResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoices_create",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#invoices_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoices_list(x_account_token, opts = {}) ⇒ PaginatedInvoiceList

Returns a list of ‘Invoice` objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :company_id (String) —

    If provided, will only return invoices for this company.

  • :contact_id (String) —

    If provided, will only return invoices for this contact.

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :issue_date_after (Time) —

    If provided, will only return objects created after this datetime.

  • :issue_date_before (Time) —

    If provided, will only return objects created before this datetime.

  • :modified_after (Time) —

    If provided, only objects synced by Merge after this date time will be returned.

  • :modified_before (Time) —

    If provided, only objects synced by Merge before this date time will be returned.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

  • :type (String) —

    If provided, will only return Invoices with this type * &#x60;ACCOUNTS_RECEIVABLE&#x60; - ACCOUNTS_RECEIVABLE * &#x60;ACCOUNTS_PAYABLE&#x60; - ACCOUNTS_PAYABLE

Returns:



119
120
121
122
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 119

def invoices_list(, opts = {})
  data, _status_code, _headers = invoices_list_with_http_info(, opts)
  data
end

#invoices_list_with_http_info(x_account_token, opts = {}) ⇒ Array<(PaginatedInvoiceList, Integer, Hash)>

Returns a list of &#x60;Invoice&#x60; objects.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :company_id (String) —

    If provided, will only return invoices for this company.

  • :contact_id (String) —

    If provided, will only return invoices for this contact.

  • :created_after (Time) —

    If provided, will only return objects created after this datetime.

  • :created_before (Time) —

    If provided, will only return objects created before this datetime.

  • :cursor (String) —

    The pagination cursor value.

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_deleted_data (Boolean) —

    Whether to include data that was marked as deleted by third party webhooks.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :issue_date_after (Time) —

    If provided, will only return objects created after this datetime.

  • :issue_date_before (Time) —

    If provided, will only return objects created before this datetime.

  • :modified_after (Time) —

    If provided, only objects synced by Merge after this date time will be returned.

  • :modified_before (Time) —

    If provided, only objects synced by Merge before this date time will be returned.

  • :page_size (Integer) —

    Number of results to return per page.

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :remote_id (String) —

    The API provider&#39;s ID for the given object.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

  • :type (String) —

    If provided, will only return Invoices with this type * &#x60;ACCOUNTS_RECEIVABLE&#x60; - ACCOUNTS_RECEIVABLE * &#x60;ACCOUNTS_PAYABLE&#x60; - ACCOUNTS_PAYABLE

Returns:

  • (Array<(PaginatedInvoiceList, Integer, Hash)>) —

    PaginatedInvoiceList data, response status code and response headers



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 145

def invoices_list_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoices_list ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling InvoicesApi.invoices_list"
  end
  allowable_values = ["accounting_period", "applied_payments", "applied_payments,accounting_period", "applied_payments,company", "applied_payments,company,accounting_period", "applied_payments,contact", "applied_payments,contact,accounting_period", "applied_payments,contact,company", "applied_payments,contact,company,accounting_period", "applied_payments,line_items", "applied_payments,line_items,accounting_period", "applied_payments,line_items,company", "applied_payments,line_items,company,accounting_period", "applied_payments,line_items,contact", "applied_payments,line_items,contact,accounting_period", "applied_payments,line_items,contact,company", "applied_payments,line_items,contact,company,accounting_period", "applied_payments,line_items,purchase_orders", "applied_payments,line_items,purchase_orders,accounting_period", "applied_payments,line_items,purchase_orders,company", "applied_payments,line_items,purchase_orders,company,accounting_period", "applied_payments,line_items,purchase_orders,contact", "applied_payments,line_items,purchase_orders,contact,accounting_period", "applied_payments,line_items,purchase_orders,contact,company", "applied_payments,line_items,purchase_orders,contact,company,accounting_period", "applied_payments,line_items,tracking_categories", "applied_payments,line_items,tracking_categories,accounting_period", "applied_payments,line_items,tracking_categories,company", "applied_payments,line_items,tracking_categories,company,accounting_period", "applied_payments,line_items,tracking_categories,contact", "applied_payments,line_items,tracking_categories,contact,accounting_period", "applied_payments,line_items,tracking_categories,contact,company", "applied_payments,line_items,tracking_categories,contact,company,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders", "applied_payments,line_items,tracking_categories,purchase_orders,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders,company", "applied_payments,line_items,tracking_categories,purchase_orders,company,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders,contact", "applied_payments,line_items,tracking_categories,purchase_orders,contact,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders,contact,company", "applied_payments,line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "applied_payments,purchase_orders", "applied_payments,purchase_orders,accounting_period", "applied_payments,purchase_orders,company", "applied_payments,purchase_orders,company,accounting_period", "applied_payments,purchase_orders,contact", "applied_payments,purchase_orders,contact,accounting_period", "applied_payments,purchase_orders,contact,company", "applied_payments,purchase_orders,contact,company,accounting_period", "applied_payments,tracking_categories", "applied_payments,tracking_categories,accounting_period", "applied_payments,tracking_categories,company", "applied_payments,tracking_categories,company,accounting_period", "applied_payments,tracking_categories,contact", "applied_payments,tracking_categories,contact,accounting_period", "applied_payments,tracking_categories,contact,company", "applied_payments,tracking_categories,contact,company,accounting_period", "applied_payments,tracking_categories,purchase_orders", "applied_payments,tracking_categories,purchase_orders,accounting_period", "applied_payments,tracking_categories,purchase_orders,company", "applied_payments,tracking_categories,purchase_orders,company,accounting_period", "applied_payments,tracking_categories,purchase_orders,contact", "applied_payments,tracking_categories,purchase_orders,contact,accounting_period", "applied_payments,tracking_categories,purchase_orders,contact,company", "applied_payments,tracking_categories,purchase_orders,contact,company,accounting_period", "company", "company,accounting_period", "contact", "contact,accounting_period", "contact,company", "contact,company,accounting_period", "line_items", "line_items,accounting_period", "line_items,company", "line_items,company,accounting_period", "line_items,contact", "line_items,contact,accounting_period", "line_items,contact,company", "line_items,contact,company,accounting_period", "line_items,purchase_orders", "line_items,purchase_orders,accounting_period", "line_items,purchase_orders,company", "line_items,purchase_orders,company,accounting_period", "line_items,purchase_orders,contact", "line_items,purchase_orders,contact,accounting_period", "line_items,purchase_orders,contact,company", "line_items,purchase_orders,contact,company,accounting_period", "line_items,tracking_categories", "line_items,tracking_categories,accounting_period", "line_items,tracking_categories,company", "line_items,tracking_categories,company,accounting_period", "line_items,tracking_categories,contact", "line_items,tracking_categories,contact,accounting_period", "line_items,tracking_categories,contact,company", "line_items,tracking_categories,contact,company,accounting_period", "line_items,tracking_categories,purchase_orders", "line_items,tracking_categories,purchase_orders,accounting_period", "line_items,tracking_categories,purchase_orders,company", "line_items,tracking_categories,purchase_orders,company,accounting_period", "line_items,tracking_categories,purchase_orders,contact", "line_items,tracking_categories,purchase_orders,contact,accounting_period", "line_items,tracking_categories,purchase_orders,contact,company", "line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "payments", "payments,accounting_period", "payments,applied_payments", "payments,applied_payments,accounting_period", "payments,applied_payments,company", "payments,applied_payments,company,accounting_period", "payments,applied_payments,contact", "payments,applied_payments,contact,accounting_period", "payments,applied_payments,contact,company", "payments,applied_payments,contact,company,accounting_period", "payments,applied_payments,line_items", "payments,applied_payments,line_items,accounting_period", "payments,applied_payments,line_items,company", "payments,applied_payments,line_items,company,accounting_period", "payments,applied_payments,line_items,contact", "payments,applied_payments,line_items,contact,accounting_period", "payments,applied_payments,line_items,contact,company", "payments,applied_payments,line_items,contact,company,accounting_period", "payments,applied_payments,line_items,purchase_orders", "payments,applied_payments,line_items,purchase_orders,accounting_period", "payments,applied_payments,line_items,purchase_orders,company", "payments,applied_payments,line_items,purchase_orders,company,accounting_period", "payments,applied_payments,line_items,purchase_orders,contact", "payments,applied_payments,line_items,purchase_orders,contact,accounting_period", "payments,applied_payments,line_items,purchase_orders,contact,company", "payments,applied_payments,line_items,purchase_orders,contact,company,accounting_period", "payments,applied_payments,line_items,tracking_categories", "payments,applied_payments,line_items,tracking_categories,accounting_period", "payments,applied_payments,line_items,tracking_categories,company", "payments,applied_payments,line_items,tracking_categories,company,accounting_period", "payments,applied_payments,line_items,tracking_categories,contact", "payments,applied_payments,line_items,tracking_categories,contact,accounting_period", "payments,applied_payments,line_items,tracking_categories,contact,company", "payments,applied_payments,line_items,tracking_categories,contact,company,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders", "payments,applied_payments,line_items,tracking_categories,purchase_orders,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders,company", "payments,applied_payments,line_items,tracking_categories,purchase_orders,company,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact,company", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "payments,applied_payments,purchase_orders", "payments,applied_payments,purchase_orders,accounting_period", "payments,applied_payments,purchase_orders,company", "payments,applied_payments,purchase_orders,company,accounting_period", "payments,applied_payments,purchase_orders,contact", "payments,applied_payments,purchase_orders,contact,accounting_period", "payments,applied_payments,purchase_orders,contact,company", "payments,applied_payments,purchase_orders,contact,company,accounting_period", "payments,applied_payments,tracking_categories", "payments,applied_payments,tracking_categories,accounting_period", "payments,applied_payments,tracking_categories,company", "payments,applied_payments,tracking_categories,company,accounting_period", "payments,applied_payments,tracking_categories,contact", "payments,applied_payments,tracking_categories,contact,accounting_period", "payments,applied_payments,tracking_categories,contact,company", "payments,applied_payments,tracking_categories,contact,company,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders", "payments,applied_payments,tracking_categories,purchase_orders,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders,company", "payments,applied_payments,tracking_categories,purchase_orders,company,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders,contact", "payments,applied_payments,tracking_categories,purchase_orders,contact,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders,contact,company", "payments,applied_payments,tracking_categories,purchase_orders,contact,company,accounting_period", "payments,company", "payments,company,accounting_period", "payments,contact", "payments,contact,accounting_period", "payments,contact,company", "payments,contact,company,accounting_period", "payments,line_items", "payments,line_items,accounting_period", "payments,line_items,company", "payments,line_items,company,accounting_period", "payments,line_items,contact", "payments,line_items,contact,accounting_period", "payments,line_items,contact,company", "payments,line_items,contact,company,accounting_period", "payments,line_items,purchase_orders", "payments,line_items,purchase_orders,accounting_period", "payments,line_items,purchase_orders,company", "payments,line_items,purchase_orders,company,accounting_period", "payments,line_items,purchase_orders,contact", "payments,line_items,purchase_orders,contact,accounting_period", "payments,line_items,purchase_orders,contact,company", "payments,line_items,purchase_orders,contact,company,accounting_period", "payments,line_items,tracking_categories", "payments,line_items,tracking_categories,accounting_period", "payments,line_items,tracking_categories,company", "payments,line_items,tracking_categories,company,accounting_period", "payments,line_items,tracking_categories,contact", "payments,line_items,tracking_categories,contact,accounting_period", "payments,line_items,tracking_categories,contact,company", "payments,line_items,tracking_categories,contact,company,accounting_period", "payments,line_items,tracking_categories,purchase_orders", "payments,line_items,tracking_categories,purchase_orders,accounting_period", "payments,line_items,tracking_categories,purchase_orders,company", "payments,line_items,tracking_categories,purchase_orders,company,accounting_period", "payments,line_items,tracking_categories,purchase_orders,contact", "payments,line_items,tracking_categories,purchase_orders,contact,accounting_period", "payments,line_items,tracking_categories,purchase_orders,contact,company", "payments,line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "payments,purchase_orders", "payments,purchase_orders,accounting_period", "payments,purchase_orders,company", "payments,purchase_orders,company,accounting_period", "payments,purchase_orders,contact", "payments,purchase_orders,contact,accounting_period", "payments,purchase_orders,contact,company", "payments,purchase_orders,contact,company,accounting_period", "payments,tracking_categories", "payments,tracking_categories,accounting_period", "payments,tracking_categories,company", "payments,tracking_categories,company,accounting_period", "payments,tracking_categories,contact", "payments,tracking_categories,contact,accounting_period", "payments,tracking_categories,contact,company", "payments,tracking_categories,contact,company,accounting_period", "payments,tracking_categories,purchase_orders", "payments,tracking_categories,purchase_orders,accounting_period", "payments,tracking_categories,purchase_orders,company", "payments,tracking_categories,purchase_orders,company,accounting_period", "payments,tracking_categories,purchase_orders,contact", "payments,tracking_categories,purchase_orders,contact,accounting_period", "payments,tracking_categories,purchase_orders,contact,company", "payments,tracking_categories,purchase_orders,contact,company,accounting_period", "purchase_orders", "purchase_orders,accounting_period", "purchase_orders,company", "purchase_orders,company,accounting_period", "purchase_orders,contact", "purchase_orders,contact,accounting_period", "purchase_orders,contact,company", "purchase_orders,contact,company,accounting_period", "tracking_categories", "tracking_categories,accounting_period", "tracking_categories,company", "tracking_categories,company,accounting_period", "tracking_categories,contact", "tracking_categories,contact,accounting_period", "tracking_categories,contact,company", "tracking_categories,contact,company,accounting_period", "tracking_categories,purchase_orders", "tracking_categories,purchase_orders,accounting_period", "tracking_categories,purchase_orders,company", "tracking_categories,purchase_orders,company,accounting_period", "tracking_categories,purchase_orders,contact", "tracking_categories,purchase_orders,contact,accounting_period", "tracking_categories,purchase_orders,contact,company", "tracking_categories,purchase_orders,contact,company,accounting_period"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  allowable_values = ["type"]
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
    fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
  end
  allowable_values = ["type"]
  if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
    fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
  end
  allowable_values = ["ACCOUNTS_PAYABLE", "ACCOUNTS_RECEIVABLE"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/invoices'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'company_id'] = opts[:'company_id'] if !opts[:'company_id'].nil?
  query_params[:'contact_id'] = opts[:'contact_id'] if !opts[:'contact_id'].nil?
  query_params[:'created_after'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'created_before'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include_deleted_data'] = opts[:'include_deleted_data'] if !opts[:'include_deleted_data'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'issue_date_after'] = opts[:'issue_date_after'] if !opts[:'issue_date_after'].nil?
  query_params[:'issue_date_before'] = opts[:'issue_date_before'] if !opts[:'issue_date_before'].nil?
  query_params[:'modified_after'] = opts[:'modified_after'] if !opts[:'modified_after'].nil?
  query_params[:'modified_before'] = opts[:'modified_before'] if !opts[:'modified_before'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
  query_params[:'remote_id'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
  query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedInvoiceList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoices_list",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#invoices_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoices_meta_post_retrieve(x_account_token, opts = {}) ⇒ MetaResponse

Returns metadata for ‘Invoice` POSTs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



231
232
233
234
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 231

def invoices_meta_post_retrieve(, opts = {})
  data, _status_code, _headers = invoices_meta_post_retrieve_with_http_info(, opts)
  data
end

#invoices_meta_post_retrieve_with_http_info(x_account_token, opts = {}) ⇒ Array<(MetaResponse, Integer, Hash)>

Returns metadata for &#x60;Invoice&#x60; POSTs.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MetaResponse, Integer, Hash)>) —

    MetaResponse data, response status code and response headers



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 240

def invoices_meta_post_retrieve_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoices_meta_post_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling InvoicesApi.invoices_meta_post_retrieve"
  end
  # resource path
  local_var_path = '/invoices/meta/post'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MetaResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoices_meta_post_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#invoices_meta_post_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#invoices_retrieve(x_account_token, id, opts = {}) ⇒ Invoice

Returns an ‘Invoice` object with the given `id`.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

Returns:



298
299
300
301
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 298

def invoices_retrieve(, id, opts = {})
  data, _status_code, _headers = invoices_retrieve_with_http_info(, id, opts)
  data
end

#invoices_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Invoice, Integer, Hash)>

Returns an &#x60;Invoice&#x60; object with the given &#x60;id&#x60;.

Parameters:

  • x_account_token (String) —

    Token identifying the end user.

  • id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :expand (String) —

    Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

  • :include_remote_data (Boolean) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.

Returns:

  • (Array<(Invoice, Integer, Hash)>) —

    Invoice data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/merge_accounting_client/api/invoices_api.rb', line 312

def invoices_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvoicesApi.invoices_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling InvoicesApi.invoices_retrieve"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling InvoicesApi.invoices_retrieve"
  end
  allowable_values = ["accounting_period", "applied_payments", "applied_payments,accounting_period", "applied_payments,company", "applied_payments,company,accounting_period", "applied_payments,contact", "applied_payments,contact,accounting_period", "applied_payments,contact,company", "applied_payments,contact,company,accounting_period", "applied_payments,line_items", "applied_payments,line_items,accounting_period", "applied_payments,line_items,company", "applied_payments,line_items,company,accounting_period", "applied_payments,line_items,contact", "applied_payments,line_items,contact,accounting_period", "applied_payments,line_items,contact,company", "applied_payments,line_items,contact,company,accounting_period", "applied_payments,line_items,purchase_orders", "applied_payments,line_items,purchase_orders,accounting_period", "applied_payments,line_items,purchase_orders,company", "applied_payments,line_items,purchase_orders,company,accounting_period", "applied_payments,line_items,purchase_orders,contact", "applied_payments,line_items,purchase_orders,contact,accounting_period", "applied_payments,line_items,purchase_orders,contact,company", "applied_payments,line_items,purchase_orders,contact,company,accounting_period", "applied_payments,line_items,tracking_categories", "applied_payments,line_items,tracking_categories,accounting_period", "applied_payments,line_items,tracking_categories,company", "applied_payments,line_items,tracking_categories,company,accounting_period", "applied_payments,line_items,tracking_categories,contact", "applied_payments,line_items,tracking_categories,contact,accounting_period", "applied_payments,line_items,tracking_categories,contact,company", "applied_payments,line_items,tracking_categories,contact,company,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders", "applied_payments,line_items,tracking_categories,purchase_orders,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders,company", "applied_payments,line_items,tracking_categories,purchase_orders,company,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders,contact", "applied_payments,line_items,tracking_categories,purchase_orders,contact,accounting_period", "applied_payments,line_items,tracking_categories,purchase_orders,contact,company", "applied_payments,line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "applied_payments,purchase_orders", "applied_payments,purchase_orders,accounting_period", "applied_payments,purchase_orders,company", "applied_payments,purchase_orders,company,accounting_period", "applied_payments,purchase_orders,contact", "applied_payments,purchase_orders,contact,accounting_period", "applied_payments,purchase_orders,contact,company", "applied_payments,purchase_orders,contact,company,accounting_period", "applied_payments,tracking_categories", "applied_payments,tracking_categories,accounting_period", "applied_payments,tracking_categories,company", "applied_payments,tracking_categories,company,accounting_period", "applied_payments,tracking_categories,contact", "applied_payments,tracking_categories,contact,accounting_period", "applied_payments,tracking_categories,contact,company", "applied_payments,tracking_categories,contact,company,accounting_period", "applied_payments,tracking_categories,purchase_orders", "applied_payments,tracking_categories,purchase_orders,accounting_period", "applied_payments,tracking_categories,purchase_orders,company", "applied_payments,tracking_categories,purchase_orders,company,accounting_period", "applied_payments,tracking_categories,purchase_orders,contact", "applied_payments,tracking_categories,purchase_orders,contact,accounting_period", "applied_payments,tracking_categories,purchase_orders,contact,company", "applied_payments,tracking_categories,purchase_orders,contact,company,accounting_period", "company", "company,accounting_period", "contact", "contact,accounting_period", "contact,company", "contact,company,accounting_period", "line_items", "line_items,accounting_period", "line_items,company", "line_items,company,accounting_period", "line_items,contact", "line_items,contact,accounting_period", "line_items,contact,company", "line_items,contact,company,accounting_period", "line_items,purchase_orders", "line_items,purchase_orders,accounting_period", "line_items,purchase_orders,company", "line_items,purchase_orders,company,accounting_period", "line_items,purchase_orders,contact", "line_items,purchase_orders,contact,accounting_period", "line_items,purchase_orders,contact,company", "line_items,purchase_orders,contact,company,accounting_period", "line_items,tracking_categories", "line_items,tracking_categories,accounting_period", "line_items,tracking_categories,company", "line_items,tracking_categories,company,accounting_period", "line_items,tracking_categories,contact", "line_items,tracking_categories,contact,accounting_period", "line_items,tracking_categories,contact,company", "line_items,tracking_categories,contact,company,accounting_period", "line_items,tracking_categories,purchase_orders", "line_items,tracking_categories,purchase_orders,accounting_period", "line_items,tracking_categories,purchase_orders,company", "line_items,tracking_categories,purchase_orders,company,accounting_period", "line_items,tracking_categories,purchase_orders,contact", "line_items,tracking_categories,purchase_orders,contact,accounting_period", "line_items,tracking_categories,purchase_orders,contact,company", "line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "payments", "payments,accounting_period", "payments,applied_payments", "payments,applied_payments,accounting_period", "payments,applied_payments,company", "payments,applied_payments,company,accounting_period", "payments,applied_payments,contact", "payments,applied_payments,contact,accounting_period", "payments,applied_payments,contact,company", "payments,applied_payments,contact,company,accounting_period", "payments,applied_payments,line_items", "payments,applied_payments,line_items,accounting_period", "payments,applied_payments,line_items,company", "payments,applied_payments,line_items,company,accounting_period", "payments,applied_payments,line_items,contact", "payments,applied_payments,line_items,contact,accounting_period", "payments,applied_payments,line_items,contact,company", "payments,applied_payments,line_items,contact,company,accounting_period", "payments,applied_payments,line_items,purchase_orders", "payments,applied_payments,line_items,purchase_orders,accounting_period", "payments,applied_payments,line_items,purchase_orders,company", "payments,applied_payments,line_items,purchase_orders,company,accounting_period", "payments,applied_payments,line_items,purchase_orders,contact", "payments,applied_payments,line_items,purchase_orders,contact,accounting_period", "payments,applied_payments,line_items,purchase_orders,contact,company", "payments,applied_payments,line_items,purchase_orders,contact,company,accounting_period", "payments,applied_payments,line_items,tracking_categories", "payments,applied_payments,line_items,tracking_categories,accounting_period", "payments,applied_payments,line_items,tracking_categories,company", "payments,applied_payments,line_items,tracking_categories,company,accounting_period", "payments,applied_payments,line_items,tracking_categories,contact", "payments,applied_payments,line_items,tracking_categories,contact,accounting_period", "payments,applied_payments,line_items,tracking_categories,contact,company", "payments,applied_payments,line_items,tracking_categories,contact,company,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders", "payments,applied_payments,line_items,tracking_categories,purchase_orders,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders,company", "payments,applied_payments,line_items,tracking_categories,purchase_orders,company,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact,accounting_period", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact,company", "payments,applied_payments,line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "payments,applied_payments,purchase_orders", "payments,applied_payments,purchase_orders,accounting_period", "payments,applied_payments,purchase_orders,company", "payments,applied_payments,purchase_orders,company,accounting_period", "payments,applied_payments,purchase_orders,contact", "payments,applied_payments,purchase_orders,contact,accounting_period", "payments,applied_payments,purchase_orders,contact,company", "payments,applied_payments,purchase_orders,contact,company,accounting_period", "payments,applied_payments,tracking_categories", "payments,applied_payments,tracking_categories,accounting_period", "payments,applied_payments,tracking_categories,company", "payments,applied_payments,tracking_categories,company,accounting_period", "payments,applied_payments,tracking_categories,contact", "payments,applied_payments,tracking_categories,contact,accounting_period", "payments,applied_payments,tracking_categories,contact,company", "payments,applied_payments,tracking_categories,contact,company,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders", "payments,applied_payments,tracking_categories,purchase_orders,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders,company", "payments,applied_payments,tracking_categories,purchase_orders,company,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders,contact", "payments,applied_payments,tracking_categories,purchase_orders,contact,accounting_period", "payments,applied_payments,tracking_categories,purchase_orders,contact,company", "payments,applied_payments,tracking_categories,purchase_orders,contact,company,accounting_period", "payments,company", "payments,company,accounting_period", "payments,contact", "payments,contact,accounting_period", "payments,contact,company", "payments,contact,company,accounting_period", "payments,line_items", "payments,line_items,accounting_period", "payments,line_items,company", "payments,line_items,company,accounting_period", "payments,line_items,contact", "payments,line_items,contact,accounting_period", "payments,line_items,contact,company", "payments,line_items,contact,company,accounting_period", "payments,line_items,purchase_orders", "payments,line_items,purchase_orders,accounting_period", "payments,line_items,purchase_orders,company", "payments,line_items,purchase_orders,company,accounting_period", "payments,line_items,purchase_orders,contact", "payments,line_items,purchase_orders,contact,accounting_period", "payments,line_items,purchase_orders,contact,company", "payments,line_items,purchase_orders,contact,company,accounting_period", "payments,line_items,tracking_categories", "payments,line_items,tracking_categories,accounting_period", "payments,line_items,tracking_categories,company", "payments,line_items,tracking_categories,company,accounting_period", "payments,line_items,tracking_categories,contact", "payments,line_items,tracking_categories,contact,accounting_period", "payments,line_items,tracking_categories,contact,company", "payments,line_items,tracking_categories,contact,company,accounting_period", "payments,line_items,tracking_categories,purchase_orders", "payments,line_items,tracking_categories,purchase_orders,accounting_period", "payments,line_items,tracking_categories,purchase_orders,company", "payments,line_items,tracking_categories,purchase_orders,company,accounting_period", "payments,line_items,tracking_categories,purchase_orders,contact", "payments,line_items,tracking_categories,purchase_orders,contact,accounting_period", "payments,line_items,tracking_categories,purchase_orders,contact,company", "payments,line_items,tracking_categories,purchase_orders,contact,company,accounting_period", "payments,purchase_orders", "payments,purchase_orders,accounting_period", "payments,purchase_orders,company", "payments,purchase_orders,company,accounting_period", "payments,purchase_orders,contact", "payments,purchase_orders,contact,accounting_period", "payments,purchase_orders,contact,company", "payments,purchase_orders,contact,company,accounting_period", "payments,tracking_categories", "payments,tracking_categories,accounting_period", "payments,tracking_categories,company", "payments,tracking_categories,company,accounting_period", "payments,tracking_categories,contact", "payments,tracking_categories,contact,accounting_period", "payments,tracking_categories,contact,company", "payments,tracking_categories,contact,company,accounting_period", "payments,tracking_categories,purchase_orders", "payments,tracking_categories,purchase_orders,accounting_period", "payments,tracking_categories,purchase_orders,company", "payments,tracking_categories,purchase_orders,company,accounting_period", "payments,tracking_categories,purchase_orders,contact", "payments,tracking_categories,purchase_orders,contact,accounting_period", "payments,tracking_categories,purchase_orders,contact,company", "payments,tracking_categories,purchase_orders,contact,company,accounting_period", "purchase_orders", "purchase_orders,accounting_period", "purchase_orders,company", "purchase_orders,company,accounting_period", "purchase_orders,contact", "purchase_orders,contact,accounting_period", "purchase_orders,contact,company", "purchase_orders,contact,company,accounting_period", "tracking_categories", "tracking_categories,accounting_period", "tracking_categories,company", "tracking_categories,company,accounting_period", "tracking_categories,contact", "tracking_categories,contact,accounting_period", "tracking_categories,contact,company", "tracking_categories,contact,company,accounting_period", "tracking_categories,purchase_orders", "tracking_categories,purchase_orders,accounting_period", "tracking_categories,purchase_orders,company", "tracking_categories,purchase_orders,company,accounting_period", "tracking_categories,purchase_orders,contact", "tracking_categories,purchase_orders,contact,accounting_period", "tracking_categories,purchase_orders,contact,company", "tracking_categories,purchase_orders,contact,company,accounting_period"]
  if @api_client.config.client_side_validation && opts[:'expand'] && !allowable_values.include?(opts[:'expand'])
    fail ArgumentError, "invalid value for \"expand\", must be one of #{allowable_values}"
  end
  allowable_values = ["type"]
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
    fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
  end
  allowable_values = ["type"]
  if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
    fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/invoices/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
  query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Invoice'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"InvoicesApi.invoices_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: InvoicesApi#invoices_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end