Request config object

AFC allows you to control the response output via the Request Config object (cfg).

There are several configuration options available:

retnb: Return nonbillable taxes
retext: Return extended data in the response
incrf: Return reporting information in the response

Return nonbillable taxes:

The retnb flag allows you to control if nonbillable taxes are returned in the response. If this field isn’t provided, it defaults to the account-level setting.

true: Return nonbillable taxes. Setting retnb to true overrides the account-level setting.
false: Don't return nonbillable taxes.

Return extended data:

Theretext flag indicates if you want to see a number of extended fields in the detailed tax result:

When taxes are returned:

Taxing PCode (taxpcd): PCode representing taxing jurisdiction
User Exempt (usexm): Flag indicating if the tax has been exempted by the user via Exemptions (exms)
Is No Tax Transaction (notax): Flag indicating that the transaction was processed successfully but returned no taxes
Transaction Type (trans): Transaction type used to calculate tax. For bundles, this field shows the specific bundled item transaction type.
Service Type (svc): Service type used to calculate tax. For bundles, this field shows the specific bundled item transaction type.
Charge (chg): Charge used to calculate tax. For bundles, this field shows the percentage of the charge applied to the bundled item. For tax inclusive calls, this field shows the calculated charge.

When no taxes are returned:

Billable (bill): Always returnsfalse
Tax Name (name): Always returns "NO TAX"
Reporting PCode (pcd) and Taxing PCode (taxpcd): Reporting PCode and Taxing PCode are always the same value.
- If the location provided is an unsupported country, the Reporting PCode (pcd) and Taxing PCode (taxpcd) are both set to the Unsupported Country PCode (5190000)
Tax Amount (tax): Always returns0
Tax Type ID (tid): Always returns0
User Exempt (usexm): Always returnsfalse
Is No Tax Transaction (notax): Always returnstrue
Transaction Type (trans): Transaction type used to calculate tax. For bundles, this field shows the specific bundled item transaction type.
Service Type (svc): Service type used to calculate tax. For bundles, this field shows the specific bundled item transaction type.
Charge (chg): Charge used to calculate tax. For bundles, this field shows the percentage of the charge applied to the bundled item. For tax inclusive calls, this field shows the calculated charge.

Include reporting information:

The incrf flag enables the return of the Reporting Information object (incrf) in the CalcTaxes response.

Populate some or all of these reporting information fields on the invoice (inv) to see the information in the response and in Explorer Reporting:

Account Reference (acct)
Customer Reference (custref)
Invoice Number Reference (invn)
Bill Cycle Reference (bcyc)
Currency Code (ccycd)

All of the reporting information fields populated on the invoice (inv), as well as the Currency Description (ccydesc) are returned in the Reporting Information object (incrf).

"incrf": {
    "acct": "Account Reference",
    "custref": "Customer Reference",
    "invn": "Invoice Number Reference",
    "bcyc": "Bill Cycle Reference",
    "ccycd": "USD",
    "ccydesc": "United States Dollar"
}

Line item reporting information:

Reporting fields are available for use on the line item (itms). Just like on the invoice, populate these reporting information fields on the invoice (itms) to see the information in the response and in Explorer Reporting (UI):

Line Item Reference (ref)
General Ledger Reference (glref)
Note that General Ledger Reference (glref) isn't returned in the response; it can be found in Explorer Reporting.