PurchaseHeader entities
| Name | Type | Is Mandatory |
|---|---|---|
| PurchaseHeaderId | Int32 | |
| ContactId | Int32 | |
| PurchaseDate | DateTime | |
| StoreId | Int32 | |
| PurchaseIdentifier | String | |
| CheckoutIdentifier | String | |
| CurrencyId | String | |
| Amount | Decimal | |
| TaxFreeAmount | Decimal | |
| DiscountAmount | Decimal | |
| DiscountTypeId | Int16 | |
| RefCurrencyId | String | |
| RefChangeRate | Decimal | |
| RefAmount | Decimal | |
| RefTaxFreeAmount | Decimal | |
| RefDiscountAmount | Decimal | |
| SalePersonCode | String | |
| PurchaseTypeId | Int16 | |
| PurchaseStatusId | Int16 | |
| FreeField1 | String | |
| FreeField2 | String | |
| FreeField3 | String | |
| FreeField4 | String | |
| FreeField5 | String | |
| FreeFieldDateTime1 | DateTime | |
| FreeFieldDateTime2 | DateTime | |
| FreeFieldDateTime3 | DateTime | |
| FreeFieldDateTime4 | DateTime | |
| FreeFieldDateTime5 | DateTime | |
| FreeFieldNumber1 | Decimal | |
| FreeFieldNumber2 | Decimal | |
| FreeFieldNumber3 | Decimal | |
| FreeFieldNumber4 | Decimal | |
| FreeFieldNumber5 | Decimal | |
| FreeFieldBoolean1 | Boolean | |
| FreeFieldBoolean2 | Boolean | |
| FreeFieldBoolean3 | Boolean | |
| FreeFieldBoolean4 | Boolean | |
| FreeFieldBoolean5 | Boolean | |
| BrandId | Int32 | |
| DeletionFlag | Boolean | |
| PurchaseStatusDate | DateTime | |
| LoyaltyCardId | Int32 | |
| StoreIdentifier | String | |
| SourceId | Int16 | |
| VoucherId | Int32 | |
| Contact | Contact | |
| PurchaseDetails | Collection of PurchaseDetail | |
| Brand | Brand | |
| Store | Store | |
| Currency | Currency | |
| DiscountType | DiscountType | |
| PurchaseType | PurchaseType | |
| PurchaseStatus | PurchaseStatus | |
| LoyaltyPoints | Collection of LoyaltyPoint | |
| LoyaltyCard | LoyaltyCard | |
| RefCurrency | Currency | |
| Source | Source | |
| Voucher | Voucher |
| Action Name | Method | Parameters | Description | Return | |
|---|---|---|---|---|---|
| SumPurchaseDetail | POST |
|
Compute Sum of chosen column of related PurchaseDetail entities | Decimal | |
Select all PurchaseHeaders
https://customerapi.fts-crm360.com/data/PurchaseHeaders()
HttpMethod : GET
Json Result :
[
{
"PurchaseHeaderId" : "13",
"ContactId" : "18",
"PurchaseDate" : "2004-10-20T00:00:00",
"StoreId" : "43",
"PurchaseIdentifier" : "x8e01P8f",
"CheckoutIdentifier" : "AN 1fM5kex x AtlCx",
"CurrencyId" : "uCn3Q",
"Amount" : "1246988.477",
"TaxFreeAmount" : "6428195.761",
"DiscountAmount" : "4898385.878",
"DiscountTypeId" : "4",
"RefCurrencyId" : "uAbCg6g4ia",
"RefChangeRate" : "3312891.859",
"RefAmount" : "3343264.249",
"RefTaxFreeAmount" : "6843624.146",
"RefDiscountAmount" : "2651577.196",
"SalePersonCode" : "8WbAdnK05iYej2d3uj",
"PurchaseTypeId" : "7",
"PurchaseStatusId" : "5",
"FreeField1" : "3ypzYzg2WM0Flc5SKh",
"FreeField2" : "KdDxK3H",
"FreeField3" : "dPC3idpWqPXTCLK",
"FreeField4" : "cQ 8aYJQ 7 e6",
"FreeField5" : "zu337xNB",
"FreeFieldDateTime1" : "2024-03-04T00:00:00",
"FreeFieldDateTime2" : "2002-07-17T00:00:00",
"FreeFieldDateTime3" : "2022-08-31T00:00:00",
"FreeFieldDateTime4" : "2009-09-14T00:00:00",
"FreeFieldDateTime5" : "2003-04-13T00:00:00",
"FreeFieldNumber1" : "8848654.898",
"FreeFieldNumber2" : "6118166.687",
"FreeFieldNumber3" : "1562338.331",
"FreeFieldNumber4" : "7598495.949",
"FreeFieldNumber5" : "5489388.924",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "True",
"BrandId" : "32",
"DeletionFlag" : "True",
"PurchaseStatusDate" : "2002-07-09T00:00:00",
"LoyaltyCardId" : "56",
"StoreIdentifier" : "oKo8GDLNYG",
"SourceId" : "1",
"VoucherId" : "69"
},
{
"PurchaseHeaderId" : "23",
"ContactId" : "88",
"PurchaseDate" : "2001-11-09T00:00:00",
"StoreId" : "62",
"PurchaseIdentifier" : "p0fZ2DyqF HlEpQ",
"CheckoutIdentifier" : "DUVu2zQmnl",
"CurrencyId" : "UoYLg",
"Amount" : "6664197.183",
"TaxFreeAmount" : "1616358.326",
"DiscountAmount" : "9888697.315",
"DiscountTypeId" : "1",
"RefCurrencyId" : "Nm6dA0WFiP4kymi",
"RefChangeRate" : "1365426.677",
"RefAmount" : "8822514.334",
"RefTaxFreeAmount" : "4784991.169",
"RefDiscountAmount" : "3194794.975",
"SalePersonCode" : "9JsOAM4CJgTfL",
"PurchaseTypeId" : "2",
"PurchaseStatusId" : "3",
"FreeField1" : "LeZJn9yfu1z",
"FreeField2" : "gqYlx1cgHL9",
"FreeField3" : "J7dc8ixN fNfQV7",
"FreeField4" : "MfJYcgeIst",
"FreeField5" : "pzV fp qeU",
"FreeFieldDateTime1" : "2010-11-10T00:00:00",
"FreeFieldDateTime2" : "2000-04-01T00:00:00",
"FreeFieldDateTime3" : "1997-02-04T00:00:00",
"FreeFieldDateTime4" : "2012-01-18T00:00:00",
"FreeFieldDateTime5" : "1995-08-14T00:00:00",
"FreeFieldNumber1" : "1583495.297",
"FreeFieldNumber2" : "8474933.856",
"FreeFieldNumber3" : "6239643.517",
"FreeFieldNumber4" : "3185513.434",
"FreeFieldNumber5" : "2743733.351",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "False",
"BrandId" : "85",
"DeletionFlag" : "False",
"PurchaseStatusDate" : "2020-10-15T00:00:00",
"LoyaltyCardId" : "72",
"StoreIdentifier" : "m7FPWu",
"SourceId" : "5",
"VoucherId" : "24"
},
...
]
Select PurchaseHeader by Id
https://customerapi.fts-crm360.com/data/PurchaseHeaders(13)
HttpMethod : GET
Json Result :
{
"PurchaseHeaderId" : "90",
"ContactId" : "97",
"PurchaseDate" : "1996-07-12T00:00:00",
"StoreId" : "88",
"PurchaseIdentifier" : "X6u5STAA CY9",
"CheckoutIdentifier" : "yApxYpK PkL7",
"CurrencyId" : "vEVg7ZzloeGUkZEl7C1",
"Amount" : "4372326.342",
"TaxFreeAmount" : "2459469.751",
"DiscountAmount" : "9282555.831",
"DiscountTypeId" : "3",
"RefCurrencyId" : "hUjs 2FVR",
"RefChangeRate" : "2445264.382",
"RefAmount" : "9598246.777",
"RefTaxFreeAmount" : "8939882.465",
"RefDiscountAmount" : "1628875.649",
"SalePersonCode" : "j 8S1k",
"PurchaseTypeId" : "5",
"PurchaseStatusId" : "4",
"FreeField1" : "LYmaMKat",
"FreeField2" : "X7mSDWTIE",
"FreeField3" : "67QvlRjTq7Ow",
"FreeField4" : "TH3Kh",
"FreeField5" : "liA5FlK7H3",
"FreeFieldDateTime1" : "2022-08-11T00:00:00",
"FreeFieldDateTime2" : "2011-02-03T00:00:00",
"FreeFieldDateTime3" : "2008-02-28T00:00:00",
"FreeFieldDateTime4" : "2005-08-27T00:00:00",
"FreeFieldDateTime5" : "2020-03-03T00:00:00",
"FreeFieldNumber1" : "4596126.877",
"FreeFieldNumber2" : "1683222.775",
"FreeFieldNumber3" : "9912244.447",
"FreeFieldNumber4" : "4842969.553",
"FreeFieldNumber5" : "9732113.697",
"FreeFieldBoolean1" : "False",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "False",
"BrandId" : "48",
"DeletionFlag" : "False",
"PurchaseStatusDate" : "2017-06-06T00:00:00",
"LoyaltyCardId" : "50",
"StoreIdentifier" : "zLaAXSLqYfNnP",
"SourceId" : "5",
"VoucherId" : "53"
}
Create a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders()
HttpMethod : POST
Json Post :
{
"ContactId" : "23",
"PurchaseDate" : "2014-02-24T00:00:00",
"StoreId" : "86",
"PurchaseIdentifier" : "IHrds8n",
"CheckoutIdentifier" : "gRbMLB",
"CurrencyId" : "ZwQOytzmPceHhIVs km",
"Amount" : "4427717.274",
"TaxFreeAmount" : "9316327.941",
"DiscountAmount" : "4454128.192",
"DiscountTypeId" : "6",
"RefCurrencyId" : "mkrfRBhJBfINTJ",
"RefChangeRate" : "5531674.521",
"RefAmount" : "9775363.583",
"RefTaxFreeAmount" : "7598874.319",
"RefDiscountAmount" : "2328738.968",
"SalePersonCode" : "FZrklVA6",
"PurchaseTypeId" : "4",
"PurchaseStatusId" : "3",
"FreeField1" : "Y c ocK0THdPyn",
"FreeField2" : "0v7zU2 FkCNMP",
"FreeField3" : "YVoqi5IZwp",
"FreeField4" : "vxgEnJ38Be",
"FreeField5" : "9j6yZ327",
"FreeFieldDateTime1" : "2002-08-07T00:00:00",
"FreeFieldDateTime2" : "2021-11-09T00:00:00",
"FreeFieldDateTime3" : "2008-01-22T00:00:00",
"FreeFieldDateTime4" : "2022-01-27T00:00:00",
"FreeFieldDateTime5" : "2018-05-19T00:00:00",
"FreeFieldNumber1" : "8637459.346",
"FreeFieldNumber2" : "1519933.291",
"FreeFieldNumber3" : "4177535.832",
"FreeFieldNumber4" : "8363866.361",
"FreeFieldNumber5" : "3724798.911",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "False",
"FreeFieldBoolean4" : "True",
"FreeFieldBoolean5" : "True",
"BrandId" : "74",
"DeletionFlag" : "False",
"PurchaseStatusDate" : "2009-08-23T00:00:00",
"LoyaltyCardId" : "21",
"StoreIdentifier" : "6JCSuv1",
"SourceId" : "7",
"VoucherId" : "15"
}
Informations :
- Non mandatory fields are optional for Json Post
Update a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders(13)
HttpMethod : PUT
Json Post :
{
"PurchaseHeaderId" : "32",
"ContactId" : "70",
"PurchaseDate" : "1995-03-31T00:00:00",
"StoreId" : "60",
"PurchaseIdentifier" : "zp6YCjYlxIGIxx0Du",
"CheckoutIdentifier" : "AcGIn1",
"CurrencyId" : "7EIxuY Fr x cb",
"Amount" : "6744926.918",
"TaxFreeAmount" : "1669277.117",
"DiscountAmount" : "1538171.118",
"DiscountTypeId" : "1",
"RefCurrencyId" : "RrYqxvtp",
"RefChangeRate" : "1913728.199",
"RefAmount" : "3777425.532",
"RefTaxFreeAmount" : "1583883.965",
"RefDiscountAmount" : "9934725.929",
"SalePersonCode" : "EFHcUekVNIQaikeEtc1",
"PurchaseTypeId" : "8",
"PurchaseStatusId" : "9",
"FreeField1" : "d ZaV9MsjYa",
"FreeField2" : "av dVsh",
"FreeField3" : "Urew NBveR",
"FreeField4" : "ApmIC",
"FreeField5" : "JmIgj3 UkDV4 fKYBJ",
"FreeFieldDateTime1" : "2003-08-27T00:00:00",
"FreeFieldDateTime2" : "2021-10-16T00:00:00",
"FreeFieldDateTime3" : "2014-02-26T00:00:00",
"FreeFieldDateTime4" : "2009-10-19T00:00:00",
"FreeFieldDateTime5" : "2017-03-19T00:00:00",
"FreeFieldNumber1" : "2911423.867",
"FreeFieldNumber2" : "6214878.553",
"FreeFieldNumber3" : "2785786.658",
"FreeFieldNumber4" : "2368965.862",
"FreeFieldNumber5" : "3372431.924",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "True",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "True",
"BrandId" : "46",
"DeletionFlag" : "False",
"PurchaseStatusDate" : "2011-08-12T00:00:00",
"LoyaltyCardId" : "33",
"StoreIdentifier" : "jsWvoVhO TQB5",
"SourceId" : "4",
"VoucherId" : "97"
}
Informations :
- Non mandatory fields are optional for Json Post
Patch a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders(13)
HttpMethod : PATCH
Json Post :
{
"TaxFreeAmount" : "9971586.514",
"SalePersonCode" : "BYPhb6bBhj3 eDx",
"FreeField3" : "j1Ibe2SreYc2w5OSY",
"RefCurrencyId" : "SI 31Vk3y A8OBq7Fn"
}
Informations :
- Non mandatory fields are optional for Json Post
Delete a PurchaseHeader
https://customerapi.fts-crm360.com/data/PurchaseHeaders(13)
HttpMethod : DELETE