GET api/paymentperiod

Get Payment Periods.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/paymentperiod. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns payment period collection.

Collection of PaymentPeriodDto

Name	Description	Type
PaymentPeriodID	Unique identifier of the payment period.	byte
PaymentPeriodEnum	list of payment period.	PaymentPeriods
AdjDescription	Payment period's adjustment description.	string
PeriodDescription	Period's description.	string

Response Formats

application/json, text/json

Sample:

[
  {
    "paymentPeriodID": 64,
    "paymentPeriodEnum": 1,
    "adjDescription": "sample string 1",
    "periodDescription": "sample string 2"
  },
  {
    "paymentPeriodID": 64,
    "paymentPeriodEnum": 1,
    "adjDescription": "sample string 1",
    "periodDescription": "sample string 2"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentPeriodDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <PaymentPeriodDto>
    <AdjDescription>sample string 1</AdjDescription>
    <PaymentPeriodEnum>Day</PaymentPeriodEnum>
    <PaymentPeriodID>64</PaymentPeriodID>
    <PeriodDescription>sample string 2</PeriodDescription>
  </PaymentPeriodDto>
  <PaymentPeriodDto>
    <AdjDescription>sample string 1</AdjDescription>
    <PaymentPeriodEnum>Day</PaymentPeriodEnum>
    <PaymentPeriodID>64</PaymentPeriodID>
    <PeriodDescription>sample string 2</PeriodDescription>
  </PaymentPeriodDto>
</ArrayOfPaymentPeriodDto>