POST api/salesreceiver/entry
Add a sales entry
Request Information
URI Parameters
Query String:
None.
Body Parameters
Data needed to add sales entries. Required.
Type: SalesEntrySet
Name | Description | Type | Additional information |
---|---|---|---|
sourceConfigId |
Sales Configuration used for this entry. |
globally unique identifier |
Required |
saleEntries |
A list of sale entries. |
Collection of SalesEntry |
Required |
Request Formats
application/json, text/json
Sample:
{ "sourceConfigId": "98ba80da-502b-4cca-abd3-af2416bad641", "saleEntries": [ { "EventTrigger": { "eventName": "sample string 1", "objectName": "sample string 2", "field": "sample string 3", "valueMatch": "sample string 4", "messages": [ { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" }, { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" } ] }, "memberMatch": { "memberCode": "sample string 1", "memberID": "sample string 2", "memberExternalID": "sample string 3", "memberEmail": "sample string 4" }, "referralMatch": { "referralID": "sample string 1", "referralExternalID": "sample string 2", "contacts": [ { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true }, { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true } ] }, "referralUpdate": { "companyName": "sample string 1", "businessName": "sample string 1", "amount": 1.1, "status": "sample string 3", "publicNote": "sample string 4", "privateNote": "sample string 5", "customFields": [ { "name": "sample string 1", "value": "sample string 2" }, { "name": "sample string 1", "value": "sample string 2" } ] } }, { "EventTrigger": { "eventName": "sample string 1", "objectName": "sample string 2", "field": "sample string 3", "valueMatch": "sample string 4", "messages": [ { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" }, { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" } ] }, "memberMatch": { "memberCode": "sample string 1", "memberID": "sample string 2", "memberExternalID": "sample string 3", "memberEmail": "sample string 4" }, "referralMatch": { "referralID": "sample string 1", "referralExternalID": "sample string 2", "contacts": [ { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true }, { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true } ] }, "referralUpdate": { "companyName": "sample string 1", "businessName": "sample string 1", "amount": 1.1, "status": "sample string 3", "publicNote": "sample string 4", "privateNote": "sample string 5", "customFields": [ { "name": "sample string 1", "value": "sample string 2" }, { "name": "sample string 1", "value": "sample string 2" } ] } } ] }
application/xml, text/xml
Sample:
<salesEntrySet xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <sourceConfigId>98ba80da-502b-4cca-abd3-af2416bad641</sourceConfigId> <saleEntries> <salesEntry xmlns=""> <EventTrigger xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:eventName>sample string 1</d4p1:eventName> <d4p1:field>sample string 3</d4p1:field> <d4p1:messages> <d4p1:EventMessage> <d4p1:configName>sample string 2</d4p1:configName> <d4p1:fieldName>sample string 4</d4p1:fieldName> <d4p1:level>sample string 1</d4p1:level> <d4p1:message>sample string 5</d4p1:message> <d4p1:objectName>sample string 3</d4p1:objectName> </d4p1:EventMessage> <d4p1:EventMessage> <d4p1:configName>sample string 2</d4p1:configName> <d4p1:fieldName>sample string 4</d4p1:fieldName> <d4p1:level>sample string 1</d4p1:level> <d4p1:message>sample string 5</d4p1:message> <d4p1:objectName>sample string 3</d4p1:objectName> </d4p1:EventMessage> </d4p1:messages> <d4p1:objectName>sample string 2</d4p1:objectName> <d4p1:valueMatch>sample string 4</d4p1:valueMatch> </EventTrigger> <memberMatch xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:memberCode>sample string 1</d4p1:memberCode> <d4p1:memberEmail>sample string 4</d4p1:memberEmail> <d4p1:memberExternalID>sample string 3</d4p1:memberExternalID> <d4p1:memberID>sample string 2</d4p1:memberID> </memberMatch> <referralMatch xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:contacts> <d4p1:Contact> <d4p1:contactId>sample string 1</d4p1:contactId> <d4p1:email>sample string 4</d4p1:email> <d4p1:email2>sample string 5</d4p1:email2> <d4p1:firstName>sample string 2</d4p1:firstName> <d4p1:is_main_contact>true</d4p1:is_main_contact> <d4p1:lastName>sample string 3</d4p1:lastName> <d4p1:phoneNumber>sample string 6</d4p1:phoneNumber> <d4p1:relationship>sample string 7</d4p1:relationship> </d4p1:Contact> <d4p1:Contact> <d4p1:contactId>sample string 1</d4p1:contactId> <d4p1:email>sample string 4</d4p1:email> <d4p1:email2>sample string 5</d4p1:email2> <d4p1:firstName>sample string 2</d4p1:firstName> <d4p1:is_main_contact>true</d4p1:is_main_contact> <d4p1:lastName>sample string 3</d4p1:lastName> <d4p1:phoneNumber>sample string 6</d4p1:phoneNumber> <d4p1:relationship>sample string 7</d4p1:relationship> </d4p1:Contact> </d4p1:contacts> <d4p1:referralExternalID>sample string 2</d4p1:referralExternalID> <d4p1:referralID>sample string 1</d4p1:referralID> </referralMatch> <referralUpdate xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:amount>1.1</d4p1:amount> <d4p1:businessName>sample string 1</d4p1:businessName> <d4p1:companyName>sample string 1</d4p1:companyName> <d4p1:customFields> <d4p1:ReferralCustomField> <d4p1:name>sample string 1</d4p1:name> <d4p1:value>sample string 2</d4p1:value> </d4p1:ReferralCustomField> <d4p1:ReferralCustomField> <d4p1:name>sample string 1</d4p1:name> <d4p1:value>sample string 2</d4p1:value> </d4p1:ReferralCustomField> </d4p1:customFields> <d4p1:privateNote>sample string 5</d4p1:privateNote> <d4p1:publicNote>sample string 4</d4p1:publicNote> <d4p1:status>sample string 3</d4p1:status> </referralUpdate> </salesEntry> <salesEntry xmlns=""> <EventTrigger xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:eventName>sample string 1</d4p1:eventName> <d4p1:field>sample string 3</d4p1:field> <d4p1:messages> <d4p1:EventMessage> <d4p1:configName>sample string 2</d4p1:configName> <d4p1:fieldName>sample string 4</d4p1:fieldName> <d4p1:level>sample string 1</d4p1:level> <d4p1:message>sample string 5</d4p1:message> <d4p1:objectName>sample string 3</d4p1:objectName> </d4p1:EventMessage> <d4p1:EventMessage> <d4p1:configName>sample string 2</d4p1:configName> <d4p1:fieldName>sample string 4</d4p1:fieldName> <d4p1:level>sample string 1</d4p1:level> <d4p1:message>sample string 5</d4p1:message> <d4p1:objectName>sample string 3</d4p1:objectName> </d4p1:EventMessage> </d4p1:messages> <d4p1:objectName>sample string 2</d4p1:objectName> <d4p1:valueMatch>sample string 4</d4p1:valueMatch> </EventTrigger> <memberMatch xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:memberCode>sample string 1</d4p1:memberCode> <d4p1:memberEmail>sample string 4</d4p1:memberEmail> <d4p1:memberExternalID>sample string 3</d4p1:memberExternalID> <d4p1:memberID>sample string 2</d4p1:memberID> </memberMatch> <referralMatch xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:contacts> <d4p1:Contact> <d4p1:contactId>sample string 1</d4p1:contactId> <d4p1:email>sample string 4</d4p1:email> <d4p1:email2>sample string 5</d4p1:email2> <d4p1:firstName>sample string 2</d4p1:firstName> <d4p1:is_main_contact>true</d4p1:is_main_contact> <d4p1:lastName>sample string 3</d4p1:lastName> <d4p1:phoneNumber>sample string 6</d4p1:phoneNumber> <d4p1:relationship>sample string 7</d4p1:relationship> </d4p1:Contact> <d4p1:Contact> <d4p1:contactId>sample string 1</d4p1:contactId> <d4p1:email>sample string 4</d4p1:email> <d4p1:email2>sample string 5</d4p1:email2> <d4p1:firstName>sample string 2</d4p1:firstName> <d4p1:is_main_contact>true</d4p1:is_main_contact> <d4p1:lastName>sample string 3</d4p1:lastName> <d4p1:phoneNumber>sample string 6</d4p1:phoneNumber> <d4p1:relationship>sample string 7</d4p1:relationship> </d4p1:Contact> </d4p1:contacts> <d4p1:referralExternalID>sample string 2</d4p1:referralExternalID> <d4p1:referralID>sample string 1</d4p1:referralID> </referralMatch> <referralUpdate xmlns:d4p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d4p1:amount>1.1</d4p1:amount> <d4p1:businessName>sample string 1</d4p1:businessName> <d4p1:companyName>sample string 1</d4p1:companyName> <d4p1:customFields> <d4p1:ReferralCustomField> <d4p1:name>sample string 1</d4p1:name> <d4p1:value>sample string 2</d4p1:value> </d4p1:ReferralCustomField> <d4p1:ReferralCustomField> <d4p1:name>sample string 1</d4p1:name> <d4p1:value>sample string 2</d4p1:value> </d4p1:ReferralCustomField> </d4p1:customFields> <d4p1:privateNote>sample string 5</d4p1:privateNote> <d4p1:publicNote>sample string 4</d4p1:publicNote> <d4p1:status>sample string 3</d4p1:status> </referralUpdate> </salesEntry> </saleEntries> </salesEntrySet>
Response Information
Resource Description
[HTTP Status 200 - OK]
Type: Collection of SalesEntry
Name | Description | Type | Additional information |
---|---|---|---|
EventTrigger |
Fields to describe what event caused the entry |
EventTrigger |
None. |
memberMatch |
Fields sent in to match with the member, if set and referral doesn't exist the referral will be added |
MemberMatch |
None. |
referralMatch |
Fields sent to find the referral to update |
ReferralMatch |
None. |
referralUpdate |
Fields to specificly update the referral |
ReferralUpdate |
None. |
Response Formats
application/json, text/json
Sample:
[ { "EventTrigger": { "eventName": "sample string 1", "objectName": "sample string 2", "field": "sample string 3", "valueMatch": "sample string 4", "messages": [ { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" }, { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" } ] }, "memberMatch": { "memberCode": "sample string 1", "memberID": "sample string 2", "memberExternalID": "sample string 3", "memberEmail": "sample string 4" }, "referralMatch": { "referralID": "sample string 1", "referralExternalID": "sample string 2", "contacts": [ { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true }, { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true } ] }, "referralUpdate": { "companyName": "sample string 1", "businessName": "sample string 1", "amount": 1.1, "status": "sample string 3", "publicNote": "sample string 4", "privateNote": "sample string 5", "customFields": [ { "name": "sample string 1", "value": "sample string 2" }, { "name": "sample string 1", "value": "sample string 2" } ] } }, { "EventTrigger": { "eventName": "sample string 1", "objectName": "sample string 2", "field": "sample string 3", "valueMatch": "sample string 4", "messages": [ { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" }, { "level": "sample string 1", "configName": "sample string 2", "objectName": "sample string 3", "fieldName": "sample string 4", "message": "sample string 5" } ] }, "memberMatch": { "memberCode": "sample string 1", "memberID": "sample string 2", "memberExternalID": "sample string 3", "memberEmail": "sample string 4" }, "referralMatch": { "referralID": "sample string 1", "referralExternalID": "sample string 2", "contacts": [ { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true }, { "contactId": "sample string 1", "firstName": "sample string 2", "lastName": "sample string 3", "email": "sample string 4", "email2": "sample string 5", "phoneNumber": "sample string 6", "relationship": "sample string 7", "is_main_contact": true } ] }, "referralUpdate": { "companyName": "sample string 1", "businessName": "sample string 1", "amount": 1.1, "status": "sample string 3", "publicNote": "sample string 4", "privateNote": "sample string 5", "customFields": [ { "name": "sample string 1", "value": "sample string 2" }, { "name": "sample string 1", "value": "sample string 2" } ] } } ]
application/xml, text/xml
Sample:
<ArrayOfsalesEntry xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <salesEntry> <EventTrigger xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:eventName>sample string 1</d3p1:eventName> <d3p1:field>sample string 3</d3p1:field> <d3p1:messages> <d3p1:EventMessage> <d3p1:configName>sample string 2</d3p1:configName> <d3p1:fieldName>sample string 4</d3p1:fieldName> <d3p1:level>sample string 1</d3p1:level> <d3p1:message>sample string 5</d3p1:message> <d3p1:objectName>sample string 3</d3p1:objectName> </d3p1:EventMessage> <d3p1:EventMessage> <d3p1:configName>sample string 2</d3p1:configName> <d3p1:fieldName>sample string 4</d3p1:fieldName> <d3p1:level>sample string 1</d3p1:level> <d3p1:message>sample string 5</d3p1:message> <d3p1:objectName>sample string 3</d3p1:objectName> </d3p1:EventMessage> </d3p1:messages> <d3p1:objectName>sample string 2</d3p1:objectName> <d3p1:valueMatch>sample string 4</d3p1:valueMatch> </EventTrigger> <memberMatch xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:memberCode>sample string 1</d3p1:memberCode> <d3p1:memberEmail>sample string 4</d3p1:memberEmail> <d3p1:memberExternalID>sample string 3</d3p1:memberExternalID> <d3p1:memberID>sample string 2</d3p1:memberID> </memberMatch> <referralMatch xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:contacts> <d3p1:Contact> <d3p1:contactId>sample string 1</d3p1:contactId> <d3p1:email>sample string 4</d3p1:email> <d3p1:email2>sample string 5</d3p1:email2> <d3p1:firstName>sample string 2</d3p1:firstName> <d3p1:is_main_contact>true</d3p1:is_main_contact> <d3p1:lastName>sample string 3</d3p1:lastName> <d3p1:phoneNumber>sample string 6</d3p1:phoneNumber> <d3p1:relationship>sample string 7</d3p1:relationship> </d3p1:Contact> <d3p1:Contact> <d3p1:contactId>sample string 1</d3p1:contactId> <d3p1:email>sample string 4</d3p1:email> <d3p1:email2>sample string 5</d3p1:email2> <d3p1:firstName>sample string 2</d3p1:firstName> <d3p1:is_main_contact>true</d3p1:is_main_contact> <d3p1:lastName>sample string 3</d3p1:lastName> <d3p1:phoneNumber>sample string 6</d3p1:phoneNumber> <d3p1:relationship>sample string 7</d3p1:relationship> </d3p1:Contact> </d3p1:contacts> <d3p1:referralExternalID>sample string 2</d3p1:referralExternalID> <d3p1:referralID>sample string 1</d3p1:referralID> </referralMatch> <referralUpdate xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:amount>1.1</d3p1:amount> <d3p1:businessName>sample string 1</d3p1:businessName> <d3p1:companyName>sample string 1</d3p1:companyName> <d3p1:customFields> <d3p1:ReferralCustomField> <d3p1:name>sample string 1</d3p1:name> <d3p1:value>sample string 2</d3p1:value> </d3p1:ReferralCustomField> <d3p1:ReferralCustomField> <d3p1:name>sample string 1</d3p1:name> <d3p1:value>sample string 2</d3p1:value> </d3p1:ReferralCustomField> </d3p1:customFields> <d3p1:privateNote>sample string 5</d3p1:privateNote> <d3p1:publicNote>sample string 4</d3p1:publicNote> <d3p1:status>sample string 3</d3p1:status> </referralUpdate> </salesEntry> <salesEntry> <EventTrigger xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:eventName>sample string 1</d3p1:eventName> <d3p1:field>sample string 3</d3p1:field> <d3p1:messages> <d3p1:EventMessage> <d3p1:configName>sample string 2</d3p1:configName> <d3p1:fieldName>sample string 4</d3p1:fieldName> <d3p1:level>sample string 1</d3p1:level> <d3p1:message>sample string 5</d3p1:message> <d3p1:objectName>sample string 3</d3p1:objectName> </d3p1:EventMessage> <d3p1:EventMessage> <d3p1:configName>sample string 2</d3p1:configName> <d3p1:fieldName>sample string 4</d3p1:fieldName> <d3p1:level>sample string 1</d3p1:level> <d3p1:message>sample string 5</d3p1:message> <d3p1:objectName>sample string 3</d3p1:objectName> </d3p1:EventMessage> </d3p1:messages> <d3p1:objectName>sample string 2</d3p1:objectName> <d3p1:valueMatch>sample string 4</d3p1:valueMatch> </EventTrigger> <memberMatch xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:memberCode>sample string 1</d3p1:memberCode> <d3p1:memberEmail>sample string 4</d3p1:memberEmail> <d3p1:memberExternalID>sample string 3</d3p1:memberExternalID> <d3p1:memberID>sample string 2</d3p1:memberID> </memberMatch> <referralMatch xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:contacts> <d3p1:Contact> <d3p1:contactId>sample string 1</d3p1:contactId> <d3p1:email>sample string 4</d3p1:email> <d3p1:email2>sample string 5</d3p1:email2> <d3p1:firstName>sample string 2</d3p1:firstName> <d3p1:is_main_contact>true</d3p1:is_main_contact> <d3p1:lastName>sample string 3</d3p1:lastName> <d3p1:phoneNumber>sample string 6</d3p1:phoneNumber> <d3p1:relationship>sample string 7</d3p1:relationship> </d3p1:Contact> <d3p1:Contact> <d3p1:contactId>sample string 1</d3p1:contactId> <d3p1:email>sample string 4</d3p1:email> <d3p1:email2>sample string 5</d3p1:email2> <d3p1:firstName>sample string 2</d3p1:firstName> <d3p1:is_main_contact>true</d3p1:is_main_contact> <d3p1:lastName>sample string 3</d3p1:lastName> <d3p1:phoneNumber>sample string 6</d3p1:phoneNumber> <d3p1:relationship>sample string 7</d3p1:relationship> </d3p1:Contact> </d3p1:contacts> <d3p1:referralExternalID>sample string 2</d3p1:referralExternalID> <d3p1:referralID>sample string 1</d3p1:referralID> </referralMatch> <referralUpdate xmlns:d3p1="http://schemas.datacontract.org/2004/07/ReferralRock.Api.Models.Request"> <d3p1:amount>1.1</d3p1:amount> <d3p1:businessName>sample string 1</d3p1:businessName> <d3p1:companyName>sample string 1</d3p1:companyName> <d3p1:customFields> <d3p1:ReferralCustomField> <d3p1:name>sample string 1</d3p1:name> <d3p1:value>sample string 2</d3p1:value> </d3p1:ReferralCustomField> <d3p1:ReferralCustomField> <d3p1:name>sample string 1</d3p1:name> <d3p1:value>sample string 2</d3p1:value> </d3p1:ReferralCustomField> </d3p1:customFields> <d3p1:privateNote>sample string 5</d3p1:privateNote> <d3p1:publicNote>sample string 4</d3p1:publicNote> <d3p1:status>sample string 3</d3p1:status> </referralUpdate> </salesEntry> </ArrayOfsalesEntry>