{"info":{"_postman_id":"d6dbe343-81e7-4b74-9915-fe3c46e0cad8","name":"Paramount Sales API","description":"

API Endpoints to Enter Sales into the Paramount System

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6290919","collectionId":"d6dbe343-81e7-4b74-9915-fe3c46e0cad8","publishedId":"RznCqzCX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-01-03T16:57:18.000Z"},"item":[{"name":"GetMemberships","id":"0443babe-5c40-4127-ab39-e3c4e5d31eb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"ClubId\":\"XXXX\"}"},"url":"https://api.webfdm.com/legacy/PAC/API/GetMemberships/{apiKey}","description":"

API Endpoint to retrieve the Memberships available for the posted location.

\n

{apiKey}: ApiKey Provided by Paramount Acceptance

\n

Response Definitions

\n
\n
Response
\n
\n
\n
\n[{\n\"AdditionalCCFee\":0,\n\"AdditionalCCFeeTax\":0,\n\"ApiScope\":\"ALL\",\n\"BillingFrequency\":\"Monthly\",\n\"ChargeBundleAmountPerFAO\":false,\n\"ChargeEnrollmentPerFAO\":false,\n\"ChargeProcessingPerFAO\":false,\n\"ContractPrice\":9.99,\n\"ContractType\":\"GM\",\n\"Description\":\"Mtm Contract\",\n\"DownPayment\":24.99,\n\"DownPaymentTax\":1.71,\n\"EffectiveDate\":\"1/2/2018 12:00:00 AM\",\n\"EndingDate\":\"1/8/2200 12:00:00 AM\",\n\"EnrollmentFee\":0,\n\"EnrollmentFeeMax\":0,\n\"EnrollmentFeeTax\":0,\n\"EnrollmentFeeTaxable\":true,\n\"ExpirationDate\":\"2/3/2019\",\n\"FirstDue\":\"2/3/2019\",\n\"ID\":12345,\n\"MaximumFamilyAddOnCount\":0,\n\"MemberAddOnPrice\":0,\n\"MemberAddOnTax\":0,\n\"MembershipBundles\":null,\n\"MembershipDetails\":[\n\"Month to Month Contract\",\n\"Access to all locations\"\n],\n\"MinimumFamilyAddOnCount\":0,\n\"MonthlyPayment\":9.99,\n\"MonthlyPaymentsDue\":1,\n\"MonthlyTaxAmount\":0.68,\n\"OrderBy\":3,\n\"ProcessingFee\":15.00,\n\"ProcessingFeeTax\":1.03,\n\"ProcessingFeeTaxable\":true,\n\"PromoCode\":\"example\",\n\"Signatures\":[\n{\n\"Type\":\"SIGNATURE\",\n\"Verbiage\":\"I authorize Example Fitness to electronically deduct (EFT) my monthly dues.\",\n\"VerbiageId\":12345\n},\n{\n\"Type\":\"INITIAL\",\n\"Verbiage\":\"Members will be billed an Annual Enhancement Fee annually\",\n\"VerbiageId\":12346\n},\n{\n\"Type\":\"SIGNATURE\",\n\"Verbiage\":\"BY SIGNING, BUYER AGREES TO ALL TERMS OF THIS CONTRACT.\",\n\"VerbiageId\":12347\n}\n],\n\"Term\":1,\n\"TotalTax\":1.71\n}]\n\n
\n
\n
","urlObject":{"protocol":"https","path":["legacy","PAC","API","GetMemberships","{apiKey}"],"host":["api","webfdm","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0443babe-5c40-4127-ab39-e3c4e5d31eb3"},{"name":"GetLocations","id":"ad3588b6-35ca-432e-8efd-44e6a8e14282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.webfdm.com/legacy/PAC/API/GetLocations/{apiKey}/{ParamountRegion}","description":"

Endpoint to retrieve locations that your apiKey has access to.

\n

{apiKey}: ApiKey Provided by Paramount Acceptance

\n

{ParamountRegion}: Region Code associated with your ApiKey, this will also be provided by Paramount Acceptance

\n
\n
Response
\n
\n
\n
\n[\n{\n\"Address1\":\"123 Street\",\n\"Address2\":\"\",\n\"ClubId\":\"XXXX\",\n\"ClubName\":\"Example Ftiness\",\n\"CorpId\":\"XXXXXXXXX\",\n\"LocationHours\":[\n                {\n                \"CloseTime\":\"00:00:00\",\n                \"ClubId\":\"XXXX\",\n                \"Date\":\"01/03/2019\",\n                \"IsWorkingDay\":true,\n                \"OpenTime\":\"04:00:00\"\n                },\n                {\n                \"CloseTime\":\"22:00:00\",\n                \"ClubId\":\"XXXX\",\n                \"Date\":\"01/04/2019\",\n                \"IsWorkingDay\":true,\n                \"OpenTime\":\"04:00:00\"\n                },\n                {\n                \"CloseTime\":\"22:00:00\",\n                \"ClubId\":\"XXXX\",\n                \"Date\":\"01/05/2019\",\n                \"IsWorkingDay\":true,\n                \"OpenTime\":\"05:00:00\"\n                },\n                {\n                \"CloseTime\":\"16:00:00\",\n                \"ClubId\":\"XXXX\",\n                \"Date\":\"01/06/2019\",\n                \"IsWorkingDay\":true,\n                \"OpenTime\":\"08:00:00\"\n                },\n                {\n                \"CloseTime\":\"00:00:00\",\n                \"ClubId\":\"XXXX\",\n                \"Date\":\"01/07/2019\",\n                \"IsWorkingDay\":true,\n                \"OpenTime\":\"04:00:00\"\n                },\n                {\n                \"CloseTime\":\"00:00:00\",\n                \"ClubId\":\"XXXX\",\n                \"Date\":\"01/08/2019\",\n                \"IsWorkingDay\":true,\n                \"OpenTime\":\"04:00:00\"\n                },\n                {\n                \"CloseTime\":\"00:00:00\",\n                \"ClubId\":\"XXXX\",\n                \"Date\":\"01/09/2019\",\n                \"IsWorkingDay\":true,\n                \"OpenTime\":\"04:00:00\"\n                }\n                ],\n\"RegionCode\":\"XXXX\",\n\"State\":\"UT\",\n\"ZipCode\":\"84117\"\n}\n]\n\n
\n
\n
\n","urlObject":{"protocol":"https","path":["legacy","PAC","API","GetLocations","{apiKey}","{ParamountRegion}"],"host":["api","webfdm","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad3588b6-35ca-432e-8efd-44e6a8e14282"},{"name":"InsertContracts","id":"c21bab4e-2cbf-486b-9838-839ae5e5828a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\"BuyerInfo\":{\r\n\"Address\":\"123 Street\",\r\n\"City\":\"MyTown\",\r\n\"State\":\"UT\",\r\n\"ZipCode\":\"12345\",\r\n\"HomePhone\":\"(123)456-7890\",\r\n\"WorkPhone\":null,\r\n\"CellPhone\":null,\r\n\"DriverLicense\":null,\r\n\"DriverLicenseExpiration\":null,\r\n\"FirstName\":\"Example\",\r\n\"LastName\":\"Test\",\r\n\"Email\":\"Test@Example.com\",\r\n\"Gender\":\"m\",\r\n\"Birthdate\":\"01/02/1993\"\r\n},\r\n\"MemberInfo\":{\r\n\"FirstName\":\"Example\",\r\n\"LastName\":\"Test\",\r\n\"Email\":\"Test@Example.com\",\r\n\"Gender\":\"m\",\r\n\"Birthdate\":\"01/02/1993\"\r\n},\r\n\"AlternateContact\":{\r\n\"FirstName\":null,\r\n\"LastName\":null,\r\n\"Relationship\":null,\r\n\"ContactPhone\":null\r\n},\r\n\"DownPayment\":{\r\n\"AccountNumber\":\"123456789\",\r\n\"RoutingNumber\":\"065000029\",\r\n\"EFTType\":\"2\",\r\n\"CVV2\":null,\r\n\"BillingZipCode\":\"12345\",\r\n\"ExpirationDate\":null,\r\n\"NameOnAccount\":\"Example Test\",\r\n\"Amount\":85.50\r\n},\r\n\"RecurringEFT\":{\r\n\"AccountNumber\":\"123456789\",\r\n\"RoutingNumber\":\"065000029\",\r\n\"EFTType\":\"2\",\r\n\"CVV2\":null,\r\n\"BillingZipCode\":\"12345\",\r\n\"ExpirationDate\":null,\r\n\"NameOnAccount\":\"Example Test\"\r\n\r\n},\r\n\"ClubId\":\"XXXX\",\r\n\"OptInForSms\":false,\r\n\"IPAddress\":\"123.456.78.9\",\r\n\"ReferredByClubId\":null,\r\n\"ReferredByMembNum\":null,\r\n\"ExistingClubId\":null,\r\n\"ExistingMembNum\":null,\r\n\"GuestId\":0.0,\r\n\"MembershipId\":[\r\n{\r\n\"Id\":12345,\r\n\"DownPaymentAmount\":85.50,\r\n\"AddOns\":[],\r\n\"SalesCredit\":[{\"CorpId\":\"\",\"EmployeeId\":\"1234567890\", \"Name\":\"Test Employee\"} ],\r\n\"MembershipBundles\":[{\"BundleID\":12345,\"BundleAmount\":5.00,\"BundleSelected\":true}],\r\n\"Signatures\":[{\"VerbiageId\":123456,\"Image\":null }]\r\n}\r\n],\r\n\"APIOrigin\":\"Online\"\r\n}"},"url":"https://dss.webfdm.com/legacy/PAC/API/InsertContracts/{apiKey}","description":"

API Endpoint to Insert 1 to many Membership Contracts.

\n

{apiKey}: ApiKey Provided by Paramount Acceptance

\n

Body Definitions and Description

\n

Down Payment Calculation

\n

Signature Example

\n

Initial Example

\n
\n
Response
\n
\n
\n
\n{\n    \"Success\": \"True\",\n    \"ContractNumber\": \"123456789W\",\n    \"Barcode\": \"\",\n    \"AddOnMembers\": [],\n    \"Error\": \"\"\n}\n\n
\n
\n
\n","urlObject":{"protocol":"https","path":["legacy","PAC","API","InsertContracts","{apiKey}"],"host":["dss","webfdm","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c21bab4e-2cbf-486b-9838-839ae5e5828a"},{"name":"GetEmployees","id":"316c2f95-5390-485b-b8d8-86c4f1e794f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"ClubId\":\"XXXX\"}"},"url":"https://api.webfdm.com/legacy/PAC/API/GetEmployees/{apiKey}","description":"

Endpoint to retrieve Employees for the Club that is passed up.

\n

{apiKey}: ApiKey Provided by Paramount Acceptance

\n
\n
Response
\n
\n
\n
\n[\n {\n        \"CorpId\": \"\",\n        \"EmployeeId\": \"0123456789\",\n        \"Name\": \"Employee One\"\n    },\n    {\n        \"CorpId\": \"\",\n        \"EmployeeId\": \"1234567890\",\n        \"Name\": \"Employee Two\"\n    }\n]\n\n
\n
\n
","urlObject":{"protocol":"https","path":["legacy","PAC","API","GetEmployees","{apiKey}"],"host":["api","webfdm","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"316c2f95-5390-485b-b8d8-86c4f1e794f4"},{"name":"GetContractTypes","id":"c30b534b-d068-4be4-b15d-83e77c7daee9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.webfdm.com/legacy/PAC/API/GetContractTypes/{apiKey}/{ClubId}","description":"

Endpoint to retrieve Contract Types for the location passed in.

\n

{apiKey}: ApiKey Provided by Paramount Acceptance

\n

{ClubId}: ClubId from the GetLocations Api Endpoint

\n
\n
Response
\n
\n
\n
\n[\n {\n        \"Contract_Type\": \"GM\",\n        \"Description\": \"Gym Membership\"\n    },\n    {\n        \"Contract_Type\": \"PT\",\n        \"Description\": \"Personal Training\"\n    },\n]\n\n
\n
\n
\n","urlObject":{"protocol":"https","path":["legacy","PAC","API","GetContractTypes","{apiKey}","{ClubId}"],"host":["api","webfdm","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c30b534b-d068-4be4-b15d-83e77c7daee9"}]}