# Python client library reference

The latest Python client library version is **3.17.0**.

## Requirements

- **Python**: 3.9+
- **Pydantic**: 2.6+


## Installation

See [Zuora Client Libraries](/docs/guides/libraries/).

## Classes and methods

The following table summarizes all available classes and methods for the Zuora Python client library.

table
thead
tr
th
Class
th
Method
th
HTTP request
th
Description
tbody
tr
td
em
APIHealthApi
td
strong
get_system_health_api_volume_summary
td
strong
GET
 /system-health/api-requests/volume-summary
td
List API volume summary records
tr
td
em
AccountingCodesApi
td
strong
activate_accounting_code
td
strong
PUT
 /v1/accounting-codes/{ac-id}/activate
td
Activate an accounting code
tr
td
em
AccountingCodesApi
td
strong
create_accounting_code
td
strong
POST
 /v1/accounting-codes
td
Create an accounting code
tr
td
em
AccountingCodesApi
td
strong
deactivate_accounting_code
td
strong
PUT
 /v1/accounting-codes/{ac-id}/deactivate
td
Deactivate an accounting code
tr
td
em
AccountingCodesApi
td
strong
delete_accounting_code
td
strong
DELETE
 /v1/accounting-codes/{ac-id}
td
Delete an accounting code
tr
td
em
AccountingCodesApi
td
strong
get_accounting_code
td
strong
GET
 /v1/accounting-codes/{ac-id}
td
Retrieve an accounting code
tr
td
em
AccountingCodesApi
td
strong
get_all_accounting_codes
td
strong
GET
 /v1/accounting-codes
td
List all accounting codes
tr
td
em
AccountingCodesApi
td
strong
update_accounting_code
td
strong
PUT
 /v1/accounting-codes/{ac-id}
td
Update an accounting code
tr
td
em
AccountingPeriodsApi
td
strong
close_accounting_period
td
strong
PUT
 /v1/accounting-periods/{ap-id}/close
td
Close an accounting period
tr
td
em
AccountingPeriodsApi
td
strong
create_accounting_period
td
strong
POST
 /v1/accounting-periods
td
Create an accounting period
tr
td
em
AccountingPeriodsApi
td
strong
delete_accounting_period
td
strong
DELETE
 /v1/accounting-periods/{ap-id}
td
Delete an accounting period
tr
td
em
AccountingPeriodsApi
td
strong
get_accounting_period
td
strong
GET
 /v1/accounting-periods/{ap-id}
td
Retrieve an accounting period
tr
td
em
AccountingPeriodsApi
td
strong
get_all_accounting_periods
td
strong
GET
 /v1/accounting-periods
td
List all accounting periods
tr
td
em
AccountingPeriodsApi
td
strong
pending_close_accounting_period
td
strong
PUT
 /v1/accounting-periods/{ap-id}/pending-close
td
Set an accounting period to pending close
tr
td
em
AccountingPeriodsApi
td
strong
reopen_accounting_period
td
strong
PUT
 /v1/accounting-periods/{ap-id}/reopen
td
Reopen an accounting period
tr
td
em
AccountingPeriodsApi
td
strong
run_trial_balance
td
strong
PUT
 /v1/accounting-periods/{ap-id}/run-trial-balance
td
Run trial balance
tr
td
em
AccountingPeriodsApi
td
strong
update_accounting_period
td
strong
PUT
 /v1/accounting-periods/{ap-id}
td
Update an accounting period
tr
td
em
AccountsApi
td
strong
create_account
td
strong
POST
 /v1/accounts
td
Create an account
tr
td
em
AccountsApi
td
strong
delete_account
td
strong
DELETE
 /v1/accounts/{account-key}
td
Delete an account
tr
td
em
AccountsApi
td
strong
get_account
td
strong
GET
 /v1/accounts/{account-key}
td
Retrieve an account
tr
td
em
AccountsApi
td
strong
get_account_default_payment_method
td
strong
GET
 /v1/accounts/{account-key}/payment-methods/default
td
Retrieve the default payment method of an account
tr
td
em
AccountsApi
td
strong
get_account_payment_methods
td
strong
GET
 /v1/accounts/{account-key}/payment-methods
td
List payment methods of an account
tr
td
em
AccountsApi
td
strong
get_account_summary
td
strong
GET
 /v1/accounts/{account-key}/summary
td
Retrieve an account summary
tr
td
em
AccountsApi
td
strong
update_account
td
strong
PUT
 /v1/accounts/{account-key}
td
Update an account
tr
td
em
ActionsApi
td
strong
action_post_create
td
strong
POST
 /v1/action/create
td
Create
tr
td
em
ActionsApi
td
strong
action_post_delete
td
strong
POST
 /v1/action/delete
td
Delete
tr
td
em
ActionsApi
td
strong
action_post_query
td
strong
POST
 /v1/action/query
td
Query
tr
td
em
ActionsApi
td
strong
action_postquery_more
td
strong
POST
 /v1/action/queryMore
td
QueryMore
tr
td
em
ActionsApi
td
strong
action_postupdate
td
strong
POST
 /v1/action/update
td
Update
tr
td
em
AdjustmentsApi
td
strong
cancel_billing_adjustment
td
strong
PUT
 /v1/adjustments/{adjustmentId}/cancel
td
Cancel an adjustment
tr
td
em
AdjustmentsApi
td
strong
create_billing_adjustment
td
strong
POST
 /v1/adjustments
td
Create an adjustment
tr
td
em
AdjustmentsApi
td
strong
get_billing_adjustment
td
strong
GET
 /v1/adjustments/{adjustment-key}
td
Retrieve an adjustment
tr
td
em
AdjustmentsApi
td
strong
get_subscription_adjustments
td
strong
GET
 /v1/adjustments
td
List all adjustments of the latest version subscription
tr
td
em
AdjustmentsApi
td
strong
preview_billing_adjustment
td
strong
POST
 /v1/adjustments/preview
td
Preview an adjustment
tr
td
em
AggregateQueriesApi
td
strong
create_batch_query
td
strong
POST
 /v1/batch-query/
td
Submit an aggregate query job
tr
td
em
AggregateQueriesApi
td
strong
delete_batch_query_job
td
strong
DELETE
 /v1/batch-query/jobs/{jobid}
td
Cancel a running aggregate query job
tr
td
em
AggregateQueriesApi
td
strong
get_batch_query_job
td
strong
GET
 /v1/batch-query/jobs/{jobid}
td
Retrieve an aggregate query job
tr
td
em
AttachmentsApi
td
strong
delete_attachments
td
strong
DELETE
 /v1/attachments/{attachment-id}
td
Delete an attachment
tr
td
em
AttachmentsApi
td
strong
get_attachments
td
strong
GET
 /v1/attachments/{attachment-id}
td
Retrieve an attachment
tr
td
em
AttachmentsApi
td
strong
get_attachments_list
td
strong
GET
 /v1/attachments/{object-type}/{object-key}
td
List attachments by object type and key
tr
td
em
AttachmentsApi
td
strong
post_attachments
td
strong
POST
 /v1/attachments
td
Create an attachment
tr
td
em
AttachmentsApi
td
strong
put_attachments
td
strong
PUT
 /v1/attachments/{attachment-id}
td
Update an attachment
tr
td
em
BillRunApi
td
strong
cancel_bill_run
td
strong
PUT
 /v1/bill-runs/{billRunId}/cancel
td
Cancel a bill run
tr
td
em
BillRunApi
td
strong
create_bill_run
td
strong
POST
 /v1/bill-runs
td
Create a bill run
tr
td
em
BillRunApi
td
strong
delete_bill_run
td
strong
DELETE
 /v1/bill-runs/{billRunId}
td
Delete a bill run
tr
td
em
BillRunApi
td
strong
email_bill_run
td
strong
POST
 /v1/bill-runs/{billRunKey}/emails
td
Email billing documents generated from a bill run
tr
td
em
BillRunApi
td
strong
get_bill_run
td
strong
GET
 /v1/bill-runs/{billRunId}
td
Retrieve a bill run
tr
td
em
BillRunApi
td
strong
post_bill_run
td
strong
PUT
 /v1/bill-runs/{billRunId}/post
td
Post a bill run
tr
td
em
BillRunHealthApi
td
strong
get_system_health_billing_doc_volume_summary
td
strong
GET
 /system-health/billing-documents/volume-summary
td
List billing document volume summary records
tr
td
em
BillingDocumentsApi
td
strong
create_billing_document_files_deletion_job
td
strong
POST
 /v1/accounts/billing-documents/files/deletion-jobs
td
Create a job to hard delete billing document files
tr
td
em
BillingDocumentsApi
td
strong
generate_billing_documents
td
strong
POST
 /v1/accounts/{key}/billing-documents/generate
td
Generate billing documents by account ID
tr
td
em
BillingDocumentsApi
td
strong
get_billing_document_files_deletion_job
td
strong
GET
 /v1/accounts/billing-documents/files/deletion-jobs/{jobId}
td
Retrieve a job of hard deleting billing document files
tr
td
em
BillingDocumentsApi
td
strong
get_billing_documents
td
strong
GET
 /v1/billing-documents
td
List billing documents for an account
tr
td
em
BillingPreviewRunApi
td
strong
create_billing_preview_run
td
strong
POST
 /v1/billing-preview-runs
td
Create a billing preview run
tr
td
em
BillingPreviewRunApi
td
strong
get_billing_preview_run
td
strong
GET
 /v1/billing-preview-runs/{billingPreviewRunId}
td
Retrieve a billing preview run
tr
td
em
BookingDateBackfillJobApi
td
strong
g_et_booking_date_backfill_job_by_id
td
strong
GET
 /v1/uno/data-backfill/bookingdate/jobs/{jobId}
td
Find BookingDate Backfill job by ID
tr
td
em
BookingDateBackfillJobApi
td
strong
g_et_list_booking_date_backfill_jobs
td
strong
GET
 /v1/uno/data-backfill/bookingdate/jobs
td
Query all Booking Date Backfill Jobs
tr
td
em
BookingDateBackfillJobApi
td
strong
p_ost_create_booking_date_backfill_job
td
strong
POST
 /v1/uno/data-backfill/bookingdate/jobs
td
Create a new BookingDate Backfil job
tr
td
em
BookingDateBackfillJobApi
td
strong
p_ut_stop_booking_date_backfill_job_by_id
td
strong
PUT
 /v1/uno/data-backfill/bookingdate/jobs/{jobId}
td
Stop BookingDate Backfill job by ID
tr
td
em
CatalogGroupsApi
td
strong
create_catalog_group
td
strong
POST
 /v1/catalog-groups
td
Create a catalog group
tr
td
em
CatalogGroupsApi
td
strong
delete_catalog_group
td
strong
DELETE
 /v1/catalog-groups/{catalog-group-key}
td
Delete a catalog group
tr
td
em
CatalogGroupsApi
td
strong
get_catalog_group
td
strong
GET
 /v1/catalog-groups/{catalog-group-key}
td
Retrieve a catalog group
tr
td
em
CatalogGroupsApi
td
strong
get_catalog_groups
td
strong
GET
 /v1/catalog-groups
td
List all catalog groups
tr
td
em
CatalogGroupsApi
td
strong
update_catalog_group
td
strong
PUT
 /v1/catalog-groups/{catalog-group-key}
td
Update a catalog group
tr
td
em
ContactSnapshotsApi
td
strong
get_contact_snapshot
td
strong
GET
 /v1/contact-snapshots/{contact-snapshot-id}
td
Retrieve a contact snapshot
tr
td
em
ContactsApi
td
strong
create_contact
td
strong
POST
 /v1/contacts
td
Create a contact
tr
td
em
ContactsApi
td
strong
delete_contact
td
strong
DELETE
 /v1/contacts/{contactId}
td
Delete a contact
tr
td
em
ContactsApi
td
strong
get_contact
td
strong
GET
 /v1/contacts/{contactId}
td
Retrieve a contact
tr
td
em
ContactsApi
td
strong
scrub_contact
td
strong
PUT
 /v1/contacts/{contactId}/scrub
td
Scrub a contact
tr
td
em
ContactsApi
td
strong
transfer_contact
td
strong
PUT
 /v1/contacts/{contactId}/transfer
td
Transfer a contact
tr
td
em
ContactsApi
td
strong
update_contact
td
strong
PUT
 /v1/contacts/{contactId}
td
Update a contact
tr
td
em
CreditMemosApi
td
strong
apply_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/apply
td
Apply a credit memo
tr
td
em
CreditMemosApi
td
strong
apply_credit_memo_async
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/apply-async
td
Async Apply a credit memo
tr
td
em
CreditMemosApi
td
strong
bulk_create_credit_memos
td
strong
POST
 /v1/credit-memos/bulk
td
Create credit memos
tr
td
em
CreditMemosApi
td
strong
bulk_update_credit_memos
td
strong
PUT
 /v1/credit-memos/bulk
td
Update credit memos
tr
td
em
CreditMemosApi
td
strong
cancel_async_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/cancel-async
td
Cancel a Credit Memo in async
tr
td
em
CreditMemosApi
td
strong
cancel_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/cancel
td
Cancel a credit memo
tr
td
em
CreditMemosApi
td
strong
create_credit_memo_from_charge
td
strong
POST
 /v1/credit-memos
td
Create a credit memo from a charge
tr
td
em
CreditMemosApi
td
strong
create_credit_memo_from_invoice
td
strong
POST
 /v1/credit-memos/invoice/{invoiceKey}
td
Create a credit memo from an invoice
tr
td
em
CreditMemosApi
td
strong
create_credit_memo_taxation_items
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/taxation-items
td
Create taxation items for a credit memo
tr
td
em
CreditMemosApi
td
strong
delete_credit_memo
td
strong
DELETE
 /v1/credit-memos/{creditMemoKey}
td
Delete a credit memo
tr
td
em
CreditMemosApi
td
strong
email_credit_memo
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/emails
td
Email a credit memo
tr
td
em
CreditMemosApi
td
strong
generate_credit_memo_pdf
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/pdfs
td
Generate a credit memo PDF file
tr
td
em
CreditMemosApi
td
strong
get_apply_credit_memo_async_job
td
strong
GET
 /v1/credit-memos/apply-async-jobs/{applyAsyncJobId}
td
Get async apply credit memo job by ID
tr
td
em
CreditMemosApi
td
strong
get_credit_memo
td
strong
GET
 /v1/credit-memos/{creditMemoKey}
td
Retrieve a credit memo
tr
td
em
CreditMemosApi
td
strong
get_credit_memo_item
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/items/{creditMemoItemId}
td
Retrieve a credit memo item
tr
td
em
CreditMemosApi
td
strong
get_credit_memo_item_part
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts/{partId}/item-parts/{itemPartId}
td
Retrieve a credit memo part item
tr
td
em
CreditMemosApi
td
strong
get_credit_memo_item_parts
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts/{partId}/item-parts
td
List all credit memo part items
tr
td
em
CreditMemosApi
td
strong
get_credit_memo_items
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/items
td
List credit memo items
tr
td
em
CreditMemosApi
td
strong
get_credit_memo_part
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts/{partId}
td
Retrieve a credit memo part
tr
td
em
CreditMemosApi
td
strong
get_credit_memo_parts
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts
td
List all parts of a credit memo
tr
td
em
CreditMemosApi
td
strong
get_credit_memo_pdf_status
td
strong
GET
 /v1/credit-memos/pdf-status
td
Retrieve PDF status of credit memos in a batch.
tr
td
em
CreditMemosApi
td
strong
get_credit_memos
td
strong
GET
 /v1/credit-memos
td
List credit memos
tr
td
em
CreditMemosApi
td
strong
get_taxation_items_of_credit_memo_item
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/items/{creditMemoItemId}/taxation-items
td
List all taxation items of a credit memo item
tr
td
em
CreditMemosApi
td
strong
get_unapply_credit_memo_async_job
td
strong
GET
 /v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}
td
Get async unapply credit memo job by ID
tr
td
em
CreditMemosApi
td
strong
post_async_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/post-async
td
Post a credit memo in async
tr
td
em
CreditMemosApi
td
strong
post_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/post
td
Post a credit memo
tr
td
em
CreditMemosApi
td
strong
refund_credit_memo
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/refund
td
Refund a credit memo
tr
td
em
CreditMemosApi
td
strong
reverse_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/reverse
td
Reverse a credit memo
tr
td
em
CreditMemosApi
td
strong
unapply_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/unapply
td
Unapply a credit memo
tr
td
em
CreditMemosApi
td
strong
unapply_credit_memo_async
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/unapply-async
td
Async Unapply a credit memo
tr
td
em
CreditMemosApi
td
strong
unpost_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/unpost
td
Unpost a credit memo
tr
td
em
CreditMemosApi
td
strong
update_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}
td
Update a credit memo
tr
td
em
CreditMemosApi
td
strong
upload_file_for_credit_memo
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/files
td
Upload a file for a credit memo
tr
td
em
CreditMemosApi
td
strong
write_off_credit_memo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/write-off
td
Write off a credit memo
tr
td
em
CustomEventTriggersApi
td
strong
delete_event_trigger
td
strong
DELETE
 /events/event-triggers/{id}
td
Delete an event trigger
tr
td
em
CustomEventTriggersApi
td
strong
get_event_trigger
td
strong
GET
 /events/event-triggers/{id}
td
Retrieve an event trigger
tr
td
em
CustomEventTriggersApi
td
strong
get_event_triggers
td
strong
GET
 /events/event-triggers
td
List event triggers
tr
td
em
CustomEventTriggersApi
td
strong
post_event_trigger
td
strong
POST
 /events/event-triggers
td
Create an event trigger
tr
td
em
CustomEventTriggersApi
td
strong
put_event_trigger
td
strong
PUT
 /events/event-triggers/{id}
td
Update an event trigger
tr
td
em
CustomExchangeRatesApi
td
strong
get_custom_exchange_rates
td
strong
GET
 /v1/custom-exchange-rates/{currency}
td
List custom exchange rates by currency
tr
td
em
CustomObjectDefinitionsApi
td
strong
delete_custom_object_definition_by_type
td
strong
DELETE
 /objects/definitions/default/{object}
td
Delete a custom object definition
tr
td
em
CustomObjectDefinitionsApi
td
strong
get_all_custom_object_definitions_in_namespace
td
strong
GET
 /objects/definitions/default
td
List custom object definitions
tr
td
em
CustomObjectDefinitionsApi
td
strong
get_custom_object_definition_by_type
td
strong
GET
 /objects/definitions/default/{object}
td
Retrieve a custom object definition
tr
td
em
CustomObjectDefinitionsApi
td
strong
post_custom_object_definitions
td
strong
POST
 /objects/definitions/default
td
Create custom object definitions
tr
td
em
CustomObjectDefinitionsApi
td
strong
post_update_custom_object_definition
td
strong
POST
 /objects/migrations
td
Update a custom object definition
tr
td
em
CustomObjectJobsApi
td
strong
get_all_custom_object_bulk_jobs
td
strong
GET
 /objects/jobs
td
List all custom object bulk jobs
tr
td
em
CustomObjectJobsApi
td
strong
get_custom_object_bulk_job
td
strong
GET
 /objects/jobs/{id}
td
Retrieve a custom object bulk job
tr
td
em
CustomObjectJobsApi
td
strong
get_custom_object_bulk_job_errors
td
strong
GET
 /objects/jobs/{id}/errors
td
List all errors for a custom object bulk job
tr
td
em
CustomObjectJobsApi
td
strong
p_atch_custom_object_bulk_job
td
strong
PATCH
 /objects/jobs/{id}/cancel
td
Cancel a custom object bulk job
tr
td
em
CustomObjectJobsApi
td
strong
post_custom_object_bulk_job
td
strong
POST
 /objects/jobs
td
Submit a custom object bulk job
tr
td
em
CustomObjectJobsApi
td
strong
post_upload_file_for_custom_object_bulk_job
td
strong
POST
 /objects/jobs/{id}/files
td
Upload a file for a custom object bulk job
tr
td
em
CustomObjectRecordsApi
td
strong
delete_custom_object_record_by_id
td
strong
DELETE
 /objects/records/default/{object}/{id}
td
Delete a custom object record
tr
td
em
CustomObjectRecordsApi
td
strong
get_all_records_for_custom_object_type
td
strong
GET
 /objects/records/default/{object}
td
List records for a custom object
tr
td
em
CustomObjectRecordsApi
td
strong
get_custom_object_record_by_id
td
strong
GET
 /objects/records/default/{object}/{id}
td
Retrieve a custom object record
tr
td
em
CustomObjectRecordsApi
td
strong
patch_partial_update_custom_object_record
td
strong
PATCH
 /objects/records/default/{object}/{id}
td
Partially update a custom object record
tr
td
em
CustomObjectRecordsApi
td
strong
post_custom_object_records
td
strong
POST
 /objects/records/default/{object}
td
Create custom object records
tr
td
em
CustomObjectRecordsApi
td
strong
post_custom_object_records_batch_update_or_delete
td
strong
POST
 /objects/batch/default/{object}
td
Update or delete custom object records
tr
td
em
CustomObjectRecordsApi
td
strong
put_custom_object_record
td
strong
PUT
 /objects/records/default/{object}/{id}
td
Update a custom object record
tr
td
em
CustomPaymentMethodTypesApi
td
strong
create_open_payment_method_type
td
strong
POST
 /open-payment-method-types
td
Create a draft custom payment method type
tr
td
em
CustomPaymentMethodTypesApi
td
strong
get_open_payment_method_type_revision
td
strong
GET
 /open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}
td
Retrieve a specific draft revision of a custom payment method type
tr
td
em
CustomPaymentMethodTypesApi
td
strong
get_published_open_payment_method_type
td
strong
GET
 /open-payment-method-types/{paymentMethodTypeName}/published
td
Retrieve a published custom payment method type
tr
td
em
CustomPaymentMethodTypesApi
td
strong
publish_open_payment_method_type
td
strong
PUT
 /open-payment-method-types/publish/{paymentMethodTypeName}
td
Publish a custom payment method type
tr
td
em
CustomPaymentMethodTypesApi
td
strong
update_open_payment_method_type
td
strong
PUT
 /open-payment-method-types/{paymentMethodTypeName}
td
Update a custom payment method type
tr
td
em
CustomScheduledEventsApi
td
strong
delete_scheduled_event_by_id
td
strong
DELETE
 /events/scheduled-events/{id}
td
Delete a scheduled event by ID
tr
td
em
CustomScheduledEventsApi
td
strong
get_scheduled_event_by_id
td
strong
GET
 /events/scheduled-events/{id}
td
Retrieve a scheduled event by ID
tr
td
em
CustomScheduledEventsApi
td
strong
get_scheduled_events
td
strong
GET
 /events/scheduled-events
td
List all scheduled events
tr
td
em
CustomScheduledEventsApi
td
strong
post_scheduled_event
td
strong
POST
 /events/scheduled-events
td
Create a scheduled event
tr
td
em
CustomScheduledEventsApi
td
strong
update_scheduled_event_by_id
td
strong
PUT
 /events/scheduled-events/{id}
td
Update a scheduled event by ID
tr
td
em
DataBackfillJobApi
td
strong
g_et_data_backfill_job_by_id
td
strong
GET
 /v1/uno/data-backfill/jobs/{jobId}
td
Find Data Backfill job by ID
tr
td
em
DataBackfillJobApi
td
strong
g_et_data_backfill_template
td
strong
GET
 /v1/uno/data-backfill/jobs/{type}/template
td
Download a Data Backfill template file
tr
td
em
DataBackfillJobApi
td
strong
g_et_list_data_backfill_jobs
td
strong
GET
 /v1/uno/date-backfill/listjobs
td
Query all data backfill jobs
tr
td
em
DataBackfillJobApi
td
strong
p_ost_create_data_backfill_job
td
strong
POST
 /v1/uno/data-backfill/jobs
td
Create a new Data Backfil job
tr
td
em
DataBackfillJobApi
td
strong
p_ut_stop_data_backfill_job_by_id
td
strong
PUT
 /v1/uno/data-backfill/jobs/{jobId}
td
Stop Data Backfill job by ID
tr
td
em
DataLabelingApi
td
strong
get_data_labeling_job
td
strong
GET
 /v1/multi-organizations/data-labeling-job/{job-id}
td
Retrieve a data labeling job
tr
td
em
DataLabelingApi
td
strong
submit_data_labeling_job
td
strong
POST
 /v1/multi-organizations/data-labeling-job
td
Submit a data labeling job
tr
td
em
DataQueriesApi
td
strong
delete_data_query_job
td
strong
DELETE
 /query/jobs/{job-id}
td
Cancel a data query job
tr
td
em
DataQueriesApi
td
strong
get_data_query_job
td
strong
GET
 /query/jobs/{job-id}
td
Retrieve a data query job
tr
td
em
DataQueriesApi
td
strong
get_data_query_jobs
td
strong
GET
 /query/jobs
td
List data query jobs
tr
td
em
DataQueriesApi
td
strong
post_data_query_job
td
strong
POST
 /query/jobs
td
Submit a data query
tr
td
em
DebitMemosApi
td
strong
bulk_create_debit_memos
td
strong
POST
 /v1/debit-memos/bulk
td
Create debit memos
tr
td
em
DebitMemosApi
td
strong
bulk_update_debit_memos
td
strong
PUT
 /v1/debit-memos/bulk
td
Update debit memos
tr
td
em
DebitMemosApi
td
strong
cancel_async_debit_memo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/cancel-async
td
Cancel a Debit Memo in async
tr
td
em
DebitMemosApi
td
strong
cancel_debit_memo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/cancel
td
Cancel a debit memo
tr
td
em
DebitMemosApi
td
strong
collect_debit_memo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/collect
td
Collect a posted debit memo
tr
td
em
DebitMemosApi
td
strong
create_debit_memo_from_charge
td
strong
POST
 /v1/debit-memos
td
Create a debit memo from a charge
tr
td
em
DebitMemosApi
td
strong
create_debit_memo_from_invoice
td
strong
POST
 /v1/debit-memos/invoice/{invoiceKey}
td
Create a debit memo from an invoice
tr
td
em
DebitMemosApi
td
strong
create_taxation_items_for_debit_memo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/taxation-items
td
Create taxation items for a debit memo
tr
td
em
DebitMemosApi
td
strong
delete_debit_memo
td
strong
DELETE
 /v1/debit-memos/{debitMemoKey}
td
Delete a debit memo
tr
td
em
DebitMemosApi
td
strong
email_debit_memo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/emails
td
Email a debit memo
tr
td
em
DebitMemosApi
td
strong
generate_debit_memo_pdf
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/pdfs
td
Generate a debit memo PDF file
tr
td
em
DebitMemosApi
td
strong
get_debit_memo
td
strong
GET
 /v1/debit-memos/{debitMemoKey}
td
Retrieve a debit memo
tr
td
em
DebitMemosApi
td
strong
get_debit_memo_application_parts
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/application-parts
td
List all application parts of a debit memo
tr
td
em
DebitMemosApi
td
strong
get_debit_memo_item
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/items/{debitMemoItemId}
td
Retrieve a debit memo item
tr
td
em
DebitMemosApi
td
strong
get_debit_memo_items
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/items
td
List debit memo items
tr
td
em
DebitMemosApi
td
strong
get_debit_memo_pdf_status
td
strong
GET
 /v1/debit-memos/pdf-status
td
Retrieve PDF status of debit memos in a batch.
tr
td
em
DebitMemosApi
td
strong
get_debit_memos
td
strong
GET
 /v1/debit-memos
td
List debit memos
tr
td
em
DebitMemosApi
td
strong
get_taxation_items_of_debit_memo_item
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/items/{debitMemoItemId}/taxation-items
td
List all taxation items of a debit memo item
tr
td
em
DebitMemosApi
td
strong
post_async_debit_memo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/post-async
td
Post a Debit Memo in async
tr
td
em
DebitMemosApi
td
strong
post_debit_memo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/post
td
Post a debit memo
tr
td
em
DebitMemosApi
td
strong
unpost_debit_memo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/unpost
td
Unpost a debit memo
tr
td
em
DebitMemosApi
td
strong
update_debit_memo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}
td
Update a debit memo
tr
td
em
DebitMemosApi
td
strong
update_debit_memos_due_dates
td
strong
PUT
 /v1/debit-memos
td
Update due dates for debit memos
tr
td
em
DebitMemosApi
td
strong
upload_file_for_debit_memo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/files
td
Upload a file for a debit memo
tr
td
em
DebitMemosApi
td
strong
write_off_debit_memo
td
strong
PUT
 /v1/debitmemos/{debitMemoKey}/write-off
td
Write off an debit memo
tr
td
em
DeploymentApi
td
strong
compare_and_deploy_product_catalog_template
td
strong
POST
 /deployment-manager/deployments/template/product_catalog
td
Compare and Deploy a template for product catalog to a target tenant
tr
td
em
DeploymentApi
td
strong
compare_and_deploy_product_catalog_tenant
td
strong
POST
 /deployment-manager/deployments/tenant/product_catalog
td
Compare and Deploy product catalog between a source tenant and a target tenant
tr
td
em
DeploymentApi
td
strong
compare_and_deploy_template
td
strong
POST
 /deployment-manager/deployments/templates
td
Compare and Deploy settings from a template to a target tenant
tr
td
em
DeploymentApi
td
strong
compare_and_deploy_tenant
td
strong
POST
 /deployment-manager/deployments/tenants
td
Compare and Deploy settings between a source tenant and a target tenant
tr
td
em
DeploymentApi
td
strong
retrieve_deployment
td
strong
GET
 /deployment-manager/deployments/{migrationId}
td
Retrieves a deployment log.
tr
td
em
DeploymentApi
td
strong
revert_deployment
td
strong
POST
 /deployment-manager/deployments/{migrationId}/revert
td
Reverts the deployment.
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
compare_template
td
strong
POST
 /deployment-manager/deployment_artifacts/compare
td
Compare settings between a source tenant and a target tenant
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
create_deployment_template
td
strong
POST
 /deployment-manager/deployment_templates
td
Create a deployment template
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
delete_deployment_template
td
strong
DELETE
 /deployment-manager/deployment_templates/{id}
td
Delete a template
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
download_deployment_template
td
strong
GET
 /deployment-manager/deployment_artifacts
td
Download a template
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
get_deployment_template_detail
td
strong
GET
 /deployment-manager/deployment_templates/{id}
td
List all details of a template
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
get_deployment_templates
td
strong
GET
 /deployment-manager/deployment_templates
td
List all templates
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
get_source_component_details
td
strong
GET
 /deployment-manager/deployment_artifacts/retrieve-settings
td
List all details of source components
tr
td
em
DeploymentConfigurationTemplatesApi
td
strong
migrate_tenant_settings
td
strong
POST
 /deployment-manager/deployment_artifacts/deploy
td
Migrate settings from source tenant to target tenant
tr
td
em
DescribeApi
td
strong
get_describe
td
strong
GET
 /v1/describe/{object}
td
Describe an object
tr
td
em
EInvoicingApi
td
strong
delete_business_region
td
strong
DELETE
 /v1/e-invoice/business-regions/{key}
td
Delete a Business Region
tr
td
em
EInvoicingApi
td
strong
delete_service_provider
td
strong
DELETE
 /v1/e-invoice/service-providers/{key}
td
Delete a Service Provider
tr
td
em
EInvoicingApi
td
strong
get_business_region
td
strong
GET
 /v1/e-invoice/business-regions/{key}
td
Retrieve a Business Region
tr
td
em
EInvoicingApi
td
strong
get_business_regions
td
strong
GET
 /v1/e-invoice/business-regions
td
List business region
tr
td
em
EInvoicingApi
td
strong
get_service_provider
td
strong
GET
 /v1/e-invoice/service-providers/{key}
td
Retrieve a Service Provider
tr
td
em
EInvoicingApi
td
strong
get_service_providers
td
strong
GET
 /v1/e-invoice/service-providers
td
List Service Provider
tr
td
em
EInvoicingApi
td
strong
post_business_region
td
strong
POST
 /v1/e-invoice/business-regions
td
Post a Business Region
tr
td
em
EInvoicingApi
td
strong
post_service_provider
td
strong
POST
 /v1/e-invoice/service-providers
td
Post a Service Provider
tr
td
em
EInvoicingApi
td
strong
update_business_region
td
strong
PUT
 /v1/e-invoice/business-regions/{key}
td
Update a Business Region
tr
td
em
EInvoicingApi
td
strong
update_service_provider
td
strong
PUT
 /v1/e-invoice/service-providers/{key}
td
Update a Service Provider
tr
td
em
ElectronicPaymentsHealthApi
td
strong
get_system_health_payment_volume_summary
td
strong
GET
 /system-health/payments/volume-summary
td
List payment volume summary records
tr
td
em
FilesApi
td
strong
get_files
td
strong
GET
 /v1/files/{file-id}
td
Retrieve a file
tr
td
em
FulfillmentsApi
td
strong
create_fulfillment
td
strong
POST
 /v1/fulfillments
td
Create fulfillments
tr
td
em
FulfillmentsApi
td
strong
create_fulfillment_item
td
strong
POST
 /v1/fulfillment-items
td
Create fulfillment items
tr
td
em
FulfillmentsApi
td
strong
delete_fulfillment
td
strong
DELETE
 /v1/fulfillments/{key}
td
Delete a fulfillment
tr
td
em
FulfillmentsApi
td
strong
delete_fulfillment_item
td
strong
DELETE
 /v1/fulfillment-items/{id}
td
Delete a fulfillment item
tr
td
em
FulfillmentsApi
td
strong
get_fulfillment
td
strong
GET
 /v1/fulfillments/{key}
td
Retrieve a fulfillment
tr
td
em
FulfillmentsApi
td
strong
get_fulfillment_item
td
strong
GET
 /v1/fulfillment-items/{id}
td
Retrieve a fulfillment item
tr
td
em
FulfillmentsApi
td
strong
update_fulfillment
td
strong
PUT
 /v1/fulfillments/{key}
td
Update a fulfillment
tr
td
em
FulfillmentsApi
td
strong
update_fulfillment_item
td
strong
PUT
 /v1/fulfillment-items/{id}
td
Update a fulfillment item
tr
td
em
HostedPagesApi
td
strong
get_hosted_pages
td
strong
GET
 /v1/hostedpages
td
List hosted pages
tr
td
em
ImportsApi
td
strong
object_get_import
td
strong
GET
 /v1/object/import/{id}
td
CRUD: Retrieve an import
tr
td
em
ImportsApi
td
strong
object_post_import
td
strong
POST
 /v1/object/import
td
CRUD: Create an import
tr
td
em
InvoiceSchedulesApi
td
strong
attach_invoice_schedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/attach
td
Attach an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
create_invoice_schedule
td
strong
POST
 /v1/invoice-schedules
td
Create an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
delete_invoice_schedule
td
strong
DELETE
 /v1/invoice-schedules/{scheduleKey}
td
Delete an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
detach_invoice_schedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/detach
td
Detach an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
execute_invoice_schedule
td
strong
POST
 /v1/invoice-schedules/{scheduleKey}/execute
td
Execute an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
get_invoice_schedule
td
strong
GET
 /v1/invoice-schedules/{scheduleKey}
td
Retrieve an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
pause_invoice_schedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/pause
td
Pause an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
resume_invoice_schedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/resume
td
Resume an invoice schedule
tr
td
em
InvoiceSchedulesApi
td
strong
update_invoice_schedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}
td
Update an invoice schedule
tr
td
em
InvoicesApi
td
strong
bulk_create_standalone_invoices
td
strong
POST
 /v1/invoices/batch
td
Create standalone invoices
tr
td
em
InvoicesApi
td
strong
bulk_post_invoices
td
strong
POST
 /v1/invoices/bulk-post
td
Post invoices
tr
td
em
InvoicesApi
td
strong
bulk_update_invoices
td
strong
PUT
 /v1/invoices
td
Update invoices
tr
td
em
InvoicesApi
td
strong
cancel_invoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/cancel
td
Cancel an invoice
tr
td
em
InvoicesApi
td
strong
create_invoice_taxation_items
td
strong
POST
 /v1/invoices/{invoiceKey}/taxation-items
td
Create taxation items for an invoice
tr
td
em
InvoicesApi
td
strong
create_standalone_invoice
td
strong
POST
 /v1/invoices
td
Create a standalone invoice
tr
td
em
InvoicesApi
td
strong
delete_invoice
td
strong
DELETE
 /v1/invoices/{invoiceKey}
td
Delete an invoice
tr
td
em
InvoicesApi
td
strong
email_invoice
td
strong
POST
 /v1/invoices/{invoiceKey}/emails
td
Email an invoice
tr
td
em
InvoicesApi
td
strong
get_invoice
td
strong
GET
 /v1/invoices/{invoiceKey}
td
Retrieve an invoice
tr
td
em
InvoicesApi
td
strong
get_invoice_application_parts
td
strong
GET
 /v1/invoices/{invoiceKey}/application-parts
td
List all application parts of an invoice
tr
td
em
InvoicesApi
td
strong
get_invoice_files
td
strong
GET
 /v1/invoices/{invoiceKey}/files
td
List all files of an invoice
tr
td
em
InvoicesApi
td
strong
get_invoice_items
td
strong
GET
 /v1/invoices/{invoiceKey}/items
td
List all items of an invoice
tr
td
em
InvoicesApi
td
strong
get_invoice_pdf_status
td
strong
GET
 /v1/invoices/pdf-status
td
Retrieve PDF status of invoices in a batch.
tr
td
em
InvoicesApi
td
strong
get_taxation_items_of_invoice_item
td
strong
GET
 /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items
td
List all taxation items of an invoice item
tr
td
em
InvoicesApi
td
strong
post_invoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/post
td
Cancel an invoice
tr
td
em
InvoicesApi
td
strong
reverse_invoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/reverse
td
Reverse an invoice
tr
td
em
InvoicesApi
td
strong
update_invoice
td
strong
PUT
 /v1/invoices/{invoiceKey}
td
Update an invoice
tr
td
em
InvoicesApi
td
strong
upload_file_for_invoice
td
strong
POST
 /v1/invoices/{invoiceKey}/files
td
Upload a file for an invoice
tr
td
em
InvoicesApi
td
strong
write_off_invoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/write-off
td
Write off an invoice
tr
td
em
JournalRunsApi
td
strong
cancel_journal_run
td
strong
PUT
 /v1/journal-runs/{jr-number}/cancel
td
Cancel a journal run
tr
td
em
JournalRunsApi
td
strong
create_journal_run
td
strong
POST
 /v1/journal-runs
td
Create a journal run
tr
td
em
JournalRunsApi
td
strong
delete_journal_run
td
strong
DELETE
 /v1/journal-runs/{jr-number}
td
Delete a journal run
tr
td
em
JournalRunsApi
td
strong
get_journal_run
td
strong
GET
 /v1/journal-runs/{jr-number}
td
Retrieve a journal run
tr
td
em
MassUpdaterApi
td
strong
create_mass_updater
td
strong
POST
 /v1/bulk
td
Perform a mass action
tr
td
em
MassUpdaterApi
td
strong
get_mass_updater
td
strong
GET
 /v1/bulk/{bulk-key}
td
List all results of a mass action
tr
td
em
MassUpdaterApi
td
strong
stop_mass_updater
td
strong
PUT
 /v1/bulk/{bulk-key}/stop
td
Stop a mass action
tr
td
em
NotificationsApi
td
strong
create_notification_definition
td
strong
POST
 /notifications/notification-definitions
td
Create a notification definition
tr
td
em
NotificationsApi
td
strong
create_or_update_email_templates
td
strong
POST
 /notifications/email-templates/import
td
Create or update email templates
tr
td
em
NotificationsApi
td
strong
delete_email_template
td
strong
DELETE
 /notifications/email-templates/{id}
td
Delete an email template
tr
td
em
NotificationsApi
td
strong
delete_notification_definition
td
strong
DELETE
 /notifications/notification-definitions/{id}
td
Delete a notification definition
tr
td
em
NotificationsApi
td
strong
delete_notification_history_for_account
td
strong
DELETE
 /notifications/history
td
Delete notification histories for an account
tr
td
em
NotificationsApi
td
strong
get_callout_history
td
strong
GET
 /v1/notification-history/callout
td
List callout notification histories
tr
td
em
NotificationsApi
td
strong
get_email_history
td
strong
GET
 /v1/notification-history/email
td
List email notification histories
tr
td
em
NotificationsApi
td
strong
get_email_template
td
strong
GET
 /notifications/email-templates/{id}
td
Retrieve an email template
tr
td
em
NotificationsApi
td
strong
get_notification_definition
td
strong
GET
 /notifications/notification-definitions/{id}
td
Retrieve a notification definition
tr
td
em
NotificationsApi
td
strong
get_notification_history_deletion_task
td
strong
GET
 /notifications/history/tasks/{id}
td
Retrieve a notification history deletion task
tr
td
em
NotificationsApi
td
strong
post_create_email_template
td
strong
POST
 /notifications/email-templates
td
Create an email template
tr
td
em
NotificationsApi
td
strong
query_email_templates
td
strong
GET
 /notifications/email-templates
td
List email templates
tr
td
em
NotificationsApi
td
strong
query_notification_definitions
td
strong
GET
 /notifications/notification-definitions
td
List notification definitions
tr
td
em
NotificationsApi
td
strong
resend_callout_notifications
td
strong
POST
 /notifications/callout-histories/resend
td
Resend callout notifications
tr
td
em
NotificationsApi
td
strong
resend_email_notifications
td
strong
POST
 /notifications/email-histories/resend
td
Resend email notifications
tr
td
em
NotificationsApi
td
strong
update_email_template
td
strong
PUT
 /notifications/email-templates/{id}
td
Update an email template
tr
td
em
NotificationsApi
td
strong
update_notification_definition
td
strong
PUT
 /notifications/notification-definitions/{id}
td
Update a notification definition
tr
td
em
OAuthApi
td
strong
create_token
td
strong
POST
 /oauth/token
td
Create an OAuth token
tr
td
em
ObjectQueriesApi
td
query_account_by_key
td
strong
GET
 /object-query/accounts/{key}
td
Retrieve an account
tr
td
em
ObjectQueriesApi
td
query_accounts
td
strong
GET
 /object-query/accounts
td
List accounts
tr
td
em
ObjectQueriesApi
td
query_amendment_by_key
td
strong
GET
 /object-query/amendments/{key}
td
Retrieve an amendment
tr
td
em
ObjectQueriesApi
td
query_amendments
td
strong
GET
 /object-query/amendments
td
List amendments
tr
td
em
ObjectQueriesApi
td
query_billing_run_by_key
td
strong
GET
 /object-query/billing-runs/{key}
td
Retrieve a bill run
tr
td
em
ObjectQueriesApi
td
query_billing_runs
td
strong
GET
 /object-query/billing-runs
td
List bill runs
tr
td
em
ObjectQueriesApi
td
query_contact_by_key
td
strong
GET
 /object-query/contacts/{key}
td
Retrieve a contact
tr
td
em
ObjectQueriesApi
td
query_contacts
td
strong
GET
 /object-query/contacts
td
List contacts
tr
td
em
ObjectQueriesApi
td
query_credit_memo_application_by_key
td
strong
GET
 /object-query/credit-memo-applications/{key}
td
Retrieve a credit memo application
tr
td
em
ObjectQueriesApi
td
query_credit_memo_applications
td
strong
GET
 /object-query/credit-memo-applications
td
List credit memo applications
tr
td
em
ObjectQueriesApi
td
query_credit_memo_by_key
td
strong
GET
 /object-query/credit-memos/{key}
td
Retrieve a credit memo
tr
td
em
ObjectQueriesApi
td
query_credit_memo_item_by_key
td
strong
GET
 /object-query/credit-memo-items/{key}
td
Retrieve a credit memo item
tr
td
em
ObjectQueriesApi
td
query_credit_memo_items
td
strong
GET
 /object-query/credit-memo-items
td
List credit memo items
tr
td
em
ObjectQueriesApi
td
query_credit_memos
td
strong
GET
 /object-query/credit-memos
td
List credit memos
tr
td
em
ObjectQueriesApi
td
query_custom_object_bykey
td
strong
GET
 /object-query/{custom-object-name}/{key}
td
Retrieve a custom object
tr
td
em
ObjectQueriesApi
td
query_custom_objects
td
strong
GET
 /object-query/{custom-object-name}
td
List custom objects
tr
td
em
ObjectQueriesApi
td
query_daily_consumption_summary_by_key
td
strong
GET
 /object-query/daily-consumption-summaries/{key}
td
Retrieve a daily consumption summary
tr
td
em
ObjectQueriesApi
td
query_daily_consumption_summarys
td
strong
GET
 /object-query/daily-consumption-summaries
td
List daily consumption summaries
tr
td
em
ObjectQueriesApi
td
query_debit_memo_by_key
td
strong
GET
 /object-query/debit-memos/{key}
td
Retrieve a debit memo
tr
td
em
ObjectQueriesApi
td
query_debit_memo_item_by_key
td
strong
GET
 /object-query/debit-memo-items/{key}
td
Retrieve a debit memo item
tr
td
em
ObjectQueriesApi
td
query_debit_memo_items
td
strong
GET
 /object-query/debit-memo-items
td
List debit memo items
tr
td
em
ObjectQueriesApi
td
query_debit_memos
td
strong
GET
 /object-query/debit-memos
td
List debit memos
tr
td
em
ObjectQueriesApi
td
query_invoice_by_key
td
strong
GET
 /object-query/invoices/{key}
td
Retrieve an invoice
tr
td
em
ObjectQueriesApi
td
query_invoice_item_by_key
td
strong
GET
 /object-query/invoice-items/{key}
td
Retrieve an invoice item
tr
td
em
ObjectQueriesApi
td
query_invoice_items
td
strong
GET
 /object-query/invoice-items
td
List invoice items
tr
td
em
ObjectQueriesApi
td
query_invoices
td
strong
GET
 /object-query/invoices
td
List invoices
tr
td
em
ObjectQueriesApi
td
strong
query_invoice_schedule_by_key
td
strong
GET
 /object-query/invoice-schedules/{key}
td
Retrieve an invoice schedule
tr
td
em
ObjectQueriesApi
td
strong
query_invoice_schedules
td
strong
GET
 /object-query/invoice-schedules
td
List invoice schedules
tr
td
em
ObjectQueriesApi
td
query_order_action_by_key
td
strong
GET
 /object-query/order-actions/{key}
td
Retrieve an order action
tr
td
em
ObjectQueriesApi
td
query_order_actions
td
strong
GET
 /object-query/order-actions
td
List order actions
tr
td
em
ObjectQueriesApi
td
query_order_line_item_by_key
td
strong
GET
 /object-query/order-line-items/{key}
td
Retrieve an order line item
tr
td
em
ObjectQueriesApi
td
query_order_line_items
td
strong
GET
 /object-query/order-line-items
td
List order line items
tr
td
em
ObjectQueriesApi
td
query_orders_by_key
td
strong
GET
 /object-query/orders/{key}
td
Retrieve an order
tr
td
em
ObjectQueriesApi
td
query_orderss
td
strong
GET
 /object-query/orders
td
List orders
tr
td
em
ObjectQueriesApi
td
query_payment_application_by_key
td
strong
GET
 /object-query/payment-applications/{key}
td
Retrieve a payment application
tr
td
em
ObjectQueriesApi
td
query_payment_applications
td
strong
GET
 /object-query/payment-applications
td
List payment applications
tr
td
em
ObjectQueriesApi
td
query_payment_by_key
td
strong
GET
 /object-query/payments/{key}
td
Retrieve a payment
tr
td
em
ObjectQueriesApi
td
query_payment_method_by_key
td
strong
GET
 /object-query/payment-methods/{key}
td
Retrieve a payment method
tr
td
em
ObjectQueriesApi
td
query_payment_method_snapshot_by_key
td
strong
GET
 /object-query/payment-method-snapshots/{key}
td
Retrieve a payment method snapshot
tr
td
em
ObjectQueriesApi
td
query_payment_method_snapshots
td
strong
GET
 /object-query/payment-method-snapshots
td
List payment method snapshots
tr
td
em
ObjectQueriesApi
td
query_payment_methods
td
strong
GET
 /object-query/payment-methods
td
List payment methods
tr
td
em
ObjectQueriesApi
td
query_payment_run_by_key
td
strong
GET
 /object-query/payment-runs/{key}
td
Retrieve a payment run
tr
td
em
ObjectQueriesApi
td
query_payment_runs
td
strong
GET
 /object-query/payment-runs
td
List payment runs
tr
td
em
ObjectQueriesApi
td
query_payment_schedule_by_key
td
strong
GET
 /object-query/payment-schedules/{key}
td
Retrieve a payment schedule
tr
td
em
ObjectQueriesApi
td
query_payment_schedule_item_by_key
td
strong
GET
 /object-query/payment-schedule-items/{key}
td
Retrieve a payment schedule item
tr
td
em
ObjectQueriesApi
td
query_payment_schedule_items
td
strong
GET
 /object-query/payment-schedule-items
td
List payment schedule items
tr
td
em
ObjectQueriesApi
td
query_payment_schedules
td
strong
GET
 /object-query/payment-schedules
td
List payment schedules
tr
td
em
ObjectQueriesApi
td
query_payments
td
strong
GET
 /object-query/payments
td
List payments
tr
td
em
ObjectQueriesApi
td
query_prepaid_balance_by_key
td
strong
GET
 /object-query/prepaid-balances/{key}
td
Retrieve a prepaid balance
tr
td
em
ObjectQueriesApi
td
query_prepaid_balance_fund_by_key
td
strong
GET
 /object-query/prepaid-balance-funds/{key}
td
Retrieve a prepaid balance fund
tr
td
em
ObjectQueriesApi
td
query_prepaid_balance_funds
td
strong
GET
 /object-query/prepaid-balance-funds
td
List prepaid balance funds
tr
td
em
ObjectQueriesApi
td
query_prepaid_balance_transaction_by_key
td
strong
GET
 /object-query/prepaid-balance-transactions/{key}
td
Retrieve a prepaid balance transaction
tr
td
em
ObjectQueriesApi
td
query_prepaid_balance_transactions
td
strong
GET
 /object-query/prepaid-balance-transactions
td
List prepaid balance transactions
tr
td
em
ObjectQueriesApi
td
query_prepaid_balances
td
strong
GET
 /object-query/prepaid-balances
td
List prepaid balances
tr
td
em
ObjectQueriesApi
td
query_processed_usage_by_key
td
strong
GET
 /object-query/processed-usages/{key}
td
Retrieve a processed usage record
tr
td
em
ObjectQueriesApi
td
query_processed_usages
td
strong
GET
 /object-query/processed-usages
td
List processed usage records
tr
td
em
ObjectQueriesApi
td
query_product_by_key
td
strong
GET
 /object-query/products/{key}
td
Retrieve a product
tr
td
em
ObjectQueriesApi
td
query_product_rate_plan_by_key
td
strong
GET
 /object-query/product-rate-plans/{key}
td
Retrieve a product rate plan
tr
td
em
ObjectQueriesApi
td
query_product_rate_plan_charge_by_key
td
strong
GET
 /object-query/product-rate-plan-charges/{key}
td
Retrieve a product rate plan charge
tr
td
em
ObjectQueriesApi
td
query_product_rate_plan_charge_tier_by_key
td
strong
GET
 /object-query/product-rate-plan-charge-tiers/{key}
td
Retrieve a product rate plan charge tier
tr
td
em
ObjectQueriesApi
td
query_product_rate_plan_charge_tiers
td
strong
GET
 /object-query/product-rate-plan-charge-tiers
td
List product rate plan charge tiers
tr
td
em
ObjectQueriesApi
td
query_product_rate_plan_charges
td
strong
GET
 /object-query/product-rate-plan-charges
td
List product rate plan charges
tr
td
em
ObjectQueriesApi
td
query_product_rate_plans
td
strong
GET
 /object-query/product-rate-plans
td
List product rate plans
tr
td
em
ObjectQueriesApi
td
query_products
td
strong
GET
 /object-query/products
td
List products
tr
td
em
ObjectQueriesApi
td
query_rate_plan_by_key
td
strong
GET
 /object-query/rate-plans/{key}
td
Retrieve a rate plan
tr
td
em
ObjectQueriesApi
td
query_rate_plan_charge_by_key
td
strong
GET
 /object-query/rate-plan-charges/{key}
td
Retrieve a rate plan charge
tr
td
em
ObjectQueriesApi
td
query_rate_plan_charge_tier_by_key
td
strong
GET
 /object-query/rate-plan-charge-tiers/{key}
td
Retrieve a rate plan charge tier
tr
td
em
ObjectQueriesApi
td
query_rate_plan_charge_tiers
td
strong
GET
 /object-query/rate-plan-charge-tiers
td
List rate plan charge tiers
tr
td
em
ObjectQueriesApi
td
query_rate_plan_charges
td
strong
GET
 /object-query/rate-plan-charges
td
List rate plan charges
tr
td
em
ObjectQueriesApi
td
query_rate_plans
td
strong
GET
 /object-query/rate-plans
td
List rate plans
tr
td
em
ObjectQueriesApi
td
strong
query_rating_detail_by_key
td
strong
GET
 /object-query/rating-details/{key}
td
Retrieve a rating detail
tr
td
em
ObjectQueriesApi
td
strong
query_rating_details
td
strong
GET
 /object-query/rating-details
td
List rating details
tr
td
em
ObjectQueriesApi
td
query_rating_result_by_key
td
strong
GET
 /object-query/rating-results/{key}
td
Retrieve a rating result
tr
td
em
ObjectQueriesApi
td
query_rating_results
td
strong
GET
 /object-query/rating-results
td
List rating results
tr
td
em
ObjectQueriesApi
td
query_refund_application_by_key
td
strong
GET
 /object-query/refund-applications/{key}
td
Retrieve a refund application
tr
td
em
ObjectQueriesApi
td
query_refund_application_item_by_key
td
strong
GET
 /object-query/refund-application-items/{key}
td
Retrieve a refund application item
tr
td
em
ObjectQueriesApi
td
query_refund_application_items
td
strong
GET
 /object-query/refund-application-items
td
List refund application items
tr
td
em
ObjectQueriesApi
td
query_refund_applications
td
strong
GET
 /object-query/refund-applications
td
List refund applications
tr
td
em
ObjectQueriesApi
td
query_refund_by_key
td
strong
GET
 /object-query/refunds/{key}
td
Retrieve a refund
tr
td
em
ObjectQueriesApi
td
query_refunds
td
strong
GET
 /object-query/refunds
td
List refunds
tr
td
em
ObjectQueriesApi
td
query_subscription_by_key
td
strong
GET
 /object-query/subscriptions/{key}
td
Retrieve a subscription
tr
td
em
ObjectQueriesApi
td
query_subscriptions
td
strong
GET
 /object-query/subscriptions
td
List subscriptions
tr
td
em
ObjectQueriesApi
td
query_summary_statement_by_key
td
strong
GET
 /object-query/summarystatements/{key}
td
Retrieve a summary statement
tr
td
em
ObjectQueriesApi
td
query_summary_statement_run_by_key
td
strong
GET
 /object-query/summarystatementruns/{key}
td
Retrieve a summary statement run
tr
td
em
ObjectQueriesApi
td
query_summary_statement_runs
td
strong
GET
 /object-query/summarystatementruns
td
List summary statement runs
tr
td
em
ObjectQueriesApi
td
query_summary_statements
td
strong
GET
 /object-query/summarystatements
td
List summary statements
tr
td
em
ObjectQueriesApi
td
query_taxation_item_by_key
td
strong
GET
 /object-query/taxation-items/{key}
td
Retrieve a taxation item
tr
td
em
ObjectQueriesApi
td
query_taxation_items
td
strong
GET
 /object-query/taxation-items
td
List taxation items
tr
td
em
ObjectQueriesApi
td
query_usage_by_key
td
strong
GET
 /object-query/usages/{key}
td
Retrieve a usage record
tr
td
em
ObjectQueriesApi
td
query_usages
td
strong
GET
 /object-query/usages
td
List usage records
tr
td
em
ObjectQueriesApi
td
query_validity_period_summary_by_key
td
strong
GET
 /object-query/validity-period-summaries/{key}
td
Retrieve a validity period summary
tr
td
em
ObjectQueriesApi
td
query_validity_period_summarys
td
strong
GET
 /object-query/validity-period-summaries
td
List validity period summaries
tr
td
em
OmniChannelSubscriptionsApi
td
strong
create_omni_channel_subscription
td
strong
POST
 /v1/omni-channel-subscriptions
td
Create an omnichannel subscription
tr
td
em
OmniChannelSubscriptionsApi
td
strong
delete_omni_channel_subscription
td
strong
DELETE
 /v1/omni-channel-subscriptions/{subscriptionKey}
td
Delete an omnichannel subscription
tr
td
em
OmniChannelSubscriptionsApi
td
strong
get_omni_channel_subscription
td
strong
GET
 /v1/omni-channel-subscriptions/{subscriptionKey}
td
Retrieve an omnichannel subscription
tr
td
em
OperationsApi
td
strong
create_billing_preview
td
strong
POST
 /v1/operations/billing-preview
td
Generate a billing preview
tr
td
em
OperationsApi
td
strong
create_bulk_pdfto_zip_generation
td
strong
POST
 /v1/operations/bulk-pdf
td
Export bulk PDF files
tr
td
em
OperationsApi
td
strong
create_invoice_collect
td
strong
POST
 /v1/operations/invoice-collect
td
Invoice and collect
tr
td
em
OperationsApi
td
strong
get_bulk_pdfto_zip_generation
td
strong
GET
 /v1/operations/bulk-pdf/{jobId}
td
Retrieve information of a bulk PDF file generation job
tr
td
em
OperationsApi
td
strong
get_operation_job
td
strong
GET
 /v1/operations/jobs/{jobId}
td
Retrieve an operation job
tr
td
em
OrderActionsApi
td
strong
update_order_action
td
strong
PUT
 /v1/orderActions/{id}
td
Update an order action
tr
td
em
OrderLineItemsApi
td
strong
get_order_line_item
td
strong
GET
 /v1/order-line-items/{itemId}
td
Retrieve an order line item
tr
td
em
OrderLineItemsApi
td
strong
update_order_line_item
td
strong
PUT
 /v1/order-line-items/{itemId}
td
Update an order line item
tr
td
em
OrderLineItemsApi
td
strong
update_order_line_items
td
strong
POST
 /v1/order-line-items/bulk
td
Update order line items
tr
td
em
OrdersApi
td
strong
activate_order
td
strong
PUT
 /v1/orders/{orderNumber}/activate
td
Activate an order
tr
td
em
OrdersApi
td
strong
cancel_order
td
strong
PUT
 /v1/orders/{orderNumber}/cancel
td
Cancel an order
tr
td
em
OrdersApi
td
strong
create_order
td
strong
POST
 /v1/orders
td
Create an order
tr
td
em
OrdersApi
td
strong
create_order_asynchronously
td
strong
POST
 /v1/async/orders
td
Create an order asynchronously
tr
td
em
OrdersApi
td
strong
delete_order
td
strong
DELETE
 /v1/orders/{orderNumber}
td
Delete an order
tr
td
em
OrdersApi
td
strong
delete_order_asynchronously
td
strong
DELETE
 /v1/async/orders/{orderNumber}
td
Async delete an order
tr
td
em
OrdersApi
td
strong
get_job_status_and_response
td
strong
GET
 /v1/async-jobs/{jobId}
td
Retrieve the status and response of a job
tr
td
em
OrdersApi
td
strong
get_order
td
strong
GET
 /v1/orders/{orderNumber}
td
Retrieve an order
tr
td
em
OrdersApi
td
strong
get_orders
td
strong
GET
 /v1/orders
td
List orders
tr
td
em
OrdersApi
td
strong
get_orders_by_invoice_owner
td
strong
GET
 /v1/orders/invoiceOwner/{accountNumber}
td
List orders of an invoice owner
tr
td
em
OrdersApi
td
strong
get_orders_by_subscription_number
td
strong
GET
 /v1/orders/subscription/{subscriptionNumber}
td
List orders by subscription number
tr
td
em
OrdersApi
td
strong
get_orders_by_subscription_owner
td
strong
GET
 /v1/orders/subscriptionOwner/{accountNumber}
td
List orders of a subscription owner
tr
td
em
OrdersApi
td
strong
get_pending_orders_by_subscription_number
td
strong
GET
 /v1/orders/subscription/{subscription-key}/pending
td
List pending orders by subscription number
tr
td
em
OrdersApi
td
strong
preview_order
td
strong
POST
 /v1/orders/preview
td
Preview an order
tr
td
em
OrdersApi
td
strong
preview_order_asynchronously
td
strong
POST
 /v1/async/orders/preview
td
Preview an order asynchronously
tr
td
em
OrdersApi
td
strong
revert_order
td
strong
POST
 /v1/orders/{orderNumber}/revert
td
Revert an order
tr
td
em
OrdersApi
td
strong
update_order
td
strong
PUT
 /v1/orders/{orderNumber}
td
Update an order
tr
td
em
OrdersApi
td
strong
update_order_custom_fields
td
strong
PUT
 /v1/orders/{orderNumber}/customFields
td
Update order custom fields
tr
td
em
OrdersApi
td
strong
update_order_trigger_dates
td
strong
PUT
 /v1/orders/{orderNumber}/triggerDates
td
Update order action trigger dates
tr
td
em
OrdersApi
td
strong
update_subscription_custom_fields
td
strong
PUT
 /v1/subscriptions/{subscriptionNumber}/customFields
td
Update subscription custom fields
tr
td
em
PaymentAuthorizationApi
td
strong
cancel_authorization
td
strong
POST
 /v1/payment-methods/{payment-method-id}/voidAuthorize
td
Cancel authorization
tr
td
em
PaymentAuthorizationApi
td
strong
create_authorization
td
strong
POST
 /v1/payment-methods/{payment-method-id}/authorize
td
Create authorization
tr
td
em
PaymentGatewayReconciliationApi
td
strong
reconcile_refund
td
strong
POST
 /v1/refunds/{refund-key}/reconcile
td
Reconcile a refund
tr
td
em
PaymentGatewayReconciliationApi
td
strong
reject_payment
td
strong
POST
 /v1/gateway-settlement/payments/{payment-key}/reject
td
Reject a payment
tr
td
em
PaymentGatewayReconciliationApi
td
strong
reverse_payment
td
strong
POST
 /v1/gateway-settlement/payments/{payment-key}/chargeback
td
Reverse a payment
tr
td
em
PaymentGatewayReconciliationApi
td
strong
settle_payment
td
strong
POST
 /v1/gateway-settlement/payments/{payment-key}/settle
td
Settle a payment
tr
td
em
PaymentGatewaysApi
td
strong
create_predebit_notification
td
strong
POST
 /v1/payment-gateways/pre-debit-notification
td
Trigger a pre-debit notification
tr
td
em
PaymentGatewaysApi
td
strong
get_payment_gateways
td
strong
GET
 /v1/payment-gateways
td
List all payment gateways
tr
td
em
PaymentMethodSnapshotsApi
td
strong
get_payment_method_snapshot
td
strong
GET
 /v1/object/payment-method-snapshot/{id}
td
CRUD: Retrieve a payment method snapshot
tr
td
em
PaymentMethodTransactionLogsApi
td
strong
get_payment_method_transaction_log
td
strong
GET
 /v1/object/payment-method-transaction-log/{id}
td
CRUD: Retrieve a payment method transaction log
tr
td
em
PaymentMethodUpdaterApi
td
strong
create_payment_method_updater_batch
td
strong
POST
 /v1/payment-method-updaters/batches
td
Create a payment method updater batch asynchronously
tr
td
em
PaymentMethodUpdaterApi
td
strong
get_payment_method_updater_instances
td
strong
GET
 /v1/payment-method-updaters
td
List payment method updater instances
tr
td
em
PaymentMethodsApi
td
strong
cancel_stored_credential_profile
td
strong
POST
 /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel
td
Cancel a stored credential profile
tr
td
em
PaymentMethodsApi
td
strong
create_payment_method
td
strong
POST
 /v1/payment-methods
td
Create a payment method
tr
td
em
PaymentMethodsApi
td
strong
create_payment_session
td
strong
POST
 /web-payments/sessions
td
Create a payment session
tr
td
em
PaymentMethodsApi
td
strong
create_stored_credential_profile
td
strong
POST
 /v1/payment-methods/{payment-method-id}/profiles
td
Create a stored credential profile
tr
td
em
PaymentMethodsApi
td
strong
decrypt_payment_method
td
strong
POST
 /v1/payment-methods/decryption
td
Create an Apple Pay payment method
tr
td
em
PaymentMethodsApi
td
strong
delete_payment_method
td
strong
DELETE
 /v1/payment-methods/{payment-method-id}
td
Delete a payment method
tr
td
em
PaymentMethodsApi
td
strong
expire_stored_credential_profile
td
strong
POST
 /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire
td
Expire a stored credential profile
tr
td
em
PaymentMethodsApi
td
strong
get_payment_method
td
strong
GET
 /v1/payment-methods/{payment-method-id}
td
Retrieve a payment method
tr
td
em
PaymentMethodsApi
td
strong
get_stored_credential_profiles
td
strong
GET
 /v1/payment-methods/{payment-method-id}/profiles
td
List stored credential profiles of a payment method
tr
td
em
PaymentMethodsApi
td
strong
scrub_payment_method
td
strong
PUT
 /v1/payment-methods/{payment-method-id}/scrub
td
Scrub a payment method
tr
td
em
PaymentMethodsApi
td
strong
update_payment_method
td
strong
PUT
 /v1/payment-methods/{payment-method-id}
td
Update a payment method
tr
td
em
PaymentMethodsApi
td
strong
verify_payment_method
td
strong
PUT
 /v1/payment-methods/{payment-method-id}/verify
td
Verify a payment method
tr
td
em
PaymentRunsApi
td
strong
create_payment_run
td
strong
POST
 /v1/payment-runs
td
Create a payment run
tr
td
em
PaymentRunsApi
td
strong
delete_payment_run
td
strong
DELETE
 /v1/payment-runs/{paymentRunKey}
td
Delete a payment run
tr
td
em
PaymentRunsApi
td
strong
get_payment_run
td
strong
GET
 /v1/payment-runs/{paymentRunKey}
td
Retrieve a payment run
tr
td
em
PaymentRunsApi
td
strong
get_payment_run_data
td
strong
GET
 /v1/payment-runs/{paymentRunKey}/data
td
Retrieve payment run data
tr
td
em
PaymentRunsApi
td
strong
get_payment_run_summary
td
strong
GET
 /v1/payment-runs/{paymentRunKey}/summary
td
Retrieve a payment run summary
tr
td
em
PaymentRunsApi
td
strong
get_payment_runs
td
strong
GET
 /v1/payment-runs
td
List payment runs
tr
td
em
PaymentRunsApi
td
strong
update_payment_run
td
strong
PUT
 /v1/payment-runs/{paymentRunKey}
td
Update a payment run
tr
td
em
PaymentSchedulesApi
td
strong
add_items_to_custom_payment_schedule
td
strong
POST
 /v1/payment-schedules/{paymentScheduleKey}/items
td
Add payment schedule items to a custom payment schedule
tr
td
em
PaymentSchedulesApi
td
strong
cancel_payment_schedule
td
strong
PUT
 /v1/payment-schedules/{paymentScheduleKey}/cancel
td
Cancel a payment schedule
tr
td
em
PaymentSchedulesApi
td
strong
cancel_payment_schedule_item
td
strong
PUT
 /v1/payment-schedule-items/{item-id}/cancel
td
Cancel a payment schedule item
tr
td
em
PaymentSchedulesApi
td
strong
create_payment_schedule
td
strong
POST
 /v1/payment-schedules
td
Create a payment schedule
tr
td
em
PaymentSchedulesApi
td
strong
create_payment_schedules
td
strong
POST
 /v1/payment-schedules/batch
td
Create multiple payment schedules at once
tr
td
em
PaymentSchedulesApi
td
strong
get_payment_schedule
td
strong
GET
 /v1/payment-schedules/{paymentScheduleKey}
td
Retrieve a payment schedule
tr
td
em
PaymentSchedulesApi
td
strong
get_payment_schedule_item
td
strong
GET
 /v1/payment-schedule-items/{item-id}
td
Retrieve a payment schedule item
tr
td
em
PaymentSchedulesApi
td
strong
get_payment_schedule_statistic
td
strong
GET
 /v1/payment-schedules/statistics/{yyyy-mm-dd}
td
Retrieve payment schedule statistic of a date
tr
td
em
PaymentSchedulesApi
td
strong
get_payment_schedules
td
strong
GET
 /v1/payment-schedules
td
List payment schedules by customer account
tr
td
em
PaymentSchedulesApi
td
strong
retry_payment_schedule_item
td
strong
POST
 /v1/payment-schedule-items/retry-payment
td
Retry failed payment schedule items
tr
td
em
PaymentSchedulesApi
td
strong
skip_payment_schedule_item
td
strong
PUT
 /v1/payment-schedule-items/{item-id}/skip
td
Skip a payment schedule item
tr
td
em
PaymentSchedulesApi
td
strong
update_payment_schedule
td
strong
PUT
 /v1/payment-schedules/{paymentScheduleKey}
td
Update a payment schedule
tr
td
em
PaymentSchedulesApi
td
strong
update_payment_schedule_item
td
strong
PUT
 /v1/payment-schedule-items/{item-id}
td
Update a payment schedule item
tr
td
em
PaymentSchedulesApi
td
strong
update_payment_schedule_preview
td
strong
PUT
 /v1/payment-schedules/{paymentScheduleKey}/preview
td
Preview the result of payment schedule updates
tr
td
em
PaymentTransactionLogsApi
td
strong
get_payment_transaction_log
td
strong
GET
 /v1/object/payment-transaction-log/{id}
td
CRUD: Retrieve a payment transaction log
tr
td
em
PaymentsApi
td
strong
apply_payment
td
strong
PUT
 /v1/payments/{paymentKey}/apply
td
Apply a payment
tr
td
em
PaymentsApi
td
strong
cancel_payment
td
strong
PUT
 /v1/payments/{paymentKey}/cancel
td
Cancel a payment
tr
td
em
PaymentsApi
td
strong
create_payment
td
strong
POST
 /v1/payments
td
Create a payment
tr
td
em
PaymentsApi
td
strong
create_refund_payment
td
strong
POST
 /v1/payments/{paymentKey}/refunds
td
Refund a payment
tr
td
em
PaymentsApi
td
strong
delete_payment
td
strong
DELETE
 /v1/payments/{paymentKey}
td
Delete a payment
tr
td
em
PaymentsApi
td
strong
get_payment
td
strong
GET
 /v1/payments/{paymentKey}
td
Retrieve a payment
tr
td
em
PaymentsApi
td
strong
get_payment_item_part
td
strong
GET
 /v1/payments/{paymentKey}/parts/{partId}/item-parts/{itemPartId}
td
Retrieve a payment part item
tr
td
em
PaymentsApi
td
strong
get_payment_item_parts
td
strong
GET
 /v1/payments/{paymentKey}/parts/{partId}/item-parts
td
List all payment part items
tr
td
em
PaymentsApi
td
strong
get_payment_part
td
strong
GET
 /v1/payments/{paymentKey}/parts/{partId}
td
Retrieve a payment part
tr
td
em
PaymentsApi
td
strong
get_payment_parts
td
strong
GET
 /v1/payments/{paymentKey}/parts
td
List all parts of a payment
tr
td
em
PaymentsApi
td
strong
get_retrieve_all_payments
td
strong
GET
 /v1/payments
td
List payments
tr
td
em
PaymentsApi
td
strong
refund_paymentwith_auto_unapply
td
strong
POST
 /v1/payments/{paymentKey}/refunds/unapply
td
Refund a payment with auto-unapplying
tr
td
em
PaymentsApi
td
strong
transfer_payment
td
strong
PUT
 /v1/payments/{paymentKey}/transfer
td
Transfer a payment
tr
td
em
PaymentsApi
td
strong
unapply_payment
td
strong
PUT
 /v1/payments/{paymentKey}/unapply
td
Unapply a payment
tr
td
em
PaymentsApi
td
strong
update_payment
td
strong
PUT
 /v1/payments/{paymentId}
td
Update a payment
tr
td
em
ProductRatePlanChargeTiersApi
td
strong
get_product_rate_plan_charge_tier
td
strong
GET
 /v1/object/product-rate-plan-charge-tier/{id}
td
CRUD: Retrieve a product rate plan charge tier
tr
td
em
ProductRatePlanChargeTiersApi
td
strong
update_product_rate_plan_charge_tier
td
strong
PUT
 /v1/object/product-rate-plan-charge-tier/{id}
td
CRUD: Update a product rate plan charge tier
tr
td
em
ProductRatePlanChargesApi
td
strong
create_product_rate_plan_charge
td
strong
POST
 /v1/object/product-rate-plan-charge
td
CRUD: Create a product rate plan charge
tr
td
em
ProductRatePlanChargesApi
td
strong
delete_product_rate_plan_charge
td
strong
DELETE
 /v1/object/product-rate-plan-charge/{id}
td
CRUD: Delete a product rate plan charge
tr
td
em
ProductRatePlanChargesApi
td
strong
get_product_rate_plan_charge
td
strong
GET
 /v1/object/product-rate-plan-charge/{id}
td
CRUD: Retrieve a product rate plan charge
tr
td
em
ProductRatePlanChargesApi
td
strong
update_product_rate_plan_charge
td
strong
PUT
 /v1/object/product-rate-plan-charge/{id}
td
CRUD: Update a product rate plan charge
tr
td
em
ProductRatePlanChargesApi
td
strong
update_product_rate_plan_charge_finance_information
td
strong
PUT
 /v1/product-rate-plan-charges/{product-rate-plan-charge-key}/finance-information
td
Update a Zuora Revenue accounting code
tr
td
em
ProductRatePlansApi
td
strong
create_product_rate_plan
td
strong
POST
 /v1/object/product-rate-plan
td
CRUD: Create a product rate plan
tr
td
em
ProductRatePlansApi
td
strong
delete_product_rate_plan
td
strong
DELETE
 /v1/object/product-rate-plan/{id}
td
CRUD: Delete a product rate plan
tr
td
em
ProductRatePlansApi
td
strong
get_product_rate_plan
td
strong
GET
 /v1/product-rate-plans/{id}
td
Retrieve a product rate plan by ID
tr
td
em
ProductRatePlansApi
td
strong
get_product_rate_plans_by_external_id
td
strong
GET
 /v1/product-rate-plans/external-id/{externalId}
td
List product rate plans by external ID
tr
td
em
ProductRatePlansApi
td
strong
get_rate_plans_by_product
td
strong
GET
 /v1/rateplan/{product-key}/productRatePlan
td
List all product rate plans of a product
tr
td
em
ProductRatePlansApi
td
strong
update_product_rate_plan
td
strong
PUT
 /v1/object/product-rate-plan/{id}
td
CRUD: Update a product rate plan
tr
td
em
ProductsApi
td
strong
create_product
td
strong
POST
 /v1/object/product
td
Create a product
tr
td
em
ProductsApi
td
strong
delete_product
td
strong
DELETE
 /v1/object/product/{id}
td
CRUD: Delete a product
tr
td
em
ProductsApi
td
strong
get_product
td
strong
GET
 /v1/catalog/product/{product-key}
td
Retrieve a product
tr
td
em
ProductsApi
td
strong
get_products
td
strong
GET
 /v1/catalog/products
td
Get all products
tr
td
em
ProductsApi
td
strong
update_product
td
strong
PUT
 /v1/object/product/{id}
td
CRUD: Update a product
tr
td
em
RSASignaturesApi
td
strong
create_rsa_signature
td
strong
POST
 /v1/rsa-signatures
td
Generate an RSA signature
tr
td
em
RSASignaturesApi
td
strong
decrypt_rsa_signature
td
strong
POST
 /v1/rsa-signatures/decrypt
td
Decrypt an RSA signature
tr
td
em
RampsApi
td
strong
get_ramp_by_number
td
strong
GET
 /v1/ramps/{rampNumber}
td
Retrieve a ramp
tr
td
em
RampsApi
td
strong
get_ramp_metrics_by_number
td
strong
GET
 /v1/ramps/{rampNumber}/ramp-metrics
td
List all ramp metrics of a ramp
tr
td
em
RampsApi
td
strong
get_ramp_metrics_by_order_number
td
strong
GET
 /v1/orders/{orderNumber}/ramp-metrics
td
List ramp metrics by order number
tr
td
em
RampsApi
td
strong
get_ramp_metrics_by_subscription_key
td
strong
GET
 /v1/subscriptions/{subscriptionKey}/ramp-metrics
td
List ramp metrics by subscription key
tr
td
em
RampsApi
td
strong
get_ramps_by_subscription_key
td
strong
GET
 /v1/subscriptions/{subscriptionKey}/ramps
td
Retrieve a ramp by subscription key
tr
td
em
RatePlansApi
td
strong
get_rate_plan
td
strong
GET
 /v1/rateplans/{ratePlanId}
td
Retrieve a rate plan
tr
td
em
RefundsApi
td
strong
cancel_refund
td
strong
PUT
 /v1/refunds/{refundKey}/cancel
td
Cancel a refund
tr
td
em
RefundsApi
td
strong
delete_refund
td
strong
DELETE
 /v1/refunds/{refundKey}
td
Delete a refund
tr
td
em
RefundsApi
td
strong
get_refund
td
strong
GET
 /v1/refunds/{refundKey}
td
Retrieve a refund
tr
td
em
RefundsApi
td
strong
get_refund_item_part
td
strong
GET
 /v1/refunds/{refundKey}/parts/{refundPartId}/item-parts/{itemPartId}
td
Retrieve a refund part item
tr
td
em
RefundsApi
td
strong
get_refund_item_parts
td
strong
GET
 /v1/refunds/{refundKey}/parts/{refundPartId}/item-parts
td
List all refund part items
tr
td
em
RefundsApi
td
strong
get_refund_part
td
strong
GET
 /v1/refunds/{refundKey}/parts/{refundPartId}
td
Retrieve a refund part
tr
td
em
RefundsApi
td
strong
get_refund_parts
td
strong
GET
 /v1/refunds/{refundKey}/parts
td
List all parts of a refund
tr
td
em
RefundsApi
td
strong
get_refunds
td
strong
GET
 /v1/refunds
td
List refunds
tr
td
em
RefundsApi
td
strong
update_refund
td
strong
PUT
 /v1/refunds/{refundId}
td
Update a refund
tr
td
em
RegenerateApi
td
strong
p_ost_create_rev_rec_events
td
strong
POST
 /v1/uno-regenerate/rev-rec-events
td
Regenerate Rev Rec Event
tr
td
em
RegenerateApi
td
strong
p_ost_generate_rev_rec_events_for_daily_consumption
td
strong
POST
 /v1/uno-regenerate/rev-rec-events/daily-consumption
td
Regenerate Rev Rec Event
tr
td
em
RegenerateApi
td
strong
p_ost_regenerate_billing_transaction
td
strong
POST
 /v1/uno-regenerate/billing-transaction
td
Regenerate Billing Transaction
tr
td
em
RegenerateApi
td
strong
p_ost_regenerate_booking_transaction
td
strong
POST
 /v1/uno-regenerate/booking-transaction
td
Regenerate Booking Transaction
tr
td
em
RevenueIntegrationApi
td
strong
describe_view_columns
td
strong
GET
 /integration/v2/biviews/{view_name}/describe-columns
td
tr
td
em
RevenueIntegrationApi
td
strong
download_report
td
strong
GET
 /integration/v1/reports/download/{filename}
td
tr
td
em
RevenueIntegrationApi
td
strong
generate_jwt_token
td
strong
POST
 /integration/v1/authenticate
td
tr
td
em
RevenueIntegrationApi
td
strong
get_bi_view_count
td
strong
GET
 /integration/v2/biviews/count/{view_name}
td
tr
td
em
RevenueIntegrationApi
td
strong
get_bi_view_status
td
strong
GET
 /integration/v2/biviews-status
td
tr
td
em
RevenueIntegrationApi
td
strong
get_bi_view_task_details
td
strong
GET
 /integration/v2/biviews-status/{task_id}
td
tr
td
em
RevenueIntegrationApi
td
strong
get_bi_views
td
strong
GET
 /integration/v1/biviews/{view_name}
td
tr
td
em
RevenueIntegrationApi
td
strong
get_bi_views_v2
td
strong
GET
 /integration/v2/biviews/{view_name}
td
tr
td
em
RevenueIntegrationApi
td
strong
get_csv_upload_status
td
strong
GET
 /integration/v1/csv/upload/status
td
tr
td
em
RevenueIntegrationApi
td
strong
get_file_upload_status_by_request_id
td
strong
GET
 /integration/v1/fileupload/status/{file_request_id}
td
tr
td
em
RevenueIntegrationApi
td
strong
get_reports_by_id
td
strong
GET
 /integration/v1/reports/{report_id}
td
tr
td
em
RevenueIntegrationApi
td
strong
get_stage_error
td
strong
GET
 /integration/v1/stage/error/{errortype}
td
tr
td
em
RevenueIntegrationApi
td
strong
integration_v2_reports_signedurl_report_id_get
td
strong
GET
 /integration/v2/reports/signedurl/{report_id}
td
tr
td
em
RevenueIntegrationApi
td
strong
list_reports
td
strong
GET
 /integration/v1/reports/list
td
tr
td
em
RevenueIntegrationApi
td
strong
select_bi_view
td
strong
POST
 /integration/v1/biviews/{view_name}
td
tr
td
em
RevenueIntegrationApi
td
strong
upload_csv
td
strong
POST
 /integration/v1/csv/upload
td
tr
td
em
RevenueIntegrationApi
td
strong
upload_file
td
strong
POST
 /integration/v1/upload/file
td
tr
td
em
RevenueIntegrationApi
td
strong
upload_mapping
td
strong
POST
 /integration/v1/upload/mapping
td
tr
td
em
RevenueAccountingCodesApi
td
strong
put_rev_pro_accounting_codes
td
strong
PUT
 /v1/revpro-accounting-codes
td
Update a Zuora Revenue accounting code
tr
td
em
SequenceSetsApi
td
strong
create_sequence_sets
td
strong
POST
 /v1/sequence-sets
td
Create sequence sets
tr
td
em
SequenceSetsApi
td
strong
delete_sequence_set
td
strong
DELETE
 /v1/sequence-sets/{id}
td
Delete a sequence set
tr
td
em
SequenceSetsApi
td
strong
get_sequence_set
td
strong
GET
 /v1/sequence-sets/{id}
td
Retrieve a sequence set
tr
td
em
SequenceSetsApi
td
strong
get_sequence_sets
td
strong
GET
 /v1/sequence-sets
td
List sequence sets
tr
td
em
SequenceSetsApi
td
strong
update_sequence_set
td
strong
PUT
 /v1/sequence-sets/{id}
td
Update a sequence set
tr
td
em
SettingsApi
td
strong
get_list_all_settings
td
strong
GET
 /settings/listing
td
List all settings
tr
td
em
SettingsApi
td
strong
post_process_settings_batch_request
td
strong
POST
 /settings/batch-requests
td
Submit settings requests
tr
td
em
SignUpApi
td
strong
post_sign_up
td
strong
POST
 /v1/sign-up
td
Sign up
tr
td
em
SubscriptionChangeLogsApi
td
strong
get_subscription_change_logs_by_order_number
td
strong
GET
 /subscription-change-logs/orders/{orderNumber}
td
Retrieve change logs for a subscription
tr
td
em
SubscriptionChangeLogsApi
td
strong
get_subscription_change_logs_by_subscription_number
td
strong
GET
 /subscription-change-logs/{subscriptionNumber}
td
Retrieve change logs for a subscription
tr
td
em
SubscriptionChangeLogsApi
td
strong
get_subscription_change_logs_by_subscription_number_and_version
td
strong
GET
 /subscription-change-logs/{subscriptionNumber}/versions/{version}
td
Retrieve change logs for a subscription
tr
td
em
SubscriptionsApi
td
strong
cancel_subscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/cancel
td
Cancel a subscription
tr
td
em
SubscriptionsApi
td
strong
create_subscription
td
strong
POST
 /v1/subscriptions
td
Create a subscription
tr
td
em
SubscriptionsApi
td
strong
delete_subscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/delete
td
Delete a subscription by number
tr
td
em
SubscriptionsApi
td
strong
get_metrics_by_subscription_numbers
td
strong
GET
 /v1/subscriptions/subscription-metrics
td
List subscriptions metrics by subscription numbers
tr
td
em
SubscriptionsApi
td
strong
get_subscription_by_key
td
strong
GET
 /v1/subscriptions/{subscription-key}
td
Retrieve a subscription by key
tr
td
em
SubscriptionsApi
td
strong
get_subscription_by_key_and_version
td
strong
GET
 /v1/subscriptions/{subscription-key}/versions/{version}
td
Retrieve a subscription by key and version
tr
td
em
SubscriptionsApi
td
strong
get_subscriptions_by_account
td
strong
GET
 /v1/subscriptions/accounts/{account-key}
td
List subscriptions by account key
tr
td
em
SubscriptionsApi
td
strong
preview_existing_subscription
td
strong
POST
 /v1/subscriptions/{subscription-key}/preview
td
Preview a subscription by key
tr
td
em
SubscriptionsApi
td
strong
preview_subscription
td
strong
POST
 /v1/subscriptions/preview
td
Preview a subscription
tr
td
em
SubscriptionsApi
td
strong
renew_subscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/renew
td
Renew a subscription
tr
td
em
SubscriptionsApi
td
strong
resume_subscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/resume
td
Resume a subscription
tr
td
em
SubscriptionsApi
td
strong
suspend_subscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/suspend
td
Suspend a subscription
tr
td
em
SubscriptionsApi
td
strong
update_subscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}
td
Update a subscription
tr
td
em
SubscriptionsApi
td
strong
update_subscription_custom_fields_of_a_specified_version
td
strong
PUT
 /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields
td
Update subscription custom fields of a subscription version
tr
td
em
SummaryJournalEntriesApi
td
strong
cancel_summary_journal_entry
td
strong
PUT
 /v1/journal-entries/{je-number}/cancel
td
Cancel a summary journal entry
tr
td
em
SummaryJournalEntriesApi
td
strong
create_summary_journal_entry
td
strong
POST
 /v1/journal-entries
td
Create a summary journal entry
tr
td
em
SummaryJournalEntriesApi
td
strong
delete_summary_journal_entry
td
strong
DELETE
 /v1/journal-entries/{je-number}
td
Delete a summary journal entry
tr
td
em
SummaryJournalEntriesApi
td
strong
get_all_summary_journal_entries
td
strong
GET
 /v1/journal-entries/journal-runs/{jr-number}
td
List all summary journal entries in a journal run
tr
td
em
SummaryJournalEntriesApi
td
strong
get_summary_journal_entry
td
strong
GET
 /v1/journal-entries/{je-number}
td
Retrieve a summary journal entry
tr
td
em
SummaryJournalEntriesApi
td
strong
update_basic_summary_journal_entry
td
strong
PUT
 /v1/journal-entries/{je-number}/basic-information
td
Update a summary journal entry
tr
td
em
TaxationItemsApi
td
strong
create_taxation_item
td
strong
POST
 /v1/object/taxation-item
td
CRUD: Create a taxation item
tr
td
em
TaxationItemsApi
td
strong
delete_taxation_item
td
strong
DELETE
 /v1/taxation-items/{id}
td
Delete a taxation item
tr
td
em
TaxationItemsApi
td
strong
get_taxation_item
td
strong
GET
 /v1/taxation-items/{id}
td
Retrieve a taxation item 
tr
td
em
TaxationItemsApi
td
strong
put_taxation_item
td
strong
PUT
 /v1/taxation-items/{id}
td
Update a taxation item
tr
td
em
UsageApi
td
strong
create_usage
td
strong
POST
 /v1/object/usage
td
CRUD: Create a usage record
tr
td
em
UsageApi
td
strong
delete_usage
td
strong
DELETE
 /v1/object/usage/{id}
td
CRUD: Delete a usage record
tr
td
em
UsageApi
td
strong
get_usage
td
strong
GET
 /v1/object/usage/{id}
td
CRUD: Retrieve a usage record
tr
td
em
UsageApi
td
strong
get_usage_rate_detail_by_invoice_item
td
strong
GET
 /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail
td
Retrieve usage rate detail for an invoice item
tr
td
em
UsageApi
td
strong
get_usages_by_account
td
strong
GET
 /v1/usage/accounts/{account-key}
td
Retrieve usage records by account
tr
td
em
UsageApi
td
strong
update_usage
td
strong
PUT
 /v1/object/usage/{id}
td
CRUD: Update a usage record
tr
td
em
UsageApi
td
strong
upload_usage_file
td
strong
POST
 /v1/usage
td
Upload a usage file
tr
td
em
WorkflowsApi
td
strong
delete_workflow
td
strong
DELETE
 /workflows/{workflow_id}
td
Delete a workflow
tr
td
em
WorkflowsApi
td
strong
delete_workflow_version
td
strong
DELETE
 /workflows/versions/{version_id}
td
Delete a workflow version
tr
td
em
WorkflowsApi
td
strong
get_workflow
td
strong
GET
 /workflows/{workflow_id}
td
Retrieve a workflow
tr
td
em
WorkflowsApi
td
strong
get_workflow_export
td
strong
GET
 /workflows/{workflow_id}/export
td
Export a workflow version
tr
td
em
WorkflowsApi
td
strong
get_workflow_run
td
strong
GET
 /workflows/workflow_runs/{workflow_run_id}
td
Retrieve a workflow run
tr
td
em
WorkflowsApi
td
strong
get_workflow_versions
td
strong
GET
 /workflows/{workflow_id}/versions
td
List all versions of a workflow definition
tr
td
em
WorkflowsApi
td
strong
get_workflows
td
strong
GET
 /workflows
td
List workflows
tr
td
em
WorkflowsApi
td
strong
get_workflows_task
td
strong
GET
 /workflows/tasks/{task_id}
td
Retrieve a workflow task
tr
td
em
WorkflowsApi
td
strong
get_workflows_tasks
td
strong
GET
 /workflows/tasks
td
List workflow tasks
tr
td
em
WorkflowsApi
td
strong
get_workflows_usages
td
strong
GET
 /workflows/metrics.json
td
Retrieve workflow task usage
tr
td
em
WorkflowsApi
td
strong
p_atch_update_workflow
td
strong
PATCH
 /workflows/{workflow_id}
td
Update a workflow
tr
td
em
WorkflowsApi
td
strong
post_run_workflow
td
strong
POST
 /workflows/{workflow_id}/run
td
Run a workflow
tr
td
em
WorkflowsApi
td
strong
post_workflow_import
td
strong
POST
 /workflows/import
td
Import a workflow
tr
td
em
WorkflowsApi
td
strong
post_workflow_versions_import
td
strong
POST
 /workflows/{workflow_id}/versions/import
td
Import a workflow version
tr
td
em
WorkflowsApi
td
strong
post_workflows_task_rerun
td
strong
POST
 /workflows/tasks/{task_id}/rerun
td
Rerun a workflow task
tr
td
em
WorkflowsApi
td
strong
put_workflows_tasks_update
td
strong
PUT
 /workflows/tasks/batch_update
td
Update workflow tasks