GET api/collectionspolicies/filter?active={active}

Get policies based on the filter. For now the only filter is "active".

Request Information

URI Parameters

Name	Description	Type	Additional information
active		boolean	Required

Body Parameters

None.

Response Information

Resource Description

Collection of CollectionsPolicyReturnViewModel

Name	Description	Type	Additional information
Id	Id	integer	None.
ModifiedBy	ModifiedBy	integer	None.
ModifiedOn	ModifiedOn	date	None.
CreatedBy	CreatedBy	integer	None.
CreatedOn	CreatedOn	date	None.
Name	Name	string	None.
Description	Description	string	None.
IsActive	IsActive	boolean	None.
Profiles	Profiles	Collection of CollectionsPolicyProfileReturnViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
    "createdBy": 2,
    "createdOn": "2024-10-14T08:20:21.8463151-04:00",
    "name": "sample string 4",
    "description": "sample string 5",
    "isActive": true,
    "profiles": [
      {
        "createdBy": 1,
        "createdOn": "2024-10-14T08:20:21.8463151-04:00",
        "name": "sample string 3",
        "description": "sample string 4",
        "isActive": true,
        "id": 5,
        "policyId": 6,
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
        "profileType": 1,
        "stages": [
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          },
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          }
        ]
      },
      {
        "createdBy": 1,
        "createdOn": "2024-10-14T08:20:21.8463151-04:00",
        "name": "sample string 3",
        "description": "sample string 4",
        "isActive": true,
        "id": 5,
        "policyId": 6,
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
        "profileType": 1,
        "stages": [
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          },
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          }
        ]
      }
    ]
  },
  {
    "id": 1,
    "modifiedBy": 1,
    "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
    "createdBy": 2,
    "createdOn": "2024-10-14T08:20:21.8463151-04:00",
    "name": "sample string 4",
    "description": "sample string 5",
    "isActive": true,
    "profiles": [
      {
        "createdBy": 1,
        "createdOn": "2024-10-14T08:20:21.8463151-04:00",
        "name": "sample string 3",
        "description": "sample string 4",
        "isActive": true,
        "id": 5,
        "policyId": 6,
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
        "profileType": 1,
        "stages": [
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          },
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          }
        ]
      },
      {
        "createdBy": 1,
        "createdOn": "2024-10-14T08:20:21.8463151-04:00",
        "name": "sample string 3",
        "description": "sample string 4",
        "isActive": true,
        "id": 5,
        "policyId": 6,
        "modifiedBy": 1,
        "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
        "profileType": 1,
        "stages": [
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          },
          {
            "id": 1,
            "policyProfileId": 2,
            "name": "sample string 3",
            "number": 4,
            "stageDay": 5,
            "calendarDay": 6,
            "graceDay": 7,
            "chargesDateThrough": 8,
            "isManual": true,
            "isInLegal": true,
            "includeDevelopers": true,
            "isActive": true,
            "createdBy": 13,
            "createdOn": "2024-10-14T08:20:21.8463151-04:00",
            "modifiedBy": 1,
            "modifiedOn": "2024-10-14T08:20:21.8463151-04:00",
            "isParcelIdReq": true,
            "legalUnitNumber": true,
            "creditHistoryIds": [
              1,
              2
            ],
            "subAccountIds": [
              1,
              2
            ]
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCollectionsPolicyReturnViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CollectionsPolicyReturnViewModel>
    <CreatedBy>2</CreatedBy>
    <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
    <Description>sample string 5</Description>
    <Id>1</Id>
    <IsActive>true</IsActive>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
    <Name>sample string 4</Name>
    <Profiles>
      <CollectionsPolicyProfileReturnViewModel>
        <CreatedBy>1</CreatedBy>
        <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
        <Description>sample string 4</Description>
        <Id>5</Id>
        <IsActive>true</IsActive>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
        <Name>sample string 3</Name>
        <PolicyId>6</PolicyId>
        <ProfileType>Late_Fees</ProfileType>
        <Stages>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
        </Stages>
      </CollectionsPolicyProfileReturnViewModel>
      <CollectionsPolicyProfileReturnViewModel>
        <CreatedBy>1</CreatedBy>
        <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
        <Description>sample string 4</Description>
        <Id>5</Id>
        <IsActive>true</IsActive>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
        <Name>sample string 3</Name>
        <PolicyId>6</PolicyId>
        <ProfileType>Late_Fees</ProfileType>
        <Stages>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
        </Stages>
      </CollectionsPolicyProfileReturnViewModel>
    </Profiles>
  </CollectionsPolicyReturnViewModel>
  <CollectionsPolicyReturnViewModel>
    <CreatedBy>2</CreatedBy>
    <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
    <Description>sample string 5</Description>
    <Id>1</Id>
    <IsActive>true</IsActive>
    <ModifiedBy>1</ModifiedBy>
    <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
    <Name>sample string 4</Name>
    <Profiles>
      <CollectionsPolicyProfileReturnViewModel>
        <CreatedBy>1</CreatedBy>
        <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
        <Description>sample string 4</Description>
        <Id>5</Id>
        <IsActive>true</IsActive>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
        <Name>sample string 3</Name>
        <PolicyId>6</PolicyId>
        <ProfileType>Late_Fees</ProfileType>
        <Stages>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
        </Stages>
      </CollectionsPolicyProfileReturnViewModel>
      <CollectionsPolicyProfileReturnViewModel>
        <CreatedBy>1</CreatedBy>
        <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
        <Description>sample string 4</Description>
        <Id>5</Id>
        <IsActive>true</IsActive>
        <ModifiedBy>1</ModifiedBy>
        <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
        <Name>sample string 3</Name>
        <PolicyId>6</PolicyId>
        <ProfileType>Late_Fees</ProfileType>
        <Stages>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
          <CollectionsStageViewModel>
            <CalendarDay>6</CalendarDay>
            <ChargesDateThrough>8</ChargesDateThrough>
            <CreatedBy>13</CreatedBy>
            <CreatedOn>2024-10-14T08:20:21.8463151-04:00</CreatedOn>
            <CreditHistoryIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </CreditHistoryIds>
            <GraceDay>7</GraceDay>
            <Id>1</Id>
            <IncludeDevelopers>true</IncludeDevelopers>
            <IsActive>true</IsActive>
            <IsInLegal>true</IsInLegal>
            <IsManual>true</IsManual>
            <IsParcelIdReq>true</IsParcelIdReq>
            <LegalUnitNumber>true</LegalUnitNumber>
            <ModifiedBy>1</ModifiedBy>
            <ModifiedOn>2024-10-14T08:20:21.8463151-04:00</ModifiedOn>
            <Name>sample string 3</Name>
            <Number>4</Number>
            <PolicyProfileId>2</PolicyProfileId>
            <StageDay>5</StageDay>
            <SubAccountIds xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:int>1</d7p1:int>
              <d7p1:int>2</d7p1:int>
            </SubAccountIds>
          </CollectionsStageViewModel>
        </Stages>
      </CollectionsPolicyProfileReturnViewModel>
    </Profiles>
  </CollectionsPolicyReturnViewModel>
</ArrayOfCollectionsPolicyReturnViewModel>