/zuora-ruby-client

Primary LanguageRuby

zuora

Zuora - the Ruby gem for the Zuora API Reference

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2017-11-15
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build zuora.gemspec

Then either install the gem locally:

gem install ./zuora-1.0.0.gem

(for development, run gem install --dev ./zuora-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'zuora', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'zuora', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'zuora'

api_instance = Zuora::AccountingCodesApi.new

ac_id = "ac_id_example" # String | ID of the accounting code you want to delete.

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 accounting code
  result = api_instance.delete_accounting_code(ac_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling AccountingCodesApi->delete_accounting_code: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
Zuora::AccountingCodesApi delete_accounting_code DELETE /v1/accounting-codes/{ac-id} Delete accounting code
Zuora::AccountingCodesApi get_accounting_code GET /v1/accounting-codes/{ac-id} Query an accounting code
Zuora::AccountingCodesApi get_all_accounting_codes GET /v1/accounting-codes Get all accounting codes
Zuora::AccountingCodesApi post_accounting_code POST /v1/accounting-codes Create accounting code
Zuora::AccountingCodesApi put_accounting_code PUT /v1/accounting-codes/{ac-id} Update an accounting code
Zuora::AccountingCodesApi put_activate_accounting_code PUT /v1/accounting-codes/{ac-id}/activate Activate accounting code
Zuora::AccountingCodesApi put_deactivate_accounting_code PUT /v1/accounting-codes/{ac-id}/deactivate Deactivate accounting code
Zuora::AccountingPeriodsApi delete_accounting_period DELETE /v1/accounting-periods/{ap-id} Delete accounting period
Zuora::AccountingPeriodsApi get_accounting_period GET /v1/accounting-periods/{ap-id} Get accounting period
Zuora::AccountingPeriodsApi get_all_accounting_periods GET /v1/accounting-periods Get all accounting periods
Zuora::AccountingPeriodsApi post_accounting_period POST /v1/accounting-periods Create accounting period
Zuora::AccountingPeriodsApi put_close_accounting_period PUT /v1/accounting-periods/{ap-id}/close Close accounting period
Zuora::AccountingPeriodsApi put_pending_close_accounting_period PUT /v1/accounting-periods/{ap-id}/pending-close Set accounting period to pending close
Zuora::AccountingPeriodsApi put_reopen_accounting_period PUT /v1/accounting-periods/{ap-id}/reopen Re-open accounting period
Zuora::AccountingPeriodsApi put_run_trial_balance PUT /v1/accounting-periods/{ap-id}/run-trial-balance Run trial balance
Zuora::AccountingPeriodsApi put_update_accounting_period PUT /v1/accounting-periods/{ap-id} Update accounting period
Zuora::AccountsApi get_account GET /v1/accounts/{account-key} Get account
Zuora::AccountsApi get_account_summary GET /v1/accounts/{account-key}/summary Get account summary
Zuora::AccountsApi object_delete_account DELETE /v1/object/account/{id} CRUD: Delete Account
Zuora::AccountsApi object_get_account GET /v1/object/account/{id} CRUD: Retrieve Account
Zuora::AccountsApi object_post_account POST /v1/object/account CRUD: Create Account
Zuora::AccountsApi object_put_account PUT /v1/object/account/{id} CRUD: Update Account
Zuora::AccountsApi post_account POST /v1/accounts Create account
Zuora::AccountsApi post_generate_billing_documents POST /v1/accounts/{id}/billing-documents/generate Generate billing documents by account
Zuora::AccountsApi put_account PUT /v1/accounts/{account-key} Update account
Zuora::ActionsApi action_pos_tamend POST /v1/action/amend Amend
Zuora::ActionsApi action_pos_tcreate POST /v1/action/create Create
Zuora::ActionsApi action_pos_tdelete POST /v1/action/delete Delete
Zuora::ActionsApi action_pos_texecute POST /v1/action/execute Execute
Zuora::ActionsApi action_pos_tgenerate POST /v1/action/generate Generate
Zuora::ActionsApi action_pos_tquery POST /v1/action/query Query
Zuora::ActionsApi action_pos_tquery_more POST /v1/action/queryMore QueryMore
Zuora::ActionsApi action_pos_tsubscribe POST /v1/action/subscribe Subscribe
Zuora::ActionsApi action_pos_tupdate POST /v1/action/update Update
Zuora::AmendmentsApi get_amendments_by_key GET /v1/amendments/{amendment-key} Get amendments by key
Zuora::AmendmentsApi get_amendments_by_subscription_id GET /v1/amendments/subscriptions/{subscription-id} Get amendments by subscription ID
Zuora::AmendmentsApi object_delete_amendment DELETE /v1/object/amendment/{id} CRUD: Delete amendment
Zuora::AmendmentsApi object_get_amendment GET /v1/object/amendment/{id} CRUD: Get amendment
Zuora::AmendmentsApi object_post_amendment POST /v1/object/amendment CRUD: Create amendment
Zuora::AmendmentsApi object_put_amendment PUT /v1/object/amendment/{id} CRUD: Update amendment
Zuora::AttachmentsApi delete_attachments DELETE /v1/attachments/{attachment-id} Delete attachments
Zuora::AttachmentsApi get_attachments GET /v1/attachments/{attachment-id} View attachments
Zuora::AttachmentsApi get_attachments_list GET /v1/attachments/{object-type}/{object-key} View attachments list
Zuora::AttachmentsApi post_attachments POST /v1/attachments Add attachments
Zuora::AttachmentsApi put_attachments PUT /v1/attachments/{attachment-id} Edit attachments
Zuora::BillRunApi object_delete_bill_run DELETE /v1/object/bill-run/{id} CRUD: Delete Bill Run
Zuora::BillRunApi object_get_bill_run GET /v1/object/bill-run/{id} CRUD: Retrieve Bill Run
Zuora::BillRunApi object_post_bill_run POST /v1/object/bill-run CRUD: Create Bill Run
Zuora::BillRunApi object_put_bill_run PUT /v1/object/bill-run/{id} CRUD: Post or Cancel Bill Run
Zuora::BillRunApi post_email_billing_documentsfrom_bill_run POST /v1/bill-runs/{billRunId}/emails Email billing documents generated from bill run
Zuora::BillingDocumentsApi get_billing_documents GET /v1/billing-documents Get billing documents
Zuora::BillingPreviewRunApi get_billing_preview_run GET /v1/billing-preview-runs/{billingPreviewRunId} Get Billing Preview Run
Zuora::BillingPreviewRunApi post_billing_preview_run POST /v1/billing-preview-runs Create Billing Preview Run
Zuora::CatalogApi get_catalog GET /v1/catalog/products Get product catalog
Zuora::CatalogApi put_catalog PUT /v1/catalog/products/{product-id}/share Multi-entity: Share a Product with an Entity
Zuora::ChargeRevenueSummariesApi get_crs_by_charge_id GET /v1/charge-revenue-summaries/subscription-charges/{charge-key} Get charge summary details by charge ID
Zuora::ChargeRevenueSummariesApi get_crs_by_crs_number GET /v1/charge-revenue-summaries/{crs-number} Get charge summary details by CRS number
Zuora::CommunicationProfilesApi object_get_communication_profile GET /v1/object/communication-profile/{id} CRUD: Retrieve CommunicationProfile
Zuora::ConnectionsApi post_connections POST /v1/connections Establish connection to Zuora REST API service
Zuora::ContactsApi object_delete_contact DELETE /v1/object/contact/{id} CRUD: Delete Contact
Zuora::ContactsApi object_get_contact GET /v1/object/contact/{id} CRUD: Retrieve Contact
Zuora::ContactsApi object_post_contact POST /v1/object/contact CRUD: Create Contact
Zuora::ContactsApi object_put_contact PUT /v1/object/contact/{id} CRUD: Update Contact
Zuora::CreditBalanceAdjustmentsApi object_get_credit_balance_adjustment GET /v1/object/credit-balance-adjustment/{id} CRUD: Retrieve CreditBalanceAdjustment
Zuora::CreditMemosApi delete_credit_memo DELETE /v1/creditmemos/{creditMemoId} Delete credit memo
Zuora::CreditMemosApi get_breakdown_credit_memo_by_order GET /v1/creditmemos/{creditMemoNumber}/amountBreakdownByOrder Get breakdown of credit memo by order
Zuora::CreditMemosApi get_credit_memo GET /v1/creditmemos/{creditMemoId} Get credit memo
Zuora::CreditMemosApi get_credit_memo_item GET /v1/creditmemos/{creditMemoId}/items/{cmitemid} Get credit memo item
Zuora::CreditMemosApi get_credit_memo_item_part GET /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts/{itempartid} Get credit memo part item
Zuora::CreditMemosApi get_credit_memo_item_parts GET /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts Get credit memo part items
Zuora::CreditMemosApi get_credit_memo_items GET /v1/creditmemos/{creditMemoId}/items Get credit memo items
Zuora::CreditMemosApi get_credit_memo_part GET /v1/creditmemos/{creditMemoId}/parts/{partid} Get credit memo part
Zuora::CreditMemosApi get_credit_memo_parts GET /v1/creditmemos/{creditMemoId}/parts Get credit memo parts
Zuora::CreditMemosApi get_credit_memos GET /v1/creditmemos Get credit memos
Zuora::CreditMemosApi post_credit_memo_from_prpc POST /v1/creditmemos Create credit memo from charge
Zuora::CreditMemosApi post_credit_memo_pdf POST /v1/creditmemos/{creditMemoId}/pdfs Create credit memo PDF
Zuora::CreditMemosApi post_email_credit_memo POST /v1/creditmemos/{creditMemoId}/emails Email credit memo
Zuora::CreditMemosApi post_refund_credit_memo POST /v1/creditmemos/{creditmemoId}/refunds Refund credit memo
Zuora::CreditMemosApi post_cm_taxation_items POST /v1/creditmemos/{creditMemoId}/taxationitems Create taxation items for credit memo
Zuora::CreditMemosApi put_apply_credit_memo PUT /v1/creditmemos/{creditMemoId}/apply Apply credit memo
Zuora::CreditMemosApi put_cancel_credit_memo PUT /v1/creditmemos/{creditMemoId}/cancel Cancel credit memo
Zuora::CreditMemosApi put_post_credit_memo PUT /v1/creditmemos/{creditMemoId}/post Post credit memo
Zuora::CreditMemosApi put_unapply_credit_memo PUT /v1/creditmemos/{creditMemoId}/unapply Unapply credit memo
Zuora::CreditMemosApi put_update_credit_memo PUT /v1/creditmemos/{creditMemoId} Update credit memo
Zuora::CustomExchangeRatesApi get_custom_exchange_rates GET /v1/custom-exchange-rates/{currency} Get custom foreign currency exchange rates
Zuora::DebitMemosApi delete_debit_memo DELETE /v1/debitmemos/{debitMemoId} Delete debit memo
Zuora::DebitMemosApi get_debit_memo GET /v1/debitmemos/{debitMemoId} Get debit memo
Zuora::DebitMemosApi get_debit_memo_item GET /v1/debitmemos/{debitMemoId}/items/{dmitemid} Get debit memo item
Zuora::DebitMemosApi get_debit_memo_items GET /v1/debitmemos/{debitMemoId}/items Get debit memo items
Zuora::DebitMemosApi get_debit_memos GET /v1/debitmemos Get debit memos
Zuora::DebitMemosApi post_debit_memo_from_prpc POST /v1/debitmemos Create debit memo from charge
Zuora::DebitMemosApi post_debit_memo_pdf POST /v1/debitmemos/{debitMemoId}/pdfs Create debit memo PDF
Zuora::DebitMemosApi post_email_debit_memo POST /v1/debitmemos/{debitMemoId}/emails Email debit memo
Zuora::DebitMemosApi post_dm_taxation_items POST /v1/debitmemos/{debitMemoId}/taxationitems Create taxation items for debit memo
Zuora::DebitMemosApi put_cancel_debit_memo PUT /v1/debitmemos/{debitMemoId}/cancel Cancel debit memo
Zuora::DebitMemosApi put_debit_memo PUT /v1/debitmemos/{debitMemoId} Update debit memo
Zuora::DebitMemosApi put_post_debit_memo PUT /v1/debitmemos/{debitMemoId}/post Post debit memo
Zuora::DescribeApi get_describe GET /v1/describe/{object} Describe object
Zuora::EntitiesApi delete_entities DELETE /v1/entities/{id} Multi-entity: Delete entity
Zuora::EntitiesApi get_entities GET /v1/entities Multi-entity: Get entities
Zuora::EntitiesApi get_entity_by_id GET /v1/entities/{id} Multi-entity: Get entity by Id
Zuora::EntitiesApi post_entities POST /v1/entities Multi-entity: Create entity
Zuora::EntitiesApi put_entities PUT /v1/entities/{id} Multi-entity: Update entity
Zuora::EntitiesApi put_provision_entity PUT /v1/entities/{id}/provision Multi-entity: Provision entity
Zuora::EntityConnectionsApi get_entity_connections GET /v1/entity-connections Multi-entity: Get connections
Zuora::EntityConnectionsApi post_entity_connections POST /v1/entity-connections Multi-entity: Initiate connection
Zuora::EntityConnectionsApi put_entity_connections_accept PUT /v1/entity-connections/{connection-id}/accept Multi-entity: Accept connection
Zuora::EntityConnectionsApi put_entity_connections_deny PUT /v1/entity-connections/{connection-id}/deny Multi-entity: Deny connection
Zuora::EntityConnectionsApi put_entity_connections_disconnect PUT /v1/entity-connections/{connection-id}/disconnect Multi-entity: Disconnect connection
Zuora::ExportsApi object_get_export GET /v1/object/export/{id} CRUD: Retrieve Export
Zuora::ExportsApi object_post_export POST /v1/object/export CRUD: Create Export
Zuora::FeaturesApi object_delete_feature DELETE /v1/object/feature/{id} CRUD: Delete Feature
Zuora::FeaturesApi object_get_feature GET /v1/object/feature/{id} CRUD: Retrieve Feature
Zuora::GetFilesApi get_files GET /v1/files/{file-id} Get files
Zuora::HMACSignaturesApi post_hmac_signatures POST /v1/hmac-signatures Return HMAC signatures
Zuora::HostedPagesApi get_hosted_pages GET /v1/hostedpages Return hosted pages
Zuora::ImportsApi object_get_import GET /v1/object/import/{id} CRUD: Retrieve Import
Zuora::InvoiceAdjustmentsApi object_delete_invoice_adjustment DELETE /v1/object/invoice-adjustment/{id} CRUD: Delete InvoiceAdjustment
Zuora::InvoiceAdjustmentsApi object_get_invoice_adjustment GET /v1/object/invoice-adjustment/{id} CRUD: Retrieve InvoiceAdjustment
Zuora::InvoiceAdjustmentsApi object_post_invoice_adjustment POST /v1/object/invoice-adjustment CRUD: Create InvoiceAdjustment
Zuora::InvoiceAdjustmentsApi object_put_invoice_adjustment PUT /v1/object/invoice-adjustment/{id} CRUD: Update InvoiceAdjustment
Zuora::InvoiceItemAdjustmentsApi object_delete_invoice_item_adjustment DELETE /v1/object/invoice-item-adjustment/{id} CRUD: Delete InvoiceItemAdjustment
Zuora::InvoiceItemAdjustmentsApi object_get_invoice_item_adjustment GET /v1/object/invoice-item-adjustment/{id} CRUD: Retrieve InvoiceItemAdjustment
Zuora::InvoiceItemsApi object_get_invoice_item GET /v1/object/invoice-item/{id} CRUD: Retrieve InvoiceItem
Zuora::InvoicePaymentsApi object_get_invoice_payment GET /v1/object/invoice-payment/{id} CRUD: Retrieve InvoicePayment
Zuora::InvoicePaymentsApi object_post_invoice_payment POST /v1/object/invoice-payment CRUD: Create InvoicePayment
Zuora::InvoicePaymentsApi object_put_invoice_payment PUT /v1/object/invoice-payment/{id} CRUD: Update InvoicePayment
Zuora::InvoiceSplitItemsApi object_get_invoice_split_item GET /v1/object/invoice-split-item/{id} CRUD: Retrieve InvoiceSplitItem
Zuora::InvoiceSplitsApi object_get_invoice_split GET /v1/object/invoice-split/{id} CRUD: Retrieve InvoiceSplit
Zuora::InvoicesApi get_breakdown_invoice_by_order GET /v1/invoices/{invoiceNumber}/amountBreakdownByOrder Get breakdown of invoice by order
Zuora::InvoicesApi object_delete_invoice DELETE /v1/object/invoice/{id} CRUD: Delete Invoice
Zuora::InvoicesApi object_get_invoice GET /v1/object/invoice/{id} CRUD: Retrieve Invoice
Zuora::InvoicesApi object_put_invoice PUT /v1/object/invoice/{id} CRUD: Update Invoice
Zuora::InvoicesApi post_credit_memo_from_invoice POST /v1/invoices/{invoiceId}/creditmemos Create credit memo from invoice
Zuora::InvoicesApi post_debit_memo_from_invoice POST /v1/invoices/{invoiceId}/debitmemos Create debit memo from invoice
Zuora::InvoicesApi post_email_invoice POST /v1/invoices/{invoiceId}/emails Email invoice
Zuora::InvoicesApi put_reverse_invoice PUT /v1/invoices/{invoiceId}/reverse Reverse invoice
Zuora::JournalRunsApi delete_journal_run DELETE /v1/journal-runs/{jr-number} Delete journal run
Zuora::JournalRunsApi get_journal_run GET /v1/journal-runs/{jr-number} Get journal run
Zuora::JournalRunsApi post_journal_run POST /v1/journal-runs Create journal run
Zuora::JournalRunsApi put_journal_run PUT /v1/journal-runs/{jr-number}/cancel Cancel journal run
Zuora::MassUpdaterApi get_mass_updater GET /v1/bulk/{bulk-key} Get mass action result
Zuora::MassUpdaterApi post_mass_updater POST /v1/bulk Perform mass action
Zuora::MassUpdaterApi put_mass_updater PUT /v1/bulk/{bulk-key}/stop Stop mass action
Zuora::NotificationHistoryApi get_callout_history GET /v1/notification-history/callout Get callout notification histories
Zuora::NotificationHistoryApi get_email_history GET /v1/notification-history/email Get email notification histories
Zuora::OAuthApi create_token POST /oauth/token Generate an OAuth token
Zuora::OperationsApi post_billing_preview POST /v1/operations/billing-preview Create billing preview
Zuora::OperationsApi post_transaction_invoice_payment POST /v1/operations/invoice-collect Invoice and collect
Zuora::OrdersApi delete_order DELETE /v1/orders/{orderNumber} Delete order
Zuora::OrdersApi get_all_orders GET /v1/orders Get all orders
Zuora::OrdersApi get_order GET /v1/orders/{orderNumber} Get an order
Zuora::OrdersApi get_order_billing_info GET /v1/orders/{orderNumber}/billingInfo Get billing information for order
Zuora::OrdersApi get_order_metricsfor_evergreen_subscription GET /v1/orders/{orderNumber}/evergreenMetrics/{subscriptionNumber} Get order metrics for evergreen subscription
Zuora::OrdersApi get_order_rated_result GET /v1/orders/{orderNumber}/ratedResults Get rated result for order
Zuora::OrdersApi get_orders_by_invoice_owner GET /v1/orders/invoiceOwner/{accountNumber} Get orders by invoice owner
Zuora::OrdersApi get_orders_by_subscription_number GET /v1/orders/subscription/{subscriptionNumber} Get orders by subscription number
Zuora::OrdersApi get_orders_by_subscription_owner GET /v1/orders/subscriptionOwner/{accountNumber} Get orders by subscription owner
Zuora::OrdersApi post_order POST /v1/orders Create and activate order
Zuora::OrdersApi post_preview_order POST /v1/orders/preview Preview order
Zuora::OrdersApi put_update_order_custom_fields PUT /v1/orders/{orderNumber}/customFields Update order custom fields
Zuora::PaymentGatewaysApi get_paymentgateways GET /v1/paymentgateways Get payment gateways
Zuora::PaymentMethodSnapshotsApi object_get_payment_method_snapshot GET /v1/object/payment-method-snapshot/{id} CRUD: Retrieve PaymentMethodSnapshot
Zuora::PaymentMethodTransactionLogsApi object_get_payment_method_transaction_log GET /v1/object/payment-method-transaction-log/{id} CRUD: Retrieve PaymentMethodTransactionLog
Zuora::PaymentMethodsApi delete_payment_methods DELETE /v1/payment-methods/{payment-method-id} Delete payment method
Zuora::PaymentMethodsApi get_payment_methods GET /v1/payment-methods/credit-cards/accounts/{account-key} Get payment methods
Zuora::PaymentMethodsApi object_delete_payment_method DELETE /v1/object/payment-method/{id} CRUD: Delete payment method
Zuora::PaymentMethodsApi object_get_payment_method GET /v1/object/payment-method/{id} CRUD: Get payment method
Zuora::PaymentMethodsApi object_post_payment_method POST /v1/object/payment-method CRUD: Create payment method
Zuora::PaymentMethodsApi object_put_payment_method PUT /v1/object/payment-method/{id} CRUD: Update payment method
Zuora::PaymentMethodsApi post_payment_methods POST /v1/payment-methods/credit-cards Create payment method
Zuora::PaymentMethodsApi post_payment_methods_decryption POST /v1/payment-methods/decryption Create payment method decryption
Zuora::PaymentMethodsApi put_payment_methods PUT /v1/payment-methods/credit-cards/{payment-method-id} Update payment method
Zuora::PaymentMethodsApi put_verify_payment_methods PUT /v1/payment-methods/{payment-method-id}/verify Verify payment method
Zuora::PaymentTransactionLogsApi object_get_payment_transaction_log GET /v1/object/payment-transaction-log/{id} CRUD: Get payment transaction log
Zuora::PaymentsApi delete_payment DELETE /v1/payments/{paymentId} Delete payment
Zuora::PaymentsApi get_payment GET /v1/payments/{paymentId} Get payment
Zuora::PaymentsApi get_payment_item_part GET /v1/payments/{paymentId}/parts/{partid}/itemparts/{itempartid} Get payment part item
Zuora::PaymentsApi get_payment_item_parts GET /v1/payments/{paymentId}/parts/{partid}/itemparts Get payment part items
Zuora::PaymentsApi get_payment_part GET /v1/payments/{paymentId}/parts/{partid} Get payment part
Zuora::PaymentsApi get_payment_parts GET /v1/payments/{paymentId}/parts Get payment parts
Zuora::PaymentsApi get_retrieve_all_payments GET /v1/payments Get all payments
Zuora::PaymentsApi object_delete_payment DELETE /v1/object/payment/{id} CRUD: Delete payment
Zuora::PaymentsApi object_get_payment GET /v1/object/payment/{id} CRUD: Get payment
Zuora::PaymentsApi object_post_payment POST /v1/object/payment CRUD: Create payment
Zuora::PaymentsApi object_put_payment PUT /v1/object/payment/{id} CRUD: Update payment
Zuora::PaymentsApi post_create_payment POST /v1/payments Create payment
Zuora::PaymentsApi post_refund_payment POST /v1/payments/{paymentId}/refunds Refund payment
Zuora::PaymentsApi put_apply_payment PUT /v1/payments/{paymentId}/apply Apply payment
Zuora::PaymentsApi put_cancel_payment PUT /v1/payments/{paymentId}/cancel Cancel payment
Zuora::PaymentsApi put_transfer_payment PUT /v1/payments/{paymentId}/transfer Transfer payment
Zuora::PaymentsApi put_unapply_payment PUT /v1/payments/{paymentId}/unapply Unapply payment
Zuora::PaymentsApi put_update_payment PUT /v1/payments/{paymentId} Update payment
Zuora::ProductFeaturesApi object_delete_product_feature DELETE /v1/object/product-feature/{id} CRUD: Delete ProductFeature
Zuora::ProductFeaturesApi object_get_product_feature GET /v1/object/product-feature/{id} CRUD: Retrieve ProductFeature
Zuora::ProductRatePlanChargeTiersApi object_get_product_rate_plan_charge_tier GET /v1/object/product-rate-plan-charge-tier/{id} CRUD: Retrieve ProductRatePlanChargeTier
Zuora::ProductRatePlanChargesApi object_delete_product_rate_plan_charge DELETE /v1/object/product-rate-plan-charge/{id} CRUD: Delete ProductRatePlanCharge
Zuora::ProductRatePlanChargesApi object_get_product_rate_plan_charge GET /v1/object/product-rate-plan-charge/{id} CRUD: Retrieve ProductRatePlanCharge
Zuora::ProductRatePlansApi object_delete_product_rate_plan DELETE /v1/object/product-rate-plan/{id} CRUD: Delete ProductRatePlan
Zuora::ProductRatePlansApi object_get_product_rate_plan GET /v1/object/product-rate-plan/{id} CRUD: Retrieve ProductRatePlan
Zuora::ProductRatePlansApi object_post_product_rate_plan POST /v1/object/product-rate-plan CRUD: Create ProductRatePlan
Zuora::ProductRatePlansApi object_put_product_rate_plan PUT /v1/object/product-rate-plan/{id} CRUD: Update ProductRatePlan
Zuora::ProductsApi object_delete_product DELETE /v1/object/product/{id} CRUD: Delete Product
Zuora::ProductsApi object_get_product GET /v1/object/product/{id} CRUD: Retrieve Product
Zuora::ProductsApi object_post_product POST /v1/object/product CRUD: Create Product
Zuora::ProductsApi object_put_product PUT /v1/object/product/{id} CRUD: Update Product
Zuora::QuotesDocumentApi post_quotes_document POST /v1/quotes/document Generate quotes document
Zuora::RSASignaturesApi post_decrypt_rsa_signatures POST /v1/rsa-signatures/decrypt Decrypt RSA signature
Zuora::RSASignaturesApi post_rsa_signatures POST /v1/rsa-signatures Generate RSA signature
Zuora::RatePlanChargeTiersApi object_get_rate_plan_charge_tier GET /v1/object/rate-plan-charge-tier/{id} CRUD: Retrieve RatePlanChargeTier
Zuora::RatePlanChargesApi object_get_rate_plan_charge GET /v1/object/rate-plan-charge/{id} CRUD: Retrieve RatePlanCharge
Zuora::RatePlansApi object_get_rate_plan GET /v1/object/rate-plan/{id} CRUD: Retrieve RatePlan
Zuora::RefundInvoicePaymentsApi object_get_refund_invoice_payment GET /v1/object/refund-invoice-payment/{id} CRUD: Retrieve RefundInvoicePayment
Zuora::RefundTransactionLogsApi object_get_refund_transaction_log GET /v1/object/refund-transaction-log/{id} CRUD: Retrieve RefundTransactionLog
Zuora::RefundsApi delete_refund DELETE /v1/refunds/{refundId} Delete refund
Zuora::RefundsApi get_refund GET /v1/refunds/{refundId} Get refund
Zuora::RefundsApi get_refund_item_part GET /v1/refunds/{refundId}/parts/{refundpartid}/itemparts/{itempartid} Get refund part item
Zuora::RefundsApi get_refund_item_parts GET /v1/refunds/{refundId}/parts/{refundpartid}/itemparts Get refund part items
Zuora::RefundsApi get_refund_part GET /v1/refunds/{refundId}/parts/{refundpartid} Get refund part
Zuora::RefundsApi get_refund_parts GET /v1/refunds/{refundId}/parts Get refund parts
Zuora::RefundsApi get_refunds GET /v1/refunds Get all refunds
Zuora::RefundsApi object_delete_refund DELETE /v1/object/refund/{id} CRUD: Delete refund
Zuora::RefundsApi object_get_refund GET /v1/object/refund/{id} CRUD: Get refund
Zuora::RefundsApi object_post_refund POST /v1/object/refund CRUD: Create refund
Zuora::RefundsApi object_put_refund PUT /v1/object/refund/{id} CRUD: Update refund
Zuora::RefundsApi put_cancel_refund PUT /v1/refunds/{refundId}/cancel Cancel refund
Zuora::RefundsApi put_update_refund PUT /v1/refunds/{refundId} Update refund
Zuora::RevenueEventsApi get_revenue_event_details GET /v1/revenue-events/{event-number} Get revenue event details
Zuora::RevenueEventsApi get_revenue_event_for_revenue_schedule GET /v1/revenue-events/revenue-schedules/{rs-number} Get revenue events for a revenue schedule
Zuora::RevenueItemsApi get_revenue_items_by_charge_revenue_event_number GET /v1/revenue-items/revenue-events/{event-number} Get revenue items by revenue event number
Zuora::RevenueItemsApi get_revenue_items_by_charge_revenue_summary_number GET /v1/revenue-items/charge-revenue-summaries/{crs-number} Get revenue items by charge revenue summary number
Zuora::RevenueItemsApi get_revenue_items_by_revenue_schedule GET /v1/revenue-items/revenue-schedules/{rs-number} Get revenue items by revenue schedule
Zuora::RevenueItemsApi put_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
Zuora::RevenueItemsApi put_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
Zuora::RevenueRulesApi get_revenue_rec_ruleby_product_rate_plan_charge GET /v1/revenue-recognition-rules/product-charges/{charge-key} Get revenue recognition rule by product rate plan charge
Zuora::RevenueRulesApi get_revenue_rec_rules GET /v1/revenue-recognition-rules/subscription-charges/{charge-key} Get revenue recognition rule by subscription charge
Zuora::RevenueSchedulesApi delete_rs DELETE /v1/revenue-schedules/{rs-number} Delete revenue schedule
Zuora::RevenueSchedulesApi get_r_sby_credit_memo_item GET /v1/revenue-schedules/credit-memo-items/{cmi-id} Get revenue schedule by credit memo item ID
Zuora::RevenueSchedulesApi get_r_sby_debit_memo_item GET /v1/revenue-schedules/debit-memo-items/{dmi-id} Get revenue schedule by debit memo item ID
Zuora::RevenueSchedulesApi get_r_sby_invoice_item GET /v1/revenue-schedules/invoice-items/{invoice-item-id} Get revenue schedule by invoice item ID
Zuora::RevenueSchedulesApi get_r_sby_invoice_item_adjustment GET /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-id}/ Get revenue schedule by invoice item adjustment
Zuora::RevenueSchedulesApi get_r_sby_product_charge_and_billing_account GET /v1/revenue-schedules/product-charges/{charge-key}/{account-key} Get all revenue schedules of product charge by charge ID and billing account ID
Zuora::RevenueSchedulesApi get_r_sfor_subsc_charge GET /v1/revenue-schedules/subscription-charges/{charge-key} Get revenue schedule by subscription charge
Zuora::RevenueSchedulesApi get_rs GET /v1/revenue-schedules/{rs-number} Get revenue schedule details
Zuora::RevenueSchedulesApi post_r_sfor_credit_memo_item_distribute_by_date_range POST /v1/revenue-schedules/credit-memo-items/{cmi-id}/distribute-revenue-with-date-range Create revenue schedule for credit memo item (distribute by date range)
Zuora::RevenueSchedulesApi post_r_sfor_credit_memo_item_manual_distribution POST /v1/revenue-schedules/credit-memo-items/{cmi-id} Create revenue schedule for credit memo item (manual distribution)
Zuora::RevenueSchedulesApi post_r_sfor_debit_memo_item_distribute_by_date_range POST /v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range Create revenue schedule for debit memo item (distribute by date range)
Zuora::RevenueSchedulesApi post_r_sfor_debit_memo_item_manual_distribution POST /v1/revenue-schedules/debit-memo-items/{dmi-id} Create revenue schedule for debit memo item (manual distribution)
Zuora::RevenueSchedulesApi post_r_sfor_invoice_item_adjustment_distribute_by_date_range POST /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}/distribute-revenue-with-date-range Create revenue schedule for Invoice Item Adjustment (distribute by date range)
Zuora::RevenueSchedulesApi post_r_sfor_invoice_item_adjustment_manual_distribution POST /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key} Create revenue schedule for Invoice Item Adjustment (manual distribution)
Zuora::RevenueSchedulesApi post_r_sfor_invoice_item_distribute_by_date_range POST /v1/revenue-schedules/invoice-items/{invoice-item-id}/distribute-revenue-with-date-range Create revenue schedule for Invoice Item (distribute by date range)
Zuora::RevenueSchedulesApi post_r_sfor_invoice_item_manual_distribution POST /v1/revenue-schedules/invoice-items/{invoice-item-id} Create revenue schedule for Invoice Item (manual distribution)
Zuora::RevenueSchedulesApi post_r_sfor_subsc_charge POST /v1/revenue-schedules/subscription-charges/{charge-key} Create revenue schedule on subscription charge
Zuora::RevenueSchedulesApi put_revenue_across_ap PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods Distribute revenue across accounting periods
Zuora::RevenueSchedulesApi put_revenue_by_recognition_startand_end_dates PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range Distribute revenue by recognition start and end dates
Zuora::RevenueSchedulesApi put_revenue_specific_date PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-on-specific-date Distribute revenue on specific date
Zuora::RevenueSchedulesApi put_rs_basic_info PUT /v1/revenue-schedules/{rs-number}/basic-information Update revenue schedule basic information
Zuora::SettingsApi get_revenue_automation_start_date GET /v1/settings/finance/revenue-automation-start-date Get the revenue automation start date
Zuora::SubscriptionProductFeaturesApi object_get_subscription_product_feature GET /v1/object/subscription-product-feature/{id} CRUD: Retrieve SubscriptionProductFeature
Zuora::SubscriptionsApi get_subscriptions_by_account GET /v1/subscriptions/accounts/{account-key} Get subscriptions by account
Zuora::SubscriptionsApi get_subscriptions_by_key GET /v1/subscriptions/{subscription-key} Get subscriptions by key
Zuora::SubscriptionsApi get_subscriptions_by_key_and_version GET /v1/subscriptions/{subscription-key}/versions/{version} Get subscriptions by key and version
Zuora::SubscriptionsApi object_delete_subscription DELETE /v1/object/subscription/{id} CRUD: Delete Subscription
Zuora::SubscriptionsApi object_get_subscription GET /v1/object/subscription/{id} CRUD: Retrieve Subscription
Zuora::SubscriptionsApi object_put_subscription PUT /v1/object/subscription/{id} CRUD: Update Subscription
Zuora::SubscriptionsApi post_preview_subscription POST /v1/subscriptions/preview Preview subscription
Zuora::SubscriptionsApi post_subscription POST /v1/subscriptions Create subscription
Zuora::SubscriptionsApi put_cancel_subscription PUT /v1/subscriptions/{subscription-key}/cancel Cancel subscription
Zuora::SubscriptionsApi put_renew_subscription PUT /v1/subscriptions/{subscription-key}/renew Renew subscription
Zuora::SubscriptionsApi put_resume_subscription PUT /v1/subscriptions/{subscription-key}/resume Resume subscription
Zuora::SubscriptionsApi put_subscription PUT /v1/subscriptions/{subscription-key} Update subscription
Zuora::SubscriptionsApi put_suspend_subscription PUT /v1/subscriptions/{subscription-key}/suspend Suspend subscription
Zuora::SubscriptionsApi put_update_subscription_custom_fields PUT /v1/subscriptions/{subscriptionNumber}/customFields Update subscription custom fields
Zuora::SummaryJournalEntriesApi delete_summary_journal_entry DELETE /v1/journal-entries/{je-number} Delete summary journal entry
Zuora::SummaryJournalEntriesApi get_all_summary_journal_entries GET /v1/journal-entries/journal-runs/{jr-number} Get all summary journal entries in a journal run
Zuora::SummaryJournalEntriesApi get_summary_journal_entry GET /v1/journal-entries/{je-number} Get summary journal entry
Zuora::SummaryJournalEntriesApi post_summary_journal_entry POST /v1/journal-entries Create summary journal entry
Zuora::SummaryJournalEntriesApi put_basic_summary_journal_entry PUT /v1/journal-entries/{je-number}/basic-information Update basic information of a summary journal entry
Zuora::SummaryJournalEntriesApi put_summary_journal_entry PUT /v1/journal-entries/{je-number}/cancel Cancel summary journal entry
Zuora::TaxationItemsApi delete_taxation_item DELETE /v1/taxationitems/{id} Delete taxation item
Zuora::TaxationItemsApi get_taxation_item GET /v1/taxationitems/{id} Get taxation item
Zuora::TaxationItemsApi object_delete_taxation_item DELETE /v1/object/taxation-item/{id} CRUD: Delete TaxationItem
Zuora::TaxationItemsApi object_get_taxation_item GET /v1/object/taxation-item/{id} CRUD: Retrieve TaxationItem
Zuora::TaxationItemsApi object_post_taxation_item POST /v1/object/taxation-item CRUD: Create TaxationItem
Zuora::TaxationItemsApi object_put_taxation_item PUT /v1/object/taxation-item/{id} CRUD: Update TaxationItem
Zuora::TaxationItemsApi put_taxation_item PUT /v1/taxationitems/{id} Update taxation item
Zuora::TransactionsApi get_transaction_invoice GET /v1/transactions/invoices/accounts/{account-key} Get invoices
Zuora::TransactionsApi get_transaction_payment GET /v1/transactions/payments/accounts/{account-key} Get payments
Zuora::UnitOfMeasureApi object_delete_unit_of_measure DELETE /v1/object/unit-of-measure/{id} CRUD: Delete UnitOfMeasure
Zuora::UnitOfMeasureApi object_get_unit_of_measure GET /v1/object/unit-of-measure/{id} CRUD: Retrieve UnitOfMeasure
Zuora::UnitOfMeasureApi object_post_unit_of_measure POST /v1/object/unit-of-measure CRUD: Create UnitOfMeasure
Zuora::UnitOfMeasureApi object_put_unit_of_measure PUT /v1/object/unit-of-measure/{id} CRUD: Update UnitOfMeasure
Zuora::UsageApi get_usage GET /v1/usage/accounts/{account-key} Get usage
Zuora::UsageApi object_delete_usage DELETE /v1/object/usage/{id} CRUD: Delete Usage
Zuora::UsageApi object_get_usage GET /v1/object/usage/{id} CRUD: Retrieve Usage
Zuora::UsageApi object_post_usage POST /v1/object/usage CRUD: Create Usage
Zuora::UsageApi object_put_usage PUT /v1/object/usage/{id} CRUD: Update Usage
Zuora::UsageApi post_usage POST /v1/usage Post usage
Zuora::UsersApi get_entities_user_accessible GET /v1/users/{username}/accessible-entities Multi-entity: Get entities that a user can access
Zuora::UsersApi put_accept_user_access PUT /v1/users/{username}/accept-access Multi-entity: Accept user access
Zuora::UsersApi put_deny_user_access PUT /v1/users/{username}/deny-access Multi-entity: Deny user access
Zuora::UsersApi put_send_user_access_requests PUT /v1/users/{username}/request-access Multi-entity: Send user access requests

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.