Zuora::SummaryJournalEntriesApi

All URIs are relative to https://rest.zuora.com

Method	HTTP request	Description
delete_summary_journal_entry	DELETE /v1/journal-entries/{je-number}	Delete summary journal entry
get_all_summary_journal_entries	GET /v1/journal-entries/journal-runs/{jr-number}	Get all summary journal entries in a journal run
get_summary_journal_entry	GET /v1/journal-entries/{je-number}	Get summary journal entry
post_summary_journal_entry	POST /v1/journal-entries	Create summary journal entry
put_basic_summary_journal_entry	PUT /v1/journal-entries/{je-number}/basic-information	Update basic information of a summary journal entry
put_summary_journal_entry	PUT /v1/journal-entries/{je-number}/cancel	Cancel summary journal entry

delete_summary_journal_entry

CommonResponseType delete_summary_journal_entry(je_number, opts)

Delete summary journal entry

This reference describes how to delete a summary journal entry using the REST API. You must have the "Delete Cancelled Journal Entry" user permission enabled to delete summary journal entries. A summary journal entry must be canceled before it can be deleted.

Example

# load the gem
require 'zuora'

api_instance = Zuora::SummaryJournalEntriesApi.new

je_number = "je_number_example" # String | Journal entry number in the format JE-00000001.

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Delete summary journal entry
  result = api_instance.delete_summary_journal_entry(je_number, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling SummaryJournalEntriesApi->delete_summary_journal_entry: #{e}"
end

Parameters

Name	Type	Description	Notes
je_number	String	Journal entry number in the format JE-00000001.
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_all_summary_journal_entries

GETJournalEntriesInJournalRunType get_all_summary_journal_entries(jr_number, opts)

Get all summary journal entries in a journal run

This REST API reference describes how to retrieve information about all summary journal entries in a journal run.

Example

# load the gem
require 'zuora'

api_instance = Zuora::SummaryJournalEntriesApi.new

jr_number = "jr_number_example" # String | Journal run number.

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  page_size: 8 # Integer | Number of rows returned per page. 
}

begin
  #Get all summary journal entries in a journal run
  result = api_instance.get_all_summary_journal_entries(jr_number, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling SummaryJournalEntriesApi->get_all_summary_journal_entries: #{e}"
end

Parameters

Name	Type	Description	Notes
jr_number	String	Journal run number.
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
page_size	Integer	Number of rows returned per page.	[optional] [default to 8]

Return type

GETJournalEntriesInJournalRunType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

get_summary_journal_entry

GETJournalEntryDetailType get_summary_journal_entry(je_number, opts)

Get summary journal entry

This REST API reference describes how to get information about a summary journal entry by its journal entry number.

Example

# load the gem
require 'zuora'

api_instance = Zuora::SummaryJournalEntriesApi.new

je_number = "je_number_example" # String | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Get summary journal entry
  result = api_instance.get_summary_journal_entry(je_number, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling SummaryJournalEntriesApi->get_summary_journal_entry: #{e}"
end

Parameters

Name	Type	Description	Notes
je_number	String
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

GETJournalEntryDetailType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

post_summary_journal_entry

POSTJournalEntryResponseType post_summary_journal_entry(request, opts)

Create summary journal entry

This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided. ## Requirements 1.The sum of debits must equal the sum of credits in the summary journal entry. 2.The following applies only if you use foreign currency conversion: * If you have configured Aggregate transactions with different currencies during a Journal Run to "Yes", the value of the currency field must be the same as your tenant's home currency. That is, you must create journal entries using your home currency. * All journal entries in an accounting period must either all be aggregated or all be unaggregated. You cannot have a mix of aggregated and unaggregated journal entries in the same accounting period.

Example

# load the gem
require 'zuora'

api_instance = Zuora::SummaryJournalEntriesApi.new

request = Zuora::POSTJournalEntryType.new # POSTJournalEntryType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Create summary journal entry
  result = api_instance.post_summary_journal_entry(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling SummaryJournalEntriesApi->post_summary_journal_entry: #{e}"
end

Parameters

Name	Type	Description	Notes
request	POSTJournalEntryType
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

POSTJournalEntryResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

put_basic_summary_journal_entry

CommonResponseType put_basic_summary_journal_entry(je_number, request, opts)

Update basic information of a summary journal entry

This REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided.

Example

# load the gem
require 'zuora'

api_instance = Zuora::SummaryJournalEntriesApi.new

je_number = "je_number_example" # String | Journal entry number in the format JE-00000001.

request = Zuora::PUTBasicSummaryJournalEntryType.new # PUTBasicSummaryJournalEntryType | 

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Update basic information of a summary journal entry
  result = api_instance.put_basic_summary_journal_entry(je_number, request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling SummaryJournalEntriesApi->put_basic_summary_journal_entry: #{e}"
end

Parameters

Name	Type	Description	Notes
je_number	String	Journal entry number in the format JE-00000001.
request	PUTBasicSummaryJournalEntryType
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

put_summary_journal_entry

CommonResponseType put_summary_journal_entry(je_number, opts)

Cancel summary journal entry

This reference describes how to cancel a summary journal entry using the REST API. You must have the "Cancel Journal Entry" user permission enabled to cancel summary journal entries. A summary journal entry cannot be canceled if its Transferred to Accounting status is "Yes" or "Processing".

Example

# load the gem
require 'zuora'

api_instance = Zuora::SummaryJournalEntriesApi.new

je_number = "je_number_example" # String | Journal entry number in the format JE-00000001.

opts = { 
  entity_id: "entity_id_example", # String | The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
  entity_name: "entity_name_example" # String | The [name of the entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity/B_Introduction_to_Entity_and_Entity_Hierarchy#Name_and_Display_Name) that you want to access. Note that you must have permission to access the entity. For more information, see [REST Authentication](https://www.zuora.com/developer/api-reference/#section/Authentication/Entity-Id-and-Entity-Name).
}

begin
  #Cancel summary journal entry
  result = api_instance.put_summary_journal_entry(je_number, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling SummaryJournalEntriesApi->put_summary_journal_entry: #{e}"
end

Parameters

Name	Type	Description	Notes
je_number	String	Journal entry number in the format JE-00000001.
entity_id	String	The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]
entity_name	String	The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication.	[optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

Files

SummaryJournalEntriesApi.md

Latest commit

History

SummaryJournalEntriesApi.md

File metadata and controls

Zuora::SummaryJournalEntriesApi

delete_summary_journal_entry

Example

Parameters

Return type

Authorization

HTTP request headers

get_all_summary_journal_entries

Example

Parameters

Return type

Authorization

HTTP request headers

get_summary_journal_entry

Example

Parameters

Return type

Authorization

HTTP request headers

post_summary_journal_entry

Example

Parameters

Return type

Authorization

HTTP request headers

put_basic_summary_journal_entry

Example

Parameters

Return type

Authorization

HTTP request headers

put_summary_journal_entry

Example

Parameters

Return type

Authorization

HTTP request headers