GET api/attorneys/{userId}/referrers/{referrerId}/fees/referral

Use this method to retrieve account ledger row items for referral fees associated with a referral/share fee attorney

Requires Authorization!

Request Information

URI Parameters

Name	Description	Type	Additional information
userId	Active Attorney Id	integer	Required
referrerId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Row model of account ledger referral fees model

Collection of AccountLedgerReferralFeeRowResponseModel

Name	Type	Additional information
CollectedCaseFees	decimal number	None.
ReferralFeesAllocated	decimal number	None.
ReferralPaymentAmount	decimal number	None.
ReferralPaymentNotes	string	None.
ReferralPaymentCheckNo	string	None.
IsRefundable	boolean	None.
ReferralPaymentMethodId	integer	None.
ReferralPaymentMethod	string	None.
ReferralFeePercent	decimal number	None.
TotalFees	decimal number	None.
Id	integer	None.
UserPropertyId	integer	None.
PropertyAddressId	integer	None.
CaseNumber	string	None.
AssessmentYear	integer	None.
SubjectPropertyAddress	string	None.
Date	string	None.
CaseStatus	string	None.
CaseStatusId	string	None.
AttorneyId	integer	None.
BusinessClientId	integer	None.
Description	string	None.
RecordType	string	None.
Balance	decimal number	None.
ClientFullName	string	None.
AttorneyAffiliateCode	string	None.
CaseTypeId	integer	None.
ClientPhoneNumber	string	None.
CountyId	integer	None.
AttorneyFullName	string	None.
Referrer	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "collectedCaseFees": 1.0,
    "referralFeesAllocated": 1.0,
    "referralPaymentAmount": 1.0,
    "referralPaymentNotes": "sample string 1",
    "referralPaymentCheckNo": "sample string 2",
    "isRefundable": true,
    "referralPaymentMethodId": 1,
    "referralPaymentMethod": "sample string 4",
    "referralFeePercent": 1.0,
    "totalFees": 5.0,
    "id": 6,
    "userPropertyId": 1,
    "propertyAddressId": 1,
    "caseNumber": "sample string 7",
    "assessmentYear": 1,
    "subjectPropertyAddress": "sample string 8",
    "date": "sample string 9",
    "caseStatus": "sample string 10",
    "caseStatusId": "sample string 11",
    "attorneyId": 12,
    "businessClientId": 1,
    "description": "sample string 13",
    "recordType": "sample string 14",
    "balance": 15.0,
    "clientFullName": "sample string 16",
    "attorneyAffiliateCode": "sample string 17",
    "caseTypeId": 18,
    "clientPhoneNumber": "sample string 19",
    "countyId": 20,
    "attorneyFullName": "sample string 21",
    "referrer": "sample string 22"
  },
  {
    "collectedCaseFees": 1.0,
    "referralFeesAllocated": 1.0,
    "referralPaymentAmount": 1.0,
    "referralPaymentNotes": "sample string 1",
    "referralPaymentCheckNo": "sample string 2",
    "isRefundable": true,
    "referralPaymentMethodId": 1,
    "referralPaymentMethod": "sample string 4",
    "referralFeePercent": 1.0,
    "totalFees": 5.0,
    "id": 6,
    "userPropertyId": 1,
    "propertyAddressId": 1,
    "caseNumber": "sample string 7",
    "assessmentYear": 1,
    "subjectPropertyAddress": "sample string 8",
    "date": "sample string 9",
    "caseStatus": "sample string 10",
    "caseStatusId": "sample string 11",
    "attorneyId": 12,
    "businessClientId": 1,
    "description": "sample string 13",
    "recordType": "sample string 14",
    "balance": 15.0,
    "clientFullName": "sample string 16",
    "attorneyAffiliateCode": "sample string 17",
    "caseTypeId": 18,
    "clientPhoneNumber": "sample string 19",
    "countyId": 20,
    "attorneyFullName": "sample string 21",
    "referrer": "sample string 22"
  }
]

text/html

Sample:

[{"collectedCaseFees":1.0,"referralFeesAllocated":1.0,"referralPaymentAmount":1.0,"referralPaymentNotes":"sample string 1","referralPaymentCheckNo":"sample string 2","isRefundable":true,"referralPaymentMethodId":1,"referralPaymentMethod":"sample string 4","referralFeePercent":1.0,"totalFees":5.0,"id":6,"userPropertyId":1,"propertyAddressId":1,"caseNumber":"sample string 7","assessmentYear":1,"subjectPropertyAddress":"sample string 8","date":"sample string 9","caseStatus":"sample string 10","caseStatusId":"sample string 11","attorneyId":12,"businessClientId":1,"description":"sample string 13","recordType":"sample string 14","balance":15.0,"clientFullName":"sample string 16","attorneyAffiliateCode":"sample string 17","caseTypeId":18,"clientPhoneNumber":"sample string 19","countyId":20,"attorneyFullName":"sample string 21","referrer":"sample string 22"},{"collectedCaseFees":1.0,"referralFeesAllocated":1.0,"referralPaymentAmount":1.0,"referralPaymentNotes":"sample string 1","referralPaymentCheckNo":"sample string 2","isRefundable":true,"referralPaymentMethodId":1,"referralPaymentMethod":"sample string 4","referralFeePercent":1.0,"totalFees":5.0,"id":6,"userPropertyId":1,"propertyAddressId":1,"caseNumber":"sample string 7","assessmentYear":1,"subjectPropertyAddress":"sample string 8","date":"sample string 9","caseStatus":"sample string 10","caseStatusId":"sample string 11","attorneyId":12,"businessClientId":1,"description":"sample string 13","recordType":"sample string 14","balance":15.0,"clientFullName":"sample string 16","attorneyAffiliateCode":"sample string 17","caseTypeId":18,"clientPhoneNumber":"sample string 19","countyId":20,"attorneyFullName":"sample string 21","referrer":"sample string 22"}]

application/xml, text/xml

Sample:

<ArrayOfAccountLedgerReferralFeeRowResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.ReferrerBinding">
  <AccountLedgerReferralFeeRowResponseModel>
    <AssessmentYear>1</AssessmentYear>
    <AttorneyAffiliateCode>sample string 17</AttorneyAffiliateCode>
    <AttorneyFullName>sample string 21</AttorneyFullName>
    <AttorneyId>12</AttorneyId>
    <Balance>15</Balance>
    <BusinessClientId>1</BusinessClientId>
    <CaseNumber>sample string 7</CaseNumber>
    <CaseStatus>sample string 10</CaseStatus>
    <CaseStatusId>sample string 11</CaseStatusId>
    <CaseTypeId>18</CaseTypeId>
    <ClientFullName>sample string 16</ClientFullName>
    <ClientPhoneNumber>sample string 19</ClientPhoneNumber>
    <CountyId>20</CountyId>
    <Date>sample string 9</Date>
    <Description>sample string 13</Description>
    <Id>6</Id>
    <PropertyAddressId>1</PropertyAddressId>
    <RecordType>sample string 14</RecordType>
    <Referrer>sample string 22</Referrer>
    <SubjectPropertyAddress>sample string 8</SubjectPropertyAddress>
    <UserPropertyId>1</UserPropertyId>
    <CollectedCaseFees>1</CollectedCaseFees>
    <IsRefundable>true</IsRefundable>
    <ReferralFeePercent>1</ReferralFeePercent>
    <ReferralFeesAllocated>1</ReferralFeesAllocated>
    <ReferralPaymentAmount>1</ReferralPaymentAmount>
    <ReferralPaymentCheckNo>sample string 2</ReferralPaymentCheckNo>
    <ReferralPaymentMethod>sample string 4</ReferralPaymentMethod>
    <ReferralPaymentMethodId>1</ReferralPaymentMethodId>
    <ReferralPaymentNotes>sample string 1</ReferralPaymentNotes>
    <TotalFees>5</TotalFees>
  </AccountLedgerReferralFeeRowResponseModel>
  <AccountLedgerReferralFeeRowResponseModel>
    <AssessmentYear>1</AssessmentYear>
    <AttorneyAffiliateCode>sample string 17</AttorneyAffiliateCode>
    <AttorneyFullName>sample string 21</AttorneyFullName>
    <AttorneyId>12</AttorneyId>
    <Balance>15</Balance>
    <BusinessClientId>1</BusinessClientId>
    <CaseNumber>sample string 7</CaseNumber>
    <CaseStatus>sample string 10</CaseStatus>
    <CaseStatusId>sample string 11</CaseStatusId>
    <CaseTypeId>18</CaseTypeId>
    <ClientFullName>sample string 16</ClientFullName>
    <ClientPhoneNumber>sample string 19</ClientPhoneNumber>
    <CountyId>20</CountyId>
    <Date>sample string 9</Date>
    <Description>sample string 13</Description>
    <Id>6</Id>
    <PropertyAddressId>1</PropertyAddressId>
    <RecordType>sample string 14</RecordType>
    <Referrer>sample string 22</Referrer>
    <SubjectPropertyAddress>sample string 8</SubjectPropertyAddress>
    <UserPropertyId>1</UserPropertyId>
    <CollectedCaseFees>1</CollectedCaseFees>
    <IsRefundable>true</IsRefundable>
    <ReferralFeePercent>1</ReferralFeePercent>
    <ReferralFeesAllocated>1</ReferralFeesAllocated>
    <ReferralPaymentAmount>1</ReferralPaymentAmount>
    <ReferralPaymentCheckNo>sample string 2</ReferralPaymentCheckNo>
    <ReferralPaymentMethod>sample string 4</ReferralPaymentMethod>
    <ReferralPaymentMethodId>1</ReferralPaymentMethodId>
    <ReferralPaymentNotes>sample string 1</ReferralPaymentNotes>
    <TotalFees>5</TotalFees>
  </AccountLedgerReferralFeeRowResponseModel>
</ArrayOfAccountLedgerReferralFeeRowResponseModel>