Fiscal Years

Fiscal Years

Returns a fiscal year from the system by its ID.

This method will look up a fiscal year by the specified ID and return it back.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the fiscal year to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The fiscal year was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The fiscal year could not be found.
429Limit exceeded... unable to retrieve fiscal year based on tenant limits.
500General server error.
get/fiscalYears/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "business_unit_id": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "status": "open",
  • "notes": "string",
  • "is_partial": true,
  • "periods": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Updates a fiscal year with the specified ID.

This method will update an existing fiscal year with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the fiscal year to update.

Request Body schema: application/json

The updated fiscal year that will be saved.

id
required
string (ID) /^[\w-:]+$/

The unique, string identifier of this fiscal year

name
required
string (Name)

The name of the fiscal year

business_unit_id
required
string (Business Unit)

The business unit that this fiscal year belongs to

start_date
required
string <date> (Start Date)

Start date of the fiscal year

end_date
required
string <date> (End Date)

End date of the fiscal year

status
string (Status)

The status of the fiscal year

Enum: "open" "closed"
notes
string (Notes)

Any notes

is_partial
boolean (Is Partial)

If true, this is a partial fiscal year and does not have 12 periods

Array of objects non-empty
Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

Responses
200The fiscal year was updated successfully.
400The fiscal year supplied was not valid.
401Unauthorized.
403Forbidden.
404The fiscal year could not be found.
409The fiscal year could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve fiscal year based on tenant limits.
500General server error.
put/fiscalYears/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "business_unit_id": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "status": "open",
  • "notes": "string",
  • "is_partial": true,
  • "periods": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "business_unit_id": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "status": "open",
  • "notes": "string",
  • "is_partial": true,
  • "periods": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Partially updates a fiscal year with the specified ID.

This method will patch an existing fiscal year with the specified ID, using the HTTP PATCH specification.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the fiscal year to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The fiscal year was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The fiscal year could not be found.
409The fiscal year could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve fiscal year based on tenant limits.
500General server error.
patch/fiscalYears/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "business_unit_id": "string",
  • "start_date": "2019-08-24",
  • "end_date": "2019-08-24",
  • "status": "open",
  • "notes": "string",
  • "is_partial": true,
  • "periods": [
    ],
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string"
}

Returns a fiscal year from the system by its ID.

This method will delete a fiscal year with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the fiscal year to delete.

Responses
200The fiscal year was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The fiscal year could not be found.
409The fiscal year could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete fiscal year based on tenant limits.
500General server error.
delete/fiscalYears/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Gets the fiscal year and fiscal period for a particular date

This method will return a fiscal year and fiscal period object

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

businessUnitId
required
string

The id of the business unit being accessed

date
required
string

The date being looked up

Responses
200The fiscal years were retrieved successfully
400The request was invalid
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error
get/fiscalYears/{tenantId}/fiscalPeriod/{businessUnitId}/{date}
Request samples
curl -i -X GET \
  https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/fiscalPeriod/:businessUnitId/:date \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Gets the current fiscal year and period

This method looks at all of the fiscal years and periods and finds the first "open" one, which is the current

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

businessUnitId
required
string

The id of the business unit being accessed

Responses
200The fiscal years were retrieved successfully
400The request was invalid
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error
get/fiscalYears/{tenantId}/current/{businessUnitId}
Request samples
curl -i -X GET \
  https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/current/:businessUnitId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "fiscal_year": {
    },
  • "fiscal_period": 0
}

Creates the next fiscal year for a business unit

This method will automatically create a fiscal year for a business unit in the future

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

business_unit_id
required
string

The business unit

query Parameters
numberOfYearsToGenerate
string

The number of years to create

Responses
200The fiscal year was saved successfully
400The fiscal year record you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
409The fiscal year could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add fiscal year based on tenant limits.
500General server error
post/fiscalYears/{tenantId}/businessUnit/{business_unit_id}
Request samples
curl -i -X POST \
  'https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/businessUnit/:business_unit_id?numberOfYearsToGenerate=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a list of records with the specified business_unit_id

Returns a list of records with the specified business_unit_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

business_unit_id
required
string

The business_unit_id to use to for record lookup

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/fiscalYears/{tenantId}/businessUnit/{business_unit_id}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/businessUnit/:business_unit_id?fields=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Initiates workflow to close a fiscal period

This method will initiate the fiscal period close process

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

fiscalYearId
required
string

The id of the fiscal year

fiscalPeriod
required
integer

The fiscal period

Responses
200An execution ARN to be used to monitor the fiscal period closing process
400The record you supplied was invalid.
401Unauthorized
403Forbidden
404The record you supplied was not found.
409The could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch based on tenant limits.
500General server error
post/fiscalYears/{tenantId}/close/{fiscalYearId}/{fiscalPeriod}
Request samples
curl -i -X POST \
  https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/close/:fiscalYearId/:fiscalPeriod \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Initiates workflow to reopen a fiscal period

This method will initiate the fiscal period reopen process

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

fiscalYearId
required
string

The id of the fiscal year

fiscalPeriod
required
integer

The fiscal period

Responses
200An execution ARN to be used to monitor the fiscal period reopening process
400The record you supplied was invalid.
401Unauthorized
403Forbidden
404The record you supplied was not found.
409The could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add batch based on tenant limits.
500General server error
post/fiscalYears/{tenantId}/reopen/{fiscalYearId}/{fiscalPeriod}
Request samples
curl -i -X POST \
  https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId/reopen/:fiscalYearId/:fiscalPeriod \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "notification_publishKey": "string",
  • "notification_subscribeKey": "string",
  • "notification_channel": "string",
  • "executionArn": "string",
  • "start_date": "2019-08-24T14:15:22Z"
}

Gets all of the fiscal years in the system.

This method will scan all fiscal years and and return them to the caller.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The fiscal yearswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/fiscalYears/{tenantId}
Request samples
curl -i -X GET \
  'https://collect.api.rhythmsoftware.com/fiscalYears/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]