Platform | Fiscal Time Zone

Service to manage entities of type 'FiscalTimeZone'.

Overview

URL	api/{tenantKey}/{orgKey}/corePatterns/fiscalTimeZones
Methods Supported	GET

All Operations

This service includes the following operations:

• GET:
  • GET FiscalTimeZones
  • GET FiscalTimeZones (paged)
  • GET FiscalTimeZone by identifier
  • GET FiscalTimeZone by key

All Resources

This service uses the following resources:

• FiscalTimeZoneResource

GET Operations

GET FiscalTimeZones

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See FiscalTimeZoneResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET FiscalTimeZones (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See FiscalTimeZoneResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET FiscalTimeZone by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See FiscalTimeZoneResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET FiscalTimeZone by key

Returns the entity record that matches the specified key.

The following elements are required:

code	(int) The fiscal time zone’s code.

Response:

When successful, the response body contains the entity record. See FiscalTimeZoneResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

FiscalTimeZoneResource

The following elements are required:

code	(int) The fiscal time zone’s code.

The following elements are optional:

name	(string) The fiscal time zone’s name.
displayName	(string) The fiscal time zone’s display name.