POST api/synergy/funds

Get funds for a property that need approval.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "PropertyId": "sample string 1",
  "ManagementFirmName": "sample string 2"
}

application/xml, text/xml

Sample:

<FundsApprovalRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <ManagementFirmName>sample string 2</ManagementFirmName>
  <PropertyId>sample string 1</PropertyId>
</FundsApprovalRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FundsApprovalRequest'.

Response Information

application/json

Sample:

{
  "FundsId": "sample string 1",
  "PropertyName": "sample string 2",
  "Provider": "sample string 3",
  "FundingRequested": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "DateDue": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "ApprovalStatus": "sample string 6",
  "BillTotal": "sample decimal 7.0",
  "LateFees": "sample decimal 8.0",
  "AccountNumber": "sample string 9",
  "ServiceAddress": "sample string 10",
  "ServiceStart": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "ServiceEnd": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "UtilityDescription": "sample string 13",
  "NumberOfAddresses": "sample integer 24"
}

text/json

Sample:

{
  "FundsToApprove": [
    {
      "FundsId": "sample string 1",
      "PropertyName": "sample string 2",
      "Provider": "sample string 3",
      "FundingRequested": "2024-11-24T21:52:56.370326-07:00",
      "DateDue": "2024-11-24T21:52:56.370326-07:00",
      "ApprovalStatus": "sample string 6",
      "BillTotal": 7.0,
      "LateFees": 8.0,
      "AccountNumber": "sample string 9",
      "ServiceAddress": "sample string 10",
      "ServiceStart": "2024-11-24T21:52:56.370326-07:00",
      "ServiceEnd": "2024-11-24T21:52:56.370326-07:00",
      "UtilityDescription": "sample string 13",
      "NumberOfAddresses": 14
    },
    {
      "FundsId": "sample string 1",
      "PropertyName": "sample string 2",
      "Provider": "sample string 3",
      "FundingRequested": "2024-11-24T21:52:56.370326-07:00",
      "DateDue": "2024-11-24T21:52:56.370326-07:00",
      "ApprovalStatus": "sample string 6",
      "BillTotal": 7.0,
      "LateFees": 8.0,
      "AccountNumber": "sample string 9",
      "ServiceAddress": "sample string 10",
      "ServiceStart": "2024-11-24T21:52:56.370326-07:00",
      "ServiceEnd": "2024-11-24T21:52:56.370326-07:00",
      "UtilityDescription": "sample string 13",
      "NumberOfAddresses": 14
    }
  ],
  "Code": "sample string 1",
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Link": "sample string 4"
}

application/xml, text/xml

Sample:

<FundsApprovalResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <Code>sample string 1</Code>
  <Description>sample string 3</Description>
  <Link>sample string 4</Link>
  <Message>sample string 2</Message>
  <FundsToApprove>
    <Funds>
      <AccountNumber>sample string 9</AccountNumber>
      <ApprovalStatus>sample string 6</ApprovalStatus>
      <BillTotal>7</BillTotal>
      <DateDue>2024-11-24T21:52:56.370326-07:00</DateDue>
      <FundingRequested>2024-11-24T21:52:56.370326-07:00</FundingRequested>
      <FundsId>sample string 1</FundsId>
      <LateFees>8</LateFees>
      <NumberOfAddresses>14</NumberOfAddresses>
      <PropertyName>sample string 2</PropertyName>
      <Provider>sample string 3</Provider>
      <ServiceAddress>sample string 10</ServiceAddress>
      <ServiceEnd>2024-11-24T21:52:56.370326-07:00</ServiceEnd>
      <ServiceStart>2024-11-24T21:52:56.370326-07:00</ServiceStart>
      <UtilityDescription>sample string 13</UtilityDescription>
    </Funds>
    <Funds>
      <AccountNumber>sample string 9</AccountNumber>
      <ApprovalStatus>sample string 6</ApprovalStatus>
      <BillTotal>7</BillTotal>
      <DateDue>2024-11-24T21:52:56.370326-07:00</DateDue>
      <FundingRequested>2024-11-24T21:52:56.370326-07:00</FundingRequested>
      <FundsId>sample string 1</FundsId>
      <LateFees>8</LateFees>
      <NumberOfAddresses>14</NumberOfAddresses>
      <PropertyName>sample string 2</PropertyName>
      <Provider>sample string 3</Provider>
      <ServiceAddress>sample string 10</ServiceAddress>
      <ServiceEnd>2024-11-24T21:52:56.370326-07:00</ServiceEnd>
      <ServiceStart>2024-11-24T21:52:56.370326-07:00</ServiceStart>
      <UtilityDescription>sample string 13</UtilityDescription>
    </Funds>
  </FundsToApprove>
</FundsApprovalResponse>