GET odata/Referrals

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Referral

Name	Type	Additional information
AuthorizationId	string	String length: inclusive between 0 and 50
ReferralId	integer	None.
ReferralType	string	String length: inclusive between 0 and 30
Description	string	String length: inclusive between 0 and 255
VendorId	string	String length: inclusive between 0 and 50
VendorCode	string	String length: inclusive between 0 and 50
BrokerID	string	String length: inclusive between 0 and 50
BrokerCode	string	String length: inclusive between 0 and 15
CommissionPct	decimal number	None.
ReferralPct	decimal number	None.
BasisAmount	decimal number	None.
EstFee	decimal number	None.
ActualFee	decimal number	None.
FeeCollectedDate	date	None.
AgreementSentDate	date	None.
Comment	string	String length: inclusive between 0 and 255
User1	date	None.
User2	date	None.
User3	decimal number	None.
User4	decimal number	None.
LAComPct	decimal number	None.
PlacedDate	date	None.
CancelledDate	date	None.
OverrideBasisAmount	decimal number	None.
User5	string	String length: inclusive between 0 and 50
User6	string	String length: inclusive between 0 and 50
User7	string	String length: inclusive between 0 and 50
User8	string	String length: inclusive between 0 and 50
User9	date	None.
User10	decimal number	None.
DateFeeBilled	date	None.
MasterRecCode	string	String length: inclusive between 0 and 10
VendorContactID	integer	None.
DSCID	integer	None.
DSCCode	string	String length: inclusive between 0 and 50
DSCMasterRecCode	string	String length: inclusive between 0 and 50
InvNbrOfDaysFromDate	date	None.
InvNbrOfDaysToDate	date	None.
InvoiceAuditedBy	string	String length: inclusive between 0 and 50
SupplierSelectedBy	string	String length: inclusive between 0 and 100
AddedOn	date	None.
AddedBy	string	String length: inclusive between 0 and 50
ModifiedOn	date	None.
ModifiedBy	string	String length: inclusive between 0 and 50
AcctInvoiceNbr	string	String length: inclusive between 0 and 20
splitInvoice	string	String length: inclusive between 0 and 5
AgentFee	decimal number	None.
TotalFee	decimal number	None.
FapiaoTrxID	integer	None.
FapiaoAmt	decimal number	None.
FapiaoNotReqReason	string	String length: inclusive between 0 and 250
ID	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AuthorizationId": "sample string 1",
    "ReferralId": 2,
    "ReferralType": "sample string 3",
    "Description": "sample string 4",
    "VendorId": "sample string 5",
    "VendorCode": "sample string 6",
    "BrokerID": "sample string 7",
    "BrokerCode": "sample string 8",
    "CommissionPct": 1.1,
    "ReferralPct": 1.1,
    "BasisAmount": 1.0,
    "EstFee": 1.0,
    "ActualFee": 1.0,
    "FeeCollectedDate": "2025-05-09T17:47:54.3816268+00:00",
    "AgreementSentDate": "2025-05-09T17:47:54.3816268+00:00",
    "Comment": "sample string 9",
    "User1": "2025-05-09T17:47:54.3816268+00:00",
    "User2": "2025-05-09T17:47:54.3816268+00:00",
    "User3": 1.0,
    "User4": 1.0,
    "LAComPct": 1.1,
    "PlacedDate": "2025-05-09T17:47:54.3816268+00:00",
    "CancelledDate": "2025-05-09T17:47:54.3816268+00:00",
    "OverrideBasisAmount": 1.0,
    "User5": "sample string 10",
    "User6": "sample string 11",
    "User7": "sample string 12",
    "User8": "sample string 13",
    "User9": "2025-05-09T17:47:54.3816268+00:00",
    "User10": 1.0,
    "DateFeeBilled": "2025-05-09T17:47:54.3816268+00:00",
    "MasterRecCode": "sample string 14",
    "VendorContactID": 1,
    "DSCID": 1,
    "DSCCode": "sample string 15",
    "DSCMasterRecCode": "sample string 16",
    "InvNbrOfDaysFromDate": "2025-05-09T17:47:54.3816268+00:00",
    "InvNbrOfDaysToDate": "2025-05-09T17:47:54.3816268+00:00",
    "InvoiceAuditedBy": "sample string 17",
    "SupplierSelectedBy": "sample string 18",
    "AddedOn": "2025-05-09T17:47:54.3816268+00:00",
    "AddedBy": "sample string 19",
    "ModifiedOn": "2025-05-09T17:47:54.3816268+00:00",
    "ModifiedBy": "sample string 20",
    "AcctInvoiceNbr": "sample string 21",
    "splitInvoice": "sample string 22",
    "AgentFee": 1.0,
    "TotalFee": 1.0,
    "FapiaoTrxID": 1,
    "FapiaoAmt": 1.0,
    "FapiaoNotReqReason": "sample string 23",
    "ID": 24
  },
  {
    "AuthorizationId": "sample string 1",
    "ReferralId": 2,
    "ReferralType": "sample string 3",
    "Description": "sample string 4",
    "VendorId": "sample string 5",
    "VendorCode": "sample string 6",
    "BrokerID": "sample string 7",
    "BrokerCode": "sample string 8",
    "CommissionPct": 1.1,
    "ReferralPct": 1.1,
    "BasisAmount": 1.0,
    "EstFee": 1.0,
    "ActualFee": 1.0,
    "FeeCollectedDate": "2025-05-09T17:47:54.3816268+00:00",
    "AgreementSentDate": "2025-05-09T17:47:54.3816268+00:00",
    "Comment": "sample string 9",
    "User1": "2025-05-09T17:47:54.3816268+00:00",
    "User2": "2025-05-09T17:47:54.3816268+00:00",
    "User3": 1.0,
    "User4": 1.0,
    "LAComPct": 1.1,
    "PlacedDate": "2025-05-09T17:47:54.3816268+00:00",
    "CancelledDate": "2025-05-09T17:47:54.3816268+00:00",
    "OverrideBasisAmount": 1.0,
    "User5": "sample string 10",
    "User6": "sample string 11",
    "User7": "sample string 12",
    "User8": "sample string 13",
    "User9": "2025-05-09T17:47:54.3816268+00:00",
    "User10": 1.0,
    "DateFeeBilled": "2025-05-09T17:47:54.3816268+00:00",
    "MasterRecCode": "sample string 14",
    "VendorContactID": 1,
    "DSCID": 1,
    "DSCCode": "sample string 15",
    "DSCMasterRecCode": "sample string 16",
    "InvNbrOfDaysFromDate": "2025-05-09T17:47:54.3816268+00:00",
    "InvNbrOfDaysToDate": "2025-05-09T17:47:54.3816268+00:00",
    "InvoiceAuditedBy": "sample string 17",
    "SupplierSelectedBy": "sample string 18",
    "AddedOn": "2025-05-09T17:47:54.3816268+00:00",
    "AddedBy": "sample string 19",
    "ModifiedOn": "2025-05-09T17:47:54.3816268+00:00",
    "ModifiedBy": "sample string 20",
    "AcctInvoiceNbr": "sample string 21",
    "splitInvoice": "sample string 22",
    "AgentFee": 1.0,
    "TotalFee": 1.0,
    "FapiaoTrxID": 1,
    "FapiaoAmt": 1.0,
    "FapiaoNotReqReason": "sample string 23",
    "ID": 24
  }
]

application/xml, text/xml

Sample:

<ArrayOfReferral xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric">
  <Referral>
    <AcctInvoiceNbr>sample string 21</AcctInvoiceNbr>
    <ActualFee>1</ActualFee>
    <AddedBy>sample string 19</AddedBy>
    <AddedOn>2025-05-09T17:47:54.3816268+00:00</AddedOn>
    <AgentFee>1</AgentFee>
    <AgreementSentDate>2025-05-09T17:47:54.3816268+00:00</AgreementSentDate>
    <AuthorizationId>sample string 1</AuthorizationId>
    <BasisAmount>1</BasisAmount>
    <BrokerCode>sample string 8</BrokerCode>
    <BrokerID>sample string 7</BrokerID>
    <CancelledDate>2025-05-09T17:47:54.3816268+00:00</CancelledDate>
    <Comment>sample string 9</Comment>
    <CommissionPct>1.1</CommissionPct>
    <DSCCode>sample string 15</DSCCode>
    <DSCID>1</DSCID>
    <DSCMasterRecCode>sample string 16</DSCMasterRecCode>
    <DateFeeBilled>2025-05-09T17:47:54.3816268+00:00</DateFeeBilled>
    <Description>sample string 4</Description>
    <EstFee>1</EstFee>
    <FapiaoAmt>1</FapiaoAmt>
    <FapiaoNotReqReason>sample string 23</FapiaoNotReqReason>
    <FapiaoTrxID>1</FapiaoTrxID>
    <FeeCollectedDate>2025-05-09T17:47:54.3816268+00:00</FeeCollectedDate>
    <ID>24</ID>
    <InvNbrOfDaysFromDate>2025-05-09T17:47:54.3816268+00:00</InvNbrOfDaysFromDate>
    <InvNbrOfDaysToDate>2025-05-09T17:47:54.3816268+00:00</InvNbrOfDaysToDate>
    <InvoiceAuditedBy>sample string 17</InvoiceAuditedBy>
    <LAComPct>1.1</LAComPct>
    <MasterRecCode>sample string 14</MasterRecCode>
    <ModifiedBy>sample string 20</ModifiedBy>
    <ModifiedOn>2025-05-09T17:47:54.3816268+00:00</ModifiedOn>
    <OverrideBasisAmount>1</OverrideBasisAmount>
    <PlacedDate>2025-05-09T17:47:54.3816268+00:00</PlacedDate>
    <ReferralId>2</ReferralId>
    <ReferralPct>1.1</ReferralPct>
    <ReferralType>sample string 3</ReferralType>
    <SupplierSelectedBy>sample string 18</SupplierSelectedBy>
    <TotalFee>1</TotalFee>
    <User1>2025-05-09T17:47:54.3816268+00:00</User1>
    <User10>1</User10>
    <User2>2025-05-09T17:47:54.3816268+00:00</User2>
    <User3>1</User3>
    <User4>1</User4>
    <User5>sample string 10</User5>
    <User6>sample string 11</User6>
    <User7>sample string 12</User7>
    <User8>sample string 13</User8>
    <User9>2025-05-09T17:47:54.3816268+00:00</User9>
    <VendorCode>sample string 6</VendorCode>
    <VendorContactID>1</VendorContactID>
    <VendorId>sample string 5</VendorId>
    <splitInvoice>sample string 22</splitInvoice>
  </Referral>
  <Referral>
    <AcctInvoiceNbr>sample string 21</AcctInvoiceNbr>
    <ActualFee>1</ActualFee>
    <AddedBy>sample string 19</AddedBy>
    <AddedOn>2025-05-09T17:47:54.3816268+00:00</AddedOn>
    <AgentFee>1</AgentFee>
    <AgreementSentDate>2025-05-09T17:47:54.3816268+00:00</AgreementSentDate>
    <AuthorizationId>sample string 1</AuthorizationId>
    <BasisAmount>1</BasisAmount>
    <BrokerCode>sample string 8</BrokerCode>
    <BrokerID>sample string 7</BrokerID>
    <CancelledDate>2025-05-09T17:47:54.3816268+00:00</CancelledDate>
    <Comment>sample string 9</Comment>
    <CommissionPct>1.1</CommissionPct>
    <DSCCode>sample string 15</DSCCode>
    <DSCID>1</DSCID>
    <DSCMasterRecCode>sample string 16</DSCMasterRecCode>
    <DateFeeBilled>2025-05-09T17:47:54.3816268+00:00</DateFeeBilled>
    <Description>sample string 4</Description>
    <EstFee>1</EstFee>
    <FapiaoAmt>1</FapiaoAmt>
    <FapiaoNotReqReason>sample string 23</FapiaoNotReqReason>
    <FapiaoTrxID>1</FapiaoTrxID>
    <FeeCollectedDate>2025-05-09T17:47:54.3816268+00:00</FeeCollectedDate>
    <ID>24</ID>
    <InvNbrOfDaysFromDate>2025-05-09T17:47:54.3816268+00:00</InvNbrOfDaysFromDate>
    <InvNbrOfDaysToDate>2025-05-09T17:47:54.3816268+00:00</InvNbrOfDaysToDate>
    <InvoiceAuditedBy>sample string 17</InvoiceAuditedBy>
    <LAComPct>1.1</LAComPct>
    <MasterRecCode>sample string 14</MasterRecCode>
    <ModifiedBy>sample string 20</ModifiedBy>
    <ModifiedOn>2025-05-09T17:47:54.3816268+00:00</ModifiedOn>
    <OverrideBasisAmount>1</OverrideBasisAmount>
    <PlacedDate>2025-05-09T17:47:54.3816268+00:00</PlacedDate>
    <ReferralId>2</ReferralId>
    <ReferralPct>1.1</ReferralPct>
    <ReferralType>sample string 3</ReferralType>
    <SupplierSelectedBy>sample string 18</SupplierSelectedBy>
    <TotalFee>1</TotalFee>
    <User1>2025-05-09T17:47:54.3816268+00:00</User1>
    <User10>1</User10>
    <User2>2025-05-09T17:47:54.3816268+00:00</User2>
    <User3>1</User3>
    <User4>1</User4>
    <User5>sample string 10</User5>
    <User6>sample string 11</User6>
    <User7>sample string 12</User7>
    <User8>sample string 13</User8>
    <User9>2025-05-09T17:47:54.3816268+00:00</User9>
    <VendorCode>sample string 6</VendorCode>
    <VendorContactID>1</VendorContactID>
    <VendorId>sample string 5</VendorId>
    <splitInvoice>sample string 22</splitInvoice>
  </Referral>
</ArrayOfReferral>