developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Voucher APIVoucherBases

Get voucher basis detailsdeprecated

gethttps://voucher-api.ancon.io/public/api/v1/Outlets/{outletId}/OrderVoucherBases/{voucherBasisId}
View .mdOpenAPI
Deprecated. Check the description for the replacement and sunset date, and see how deprecation works.

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required
  • voucherBasisIdstring (uuid)required

Query parameters

  • TenantUserIdstring (uuid)
  • ClientIdstring (uuid)

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • voucherBasisobject | null
    40 fields in voucherBasis
    • idstring (uuid)
    • createdstring (date-time)
    • outletIdstring (uuid)
    • voucherNostring | null
    • namestring | null
    • statusinteger (int32)

      Allowed values: 0, 1.

    • numberOfOpenChecksinteger (int32)
    • numberOfOrderReceiptCopiesinteger (int32)
    • orderReceiptCopiesSumobject | null
      2 fields in orderReceiptCopiesSum
      • amountnumber (double)
      • currencystring | null
    • numberOfCheckReceiptCopiesinteger (int32)
    • checkReceiptCopiesSumobject | null
      2 fields in checkReceiptCopiesSum
      • amountnumber (double)
      • currencystring | null
    • numberOfCheckoutReceiptCopiesinteger (int32)
    • checkoutReceiptCopiesSumobject | null
      2 fields in checkoutReceiptCopiesSum
      • amountnumber (double)
      • currencystring | null
    • sumobject | null
      6 fields in sum
      • paymentMethodAmountobject | null
        2 fields in paymentMethodAmount
        • amountnumber (double)
        • currencyCodestring | null
      • productGroupAmountInclTaxobject | null
        2 fields in productGroupAmountInclTax
        • amountnumber (double)
        • currencyCodestring | null
      • productGroupAmountExclTaxobject | null
        2 fields in productGroupAmountExclTax
        • amountnumber (double)
        • currencyCodestring | null
      • orderFeeAmountInclTaxobject | null
        2 fields in orderFeeAmountInclTax
        • amountnumber (double)
        • currencyCodestring | null
      • orderFeeAmountExclTaxobject | null
        2 fields in orderFeeAmountExclTax
        • amountnumber (double)
        • currencyCodestring | null
      • taxAmountobject | null
        2 fields in taxAmount
        • amountnumber (double)
        • currencyCodestring | null
    • totalOrderAmountobject | null
      2 fields in totalOrderAmount
      • amountnumber (double)
      • currencystring | null
    • totalOrderRefundAmountobject | null
      2 fields in totalOrderRefundAmount
      • amountnumber (double)
      • currencystring | null
    • totalCheckAmountobject | null
      2 fields in totalCheckAmount
      • amountnumber (double)
      • currencystring | null
    • totalCheckRefundAmountobject | null
      2 fields in totalCheckRefundAmount
      • amountnumber (double)
      • currencystring | null
    • totalCheckoutAmountobject | null
      2 fields in totalCheckoutAmount
      • amountnumber (double)
      • currencystring | null
    • totalCheckoutRefundAmountobject | null
      2 fields in totalCheckoutRefundAmount
      • amountnumber (double)
      • currencystring | null
    • lowestReferenceNumberinteger (int64) | null
    • highestReferenceNumberinteger (int64) | null
    • numberOfOrdersinteger (int32)
    • numberOfChecksinteger (int32)
    • numberOfCheckoutsinteger (int32)
    • numberOfOrderRefundsinteger (int32)
    • numberOfCheckRefundsinteger (int32)
    • numberOfCheckoutRefundsinteger (int32)
    • checkTotalsobject | null
      3 fields in checkTotals
      • grossAmountobject | null
        2 fields in grossAmount
        • amountnumber (double)
        • currencyCodestring | null
      • refundAmountobject | null
        2 fields in refundAmount
        • amountnumber (double)
        • currencyCodestring | null
      • netAmountobject | null
        2 fields in netAmount
        • amountnumber (double)
        • currencyCodestring | null
    • checkoutTotalsobject | null
      3 fields in checkoutTotals
      • grossAmountobject | null
        2 fields in grossAmount
        • amountnumber (double)
        • currencyCodestring | null
      • refundAmountobject | null
        2 fields in refundAmount
        • amountnumber (double)
        • currencyCodestring | null
      • netAmountobject | null
        2 fields in netAmount
        • amountnumber (double)
        • currencyCodestring | null
    • publishedDatestring (date-time) | null
    • partsarray<object> | null
      11 fields in parts
      • sumobject | null
        6 fields in sum
        • paymentMethodAmountobject | null
          2 fields in paymentMethodAmount
          • amountnumber (double)
          • currencyCodestring | null
        • productGroupAmountInclTaxobject | null
          2 fields in productGroupAmountInclTax
          • amountnumber (double)
          • currencyCodestring | null
        • productGroupAmountExclTaxobject | null
          2 fields in productGroupAmountExclTax
          • amountnumber (double)
          • currencyCodestring | null
        • orderFeeAmountInclTaxobject | null
          2 fields in orderFeeAmountInclTax
          • amountnumber (double)
          • currencyCodestring | null
        • orderFeeAmountExclTaxobject | null
          2 fields in orderFeeAmountExclTax
          • amountnumber (double)
          • currencyCodestring | null
        • taxAmountobject | null
          2 fields in taxAmount
          • amountnumber (double)
          • currencyCodestring | null
      • typeinteger (int32)

        Allowed values: 0, 1, 2.

      • paymentMethodsarray<object> | null
        5 fields in paymentMethods
        • paymentMethodIdstring | null
        • paymentMethodTypeinteger (int32)

          Allowed values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23.

        • paymentMethodDisplayNamestring | null
        • amountobject | null
          2 fields in amount
          • amountnumber (double)
          • currencystring | null
        • accountNumberstring | null
      • productGroupsarray<object> | null
        6 fields in productGroups
        • productGroupIdstring (uuid)
        • productGroupNamestring | null
        • amountInclTaxobject | null
          2 fields in amountInclTax
          • amountnumber (double)
          • currencystring | null
        • amountExclTaxobject | null
          2 fields in amountExclTax
          • amountnumber (double)
          • currencystring | null
        • accountNumberstring | null
        • countnumber (double)
      • feesarray<object> | null
        6 fields in fees
        • feeIdstring (uuid)
        • feeNamestring | null
        • amountInclTaxobject | null
          2 fields in amountInclTax
          • amountnumber (double)
          • currencystring | null
        • amountExclTaxobject | null
          2 fields in amountExclTax
          • amountnumber (double)
          • currencystring | null
        • accountNumberstring | null
        • countnumber (double)
      • taxesarray<object> | null
        7 fields in taxes
        • taxIdstring (uuid)
        • typeinteger (int32)

          Allowed values: 1, 2.

        • ratenumber (double)
        • taxSaleAmountInclTaxobject | null
          2 fields in taxSaleAmountInclTax
          • amountnumber (double)
          • currencystring | null
        • taxSaleAmountExclTaxobject | null
          2 fields in taxSaleAmountExclTax
          • amountnumber (double)
          • currencystring | null
        • taxAmountobject | null
          2 fields in taxAmount
          • amountnumber (double)
          • currencystring | null
        • accountNumberstring | null
      • discountsarray<object> | null
        6 fields in discounts
        • discountIdstring (uuid) | null
        • namestring | null
        • discountValueobject | null
          2 fields in discountValue
          • discountTypeinteger (int32) | null

            Allowed values: 0, 1.

          • discountValuenumber (double) | null
        • timesUsedinteger (int32)
        • amountInclTaxobject | null
          2 fields in amountInclTax
          • amountnumber (double)
          • currencystring | null
        • amountExclTaxobject | null
          2 fields in amountExclTax
          • amountnumber (double)
          • currencystring | null
      • vouchersarray<object> | null
        1 field in vouchers
        • voucherIdstring (uuid)
      • totalDiscountAmountInclTaxobject | null
        2 fields in totalDiscountAmountInclTax
        • amountnumber (double)
        • currencystring | null
      • totalDiscountAmountExclTaxobject | null
        2 fields in totalDiscountAmountExclTax
        • amountnumber (double)
        • currencystring | null
      • numberOfDiscountUsagesinteger (int32)
    • clientsarray<object> | null
      4 fields in clients
      • idstring (uuid)
      • namestring | null
      • cashBoxOpenCountinteger (int32)
      • changeSumsarray<object> | null
        2 fields in changeSums
        • startingAmountobject | null
          2 fields in startingAmount
          • amountnumber (double)
          • currencystring | null
        • currentAmountobject | null
          2 fields in currentAmount
          • amountnumber (double)
          • currencystring | null
    • overdueGiftCardsBalanceobject | null
      2 fields in overdueGiftCardsBalance
      • amountnumber (double)
      • currencystring | null
    • overdueGiftCardsAccountstring | null
    • overdueGiftCardsCountinteger (int32)
    • cashInOutTotalsarray<object> | null
      6 fields in cashInOutTotals
      • outletIdstring (uuid)
      • tenantUserIdstring (uuid)
      • tenantUserNamestring | null
      • totalOutobject | null
        2 fields in totalOut
        • amountnumber (double)
        • currencystring | null
      • totalInobject | null
        2 fields in totalIn
        • amountnumber (double)
        • currencystring | null
      • totalReceiptobject | null
        2 fields in totalReceipt
        • amountnumber (double)
        • currencystring | null
    • overdueWalletsAmountobject | null
      2 fields in overdueWalletsAmount
      • amountnumber (double)
      • currencystring | null
    • overdueWalletsAccountstring | null
    • overdueWalletsCountinteger (int32)
401Unauthorizedapplication/json
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)