Field mapping and constraints
This document outlines the mapping of Adyen Level 2/Level 3 fields to Zuora fields, including constraints and requirements for each field.
| Adyen Level 2/Level 3 field | Zuora field and constraints | Level | Required |
|---|---|---|---|
| enhancedSchemeData.customerReference | Invoice number if it is present. The maximum length is 25 characters. | Level 2 and Level 3 | Mandatory |
| enhancedSchemeData.totalTaxAmount | The tax amount field on the InvoiceItem object in Zuora. If the currency is any of "BYR, CVE, DJF, GHC, GNF, IDR, JPY, KMF, KRW, PYG, RWF, UGX, VND, VUV, XAF, XOF, XPF" (zero decimal currency), totalTaxAmount is the same value. Otherwise, totalTaxAmount is multiplied by 100. The maximum length is 12. | Level 2 and Level 3 | Mandatory |
| enhancedSchemeData.itemDetailLine[itemNr].productCode | Must be configured in Zuora product catalog as ProductRatePlanCharge level custom fields. The maximum length is 12 characters. | Level 3 | Mandatory |
| enhancedSchemeData.itemDetailLine[itemNr].description | This field will be populated only when the InvoiceItem description field is not empty. The value will be InvoiceItem charge name. The maximum length is 26. If you want to remove the dependency on the InvoiceItem description field, submit a request at Zuora Global Support. | Level 3 | Mandatory |
| enhancedSchemeData.itemDetailLine[itemNr].quantity | The quantity field on the InvoiceItem object in Zuora if it is present. The maximum length is 12. | Level 3 | Mandatory |
| enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure | The unitofmeasure field on the InvoiceItem object in Zuora if it is present. The maximum length is 3. | Level 3 | Mandatory |
| enhancedSchemeData.itemDetailLine[itemNr].commodityCode | Must be configured in Zuora product catalog as ProductRatePlanCharge level custom fields. The maximum length is 12 characters. | Level 3 | Mandatory |
| enhancedSchemeData.itemDetailLine[itemNr].totalAmount | Zuora combines the values from the amount_without_tax and tax_amount fields on the InvoiceItem object and considers it as totalAmount. If the currency is any of "BYR, CVE, DJF, GHC, GNF, IDR, JPY, KMF, KRW, PYG, RWF, UGX, VND, VUV, XAF, XOF, XPF" (zero decimal currency), the value of totalAmount is rounded to 2 decimal places. Otherwise, the value of totalAmount is rounded to 2 decimal places and multiplied by 100. The maximum length is 12. | Level 3 | Mandatory |
| enhancedSchemeData.itemDetailLine[itemNr].unitPrice | The unitprice field on the InvoiceItem object in Zuora and it is rounded to 2 decimal places. | Level 3 | Mandatory |
| enhancedSchemeData.destinationCountryCode | If the value of the SoldToContactCountry field (3-letter ISO code) is present and the credit card type is not American Express, Zuora sets this field to the same value as SoldToContactCountry. The maximum length is 3 characters. | Level 3 | Optional |
| enhancedSchemeData.destinationPostalCode | If the value of the SoldToContactZip field is present, Zuora sets this field to the same value as SoldToContactZip. The maximum length is 10 characters. | Level 3 | Optional |
| enhancedSchemeData.destinationStateProvinceCode | If the value of the SoldToContactState field is present and the credit card type is American Express, Zuora sets this field to the 2-letter state code if the SoldToContactState length is greater than 2 and SoldToContactCountry value is present. Otherwise, the value remains the same as SoldToContactState. | Level 3 | Optional |
| enhancedSchemeData.dutyAmount | If the credit card type is not American Express, this field is set to 0. | Level 3 | Optional |
| enhancedSchemeData.orderDate | If the credit card type is American Express, Zuora sets the date and time in PST timezone. | Level 3 | Optional |
| enhancedSchemeData.shipFromPostalCode | Must be configured as an Account level custom field in Zuora. This value is passed to the gateway when the credit card type is not American Express. The maximum length is 10. | Level 3 | Optional |
| enhancedSchemeData.itemDetailLine[itemNr].discountAmount | The discount field on the InvoiceItem object in Zuora and it is rounded to 2 decimal places. This field is passed to the gateway when the credit card type is not American Express. If the currency is any of "BYR, CVE, DJF, GHC, GNF, IDR, JPY, KMF, KRW, PYG, RWF, UGX, VND, VUV, XAF, XOF, XPF" (zero decimal currency), discount is the same value. Otherwise, totalTaxAmount is multiplied by 100. The maximum length is 12. | Level 3 | Optional |