fiscal-years
Operations addressed under /fiscal-years — 11 operations.
get-fiscal-year-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<FiscalYearDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
YearStart | DateOnly? | yes |
YearEnd | DateOnly? | yes |
Status | int? | yes |
YearEndClosingStatus | int? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-fiscal-year-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
idstatusPermitted values (3):
0— closed1— open2— Permanently Closed (tr: Kalici olarak kapali)
yearEndyearEndClosingStatusyearStartcreate-fiscal-year
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_140 | 400 | CANNOT_CREATE_FISCAL_YEAR_FOR_SAME_DATES | It is not allowed to create more than one fiscal year for same dates. |
ERR_ACCTNG_141 | 400 | — | It is not allowed to create a fiscal year which is longer than one year. |
ERR_ACCTNG_142 | 400 | — | 'YearEnd' must be bigger than 'YearStart'. |
create-fiscal-year › Request Body
yearEndyearStartcreate-fiscal-year › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idget-fiscal-year-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as FiscalYearDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
YearStart | DateOnly? | yes |
YearEnd | DateOnly? | yes |
Status | int? | yes |
YearEndClosingStatus | int? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_143 | 400 | FISCAL_YEAR_IS_NOT_FOUND | Fiscal year is not found with given id '{0}'. |
path Parameters
idget-fiscal-year-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idstatusPermitted values (3):
0— closed1— open2— Permanently Closed (tr: Kalici olarak kapali)
yearEndyearEndClosingStatusyearStartupdate-fiscal-year
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_140 | 400 | CANNOT_CREATE_FISCAL_YEAR_FOR_SAME_DATES | It is not allowed to create more than one fiscal year for same dates. |
ERR_ACCTNG_141 | 400 | — | It is not allowed to create a fiscal year which is longer than one year. |
ERR_ACCTNG_143 | 400 | — | Fiscal year is not found with given id '{0}'. |
ERR_ACCTNG_144 | 400 | — | Fiscal year has periods. Its dates cannot be updated. |
ERR_ACCTNG_145 | 400 | — | Fiscal year has open periods. It cannot be closed. |
path Parameters
idupdate-fiscal-year › Request Body
statusPermitted values (3):
0— closed1— open2— Permanently Closed (tr: Kalici olarak kapali)
yearEndyearStartupdate-fiscal-year › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-fiscal-year
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Message |
|---|---|---|
ERR_ACCTNG_143 | 400 | Fiscal year is not found with given id '{0}'. |
ERR_ACCTNG_146 | 400 | Fiscal year has periods. It cannot be deleted. |
path Parameters
iddelete-fiscal-year › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-fiscal-period-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<FiscalPeriodDto>.
| Field | Declared type | Nullable |
|---|---|---|
FiscalPeriodId | Guid | no |
PeriodStart | DateOnly? | yes |
PeriodEnd | DateOnly? | yes |
OrdinalPosition | int? | yes |
Organizations | List<Organization> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_143 | 400 | FISCAL_YEAR_IS_NOT_FOUND | Fiscal year is not found with given id '{0}'. |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-fiscal-period-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
fiscalPeriodIdidisClosedordinalPositionperiodEndperiodStartCreate Fiscal Period
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the create-fiscal-period service definition through POST /fiscal-years/{id}/periods.
Response body, read from the service source
The route declares its response as IEnumerable<FiscalPeriodDto>.
| Field | Declared type | Nullable |
|---|---|---|
FiscalPeriodId | Guid | no |
PeriodStart | DateOnly? | yes |
PeriodEnd | DateOnly? | yes |
OrdinalPosition | int? | yes |
Organizations | List<Organization> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_143 | 400 | FISCAL_YEAR_IS_NOT_FOUND | Fiscal year is not found with given id '{0}'. |
ERR_ACCTNG_152 | 400 | FISCAL_PERIOD_HAS_ALREADY_CREATED | Fiscal periods has already created. |
ERR_ACCTNG_19 | 400 | GL_CODE_FORMAT_NOT_FOUND_FISCAL_PERIOD_CANNOT_BE_CREATED | GL Code Format is not found, fiscal periods cannot be created. |
ERR_ACCTNG_60 | 400 | GL_CODE_SECTION_VALUE_NOT_FOUND | Rezerve |
path Parameters
idCreate Fiscal Period › Request Body
typePermitted values — validated against the fiscal_period_type parameter.
| Value | Meaning |
|---|---|
1 | Weekly |
2 | Monthly |
3 | 3 Months |
4 | 6 Months |
Create Fiscal Period › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
fiscalPeriodIdordinalPositionperiodEndperiodStartdelete-fiscal-period
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Message |
|---|---|---|
ERR_ACCTNG_143 | 400 | Fiscal year is not found with given id '{0}'. |
ERR_ACCTNG_151 | 400 | There are accounting entries created in this fiscal year. Periods cannot be deleted. |
path Parameters
iddelete-fiscal-period › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-fiscal-period-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as FiscalPeriodDto.
| Field | Declared type | Nullable |
|---|---|---|
FiscalPeriodId | Guid | no |
PeriodStart | DateOnly? | yes |
PeriodEnd | DateOnly? | yes |
OrdinalPosition | int? | yes |
Organizations | List<Organization> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_143 | 400 | FISCAL_YEAR_IS_NOT_FOUND | Fiscal year is not found with given id '{0}'. |
ERR_ACCTNG_147 | 400 | FISCAL_PERIOD_IS_NOT_FOUND | Fiscal period is not found with the given PeriodId '{0}'. |
path Parameters
idperiodIdget-fiscal-period-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
fiscalPeriodIdordinalPositionperiodEndperiodStartupdate-fiscal-period-status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_143 | 400 | FISCAL_YEAR_IS_NOT_FOUND | Fiscal year is not found with given id '{0}'. |
ERR_ACCTNG_147 | 400 | FISCAL_PERIOD_IS_NOT_FOUND | Fiscal period is not found with the given PeriodId '{0}'. |
ERR_ACCTNG_150 | 400 | FISCAL_YEAR_OF_THE_PERIOD_IS_CLOSED | Fiscal year of the period is closed and the period is not final period of the fiscal year. It cannot be updated. |
ERR_ACCTNG_243 | 400 | FISCAL_YEAR_PERMANENTLY_CLOSED | not published in this snapshot |
path Parameters
idperiodIdupdate-fiscal-period-status › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
update organization fiscal period status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the update-organization-fiscal-period-status service definition through PUT /fiscal-years/{id}/periods/{periodId}/organizations/by-organization-code/{organizationCode}.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_ACCTNG_143 | 400 | FISCAL_YEAR_IS_NOT_FOUND | Fiscal year is not found with given id '{0}'. |
ERR_ACCTNG_147 | 400 | FISCAL_PERIOD_IS_NOT_FOUND | Fiscal period is not found with the given PeriodId '{0}'. |
ERR_ACCTNG_150 | 400 | FISCAL_YEAR_OF_THE_PERIOD_IS_CLOSED | Fiscal year of the period is closed and the period is not final period of the fiscal year. It cannot be updated. |
ERR_ACCTNG_154 | 400 | ORGANIZATION_CODE_IS_NOT_FOUND | Organization fiscal period is not found with the give organization code: '{0}' |
path Parameters
idperiodIdorganizationCodeupdate organization fiscal period status › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.