GiftCertificates Test
Finance/GiftCertificates/{giftCertificateNumber}
Get details of a specific gift certificate.

The original amount, amount used and balance are all returned. Amounts applied to a current web session are included.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Finance/GiftCertificates/{giftCertificateNumber}

URI Parameters

Parameter Name Data Type Required Notes
giftCertificateNumber string N

Request Body

None.
No request body.

Response object type : GiftCertificateInfo

Response object type GiftCertificateInfo has the following properties.
Property Name Data Type Length Required Readonly Notes
Balance decimal number
BatchId integer The batch that has the gift certificate locked, if any.
GiftCertificateNumber string
LastPrintDate date
Notes string
OriginalAmount decimal number
OriginalDate date
PrintCount integer
RecipientName string
SessionKey string The web session key of a current web session that has used amounts from this gift certificate.
UsedAmount decimal number 
{
  "GiftCertificateNumber": "sample string 1",
  "OriginalAmount": 2.0,
  "UsedAmount": 3.0,
  "Balance": 4.0,
  "OriginalDate": "2025-04-24T05:30:30.1607445-07:00",
  "PrintCount": 1,
  "LastPrintDate": "2025-04-24T05:30:30.1607445-07:00",
  "BatchId": 1,
  "SessionKey": "sample string 6",
  "RecipientName": "sample string 7",
  "Notes": "sample string 8"
}
<GiftCertificateInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Balance>4</Balance>
  <BatchId>1</BatchId>
  <GiftCertificateNumber>sample string 1</GiftCertificateNumber>
  <LastPrintDate>2025-04-24T05:30:30.1607445-07:00</LastPrintDate>
  <Notes>sample string 8</Notes>
  <OriginalAmount>2</OriginalAmount>
  <OriginalDate>2025-04-24T05:30:30.1607445-07:00</OriginalDate>
  <PrintCount>1</PrintCount>
  <RecipientName>sample string 7</RecipientName>
  <SessionKey>sample string 6</SessionKey>
  <UsedAmount>3</UsedAmount>
</GiftCertificateInfo>

No entries in change log for this operation.