CRM360° CustomerApi Documentation

Customer - Voucher

Voucher entities

Required HTTP Headers

  • X-Crm360Api-Token
  • X-Crm360Api-CustomerName
  • X-Crm360Api-DatabaseAlias

Functions

Entity Properties

Name Type Is Mandatory
VoucherId Int32
VoucherIdentifier String
ContactId Int32
LoyaltyCardId Int32
SourceId Int16
VoucherCode String
VoucherTypeId Int16
VoucherStateId Int16
Amount Decimal
CurrencyId String
ValidityStartDate DateTime
ValidityEndDate DateTime
DeletionFlag Boolean
VoucherCategoryId Int16
UseDate DateTime
VoucherState VoucherState
VoucherType VoucherType
Contact Contact
LoyaltyCard LoyaltyCard
Currency Currency
Source Source
LoyaltyPoints Collection of LoyaltyPoint
PurchaseHeaders Collection of PurchaseHeader
VoucherCategory VoucherCategory

Examples

Select all Vouchers

https://customerapi.fts-crm360.com/data/Vouchers()
HttpMethod : GET
Json Result :
[ { "VoucherId" : "92", "VoucherIdentifier" : "jVVRrZwTRDjpLWrW", "ContactId" : "44", "LoyaltyCardId" : "44", "SourceId" : "6", "VoucherCode" : "7GEjQ", "VoucherTypeId" : "8", "VoucherStateId" : "9", "Amount" : "7122915.197", "CurrencyId" : "dpGkjSHk9d7v 9b1xbQ", "ValidityStartDate" : "2017-06-24T00:00:00", "ValidityEndDate" : "1995-07-03T00:00:00", "DeletionFlag" : "True", "VoucherCategoryId" : "5", "UseDate" : "1996-03-16T00:00:00" }, { "VoucherId" : "24", "VoucherIdentifier" : "5mooUx", "ContactId" : "61", "LoyaltyCardId" : "44", "SourceId" : "9", "VoucherCode" : "7Wiybr3bxUMLfJwjp9", "VoucherTypeId" : "9", "VoucherStateId" : "6", "Amount" : "2145459.422", "CurrencyId" : "i h4 4c", "ValidityStartDate" : "2004-07-11T00:00:00", "ValidityEndDate" : "2004-10-06T00:00:00", "DeletionFlag" : "False", "VoucherCategoryId" : "1", "UseDate" : "2002-07-28T00:00:00" }, ... ]

Select Voucher by Id

https://customerapi.fts-crm360.com/data/Vouchers(92)
HttpMethod : GET
Json Result :
{ "VoucherId" : "92", "VoucherIdentifier" : "uGd2vHnbTu2 DZ6uiS", "ContactId" : "62", "LoyaltyCardId" : "19", "SourceId" : "6", "VoucherCode" : "8PVqLpo", "VoucherTypeId" : "7", "VoucherStateId" : "2", "Amount" : "8466455.415", "CurrencyId" : "syA D", "ValidityStartDate" : "2006-05-15T00:00:00", "ValidityEndDate" : "2012-05-31T00:00:00", "DeletionFlag" : "False", "VoucherCategoryId" : "7", "UseDate" : "2013-08-20T00:00:00" }

Create a Voucher

https://customerapi.fts-crm360.com/data/Vouchers()
HttpMethod : POST
Json Post :
{
"VoucherIdentifier" : "OiINhE79zkkDkdvh",
"ContactId" : "27",
"LoyaltyCardId" : "11",
"SourceId" : "9",
"VoucherCode" : "qhdKN60HQCW K",
"VoucherTypeId" : "7",
"VoucherStateId" : "4",
"Amount" : "1339315.323",
"CurrencyId" : "WT0UQ0CDsE9 mP tvN",
"ValidityStartDate" : "1999-07-01T00:00:00",
"ValidityEndDate" : "2020-11-20T00:00:00",
"DeletionFlag" : "True",
"VoucherCategoryId" : "2",
"UseDate" : "2013-12-28T00:00:00"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Update a Voucher

https://customerapi.fts-crm360.com/data/Vouchers(92)
HttpMethod : PUT
Json Post :
{
"VoucherId" : "29",
"VoucherIdentifier" : "LjeIP",
"ContactId" : "35",
"LoyaltyCardId" : "94",
"SourceId" : "3",
"VoucherCode" : "ez uFk",
"VoucherTypeId" : "2",
"VoucherStateId" : "6",
"Amount" : "6133313.859",
"CurrencyId" : "E5MpiS",
"ValidityStartDate" : "1997-03-14T00:00:00",
"ValidityEndDate" : "2003-02-13T00:00:00",
"DeletionFlag" : "False",
"VoucherCategoryId" : "9",
"UseDate" : "2008-03-23T00:00:00"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Patch a Voucher

https://customerapi.fts-crm360.com/data/Vouchers(92)
HttpMethod : PATCH
Json Post :
{
"ValidityEndDate" : "2016-06-08T00:00:00",
"Amount" : "1757131.267",
"VoucherCode" : "en y3eNUs",
"SourceId" : "4",
"LoyaltyCardId" : "87",
"DeletionFlag" : "False"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Voucher

https://customerapi.fts-crm360.com/data/Vouchers(92)
HttpMethod : DELETE