Skip to content

Latest commit

 

History

History
273 lines (194 loc) · 15.6 KB

RevenueItemsApi.md

File metadata and controls

273 lines (194 loc) · 15.6 KB
Raw

zuora_client.RevenueItemsApi

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

Method HTTP request Description
g_et_revenue_items_by_charge_revenue_event_number GET /v1/revenue-items/revenue-events/{event-number} Get revenue items by revenue event number
g_et_revenue_items_by_charge_revenue_summary_number GET /v1/revenue-items/charge-revenue-summaries/{crs-number} Get revenue items by charge revenue summary number
g_et_revenue_items_by_revenue_schedule GET /v1/revenue-items/revenue-schedules/{rs-number} Get revenue items by revenue schedule
p_ut_custom_fieldson_revenue_items_by_revenue_event PUT /v1/revenue-items/revenue-events/{event-number} Update custom fields on revenue items by revenue event number
p_ut_custom_fieldson_revenue_items_by_revenue_schedule PUT /v1/revenue-items/revenue-schedules/{rs-number} Update custom fields on revenue items by revenue schedule number

g_et_revenue_items_by_charge_revenue_event_number

GETRevenueItemsType g_et_revenue_items_by_charge_revenue_event_number(event_number, zuora_entity_ids=zuora_entity_ids, page_size=page_size)

Get revenue items by revenue event number

This REST API reference describes how to get the details of each revenue item in a revenue event by specifying the revenue event number. Request and response field descriptions and sample code are provided.

Example

from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = zuora_client.RevenueItemsApi()
event_number = 'event_number_example' # str | The number associated with the revenue event.
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)
page_size = 300 # int | Number of rows returned per page.  (optional) (default to 300)

try:
    # Get revenue items by revenue event number
    api_response = api_instance.g_et_revenue_items_by_charge_revenue_event_number(event_number, zuora_entity_ids=zuora_entity_ids, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevenueItemsApi->g_et_revenue_items_by_charge_revenue_event_number: %s\n" % e)

Parameters

Name Type Description Notes
event_number str The number associated with the revenue event.
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]
page_size int Number of rows returned per page. [optional] [default to 300]

Return type

GETRevenueItemsType

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

g_et_revenue_items_by_charge_revenue_summary_number

GETRevenueItemsType g_et_revenue_items_by_charge_revenue_summary_number(crs_number, zuora_entity_ids=zuora_entity_ids, page_size=page_size)

Get revenue items by charge revenue summary number

This REST API reference describes how to get the details for each revenue item in a charge revenue summary by specifying the charge revenue summary number. Request and response field descriptions and sample code are provided.

Example

from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = zuora_client.RevenueItemsApi()
crs_number = 'crs_number_example' # str | The charge revenue summary number.
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)
page_size = 300 # int | Number of rows returned per page.  (optional) (default to 300)

try:
    # Get revenue items by charge revenue summary number
    api_response = api_instance.g_et_revenue_items_by_charge_revenue_summary_number(crs_number, zuora_entity_ids=zuora_entity_ids, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevenueItemsApi->g_et_revenue_items_by_charge_revenue_summary_number: %s\n" % e)

Parameters

Name Type Description Notes
crs_number str The charge revenue summary number.
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]
page_size int Number of rows returned per page. [optional] [default to 300]

Return type

GETRevenueItemsType

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

g_et_revenue_items_by_revenue_schedule

GETRsRevenueItemsType g_et_revenue_items_by_revenue_schedule(rs_number, zuora_entity_ids=zuora_entity_ids, page_size=page_size)

Get revenue items by revenue schedule

This REST API reference describes how to get the details for each revenue items in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided.

Example

from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = zuora_client.RevenueItemsApi()
rs_number = 'rs_number_example' # str | Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\".
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)
page_size = 300 # int | Number of rows returned per page.  (optional) (default to 300)

try:
    # Get revenue items by revenue schedule
    api_response = api_instance.g_et_revenue_items_by_revenue_schedule(rs_number, zuora_entity_ids=zuora_entity_ids, page_size=page_size)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevenueItemsApi->g_et_revenue_items_by_revenue_schedule: %s\n" % e)

Parameters

Name Type Description Notes
rs_number str Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001".
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]
page_size int Number of rows returned per page. [optional] [default to 300]

Return type

GETRsRevenueItemsType

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

p_ut_custom_fieldson_revenue_items_by_revenue_event

CommonResponseType p_ut_custom_fieldson_revenue_items_by_revenue_event(event_number, request, zuora_entity_ids=zuora_entity_ids)

Update custom fields on revenue items by revenue event number

This REST API reference describes how to update custom fields on revenue items by specifying the revenue event number. Request and response field descriptions and sample code are provided.

Example

from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = zuora_client.RevenueItemsApi()
event_number = 'event_number_example' # str | The number associated with the revenue event.
request = zuora_client.PUTEventRIDetailType() # PUTEventRIDetailType | 
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)

try:
    # Update custom fields on revenue items by revenue event number
    api_response = api_instance.p_ut_custom_fieldson_revenue_items_by_revenue_event(event_number, request, zuora_entity_ids=zuora_entity_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevenueItemsApi->p_ut_custom_fieldson_revenue_items_by_revenue_event: %s\n" % e)

Parameters

Name Type Description Notes
event_number str The number associated with the revenue event.
request PUTEventRIDetailType
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

p_ut_custom_fieldson_revenue_items_by_revenue_schedule

CommonResponseType p_ut_custom_fieldson_revenue_items_by_revenue_schedule(rs_number, request, zuora_entity_ids=zuora_entity_ids)

Update custom fields on revenue items by revenue schedule number

This REST API reference describes how to update custom fields on revenue Items by specifying the revenue schedule number. Request and response field descriptions and sample code are provided.

Example

from __future__ import print_function
import time
import zuora_client
from zuora_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = zuora_client.RevenueItemsApi()
rs_number = 'rs_number_example' # str | Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\".
request = zuora_client.PUTScheduleRIDetailType() # PUTScheduleRIDetailType | 
zuora_entity_ids = 'zuora_entity_ids_example' # str | An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.  (optional)

try:
    # Update custom fields on revenue items by revenue schedule number
    api_response = api_instance.p_ut_custom_fieldson_revenue_items_by_revenue_schedule(rs_number, request, zuora_entity_ids=zuora_entity_ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RevenueItemsApi->p_ut_custom_fieldson_revenue_items_by_revenue_schedule: %s\n" % e)

Parameters

Name Type Description Notes
rs_number str Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001".
request PUTScheduleRIDetailType
zuora_entity_ids str An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header. [optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]