Skip to content

Latest commit

 

History

History
116 lines (76 loc) · 6.63 KB

BillingPreviewRunApi.md

File metadata and controls

116 lines (76 loc) · 6.63 KB
Raw

Zuora::BillingPreviewRunApi

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

Method HTTP request Description
get_billing_preview_run GET /v1/billing-preview-runs/{billingPreviewRunId} Get Billing Preview Run
post_billing_preview_run POST /v1/billing-preview-runs Create Billing Preview Run

get_billing_preview_run

GetBillingPreviewRunResponse get_billing_preview_run(billing_preview_run_id, opts)

Get Billing Preview Run

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Advanced AR Settlement feature enabled, you can also retrieve a preview of future credit memo items. The Advanced AR Settlement feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. A billing preview run asynchronously generates a downloadable CSV file containing a preview of invoice item data and credit memo item data for a batch of customer accounts.

Example

# load the gem
require 'zuora'

api_instance = Zuora::BillingPreviewRunApi.new

billing_preview_run_id = "billing_preview_run_id_example" # String | Id of the billing preview run. 

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 Billing Preview Run
  result = api_instance.get_billing_preview_run(billing_preview_run_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling BillingPreviewRunApi->get_billing_preview_run: #{e}"
end

Parameters

Name Type Description Notes
billing_preview_run_id String Id of the billing preview run.
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

GetBillingPreviewRunResponse

Authorization

No authorization required

HTTP request headers

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

post_billing_preview_run

InlineResponse200 post_billing_preview_run(request, opts)

Create Billing Preview Run

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Creates billing preview runs for multiple customer accounts. You can run up to 10 billing previews in batches concurrently. A single batch of customer accounts can only have one billing preview run at a time. So you can have up to 10 batches running at the same time. If you create a billing preview run for all customer batches, you cannot create another billing preview run until this preview run is completed.

Example

# load the gem
require 'zuora'

api_instance = Zuora::BillingPreviewRunApi.new

request = Zuora::PostBillingPreviewRunParam.new # PostBillingPreviewRunParam | 

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 Billing Preview Run
  result = api_instance.post_billing_preview_run(request, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling BillingPreviewRunApi->post_billing_preview_run: #{e}"
end

Parameters

Name Type Description Notes
request PostBillingPreviewRunParam
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

InlineResponse200

Authorization

No authorization required

HTTP request headers

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