Skip to content

Latest commit

 

History

History
677 lines (454 loc) · 49.3 KB

DebitMemosApi.md

File metadata and controls

677 lines (454 loc) · 49.3 KB

Zuora::DebitMemosApi

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

Method HTTP request Description
delete_debit_memo DELETE /v1/debitmemos/{debitMemoId} Delete debit memo
get_debit_memo GET /v1/debitmemos/{debitMemoId} Get debit memo
get_debit_memo_item GET /v1/debitmemos/{debitMemoId}/items/{dmitemid} Get debit memo item
get_debit_memo_items GET /v1/debitmemos/{debitMemoId}/items Get debit memo items
get_debit_memos GET /v1/debitmemos Get debit memos
post_debit_memo_from_prpc POST /v1/debitmemos Create debit memo from charge
post_debit_memo_pdf POST /v1/debitmemos/{debitMemoId}/pdfs Create debit memo PDF
post_email_debit_memo POST /v1/debitmemos/{debitMemoId}/emails Email debit memo
post_dm_taxation_items POST /v1/debitmemos/{debitMemoId}/taxationitems Create taxation items for debit memo
put_cancel_debit_memo PUT /v1/debitmemos/{debitMemoId}/cancel Cancel debit memo
put_debit_memo PUT /v1/debitmemos/{debitMemoId} Update debit memo
put_post_debit_memo PUT /v1/debitmemos/{debitMemoId}/post Post debit memo

delete_debit_memo

CommonResponseType delete_debit_memo(debit_memo_id, opts)

Delete debit memo

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Deletes a debit memo. Only debit memos with the Cancelled status can be deleted. You can delete a debit memo only if you have the user permission. See Billing Roles for more information.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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 debit memo
  result = api_instance.delete_debit_memo(debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->delete_debit_memo: #{e}"
end

Parameters

Name Type Description Notes
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

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

get_debit_memo

GETDebitMemoType get_debit_memo(debit_memo_id, opts)

Get debit memo

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about a specific debit memo.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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

begin
  #Get debit memo
  result = api_instance.get_debit_memo(debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->get_debit_memo: #{e}"
end

Parameters

Name Type Description Notes
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

GETDebitMemoType

Authorization

No authorization required

HTTP request headers

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

get_debit_memo_item

GETDebitMemoItemType get_debit_memo_item(dmitemid, debit_memo_id, opts)

Get debit memo item

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

dmitemid = "dmitemid_example" # String | The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo items](https://www.zuora.com/developer/api-reference/#operation/GET_DebitMemoItems). 

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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

begin
  #Get debit memo item
  result = api_instance.get_debit_memo_item(dmitemid, debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->get_debit_memo_item: #{e}"
end

Parameters

Name Type Description Notes
dmitemid String The unique ID of a debit memo item. You can get the debit memo item ID from the response of Get debit memo items.
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

GETDebitMemoItemType

Authorization

No authorization required

HTTP request headers

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

get_debit_memo_items

GETDebitMemoItemCollectionType get_debit_memo_items(debit_memo_id, opts)

Get debit memo items

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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. 
  fields_filterable: "fields_filterable_example", # String | This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on.   A single filter uses the following form:   *fieldsFilterable* `=` *field_value*              Filters can be combined by using `&`. For example: *fieldsFilterable* `=` *field_value* `&` *fieldsFilterable* `=` *field_value*  *fieldsFilterable* indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below:    - id   - amount   - beAppliedAmount   - sku   - skuName   - serviceStartDate   - serviceEndDate   - sourceItemId   - createdDate   - createdById   - updatedDate   - updatedById   - subscriptionId   *field_value* indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to `null` value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the **Responses** section.     Examples:  - /debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100  - /debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate 
  sort: "sort_example" # String | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.  A sortable field uses the following form:   *operator* *field_name*  You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*    *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.    - The `-` operator indicates an ascending order.   - The `+` operator indicates a descending order.  By default, the response data is displayed in descending order by updated date.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - id   - amount   - beAppliedAmount   - sku   - skuName   - serviceStartDate   - serviceEndDate   - sourceItemId   - createdDate   - createdById   - updatedDate   - updatedById   - subscriptionId    Examples:  - /debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate  - /debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate 
}

begin
  #Get debit memo items
  result = api_instance.get_debit_memo_items(debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->get_debit_memo_items: #{e}"
end

Parameters

Name Type Description Notes
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
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]
fields_filterable String This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on. A single filter uses the following form: fieldsFilterable `=` field_value Filters can be combined by using `&`. For example: fieldsFilterable `=` field_value `&` fieldsFilterable `=` field_value fieldsFilterable indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId field_value indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to `null` value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the Responses section. Examples: - /debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100 - /debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate [optional]
sort String This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: operator field_name You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: operator field_name, operator field_name operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate [optional]

Return type

GETDebitMemoItemCollectionType

Authorization

No authorization required

HTTP request headers

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

get_debit_memos

GETDebitMemoCollectionType get_debit_memos(opts)

Get debit memos

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Retrieves the information about all debit memos associated with all customer accounts.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

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. 
  fields_filterable: "fields_filterable_example", # String | This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on.   A single filter uses the following form:   *fieldsFilterable* `=` *field_value*              Filters can be combined by using `&`. For example: *fieldsFilterable* `=` *field_value* `&` *fieldsFilterable* `=` *field_value*  *fieldsFilterable* indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below:    - number   - accountId   - debitMemoDate   - targetDate   - dueDate   - currency   - status   - amount   - taxAmount   - totalTaxExemptAmount   - balance   - beAppliedAmount   - referredInvoiceId   - createdDate   - createdById   - updatedDate   - updatedById   *field_value* indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to `null` value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the **Responses** section.     Examples:  - /debitmemos?status=Processed  - /debitmemos?referredInvoiceId=null&status=Draft  - /debitmemos?status=Processed&type=External&sort=+number 
  sort: "sort_example" # String | This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.  A sortable field uses the following form:   *operator* *field_name*  You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*    *operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.    - The `-` operator indicates an ascending order.   - The `+` operator indicates a descending order.  By default, the response data is displayed in descending order by debit memo number.  *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:    - number   - accountId   - debitMemoDate   - targetDate   - dueDate   - amount   - taxAmount   - totalTaxExemptAmount   - balance   - beAppliedAmount   - referredInvoiceId   - createdDate   - createdById   - updatedDate   - updatedById    Examples:  - /debitmemos?sort=+number  - /debitmemos?status=Processed&sort=-number,+amount 
}

begin
  #Get debit memos
  result = api_instance.get_debit_memos(opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->get_debit_memos: #{e}"
end

Parameters

Name Type Description Notes
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]
fields_filterable String This parameter restricts the data returned in the response. You can use this parameter to supply a dimension you want to filter on. A single filter uses the following form: fieldsFilterable `=` field_value Filters can be combined by using `&`. For example: fieldsFilterable `=` field_value `&` fieldsFilterable `=` field_value fieldsFilterable indicates the name of a supported field that you can use to filter the response data. The supported filterable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - currency - status - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById field_value indicates a valid value of the filterable field. If the type of the field value is string, you can set the field to `null` value for filtering. Then, you can get the response data with this field value being 'null'. For more information about these fields, see the field descriptions in the Responses section. Examples: - /debitmemos?status=Processed - /debitmemos?referredInvoiceId=null&status=Draft - /debitmemos?status=Processed&type=External&sort=+number [optional]
sort String This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on. A sortable field uses the following form: operator field_name You can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: operator field_name, operator field_name operator is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by debit memo number. field_name indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById Examples: - /debitmemos?sort=+number - /debitmemos?status=Processed&sort=-number,+amount [optional]

Return type

GETDebitMemoCollectionType

Authorization

No authorization required

HTTP request headers

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

post_debit_memo_from_prpc

GETDebitMemoType post_debit_memo_from_prpc(body, opts)

Create debit memo from charge

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Creates an ad-hoc debit memo from a product rate plan charge. Zuora only supports one-time positive charges for debit memos. You can create a debit memo only if you have the user permission. See Billing Roles for more information.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

body = Zuora::DebitMemoFromChargeType.new # DebitMemoFromChargeType | 

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

begin
  #Create debit memo from charge
  result = api_instance.post_debit_memo_from_prpc(body, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->post_debit_memo_from_prpc: #{e}"
end

Parameters

Name Type Description Notes
body DebitMemoFromChargeType
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

GETDebitMemoType

Authorization

No authorization required

HTTP request headers

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

post_debit_memo_pdf

POSTMemoPdfResponse post_debit_memo_pdf(debit_memo_id, opts)

Create debit memo PDF

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Creates PDF for a specified debit memo. To access the generated PDF, you can download it by clicking View PDF on the detailed debit memo page through the Zuora UI.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

debit_memo_id = "debit_memo_id_example" # String | The unique ID of the debit memo that you want to create PDF for. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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

begin
  #Create debit memo PDF
  result = api_instance.post_debit_memo_pdf(debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->post_debit_memo_pdf: #{e}"
end

Parameters

Name Type Description Notes
debit_memo_id String The unique ID of the debit memo that you want to create PDF for. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

POSTMemoPdfResponse

Authorization

No authorization required

HTTP request headers

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

post_email_debit_memo

CommonResponseType post_email_debit_memo(request, debit_memo_id, opts)

Email debit memo

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Sends a posted debit memo to the specified email addresses manually. ## Notes - You must activate the Email Debit Memo | Manually email Debit Memo notification before emailing debit memos. To include the debit memo PDF in the email, select the Include Debit Memo PDF check box in the Edit notification dialog from the Zuora UI. See Create and Edit Notifications for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the Delivery Options panel of the Edit notification dialog from the Zuora UI. By default, the Manual Email for Debit Memo Default Template template is used. See Create and Edit Email Templates for more information. - The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The useEmailTemplateSetting field is set to false. * The email addresses are not specified in the emailAddresses field.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

request = Zuora::PostDebitMemoEmailType.new # PostDebitMemoEmailType | 

debit_memo_id = "debit_memo_id_example" # String | The ID of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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
  #Email debit memo
  result = api_instance.post_email_debit_memo(request, debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->post_email_debit_memo: #{e}"
end

Parameters

Name Type Description Notes
request PostDebitMemoEmailType
debit_memo_id String The ID of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

CommonResponseType

Authorization

No authorization required

HTTP request headers

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

post_dm_taxation_items

GETTaxationItemListType post_dm_taxation_items(debit_memo_id, body, opts)

Create taxation items for debit memo

Note: This feature is only available if you have the Advanced AR Settlement feature enabled. The Advanced AR Settlement feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support. Creates taxation items for a debit memo.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

body = Zuora::POSTTaxationItemListForDMType.new # POSTTaxationItemListForDMType | 

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

begin
  #Create taxation items for debit memo
  result = api_instance.post_dm_taxation_items(debit_memo_id, body, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->post_dm_taxation_items: #{e}"
end

Parameters

Name Type Description Notes
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
body POSTTaxationItemListForDMType
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

GETTaxationItemListType

Authorization

No authorization required

HTTP request headers

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

put_cancel_debit_memo

GETDebitMemoType put_cancel_debit_memo(debit_memo_id, opts)

Cancel debit memo

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Cancels a debit memo. Only debit memos with the Draft status can be cancelled. You can cancel a debit memo only if you have the user permission. See Billing Roles for more information.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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
  #Cancel debit memo
  result = api_instance.put_cancel_debit_memo(debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->put_cancel_debit_memo: #{e}"
end

Parameters

Name Type Description Notes
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

GETDebitMemoType

Authorization

No authorization required

HTTP request headers

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

put_debit_memo

GETDebitMemoType put_debit_memo(body, debit_memo_id, opts)

Update debit memo

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Updates the basic and finance information about a debit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. You can update a debit memo only if you have the user permission. See Billing Roles for more information.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

body = Zuora::PUTDebitMemoType.new # PUTDebitMemoType | 

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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
  #Update debit memo
  result = api_instance.put_debit_memo(body, debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->put_debit_memo: #{e}"
end

Parameters

Name Type Description Notes
body PUTDebitMemoType
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

GETDebitMemoType

Authorization

No authorization required

HTTP request headers

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

put_post_debit_memo

GETDebitMemoType put_post_debit_memo(debit_memo_id, opts)

Post debit memo

Note: The Advanced AR Settlement feature is in Limited Availability. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you wish to have access to the feature, submit a request at Zuora Global Support. Posts a debit memo to activate it. You can post debit memos only if you have the Billing permissions.

Example

# load the gem
require 'zuora'

api_instance = Zuora::DebitMemosApi.new

debit_memo_id = "debit_memo_id_example" # String | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. 

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
  #Post debit memo
  result = api_instance.put_post_debit_memo(debit_memo_id, opts)
  p result
rescue Zuora::ApiError => e
  puts "Exception when calling DebitMemosApi->put_post_debit_memo: #{e}"
end

Parameters

Name Type Description Notes
debit_memo_id String The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.
entity_id String The Id of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]
entity_name String The name of the entity that you want to access. Note that you must have permission to access the entity. For more information, see REST Authentication. [optional]

Return type

GETDebitMemoType

Authorization

No authorization required

HTTP request headers

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