Skip to content

Latest commit

 

History

History
120 lines (80 loc) · 5.67 KB

TransactionsApi.md

File metadata and controls

120 lines (80 loc) · 5.67 KB
Raw

Zuora::TransactionsApi

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

Method HTTP request Description
get_transaction_invoice GET /v1/transactions/invoices/accounts/{account-key} Get invoices
get_transaction_payment GET /v1/transactions/payments/accounts/{account-key} Get payments

get_transaction_invoice

GETInvoiceFileWrapper get_transaction_invoice(account_key, opts)

Get invoices

Retrieves invoices for a specified account. Invoices are returned in reverse chronological order by updatedDate.

Example

# load the gem
require 'zuora'

api_instance = Zuora::TransactionsApi.new

account_key = "account_key_example" # String | Account number or account ID. 

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

begin
  #Get invoices
  result = api_instance.get_transaction_invoice(account_key, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling TransactionsApi->get_transaction_invoice: #{e}"
end

Parameters

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

Return type

GETInvoiceFileWrapper

Authorization

No authorization required

HTTP request headers

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

get_transaction_payment

GETPaymentsType get_transaction_payment(account_key, opts)

Get payments

Retrieves payments for a specified account. Payments are returned in reverse chronological order by updatedDate.

Example

# load the gem
require 'zuora'

api_instance = Zuora::TransactionsApi.new

account_key = "account_key_example" # String | Account number or account ID.

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

begin
  #Get payments
  result = api_instance.get_transaction_payment(account_key, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling TransactionsApi->get_transaction_payment: #{e}"
end

Parameters

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

Return type

GETPaymentsType

Authorization

No authorization required

HTTP request headers

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