Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Calculating Tax for Credit and Rebill

This API allows you to calculate tax for credit memo generated by the createCreditRebill API. For more information, see Creating Credit and Rebill Credit Memos and Calculating Tax for Credit and Rebill.

Note:

You must call the calculateTaxForCreditRebill API after calling the createCreditRebill API, when the following scenarios true:

  • You have defined the TestTaxCallbackWithExternalCallout callback class in Setup Develop Custom Settings Config Custom Classes Tax Callback Class.
  • You want to select both Auto Approve credit memo and Unrate the usage inputs options.

API

Signature

calculateTaxForCreditRebill

static Map calculateTaxForCreditRebill(Id creditMemoId, Boolean autoApproveCreditMemo, Boolean unrateUsageInputs)

This API accepts the following input parameters.

Request

Field

Type

Required?

Description

creditMemoId

Id

Yes

ID of the credit memo.

autoApproveCreditMemo

Boolean

Yes

If set to true, Conga Billing auto-approves credit memos.

unrateUsageInputs

Boolean

Yes

If set to true, Conga Billing unrates usage inputs.

The API returns a Map<String, Value> as a response parameter.

Response

Field

Type

Description

Result

Map

The result map contains the success string and a value

If the API executes successfully, the value contains the following keys:

  • success - set to true
  • creditMemoId - the ID of the created credit memo

If the API is not executed successfully, the value contains the following keys:

  • success - set to false
  • errorMessage - contains the error message
  • stackTrace - contains the stackTrack of the API call