Skip to content

Latest commit

 

History

History
195 lines (144 loc) · 8.51 KB

CreditNotesApi.md

File metadata and controls

195 lines (144 loc) · 8.51 KB
Raw

MergeAccountingClient::CreditNotesApi

All URIs are relative to https://api.merge.dev/api/accounting/v1

Method HTTP request Description
credit_notes_list GET /credit-notes
credit_notes_retrieve GET /credit-notes/{id}

credit_notes_list

credit_notes_list(x_account_token, opts)

Returns a list of CreditNote objects.

Examples

require 'time'
require 'merge_accounting_client'
# setup authorization
MergeAccountingClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeAccountingClient::CreditNotesApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
opts = {
  company_id: 'company_id_example', # String | If provided, will only return credit notes for this company.
  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created before this datetime.
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
  expand: 'accounting_period', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
  include_deleted_data: true, # Boolean | Whether to include data that was marked as deleted by third party webhooks.
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
  modified_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge after this date time will be returned.
  modified_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, only objects synced by Merge before this date time will be returned.
  page_size: 56, # Integer | Number of results to return per page.
  remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
  remote_id: 'remote_id_example', # String | The API provider's ID for the given object.
  show_enum_origins: 'status', # String | Which fields should be returned in non-normalized form.
  transaction_date_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | If provided, will only return objects created after this datetime.
  transaction_date_before: Time.parse('2013-10-20T19:20:30+01:00') # Time | If provided, will only return objects created before this datetime.
}

begin
  
  result = api_instance.credit_notes_list(x_account_token, opts)
  p result
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling CreditNotesApi->credit_notes_list: #{e}"
end

Using the credit_notes_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> credit_notes_list_with_http_info(x_account_token, opts)

begin
  
  data, status_code, headers = api_instance.credit_notes_list_with_http_info(x_account_token, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedCreditNoteList>
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling CreditNotesApi->credit_notes_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_account_token String Token identifying the end user.
company_id String If provided, will only return credit notes for this company. [optional]
created_after Time If provided, will only return objects created after this datetime. [optional]
created_before Time If provided, will only return objects created before this datetime. [optional]
cursor String The pagination cursor value. [optional]
expand String Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. [optional]
include_deleted_data Boolean Whether to include data that was marked as deleted by third party webhooks. [optional]
include_remote_data Boolean Whether to include the original data Merge fetched from the third-party to produce these models. [optional]
modified_after Time If provided, only objects synced by Merge after this date time will be returned. [optional]
modified_before Time If provided, only objects synced by Merge before this date time will be returned. [optional]
page_size Integer Number of results to return per page. [optional]
remote_fields String Deprecated. Use show_enum_origins. [optional]
remote_id String The API provider's ID for the given object. [optional]
show_enum_origins String Which fields should be returned in non-normalized form. [optional]
transaction_date_after Time If provided, will only return objects created after this datetime. [optional]
transaction_date_before Time If provided, will only return objects created before this datetime. [optional]

Return type

PaginatedCreditNoteList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

credit_notes_retrieve

credit_notes_retrieve(x_account_token, id, opts)

Returns a CreditNote object with the given id.

Examples

require 'time'
require 'merge_accounting_client'
# setup authorization
MergeAccountingClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeAccountingClient::CreditNotesApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
id = TODO # String | 
opts = {
  expand: 'accounting_period', # String | Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
  include_remote_data: true, # Boolean | Whether to include the original data Merge fetched from the third-party to produce these models.
  remote_fields: 'status', # String | Deprecated. Use show_enum_origins.
  show_enum_origins: 'status' # String | Which fields should be returned in non-normalized form.
}

begin
  
  result = api_instance.credit_notes_retrieve(x_account_token, id, opts)
  p result
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling CreditNotesApi->credit_notes_retrieve: #{e}"
end

Using the credit_notes_retrieve_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> credit_notes_retrieve_with_http_info(x_account_token, id, opts)

begin
  
  data, status_code, headers = api_instance.credit_notes_retrieve_with_http_info(x_account_token, id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreditNote>
rescue MergeAccountingClient::ApiError => e
  puts "Error when calling CreditNotesApi->credit_notes_retrieve_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_account_token String Token identifying the end user.
id String
expand String Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. [optional]
include_remote_data Boolean Whether to include the original data Merge fetched from the third-party to produce these models. [optional]
remote_fields String Deprecated. Use show_enum_origins. [optional]
show_enum_origins String Which fields should be returned in non-normalized form. [optional]

Return type

CreditNote

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json