WEBCentralizedShoppingCartAccreditationSetLineItems
|
Initial Build |
2017.1 |
|
xWeb |
xWeb Method |
|
Response Type |
Object |
This method is used to add and remove fees for an Accrediation Object. This method should be called before adding the object to the Shopping Cart Object.
Parameters
- oAccreditation (Accreditation Object). The accreditation object. Use the CurrentKey field to pass the accreditation key to the method.
- oFeeCollection (FeeCollection Object). The fees to be added or removed for this customer.
Response
Accreditation Object - the accreditation object with the invoice details collection updated to match the fee collection. New invoice details will be created for fees to add and existing invoice details will be removed for fees to remove. The details of the object returned vary based on the line items set by the request.
Exceptions
This method issues exceptions for invalid keys and data.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<ns:Token>***********************</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBCentralizedShoppingCartAccreditationSetLineItems>
<ns:oAccreditation>
<ns:CurrentKey>5fb6bf9a-0cda-4a7a-b8d0-723cbef2f0c6</ns:CurrentKey>
[[Accreditation]]
</ns:oAccreditation>
<ns:oFeeCollection>
<!--Zero or more repetitions:-->
[[FeeCollection]]
</ns:oFeeCollection>
</ns:WEBCentralizedShoppingCartAccreditationSetLineItems>
</soapenv:Body>
</soapenv:Envelope>
JSON Method
POST /xWeb/JSON/WEBCentralizedShoppingCartAccreditationSetLineItems
Copy
DATA: JSON
"WEBCentralizedShoppingCartAccreditationSetLineItems" : {
"oAccreditation" : {{accreditationObjFromGetNew}},
"oFeeCollection" : [
{
"prc_key":"{{prcKeyAccreditationFee}}",
"action" : "0",
"qty" : "1",
"overrideAmount":"{{prcOverrideAmountAccreditationFee}}"
}
]
}
}
Copy
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"AccreditationAreaType": {
"Accreditation_Customer": {
"amc_key": "02f20b60-1787-4c1a-bd3d-d05ffe88cdab",
"amc_cst_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"amc_key_ext": "02f20b60-1787-4c1a-bd3d-d05ffe88cdab",
"amc_ama_key": "d68697e9-2c08-4206-a7af-f7e8733ff8a3"
},
"Customer": {
"cst_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"cst_type": "Organization",
"cst_name_cp": "Keebler Corp",
"cst_sort_name_dn": "Keebler Corp",
"cst_org_name_dn": "Keebler Corp",
"cst_add_date": "2021-10-27T17:47:00+13:00",
"cst_add_user": "phil.roberts",
"cst_change_date": "2021-10-27T17:47:00+13:00",
"cst_change_user": "phil.roberts",
"cst_delete_flag": "0",
"cst_recno": "6927",
"cst_id": "000006927O",
"cst_key_ext": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"cst_email_text_only": "0",
"cst_tax_exempt_flag": "0",
"cst_no_email_flag": "0",
"cst_no_phone_flag": "0",
"cst_no_fax_flag": "0",
"cst_no_web_flag": "0",
"cst_member_flag": "0",
"cst_no_msg_flag": "0",
"cst_no_mail_flag": "0",
"cst_web_force_password_change": "0",
"cst_web_login_disabled_flag": "0",
"cst_credit_hold_flag": "0",
"cst_web_forgot_password_status": "0",
"cst_no_publish_flag": "0",
"cst_exclude_from_social_flag": "0",
"cst_web_login_locked_flag": "0"
},
"Customer_Address": null,
"Customer_Primary_Address": {
"adr_state": "VA",
"adr_country": "UNITED STATES"
},
"Organization": {
"org_consortia_flag": "0",
"org_cst_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"org_name": "Keebler Corp",
"org_cst_key_ext": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"org_add_date": "2021-10-27T17:47:00+13:00",
"org_nonprofit_flag": "0",
"org_add_user": "phil.roberts",
"org_delete_flag": "0"
},
"Accreditation": {
"ama_key": "d68697e9-2c08-4206-a7af-f7e8733ff8a3",
"ama_code": "NAEYC Accreditation",
"ama_desc": "NAEYC Accreditation",
"ama_add_user": "joanna.szarko",
"ama_add_date": "2021-02-18T00:00:00+13:00",
"ama_change_user": "joanna.szarko",
"ama_change_date": "2021-02-18T00:00:00+13:00",
"ama_delete_flag": "0",
"ama_key_ext": "d68697e9-2c08-4206-a7af-f7e8733ff8a3"
},
"Accreditation_Status": null,
"Accreditation_Type": null,
"Individual_Organization_CEO_Affiliation": null,
"Affiliated_CEO": null,
"Individual_Organization_CAO_Affiliation": null,
"Affiliated_CAO": null,
"Individual_Organization_CMOA_ffiliation": null,
"Affiliated_CMO": null,
"Individual_Organization_Survey_Contact_Affiliation": null,
"Affiliated_Survey_Contact": null,
"Individual_Decision_Letter_Recipient": null,
"Decision_Letter_Recipient": null,
"Invoice": {
"inv_print_count": "0",
"inv_ship_priority": "3",
"inv_AutoRefund": "0",
"inv_eweb_credit_available": "0.00",
"inv_eweb_apply_credit_amount": "0.00",
"inv_total": "0.00",
"inv_amount": "0.00",
"inv_balance": "0.00",
"inv_payment_to_apply_distributed": "0.00",
"inv_close_opportunity": "0",
"inv_credit_to_apply_distributed": "0.00",
"inv_distributable_credit_total": "0.00",
"inv_distributable_credit_balance": "0.00",
"inv_paid_by_liability_balance": "0.00",
"inv_nettotal": "0.00",
"inv_netpayment": "0.00",
"inv_credit_to_apply": "0.00",
"inv_netbalance": "0.00",
"inv_netcredit": "0.00",
"inv_netunpaidbalance": "0.00",
"inv_netwriteoff": "0.00",
"inv_writeoff_to_apply": "0.00",
"inv_netreturn": "0.00",
"inv_return_to_apply": "0.00",
"inv_netapplied": "0.00",
"inv_previous_netapplied": "0.00",
"inv_previous_netpayment": "0.00",
"inv_total_to_apply": "0.00",
"inv_allow_payment_with_frozen_payment_method": "0",
"inv_select_all": "0",
"inv_autoapply": "0",
"inv_autoapplypayment": "0",
"inv_installment_flag": "0",
"inv_coe_flag": "0",
"inv_shippable_total": "0.00",
"inv_unapplied_shipping_total": "0.00",
"inv_shippable_items_flag": "0",
"inv_autoapplycredit": "0",
"inv_bill_me": "0",
"inv_HasNewLineItems": "0",
"inv_HasOldLineItems": "0",
"inv_total_weight": "0.00",
"inv_discount": "0.00",
"inv_shipping": "0.00",
"inv_tax": "0.00"
},
"Payment": null,
"Payment_Info": {
"pin_hosted_page_available": "0",
"pin_mobile_app_available": "0",
"pin_hosted_payment": "0",
"pin_isvault": "0",
"pin_tax_amt": "0.00",
"pin_billing_info_required_for_ach_flag": "0",
"pin_allow_online_payment_flag": "0",
"pin_preferred_flag": "0"
},
"Payment_Method": null,
"Invoice_DetailCollection": {
"InvoiceDetail": [
{
"Invoice_Detail": {
"ivd_price_previous": "495.00",
"ivd_qty_previous": "1.00",
"ivd_key": "6cd93b29-cbba-4e60-bd50-a230db2c42fe",
"ivd_price": "495.00",
"ivd_qty": "1.0000",
"ivd_close_flag": "0",
"ivd_prc_key": "718aa98f-78e4-4d4d-81ca-3ddb8996818c",
"ivd_prc_prd_key": "22023ff6-efaf-4d8a-abc2-7b847017f93f",
"ivd_amount_cp": "495.00",
"ivd_parity": "1",
"ivd_cst_ship_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"ivd_prc_prd_ptp_key": "931161ef-4834-4511-9d93-efb6565c9146",
"ivd_type": "Product",
"ivd_createorder_flag": "0",
"ivd_lineamount": "495.00",
"ivd_lineamount_no_discount": "495.00",
"ivd_createinvoice_flag": "1",
"ivd_linebalance": "495.00",
"ivd_net_amount_due": "495.00",
"ivd_payamount": "0.00",
"ivd_disable_quantity": "0",
"ivd_subtotal": "495.00",
"ivd_discountamount": "0.00",
"ivd_total": "495.00",
"ivd_applied_payment": "0.00",
"ivd_applied_credit": "0.00",
"ivd_write_off": "0.00",
"ivd_return_payment": "0.00",
"ivd_balance": "495.00",
"ivd_tax": "0.00",
"ivd_shipping": "0.00",
"ivd_nettotal": "495.00",
"ivd_netpayment": "0.00",
"ivd_payment_to_apply": "0.00",
"ivd_credit_to_apply": "0.00",
"ivd_netcredit": "0.00",
"ivd_netwriteoff": "0",
"ivd_writeoff_to_apply": "0.00",
"ivd_netreturn": "0.00",
"ivd_return_to_apply": "0.00",
"ivd_netapplied": "0.00",
"ivd_previous_netpayment": "0.00",
"ivd_total_to_apply": "0.00",
"ivd_netbalance": "495.00",
"ivd_netunpaidbalance": "495.00",
"ivd_price_aggregated": "495.00",
"ivd_discountamount_aggregated": "0.00",
"ivd_tax_aggregated": "0.00",
"ivd_shipping_aggregated": "0.00",
"ivd_nettotal_aggregated": "495.00",
"ivd_netunpaidbalance_aggregated": "495.00",
"ivd_shippable_flag_aggregated": "0",
"ivd_partof_groupreg_discount": "0",
"ivd_cst_credit_available": "0.00",
"ivd_term_based": "0",
"ivd_sub_prorated_flag": "0",
"ivd_autoapply": "0",
"ivd_is_agency_sub": "0",
"ivd_formdetailkey": "6cd93b29-cbba-4e60-bd50-a230db2c42fe",
"ivd_formkey": "3d466e13-a42e-427d-bdfe-ffc8cf188788",
"ivd_parentdataobject": "Invoice Detail",
"ivd_addl_info": "Keebler Corp",
"ivd_shippable_flag": "0",
"ivd_inv_shippable_total": "0.00",
"ivd_inv_distributable_credit_total": "0"
},
"Invoice_Detail_Term": null,
"Invoice": {
"inv_print_count": "0",
"inv_ship_priority": "3",
"inv_cst_billing_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e"
},
"Price": {
"prc_key": "718aa98f-78e4-4d4d-81ca-3ddb8996818c",
"prc_prd_key": "22023ff6-efaf-4d8a-abc2-7b847017f93f",
"prc_price": "495.00",
"prc_add_user": "joanna.szarko",
"prc_add_date": "2021-02-18T08:40:13+13:00",
"prc_change_user": "John.Doe1",
"prc_change_date": "2021-10-20T09:06:09+13:00",
"prc_delete_flag": "0",
"prc_key_ext": "718aa98f-78e4-4d4d-81ca-3ddb8996818c",
"prc_gla_ar_key": "30ba4896-ef2e-4bfc-a0aa-7fb1472b32d7",
"prc_gla_revenue_key": "71e39612-e9da-4d71-865c-a8bfecd11660",
"prc_gla_liability_key": "e35925d1-fb18-4296-8d0e-755dcf7631a1",
"prc_gla_return_key": "71e39612-e9da-4d71-865c-a8bfecd11660",
"prc_gla_writeoff_key": "0294f2b1-c873-4d9c-b636-cb23e370fdb8",
"prc_prd_ptp_key": "931161ef-4834-4511-9d93-efb6565c9146",
"prc_percent": "0.0000",
"prc_percent_cp": "0.00",
"prc_prd_atc_key": "77b40124-02d2-48d2-a427-ebdce3b26ef4",
"prc_display_name": "NAEYC Accreditation ",
"prc_sell_online": "1",
"prc_deferred_flag": "0",
"prc_mail": "0",
"prc_email": "0",
"prc_fax": "0",
"prc_account_split_flag": "0",
"prc_prorate_flag": "0",
"prc_prorate_first_year_flag": "0",
"prc_web": "0",
"prc_microfiche": "0",
"prc_revenue_recog_frequency": "1",
"prc_allow_installment": "0",
"prc_shippable_flag": "0",
"prc_recognize_by_issue_flag": "0",
"prc_num_grace_issues": "0",
"prc_back_issue_flag": "0",
"prc_renew_unpaid_orders_flag": "1",
"prc_allow_unpaid_orders_flag": "1",
"prc_award_credit_flag": "0",
"prc_allow_sync_flag": "0",
"prc_no_discount_flag": "0"
},
"Product": {
"prd_key": "22023ff6-efaf-4d8a-abc2-7b847017f93f",
"prd_name": "NAEYC Accreditation",
"prd_add_user": "joanna.szarko",
"prd_add_date": "2021-02-18T08:40:13+13:00",
"prd_change_user": "John.Doe1",
"prd_change_date": "2021-10-20T09:05:59+13:00",
"prd_delete_flag": "0",
"prd_qty_available": "-1.00",
"prd_key_ext": "22023ff6-efaf-4d8a-abc2-7b847017f93f",
"prd_allow_partial_ship_flag": "0",
"prd_track_inventory_flag": "0",
"prd_ptp_key": "931161ef-4834-4511-9d93-efb6565c9146",
"prd_taxable_flag": "0",
"prd_allow_backorder": "0",
"prd_atc_key": "77b40124-02d2-48d2-a427-ebdce3b26ef4",
"prd_qty_reorder": "0.0000",
"prd_restock_fee": "0.00",
"prd_restock_percent": "0.0000",
"prd_restock_percent_cp": "0.00",
"prd_mail": "0",
"prd_email": "0",
"prd_fax": "0",
"prd_sell_online": "1",
"prd_web": "0",
"prd_microfiche": "0",
"prd_featured_product_flag": "0"
},
"ShipToCustomer": {
"cst_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"cst_type": "Organization",
"cst_name_cp": "Keebler Corp",
"cst_sort_name_dn": "Keebler Corp",
"cst_org_name_dn": "Keebler Corp",
"cst_add_date": "2021-10-27T17:47:00+13:00",
"cst_add_user": "phil.roberts",
"cst_change_date": "2021-10-27T17:47:00+13:00",
"cst_change_user": "phil.roberts",
"cst_delete_flag": "0",
"cst_recno": "6927",
"cst_id": "000006927O",
"cst_key_ext": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"cst_email_text_only": "0",
"cst_tax_exempt_flag": "0",
"cst_no_email_flag": "0",
"cst_no_phone_flag": "0",
"cst_no_fax_flag": "0",
"cst_no_web_flag": "0",
"cst_member_flag": "0",
"cst_no_msg_flag": "0",
"cst_no_mail_flag": "0",
"cst_web_force_password_change": "0",
"cst_web_login_disabled_flag": "0",
"cst_credit_hold_flag": "0",
"cst_web_forgot_password_status": "0",
"cst_no_publish_flag": "0",
"cst_exclude_from_social_flag": "0",
"cst_web_login_locked_flag": "0"
},
"SoldToCustomer": null,
"Shipping_Address": null,
"Shipping_Address_Type": null,
"Invoice_Detail_Additional": null,
"Package_Component": {
"pkg_qty": "1.0000"
},
"Bundle_Component": null,
"Product_Type": {
"ptp_key": "931161ef-4834-4511-9d93-efb6565c9146",
"ptp_code": "Accreditation",
"ptp_add_user": "blam",
"ptp_add_date": "2003-03-06T12:18:19+13:00",
"ptp_change_user": "skatragadda",
"ptp_change_date": "2004-10-29T10:48:23+13:00",
"ptp_delete_flag": "0",
"ptp_key_ext": "931161ef-4834-4511-9d93-efb6565c9146",
"ptp_sell_online": "1",
"ptp_online_code": "Accreditation",
"ptp_discount_flag": "0",
"ptp_exclude_from_bundle_flag": "0",
"ptp_disallow_fractions": "1"
},
"Discount_Product_X_Product": null,
"Billing_Address": null,
"Currency": {
"cur_separator": ",",
"cur_calc_method": "multiply",
"cur_fraction_separator": "."
},
"Order_Detail_Schedule": null,
"Invoice_Detail_IP_Range": null,
"Product_Type_Social_Messages": null,
"Invoice_Detail_Liability": null,
"Credit_Detail": {
"cdd_type": "create credit",
"cdd_required_usage_flag": "0"
},
"Invoice_Detail_Amount_Due": null,
"Invoice_Detail_Get_Balance": null,
"Additional_Invoice_DetailCollection": null,
"Invoice_Detail_AdditionalCollection": null,
"Invoice_Detail_LiabilityCollection": null
}
]
}
}
}