class BudgeaClient::DocumentsApi
Attributes
Public Class Methods
# File lib/budgea_client/api/documents_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get document types
@param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20018]
# File lib/budgea_client/api/documents_api.rb, line 27 def documenttypes_get(opts = {}) data, _status_code, _headers = documenttypes_get_with_http_info(opts) data end
Get document types
@param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20018
, Fixnum, Hash)>] InlineResponse20018
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 37 def documenttypes_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.documenttypes_get ...' end # resource path local_var_path = '/documenttypes' # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20018') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#documenttypes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document type Change value of a document type.
@param id_documenttype @param name Displayed name of document type @param attacheable If true, documents of this type can be attached to a transaction, and have amount related meta-data @param [Hash] opts the optional parameters @option opts [String] :expand @return [DocumentType]
# File lib/budgea_client/api/documents_api.rb, line 81 def documenttypes_id_documenttype_put(id_documenttype, name, attacheable, opts = {}) data, _status_code, _headers = documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts) data end
Edit a document type Change value of a document type.<br><br> @param id_documenttype @param name Displayed name of document type @param attacheable If true, documents of this type can be attached to a transaction, and have amount related meta-data @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(DocumentType
, Fixnum, Hash)>] DocumentType
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 94 def documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.documenttypes_id_documenttype_put ...' end # verify the required parameter 'id_documenttype' is set if @api_client.config.client_side_validation && id_documenttype.nil? fail ArgumentError, "Missing the required parameter 'id_documenttype' when calling DocumentsApi.documenttypes_id_documenttype_put" end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling DocumentsApi.documenttypes_id_documenttype_put" end # verify the required parameter 'attacheable' is set if @api_client.config.client_side_validation && attacheable.nil? fail ArgumentError, "Missing the required parameter 'attacheable' when calling DocumentsApi.documenttypes_id_documenttype_put" end # resource path local_var_path = '/documenttypes/{id_documenttype}'.sub('{' + 'id_documenttype' + '}', id_documenttype.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['name'] = name form_params['attacheable'] = attacheable # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DocumentType') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#documenttypes_id_documenttype_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.
@param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [nil]
# File lib/budgea_client/api/documents_api.rb, line 151 def ocr_post(file, opts = {}) ocr_post_with_http_info(file, opts) nil end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.<br><br> @param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 163 def ocr_post_with_http_info(file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.ocr_post ...' end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling DocumentsApi.ocr_post" end # resource path local_var_path = '/ocr' # query parameters query_params = {} # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['file'] = file form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#ocr_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 212 def users_id_user_accounts_id_account_transactions_id_transaction_documents_delete(id_user, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_account, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 225 def users_id_user_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 290 def users_id_user_accounts_id_account_transactions_id_transaction_documents_get(id_user, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_account, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 312 def users_id_user_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 378 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete(id_user, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_account, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 392 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 464 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put(id_user, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_account, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 489 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 572 def users_id_user_accounts_id_account_transactions_id_transaction_documents_post(id_user, id_account, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_account, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 597 def users_id_user_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_account, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 674 def users_id_user_accounts_id_account_transactions_id_transaction_documents_put(id_user, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_account, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 688 def users_id_user_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 749 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_account, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 762 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 827 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_account, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 849 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 915 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 929 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1001 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1026 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1109 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_account, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1134 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1211 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1225 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1287 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete(id_user, id_connection, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_account, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1301 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 1371 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get(id_user, id_connection, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_account, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1394 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1465 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1480 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1557 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1583 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1671 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_account, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1697 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1779 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1794 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 1860 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1874 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 1944 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 1967 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2038 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2053 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2130 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2156 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2244 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2270 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2352 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2367 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2431 def users_id_user_connections_id_connection_documents_delete(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2443 def users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 2503 def users_id_user_connections_id_connection_documents_get(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2524 def users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2585 def users_id_user_connections_id_connection_documents_id_document_delete(id_user, id_connection, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2598 def users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2665 def users_id_user_connections_id_connection_documents_id_document_put(id_user, id_connection, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2689 def users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2767 def users_id_user_connections_id_connection_documents_post(id_user, id_connection, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2791 def users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2863 def users_id_user_connections_id_connection_documents_put(id_user, id_connection, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2876 def users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 2933 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete(id_user, id_connection, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 2946 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 3011 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get(id_user, id_connection, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3033 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3099 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete(id_user, id_connection, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3113 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3185 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put(id_user, id_connection, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3210 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3293 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post(id_user, id_connection, id_subscription, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3318 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3395 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put(id_user, id_connection, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3409 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3470 def users_id_user_connections_id_connection_transactions_id_transaction_documents_delete(id_user, id_connection, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3483 def users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 3548 def users_id_user_connections_id_connection_transactions_id_transaction_documents_get(id_user, id_connection, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3570 def users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3636 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3650 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3722 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3747 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3830 def users_id_user_connections_id_connection_transactions_id_transaction_documents_post(id_user, id_connection, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3855 def users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 3932 def users_id_user_connections_id_connection_transactions_id_transaction_documents_put(id_user, id_connection, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 3946 def users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4007 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4020 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 4085 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4107 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4173 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4187 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4259 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4284 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4367 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4392 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4469 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4483 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4542 def users_id_user_documents_delete(id_user, opts = {}) data, _status_code, _headers = users_id_user_documents_delete_with_http_info(id_user, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4553 def users_id_user_documents_delete_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_delete" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 4608 def users_id_user_documents_get(id_user, opts = {}) data, _status_code, _headers = users_id_user_documents_get_with_http_info(id_user, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4628 def users_id_user_documents_get_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_get" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4684 def users_id_user_documents_id_document_delete(id_user, id_document, opts = {}) data, _status_code, _headers = users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4696 def users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4758 def users_id_user_documents_id_document_put(id_user, id_document, opts = {}) data, _status_code, _headers = users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4781 def users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4854 def users_id_user_documents_post(id_user, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_documents_post_with_http_info(id_user, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4877 def users_id_user_documents_post_with_http_info(id_user, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_documents_post" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 4944 def users_id_user_documents_put(id_user, id_document, opts = {}) data, _status_code, _headers = users_id_user_documents_put_with_http_info(id_user, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 4956 def users_id_user_documents_put_with_http_info(id_user, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_documents_put" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.
@param id_user Hint: you can use 'me' or 'all' @param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [nil]
# File lib/budgea_client/api/documents_api.rb, line 5009 def users_id_user_ocr_post(id_user, file, opts = {}) users_id_user_ocr_post_with_http_info(id_user, file, opts) nil end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.<br><br> @param id_user Hint: you can use 'me' or 'all' @param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5022 def users_id_user_ocr_post_with_http_info(id_user, file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_ocr_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_ocr_post" end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling DocumentsApi.users_id_user_ocr_post" end # resource path local_var_path = '/users/{id_user}/ocr'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['file'] = file form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_ocr_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5074 def users_id_user_subscriptions_id_subscription_documents_delete(id_user, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5086 def users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_delete" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_subscriptions_id_subscription_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 5146 def users_id_user_subscriptions_id_subscription_documents_get(id_user, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5167 def users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_get" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_get" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_subscriptions_id_subscription_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5228 def users_id_user_subscriptions_id_subscription_documents_id_document_delete(id_user, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5241 def users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_subscriptions_id_subscription_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5308 def users_id_user_subscriptions_id_subscription_documents_id_document_put(id_user, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5332 def users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_subscriptions_id_subscription_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5410 def users_id_user_subscriptions_id_subscription_documents_post(id_user, id_subscription, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5434 def users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_post" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_subscriptions_id_subscription_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5506 def users_id_user_subscriptions_id_subscription_documents_put(id_user, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5519 def users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_subscriptions_id_subscription_documents_put" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_subscriptions_id_subscription_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5575 def users_id_user_transactions_id_transaction_documents_delete(id_user, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5587 def users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 5647 def users_id_user_transactions_id_transaction_documents_get(id_user, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5668 def users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5729 def users_id_user_transactions_id_transaction_documents_id_document_delete(id_user, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5742 def users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5809 def users_id_user_transactions_id_transaction_documents_id_document_put(id_user, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5833 def users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 5911 def users_id_user_transactions_id_transaction_documents_post(id_user, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 5935 def users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 6007 def users_id_user_transactions_id_transaction_documents_put(id_user, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 6020 def users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 6076 def users_id_user_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 6088 def users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/documents_api.rb, line 6148 def users_id_user_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 6169 def users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 6230 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 6243 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 6310 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 6334 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 6412 def users_id_user_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 6436 def users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/documents_api.rb, line 6508 def users_id_user_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/documents_api.rb, line 6521 def users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling DocumentsApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: DocumentsApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end