Jump to

• Request
• Response

Create a period

post

/fscmRestApi/resources/11.13.18.05/publicSectorCalendars

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountingPeriod: string
  Title: Period

  Maximum Length: 8

  The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.
• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency associated with the calendar. Value is mandatory and is set programmatically based on the user's login.
• OpenCloseFlag: string
  Title: Status

  Maximum Length: 1

  Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.
• PeriodEndDate: string (date-time)
  Title: End Date

  The last day of the accounting period.
• PeriodStartDate: string (date-time)
  Title: Start Date

  The first day of the accounting period.

{
    "type":"object",
    "properties":{
        "OpenCloseFlag":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the calendar. Value is mandatory and is set programmatically based on the user's login.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last day of the accounting period.",
            "format":"date-time",
            "nullable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The first day of the accounting period.",
            "format":"date-time",
            "nullable":true
        },
        "AccountingPeriod":{
            "title":"Period",
            "maxLength":"8",
            "type":"string",
            "description":"The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorCalendars-item-response

Type: object

Show Source

• AccountingPeriod: string
  Title: Period

  Maximum Length: 8

  The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.
• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency associated with the calendar. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the accounting period using the Create Periods button on the Monthly Accounting Calendar page.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the accounting period was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the accounting period was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the accounting period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OpenCloseFlag: string
  Title: Status

  Maximum Length: 1

  Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.
• PeriodEndDate: string (date-time)
  Title: End Date

  The last day of the accounting period.
• PeriodStartDate: string (date-time)
  Title: Start Date

  The first day of the accounting period.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the accounting period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenCloseFlag":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the period is open or closed for posting accounting journals. Accepted values are O (Open) and C (Closed). The default value is C.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the accounting period was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the accounting period using the Create Periods button on the Monthly Accounting Calendar page.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the calendar. Value is mandatory and is set programmatically based on the user's login.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AccountingPeriod":{
            "title":"Period",
            "maxLength":"8",
            "type":"string",
            "description":"The unique identifier of the calendar year and month assigned to an accounting journal by the Generate Accounting process.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last day of the accounting period.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The first day of the accounting period.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the accounting period was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top