POST api/Master/RetrievePeriodDefinition

Request Information

URI Parameters

None.

Body Parameters

PeriodDefinition
NameDescriptionTypeAdditional information
PD_COMP_CODE

integer

None.

PD_YEAR

integer

None.

PD_TYPE

string

None.

PD_LEDGER

integer

None.

PD_TRANS_TYPE

string

None.

PD_PROGRAM_ID

string

None.

PD_CREATED_BY

integer

None.

PD_PERIOD_DETAILS_TYPE

Collection of PERIOD_DETAILS

None.

Request Formats

application/json, text/json

Sample:
{
  "PD_COMP_CODE": 1,
  "PD_YEAR": 1,
  "PD_TYPE": "sample string 1",
  "PD_LEDGER": 1,
  "PD_TRANS_TYPE": "sample string 2",
  "PD_PROGRAM_ID": "sample string 3",
  "PD_CREATED_BY": 1,
  "PD_PERIOD_DETAILS_TYPE": [
    {
      "PD_COMP_ID": 1,
      "PD_COMP_CODE": "sample string 1",
      "PD_YEAR": 1,
      "PD_PERIOD": 1,
      "PD_FROM_DATE": "2024-05-19T17:36:36.3272246+05:30",
      "PD_TO_DATE": "2024-05-19T17:36:36.3272246+05:30",
      "PD_TYPE": "sample string 2",
      "PD_TYPE_CODE": "sample string 3",
      "PD_LEDGER": 1,
      "PD_LEDGER_CODE": "sample string 4",
      "PD_STATUS": "sample string 5",
      "PD_STATUS_CODE": "sample string 6",
      "PD_NOTES": "sample string 7"
    },
    {
      "PD_COMP_ID": 1,
      "PD_COMP_CODE": "sample string 1",
      "PD_YEAR": 1,
      "PD_PERIOD": 1,
      "PD_FROM_DATE": "2024-05-19T17:36:36.3272246+05:30",
      "PD_TO_DATE": "2024-05-19T17:36:36.3272246+05:30",
      "PD_TYPE": "sample string 2",
      "PD_TYPE_CODE": "sample string 3",
      "PD_LEDGER": 1,
      "PD_LEDGER_CODE": "sample string 4",
      "PD_STATUS": "sample string 5",
      "PD_STATUS_CODE": "sample string 6",
      "PD_NOTES": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:
<PeriodDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ZealitAPI.Models">
  <PD_COMP_CODE>1</PD_COMP_CODE>
  <PD_CREATED_BY>1</PD_CREATED_BY>
  <PD_LEDGER>1</PD_LEDGER>
  <PD_PERIOD_DETAILS_TYPE>
    <PERIOD_DETAILS>
      <PD_COMP_CODE>sample string 1</PD_COMP_CODE>
      <PD_COMP_ID>1</PD_COMP_ID>
      <PD_FROM_DATE>2024-05-19T17:36:36.3272246+05:30</PD_FROM_DATE>
      <PD_LEDGER>1</PD_LEDGER>
      <PD_LEDGER_CODE>sample string 4</PD_LEDGER_CODE>
      <PD_NOTES>sample string 7</PD_NOTES>
      <PD_PERIOD>1</PD_PERIOD>
      <PD_STATUS>sample string 5</PD_STATUS>
      <PD_STATUS_CODE>sample string 6</PD_STATUS_CODE>
      <PD_TO_DATE>2024-05-19T17:36:36.3272246+05:30</PD_TO_DATE>
      <PD_TYPE>sample string 2</PD_TYPE>
      <PD_TYPE_CODE>sample string 3</PD_TYPE_CODE>
      <PD_YEAR>1</PD_YEAR>
    </PERIOD_DETAILS>
    <PERIOD_DETAILS>
      <PD_COMP_CODE>sample string 1</PD_COMP_CODE>
      <PD_COMP_ID>1</PD_COMP_ID>
      <PD_FROM_DATE>2024-05-19T17:36:36.3272246+05:30</PD_FROM_DATE>
      <PD_LEDGER>1</PD_LEDGER>
      <PD_LEDGER_CODE>sample string 4</PD_LEDGER_CODE>
      <PD_NOTES>sample string 7</PD_NOTES>
      <PD_PERIOD>1</PD_PERIOD>
      <PD_STATUS>sample string 5</PD_STATUS>
      <PD_STATUS_CODE>sample string 6</PD_STATUS_CODE>
      <PD_TO_DATE>2024-05-19T17:36:36.3272246+05:30</PD_TO_DATE>
      <PD_TYPE>sample string 2</PD_TYPE>
      <PD_TYPE_CODE>sample string 3</PD_TYPE_CODE>
      <PD_YEAR>1</PD_YEAR>
    </PERIOD_DETAILS>
  </PD_PERIOD_DETAILS_TYPE>
  <PD_PROGRAM_ID>sample string 3</PD_PROGRAM_ID>
  <PD_TRANS_TYPE>sample string 2</PD_TRANS_TYPE>
  <PD_TYPE>sample string 1</PD_TYPE>
  <PD_YEAR>1</PD_YEAR>
</PeriodDefinition>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.