Skip to main content

EnrichmentRequest

cardBrandCardBrandnullable

Possible values: [VISA, MASTERCARD, AMEX, DISCOVER, CUP, JCB, DINERS, UNKNOWN]

level2 objectnullable
chargeDescriptorstringnullable
commercialCardLevelCommercialCardLevelnullable

Possible values: [LEVEL2, LEVEL3]

customerCodestringnullable
customerRefIDstringnullable
purchaseOrderstringnullable
shipToZipstringnullable
supplierReferenceNumberstringnullable
taxAmountinteger<int64>nullable

Possible values: >= 0

taxIndicatorstringnullable
level3 objectnullable
additionalTaxDetails object[]
  • Array [
  • taxAmountinteger<int64>required

    Possible values: >= 0

    taxCategoryTaxCategoryrequired

    Possible values: [TAXABLE, NON_TAXABLE]

    taxRatestringnullable
    taxTypeTaxTyperequired

    Possible values: [SALES_TAX, VAT, GST]

  • ]
  • commercialCardLevelCommercialCardLevelnullable

    Possible values: [LEVEL2, LEVEL3]

    customerVATNumberstringnullable
    destinationCountryCodestringnullable
    discountAmountinteger<int64>nullable

    Possible values: >= 0

    dutyAmountinteger<int64>nullable

    Possible values: >= 0

    freightAmountinteger<int64>nullable

    Possible values: >= 0

    lineItems object[]required

    Possible values: >= 1

  • Array [
  • commodityCodestringnullable

    Possible values: non-empty

    descriptionstringnullable
    discountAmountinteger<int64>nullable

    Possible values: >= 0

    discountNamestringnullable
    discountPercentagestringnullable
    discountPriorityinteger<int32>nullable
    discountStackablebooleannullable
    discountTypeProductDiscountTypenullable

    Possible values: [AMOUNT, PERCENTAGE]

    lineTotalinteger<int64>nullable

    Possible values: >= 0

    productCodestringnullable

    Possible values: non-empty

    quantityinteger<int32>nullable

    Possible values: >= 1

    taxAmountinteger<int64>nullable

    Possible values: >= 0

    taxNamestringnullable
    taxPercentagestringnullable
    unitCostinteger<int64>nullable

    Possible values: >= 0

    unitOfMeasurestringnullable
  • ]
  • orderDatestringnullable
    purchaseOrderstringnullable
    salesTaxinteger<int64>nullable

    Possible values: >= 0

    shipFromZipstringnullable
    shipToZipstringnullable
    summaryCommodityCodestringnullable
    vatInvoicestringnullable
    EnrichmentRequest
    {
    "cardBrand": "VISA",
    "level2": {
    "chargeDescriptor": "string",
    "commercialCardLevel": "LEVEL2",
    "customerCode": "string",
    "customerRefID": "string",
    "purchaseOrder": "string",
    "shipToZip": "string",
    "supplierReferenceNumber": "string",
    "taxAmount": 0,
    "taxIndicator": "string"
    },
    "level3": {
    "additionalTaxDetails": [
    {
    "taxAmount": 0,
    "taxCategory": "TAXABLE",
    "taxRate": "string",
    "taxType": "SALES_TAX"
    }
    ],
    "commercialCardLevel": "LEVEL2",
    "customerVATNumber": "string",
    "destinationCountryCode": "string",
    "discountAmount": 0,
    "dutyAmount": 0,
    "freightAmount": 0,
    "lineItems": [
    {
    "commodityCode": "string",
    "description": "string",
    "discountAmount": 0,
    "discountName": "string",
    "discountPercentage": "string",
    "discountPriority": 0,
    "discountStackable": true,
    "discountType": "AMOUNT",
    "lineTotal": 0,
    "productCode": "string",
    "quantity": 0,
    "taxAmount": 0,
    "taxName": "string",
    "taxPercentage": "string",
    "unitCost": 0,
    "unitOfMeasure": "string"
    }
    ],
    "orderDate": "string",
    "purchaseOrder": "string",
    "salesTax": 0,
    "shipFromZip": "string",
    "shipToZip": "string",
    "summaryCommodityCode": "string",
    "vatInvoice": "string"
    }
    }