Update period

PUT /closeAPI/api/close/period/{id}

Oidc Oauth2

application/json

Body Required

id integer
name string
year string
frequency object
Hide frequency attributes Show frequency attributes object
- id integer
- systemValueGroupId integer
- name string
- shortName string
- exportValue string
- order integer
- status string
  
  Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.
closeDaysByFrequency array[object]
Hide closeDaysByFrequency attributes Show closeDaysByFrequency attributes object
- frequency object
  Hide frequency attributes Show frequency attributes object
  
  id integer
  
  systemValueGroupId integer
  
  name string
  
  shortName string
  
  exportValue string
  
  order integer
  
  status string
  
  Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.
- closeDays array[object]
  Hide closeDays attributes Show closeDays attributes object
  
  id integer
  
  closeDay object
  
  Hide closeDay attributes Show closeDay attributes object
  
  name string
  
  closeDate string(date-time)
  
  completeCount integer(int32)
  
  inProcessCount integer(int32)
  
  lateCount integer(int32)
  
  dayOrder integer(int32)
  
  frequency object
  
  Hide frequency attributes Show frequency attributes object
  
  id integer
  
  systemValueGroupId integer
  
  name string
  
  shortName string
  
  exportValue string
  
  order integer
  
  status string
  
  Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.
  
  date string(date)
statusType string

Values are NOT_STARTED, IN_PROGRESS, COMPLETE, DELETED, or DISABLED.
startDate string(date)
endDate string(date)
percentComplete integer(int32)

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id integer
- name string
- year string
- frequency object
  
  Hide frequency attributes Show frequency attributes object
  
  id integer
  
  systemValueGroupId integer
  
  name string
  
  shortName string
  
  exportValue string
  
  order integer
  
  status string
  
  Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.
- closeDaysByFrequency array[object]
  
  Hide closeDaysByFrequency attributes Show closeDaysByFrequency attributes object
  
  frequency object
  
  Hide frequency attributes Show frequency attributes object
  
  id integer
  
  systemValueGroupId integer
  
  name string
  
  shortName string
  
  exportValue string
  
  order integer
  
  status string
  
  Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.
  
  closeDays array[object]
  
  Hide closeDays attributes Show closeDays attributes object
  
  id integer
  
  closeDay object
  
  Hide closeDay attributes Show closeDay attributes object
  
  name string
  
  closeDate string(date-time)
  
  completeCount integer(int32)
  
  inProcessCount integer(int32)
  
  lateCount integer(int32)
  
  dayOrder integer(int32)
  
  frequency object
  
  Hide frequency attributes Show frequency attributes object
  
  id integer
  
  systemValueGroupId integer
  
  name string
  
  shortName string
  
  exportValue string
  
  order integer
  
  status string
  
  Values are ACTIVE, INACTIVE, DISABLED, NOT_STARTED, IN_PROGRESS, COMPLETE, or DELETED.
  
  date string(date)
- statusType string
  
  Values are NOT_STARTED, IN_PROGRESS, COMPLETE, DELETED, or DISABLED.
- startDate string(date)
- endDate string(date)
- percentComplete integer(int32)

PUT /closeAPI/api/close/period/{id}

curl \
 --request PUT 'https://customer.trintech.com/closeAPI/api/close/period/{id}' \
 --header "Content-Type: application/json" \
 --data '{"id":42,"name":"string","year":"string","frequency":{"id":42,"systemValueGroupId":42,"name":"string","shortName":"string","exportValue":"string","order":42,"status":"ACTIVE"},"closeDaysByFrequency":[{"frequency":{"id":42,"systemValueGroupId":42,"name":"string","shortName":"string","exportValue":"string","order":42,"status":"ACTIVE"},"closeDays":[{"id":42,"closeDay":{"name":"string","closeDate":"2025-05-04T09:42:00Z","completeCount":42,"inProcessCount":42,"lateCount":42,"dayOrder":42},"frequency":{"id":42,"systemValueGroupId":42,"name":"string","shortName":"string","exportValue":"string","order":42,"status":"ACTIVE"},"date":"2025-05-04"}]}],"statusType":"NOT_STARTED","startDate":"2025-05-04","endDate":"2025-05-04","percentComplete":42}'

Request examples

{
  "id": 42,
  "name": "string",
  "year": "string",
  "frequency": {
    "id": 42,
    "systemValueGroupId": 42,
    "name": "string",
    "shortName": "string",
    "exportValue": "string",
    "order": 42,
    "status": "ACTIVE"
  },
  "closeDaysByFrequency": [
    {
      "frequency": {
        "id": 42,
        "systemValueGroupId": 42,
        "name": "string",
        "shortName": "string",
        "exportValue": "string",
        "order": 42,
        "status": "ACTIVE"
      },
      "closeDays": [
        {
          "id": 42,
          "closeDay": {
            "name": "string",
            "closeDate": "2025-05-04T09:42:00Z",
            "completeCount": 42,
            "inProcessCount": 42,
            "lateCount": 42,
            "dayOrder": 42
          },
          "frequency": {
            "id": 42,
            "systemValueGroupId": 42,
            "name": "string",
            "shortName": "string",
            "exportValue": "string",
            "order": 42,
            "status": "ACTIVE"
          },
          "date": "2025-05-04"
        }
      ]
    }
  ],
  "statusType": "NOT_STARTED",
  "startDate": "2025-05-04",
  "endDate": "2025-05-04",
  "percentComplete": 42
}

Response examples (200)

{
  "id": 42,
  "name": "string",
  "year": "string",
  "frequency": {
    "id": 42,
    "systemValueGroupId": 42,
    "name": "string",
    "shortName": "string",
    "exportValue": "string",
    "order": 42,
    "status": "ACTIVE"
  },
  "closeDaysByFrequency": [
    {
      "frequency": {
        "id": 42,
        "systemValueGroupId": 42,
        "name": "string",
        "shortName": "string",
        "exportValue": "string",
        "order": 42,
        "status": "ACTIVE"
      },
      "closeDays": [
        {
          "id": 42,
          "closeDay": {
            "name": "string",
            "closeDate": "2025-05-04T09:42:00Z",
            "completeCount": 42,
            "inProcessCount": 42,
            "lateCount": 42,
            "dayOrder": 42
          },
          "frequency": {
            "id": 42,
            "systemValueGroupId": 42,
            "name": "string",
            "shortName": "string",
            "exportValue": "string",
            "order": 42,
            "status": "ACTIVE"
          },
          "date": "2025-05-04"
        }
      ]
    }
  ],
  "statusType": "NOT_STARTED",
  "startDate": "2025-05-04",
  "endDate": "2025-05-04",
  "percentComplete": 42
}