Put /api/v3/admin/accounting

Operation: EditAccountingSettingsV3 Permissions: AccountingSettings (Manage)

Summary

Edit accounting settings

Request Body Parameters

Content-Type: application/json

Type Reference: AccountingSettingsRequest

Parameter Description Type
fiscalYearStartMonth First month of fiscal year Must be between 1 and 12 Required (defined) integer
fiscalYearDefinedAtYear Fiscal year reflects the calendar year in which it Begins or Ends One of ‘beginning’, ‘ending’ Case sensitive Required (defined) string
calendarizationMethod Calendarization method
Value will be one of “monthly”, “user-defined” One of ‘monthly’, ‘user-defined’ Case sensitive Required (defined)
string
accountPeriods List of accounting period names Required (defined) AccountPeriodRequest [Array]
   periodNumber The period number
When submitted with a list of other account periods, there cannot be more than one account period with the same periodNumber Must be between 1 and 12 Required (defined)
integer
   name The name of the period Max length of 32 Required (defined) string

Request Body

{
  "fiscalYearStartMonth": 1,
  "fiscalYearDefinedAtYear": "string",
  "calendarizationMethod": "string",
  "accountPeriods": [
    {
      "periodNumber": 1,
      "name": "string"
    }
  ]
}

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

Type Reference: AccountingSettingsResponse

Parameter Description Type
fiscalYearStartMonth First month of fiscal year
Value will be from 1-12
integer
fiscalYearDefinedAtYear Fiscal year reflects the calendar year in which it Begins or Ends
Value will be one of “beginning”, “ending”
string
calendarizationMethod Calendarization method
Value will be one of “monthly”, “user-defined”
string
accountPeriods List of accounting period names AccountPeriodResponse [Array]
   accountPeriodId The account period identifier integer
   periodNumber The period number integer
   name The name of the period string

Responses

HTTP 200

Body

Content Type: application/json
{
  "fiscalYearStartMonth": 1,
  "fiscalYearDefinedAtYear": "string",
  "calendarizationMethod": "string",
  "accountPeriods": [
    {
      "accountPeriodId": 1,
      "periodNumber": 1,
      "name": "string"
    }
  ]
}