POST api/collectionsstages

Insert a new CollectionsStage

Request Information

URI Parameters

None.

Body Parameters

CollectionsStageViewModel>ViewModel

Name	Description	Type	Additional information
PolicyProfileId	PolicyProfileId	integer	Required Range: inclusive between 1 and 2147483647
Name	Name	string	Required Max length: 100
StageDay	StageDay	integer	Required Range: inclusive between 1 and 365
CalendarDay	CalendarDay	integer	Required Range: inclusive between 1 and 31
GraceDay	GraceDay	integer	Required Range: inclusive between 0 and 365
ChargesDateThrough	ChargesDateThrough	integer	Required Range: inclusive between 0 and 31
IsManual	IsManual	boolean	Required
IsInLegal	IsInLegal	boolean	Required
IncludeDevelopers	IncludeDevelopers	boolean	Required
IsActive	IsActive	boolean	Required
IsParcelIdReq	IsParcelIdReq	boolean	Required
LegalUnitNumber	LegalUnitNumber	boolean	Required
CreditHistoryIds		Collection of integer	None.
SubAccountIds	SubAccountId	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "policyProfileId": 1,
  "name": "sample string 2",
  "stageDay": 3,
  "calendarDay": 4,
  "graceDay": 5,
  "chargesDateThrough": 6,
  "isManual": true,
  "isInLegal": true,
  "includeDevelopers": true,
  "isActive": true,
  "isParcelIdReq": true,
  "legalUnitNumber": true,
  "creditHistoryIds": [
    1,
    2
  ],
  "subAccountIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<CollectionsStageCreateViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CalendarDay>4</CalendarDay>
  <ChargesDateThrough>6</ChargesDateThrough>
  <CreditHistoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </CreditHistoryIds>
  <GraceDay>5</GraceDay>
  <IncludeDevelopers>true</IncludeDevelopers>
  <IsActive>true</IsActive>
  <IsInLegal>true</IsInLegal>
  <IsManual>true</IsManual>
  <IsParcelIdReq>true</IsParcelIdReq>
  <LegalUnitNumber>true</LegalUnitNumber>
  <Name>sample string 2</Name>
  <PolicyProfileId>1</PolicyProfileId>
  <StageDay>3</StageDay>
  <SubAccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubAccountIds>
</CollectionsStageCreateViewModel>

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 'CollectionsStageCreateViewModel'.

Response Information

Resource Description

CollectionsStageViewModel>ViewModel

CollectionsStageViewModel

Name	Description	Type	Additional information
Id	Id	integer	None.
PolicyProfileId	PolicyProfileId	integer	None.
Name	Name	string	None.
Number	Number	integer	None.
StageDay	StageDay	integer	None.
CalendarDay	CalendarDay	integer	None.
GraceDay	GraceDay	integer	None.
ChargesDateThrough	ChargesDateThrough	integer	None.
IsManual	IsManual	boolean	None.
IsInLegal	IsInLegal	boolean	None.
IncludeDevelopers	IncludeDevelopers	boolean	None.
IsActive	IsActive	boolean	None.
CreatedBy	CreatedBy	integer	None.
CreatedOn	CreatedOn	date	None.
ModifiedBy	ModifiedBy	integer	None.
ModifiedOn	ModifiedOn	date	None.
IsParcelIdReq	IsParcelIdReq	boolean	None.
LegalUnitNumber	LegalUnitNumber	boolean	None.
CreditHistoryIds	Credit history code ids	Collection of integer	None.
SubAccountIds	SubAccountId	Collection of integer	None.

Response Formats

application/json, text/json

Sample:

{
  "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:26:31.4498794-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-14T08:26:31.4498794-04:00",
  "isParcelIdReq": true,
  "legalUnitNumber": true,
  "creditHistoryIds": [
    1,
    2
  ],
  "subAccountIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:

<CollectionsStageViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CalendarDay>6</CalendarDay>
  <ChargesDateThrough>8</ChargesDateThrough>
  <CreatedBy>13</CreatedBy>
  <CreatedOn>2024-10-14T08:26:31.4498794-04:00</CreatedOn>
  <CreditHistoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1: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:26:31.4498794-04:00</ModifiedOn>
  <Name>sample string 3</Name>
  <Number>4</Number>
  <PolicyProfileId>2</PolicyProfileId>
  <StageDay>5</StageDay>
  <SubAccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SubAccountIds>
</CollectionsStageViewModel>