POST api/v{version}/DynamicPayout/Journal

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

Collection of JournalState

Name	Type	Additional information
DistrictId	integer	None.
Type	string	None.
SiteId	string	None.
StartDate	date	None.
EndDate	date	None.
EffectiveDate	date	None.
UserId	integer	None.
CheckCollectionKeyList	Collection of CheckCollectionKey	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "DistrictId": 1,
    "Type": "sample string 2",
    "SiteId": "sample string 3",
    "StartDate": "2025-10-27T22:05:56.0941534-04:00",
    "EndDate": "2025-10-27T22:05:56.0941534-04:00",
    "EffectiveDate": "2025-10-27T22:05:56.0941534-04:00",
    "UserId": 7,
    "CheckCollectionKeyList": [
      {
        "DistrictId": 1,
        "SiteId": "sample string 2",
        "FeeType": "sample string 3",
        "AccountNumber": "sample string 4",
        "RoutingNumber": "sample string 5",
        "PaymentHistoryId": 6
      },
      {
        "DistrictId": 1,
        "SiteId": "sample string 2",
        "FeeType": "sample string 3",
        "AccountNumber": "sample string 4",
        "RoutingNumber": "sample string 5",
        "PaymentHistoryId": 6
      }
    ]
  },
  {
    "DistrictId": 1,
    "Type": "sample string 2",
    "SiteId": "sample string 3",
    "StartDate": "2025-10-27T22:05:56.0941534-04:00",
    "EndDate": "2025-10-27T22:05:56.0941534-04:00",
    "EffectiveDate": "2025-10-27T22:05:56.0941534-04:00",
    "UserId": 7,
    "CheckCollectionKeyList": [
      {
        "DistrictId": 1,
        "SiteId": "sample string 2",
        "FeeType": "sample string 3",
        "AccountNumber": "sample string 4",
        "RoutingNumber": "sample string 5",
        "PaymentHistoryId": 6
      },
      {
        "DistrictId": 1,
        "SiteId": "sample string 2",
        "FeeType": "sample string 3",
        "AccountNumber": "sample string 4",
        "RoutingNumber": "sample string 5",
        "PaymentHistoryId": 6
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfJournalState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/K12.Shared.Models.DynamicPayout">
  <JournalState>
    <CheckCollectionKeyList>
      <CheckCollectionKey>
        <AccountNumber>sample string 4</AccountNumber>
        <DistrictId>1</DistrictId>
        <FeeType>sample string 3</FeeType>
        <PaymentHistoryId>6</PaymentHistoryId>
        <RoutingNumber>sample string 5</RoutingNumber>
        <SiteId>sample string 2</SiteId>
      </CheckCollectionKey>
      <CheckCollectionKey>
        <AccountNumber>sample string 4</AccountNumber>
        <DistrictId>1</DistrictId>
        <FeeType>sample string 3</FeeType>
        <PaymentHistoryId>6</PaymentHistoryId>
        <RoutingNumber>sample string 5</RoutingNumber>
        <SiteId>sample string 2</SiteId>
      </CheckCollectionKey>
    </CheckCollectionKeyList>
    <DistrictId>1</DistrictId>
    <EffectiveDate>2025-10-27T22:05:56.0941534-04:00</EffectiveDate>
    <EndDate>2025-10-27T22:05:56.0941534-04:00</EndDate>
    <SiteId>sample string 3</SiteId>
    <StartDate>2025-10-27T22:05:56.0941534-04:00</StartDate>
    <Type>sample string 2</Type>
    <UserId>7</UserId>
  </JournalState>
  <JournalState>
    <CheckCollectionKeyList>
      <CheckCollectionKey>
        <AccountNumber>sample string 4</AccountNumber>
        <DistrictId>1</DistrictId>
        <FeeType>sample string 3</FeeType>
        <PaymentHistoryId>6</PaymentHistoryId>
        <RoutingNumber>sample string 5</RoutingNumber>
        <SiteId>sample string 2</SiteId>
      </CheckCollectionKey>
      <CheckCollectionKey>
        <AccountNumber>sample string 4</AccountNumber>
        <DistrictId>1</DistrictId>
        <FeeType>sample string 3</FeeType>
        <PaymentHistoryId>6</PaymentHistoryId>
        <RoutingNumber>sample string 5</RoutingNumber>
        <SiteId>sample string 2</SiteId>
      </CheckCollectionKey>
    </CheckCollectionKeyList>
    <DistrictId>1</DistrictId>
    <EffectiveDate>2025-10-27T22:05:56.0941534-04:00</EffectiveDate>
    <EndDate>2025-10-27T22:05:56.0941534-04:00</EndDate>
    <SiteId>sample string 3</SiteId>
    <StartDate>2025-10-27T22:05:56.0941534-04:00</StartDate>
    <Type>sample string 2</Type>
    <UserId>7</UserId>
  </JournalState>
</ArrayOfJournalState>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.