Get started

API Endpoint
http://demo.joynadmin.org/                

The joyn API enables our client to link their association website with the AMS software or access and manage their association data in joyn using a 3rd party integration.

All APIs under the joyn API are based on REST architecture and are accessed via HTTPS at specified URLs. To use joyn API you will need to be a client or a vendor associated with on of our clients. Please contact API Admin to get the secret key and relevant information to consume our APIs.

doLoginPOST

Response:
{
    "aff_id": "Affiliate ID",
    "user_fname": "First name",
    "user_lname": "Last name",
    "member_cat": "Member category",
    "member_type": "Member Type / User Type",
    "paid_thru_date.sec": "Paid through date of an affiliate. i.e, Affliate membership is valid till this date. Field value is in Unix timestamp (the number of seconds since January 1 1970 00:00:00 UTC)",
    "pay_dues": "true / false This affiliate has any open billing documents to pay?",
    "org": "True / False This will let you know if affiliate is organization record or not",
    "mstatus": "Member Status Like Active/Inactive/Lapsed etc."
}
                    

resetPasswordPOST

Response:
{
    success: 1
}
                    

changePasswordGET

Response:
{
    success: 1
}
                    

getDropdownsGET

Response:
Each dropdown field will have an array of keys (Field name “k”) and values (Field name “v”). Always key should be passed to create / update user account.

For example, if user selects “Male” as his gender, then key value of Male is “M” and this should be passed to “gender” field to create / update user details.

{
  "prefix": [
    {
      "k": "Mr",
      "v": "Mr."
    },
    {
      "k": "Dr",
      "v": "Dr."
    },
    {
      "k": "Mrs",
      "v": "Mrs."
    },
}
                    

creditEduHoursPOST

Response:
{
     success: 1
}
                    

getMemberDuesGET

Response:
{
    "_id": "Billing document number",
    "a_id": "Affiliate ID",
    "gross_amt": "Gross amount",
    "adj_amt": "Total discount amount",
    "adj_det": [{
        "amt": "Discount amount",
        "r": "Discount reason"
    }],
    "bill_amt": "Billed amount(Gross Amount– Discount Amount)",
    "bill_date.s": "Billed date",
    "bdate.sec": "Begin date",
    "edate.sec": "End Date",
    "o_id": "Order id",
    "p_code": "Product code “pcode” is dropdown field.Product descriptions for product codes can be fetched from getDropdowns api.",
    "pline": "Product line | Dropdown field– p_line",
    "p_grp": "Product Group | Dropdown field– p_grp",
    "p_sgrp": "Product Sub Group | Dropdown field– p_sgrp",
    "qty": "Quantity",
    "recur": "Is this recurring billing ?",
    "status": "Billing document status",
    "uom": "Currency",
    "taxes": "Array | If association has setup any tax for the membership or products applicable tax name and percentage will be sent as array of objects",
    "promo_code": "If product has any applicable promo code that can be used then this parameter will be sent as true else this parameter will not be sent",
    "secondary_aff_bills": "Array | of object(Bill Details) When primary affiliate logs in to pay member due then we give an option for them to pay all there secondary affiliates associated with affiliate"
}
                    

searchDirectoryGET

Response:
{
    "affiliates": [{
        "aff_id": "Affiliate ID",
        "fname": "First Name",
        "lname": "Last Name",
        "email": "E-mail address",
        "mcat": "Member Category",
        "company": "Company",
        "jtitle": "Job Title",
        "city": "City",
        "state": "State",
        "phone": "Phone number",
        "search_dir": "Member Search Directory Flag",
    }],
    "total_Count": "Total number of affiliate matches for given search criteria. This will be helpful in pagination."
}
                    

getPrimaryAffConnectionsGET

Response:
{
    "affiliates":  [
        {
            "_id": "Affiliate ID",
            "fname": "First Name",
            "lname": "Last Name",
            "email": "Email Address",
            "mcat": "Affiliate Category",
            "company": "Company Name",
            "mstatus": "Affiliate Status",
            "pthru": "Paid Through Date",
            "user_type": "Affiliate Type",
            "company_admin": "Company Admin Flag",
        }
    ],
    "count": "Total Number of Connected Affiliates"
}
                    

getUserDetailsGET

Response:
{
  "aff_details": {
    "_id": 5000002,
    "biography": "Dr. O’Connor is a graduate of the U-M Medical School and completed his internal medicine residency at the U-M Medical Center,\nwhere he served as Chief Medical Resident. He currently serves as Associate Division Chief for Clinical Programs in the Division of\nGeneral Medicine.*He is also Medical Director of Briarwood Medical Group. Dr. O’Connor has been cited in The Best Doctors in the\nU.S.: Midwest Edition since 1996. He is interested in comprehensive primary care of adults.",
    "company": "University of Michigan Health System",
    "disp_name": "Thomas Patrick O’Connor MD",
    "dob": {
      "sec": 45253,
      "usec": 0
    },
    "email": "[email protected]",
    "ethnicity": "W",
    "fname": "Thomas",
    "gender": "M",
    "invited_by": "Carl J. Jenkins",
    "jtitle": "Associate Professor, Internal Medicine",
    "l_login": {
      "sec": 1387941249,
      "usec": 418000
    },
    "lname": "O’Connor",
    "mname": "Patrick",
    "prefix": "Dr",
    "second_cont": {
      "fname": "Tammy",
      "lname": "Williams",
      "phone": "6155551278",
      "email": "[email protected]",
      "prefix": "Mrs"
    },
    "user_type": "N"
  },
  "addresses": [
    {
      "_id": 7000001,
      "a_id": 5000002,
      "add1": "123 Cherry Lane",
      "add2": "",
      "add3": "",
      "add_type": "H",
      "bill2": 1,
      "city": "Ann Arbor",
      "company": "",
      "country": "US",
      "county": "",
      "email": "[email protected]",
      "email2": 1,
      "fax": "",
      "mail2": 1,
      "mobile": "",
      "phone": "",
      "ship2": 0,
      "state": "MI",
      "url": "",
      "zip": "48108"
    },
  ]
}
                    

updateUserDetailsPOST

Response:
{
    success: 1,
    aff_id: Affiliate ID
}

                    

getPaymentDetailsGET

Response:
{
    "payment_details": [{
        "_id": "Payment ID",
        "a_id": "Affiliate ID",
        "b_id": "Billing ID",
        "bdate": "Begin Date (Object)",
        "edate": "End Date (Object)",
        "p_code": "Product Code",
        "p_amt": "Paid Amount",
        "paid_date": "Paid On Date",
        "status": "Payment Status",
        "qty": "Quantity",
        "notes": "Notes",
    }],
    "edu_hrs":  1,
}
                    

getOpenOrdersGET

Response:
{
    "Field": "Description",
    "_id": "OrderID",
    "a_id": "Affiliate ID",
    "b_amt": "Billing Amount",
    "bdate": "Begin Date",
    "cby": "Created By",
    "con": "Created On",
    "edate": "End Date",
    "freq": "Frequency ",
    "uom": "Unit of Money",
    "qty": "Quantity",
    "status": "Status of the order",
    "pterms": "Payment Terms",
    "p_line": "Product Line",
    "p_grp": "Product Group",
    "p_sgrp": "Product Sub Group",
    "p_code": "Product Code",
    "o_amt": "Order Amt",
    "recur": "Recurring Flag"
}
                    

payMemberDuesPOST

Response:
{
    "paid_thru_date.sec": "Updated affiliate paid through date after payment Unix timestamp",
    "payment_ids": "Array of payment ids for the paid billing documents",
    "success": 1,
}
                    

checkOutMultipleProductPOST

Response:
{
    "bill_ids": "Array Billing Numbers",
    "bill_amt_details": [
        {
            "bill_num": "Billing Number",
            "bill_amt": "Billing Amount"
        }
    ]
}
                    

buyproductPOST

Response:
{
    "billNum":  Billing ID,
    "billAmt": "Billing Amount"
    "zero_val_bill": "True will be sent if billing amount is zero (Boolean)"
}
                    

applyPromoCodePOST

Response:
{
    "success":  Boolean,
    "msg": "Promotional Discount Applied Successfully
                or
            Required Parameters were not passed for the API.
                or
            Promo Code entered is not valid.
                or
            Selected Bill is not valid.
                or
            Promo Code already applied for selected bill."
}
                    

cancelOpenOrdersPOST

Response:
{
    success: true,
    orders_closed: Number of Orders closed (Count)
}
                    

updateOrderARBPOST

Response:
{
    "success":  1,
}
                    

linkAuthNetCustProfWithAffProfPOST

Response:
{
     success: 1
}
                    

createAuthNetSubByCustProfPOST

Response:
{
    "success": 1,
    "subscription_ids": [
        {
            "bill_id": "", 
            "subscription_id": ""
        }
    ]
}
                    

createAuthNetInstallmentByCustProfPOST

Response:
{
    "success": 1,
    "installment_id": "Installment ID"
}
                    

updateAuthNetCustProfWithAffProfPOST

Response:
{
    "success": 1
}
                    

deleteAuthNetCustProfPOST

Response:
{
    "success": 1
}
                    

Response codes and error messages

The JoynAMS API uses the following error codes