financial-statement-templates

Operations addressed under /financial-statement-templates — 13 operations.

get-statement-template-list

GET

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates

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<StatementTemplateDto>.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no

Member names are the service's declaration names.

get-statement-template-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-statement-template-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.

object[]

Array of catalog-declared response records.

description

string

id

string · uuid

name

string

create-statement-template

POST

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates

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 AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

create-statement-template › Request Body

description

string · required

name

string · required

create-statement-template › 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.

id

string · uuid

get-statement-template-by-id

GET

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{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 StatementTemplateDto.

Field	Declared type	Nullable
`Name`	`string`	no
`Description`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.

get-statement-template-by-id › path Parameters

id

string · uuid · required

get-statement-template-by-id › Responses

description

string

id

string · uuid

name

string

update-statement-template

PUT

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}

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_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.

update-statement-template › path Parameters

id

string · uuid · required

update-statement-template › Request Body

description

string · required

name

string · required

update-statement-template › 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.

No data returned

delete-statement-template

DELETE

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}

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_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.

delete-statement-template › path Parameters

id

string · uuid · required

delete-statement-template › Responses

No data returned

get-statement-template-item-and-details-by-template-id

GET

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items

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<StatementTemplateItemDto>.

Field	Declared type	Nullable
`FinancialStatementTemplateItemId`	`Guid`	no
`Name`	`string`	no
`Code`	`string`	no
`IsSummary`	`bool?`	yes
`IsAbsolute`	`bool?`	yes
`CalculationResource`	`int?`	yes
`ParentFinancialStatementTemplateItemId`	`Guid?`	yes
`Details`	`IEnumerable<StatementTemplateItemDetailDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.

get-statement-template-item-and-details-by-template-id › path Parameters

id

string · uuid · required

get-statement-template-item-and-details-by-template-id › Responses

object[]

Array of catalog-declared response records.

calculationResource

integer · int32

Permitted values — validated against the calculation_resource parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Ledger`	ar: دفتر الحسابات
`2`	`financial_statement_item`	ar: عنصر البيان المالي

code

string

object[]

financialStatementTemplateItemId

string · uuid

isAbsolute

boolean

isSummary

boolean

name

string

parentFinancialStatementTemplateItemId

string · uuid

GET/financial-statement-templates/{id}/items

curl https://dg-sandbox.dgpays.com/accounting-service/financial-statement-templates/:id/items

Example Responses

[
  {
    "calculationResource": 0,
    "code": "code",
    "details": [
      {
        "calcFinancialStatementTemplateItemId": "00000000-0000-0000-0000-000000000000",
        "calcLedgerCode": "calcLedgerCode",
        "effectType": 0,
        "financialStatementTemplateDetailId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "financialStatementTemplateItemId": "00000000-0000-0000-0000-000000000000",
    "isAbsolute": true,
    "isSummary": true,
    "name": "name",
    "parentFinancialStatementTemplateItemId": "00000000-0000-0000-0000-000000000000"
  }
]

json

application/json

create-statement-template-item

POST

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items

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_21`	400	`LEDGER_MUST_BE_NOT_NULL`	Ledger '`{0}`' is not found
`ERR_ACCTNG_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.
`ERR_ACCTNG_222`	400	`DUPLICATE_TEMPLATE_ITEM_NAME_NOT_ALLOWED`	Items belong to a template cannot have same name.
`ERR_ACCTNG_223`	400	`CALCULATION_RESOURCE_AND_TEMPLATE_ITEM_DETAIL_IS_NOT_MATCHED`	Calculation resource and template item detail is not matched.
`ERR_ACCTNG_224`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND`	One or more items in the following list is not found. '`{0}`'
`ERR_ACCTNG_227`	400	`DUPLICATE_TEMPLATE_ITEM_CODE_NOT_ALLOWED`	Items belong to a template cannot have same code.
`ERR_ACCTNG_228`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_DETAIL_MUST_BE_EMPTY_FOR_SUMMERY`	It is not allowed summary items to have details.

create-statement-template-item › path Parameters

id

string · uuid · required

create-statement-template-item › Request Body

object[] · required

create-statement-template-item › Responses

id

string · uuid

POST/financial-statement-templates/{id}/items

curl https://dg-sandbox.dgpays.com/accounting-service/financial-statement-templates/:id/items \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "financialStatementTemplateItems": [
    {
      "calculationResource": 0,
      "code": "",
      "details": [
        {
          "calcFinancialStatementTemplateItemCode": "",
          "calcLedgerCode": "",
          "effectType": 0
        }
      ],
      "isAbsolute": false,
      "isSummary": false,
      "name": "",
      "parentFinancialStatementTemplateItemCode": ""
    }
  ]
}'

Example Request Body

{
  "financialStatementTemplateItems": [
    {
      "calculationResource": 0,
      "code": "",
      "details": [
        {
          "calcFinancialStatementTemplateItemCode": "",
          "calcLedgerCode": "",
          "effectType": 0
        }
      ],
      "isAbsolute": false,
      "isSummary": false,
      "name": "",
      "parentFinancialStatementTemplateItemCode": ""
    }
  ]
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

Update Statement Template Item

PUT

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the update-statement-template-item service definition through PUT /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.
`ERR_ACCTNG_222`	400	`DUPLICATE_TEMPLATE_ITEM_NAME_NOT_ALLOWED`	Items belong to a template cannot have same name.
`ERR_ACCTNG_223`	400	`CALCULATION_RESOURCE_AND_TEMPLATE_ITEM_DETAIL_IS_NOT_MATCHED`	Calculation resource and template item detail is not matched.
`ERR_ACCTNG_224`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND`	One or more items in the following list is not found. '`{0}`'
`ERR_ACCTNG_227`	400	`DUPLICATE_TEMPLATE_ITEM_CODE_NOT_ALLOWED`	Items belong to a template cannot have same code.

Update Statement Template Item › path Parameters

id

string · uuid · required

financialStatementTemplateItemId

string · uuid · required

Update Statement Template Item › Request Body

code

string · required

isAbsolute

boolean · required

isSummary

boolean · required

name

string · required

calculationResource

integer · int32

Permitted values — validated against the calculation_resource parameter.

Value	Meaning
`1`	Ledger
`2`	financial_statement_item

Permitted values — validated against the calculation_resource parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Ledger`	ar: دفتر الحسابات
`2`	`financial_statement_item`	ar: عنصر البيان المالي

parentFinancialStatementTemplateItemCode

string

Update Statement Template Item › Responses

No data returned

PUT/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}

curl https://dg-sandbox.dgpays.com/accounting-service/financial-statement-templates/:id/items/:financialStatementTemplateItemId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "calculationResource": 0,
  "code": "",
  "isAbsolute": false,
  "isSummary": false,
  "name": "",
  "parentFinancialStatementTemplateItemCode": ""
}'

Example Request Body

{
  "calculationResource": 0,
  "code": "",
  "isAbsolute": false,
  "isSummary": false,
  "name": "",
  "parentFinancialStatementTemplateItemCode": ""
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

Create Statement Template Item

POST

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the create-statement-template-item-detail service definition through POST /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}.

Response body, read from the service source

The route declares its response as AuraCommandDto.

Field	Declared type	Nullable
`Id`	`Guid`	no

Member names are the service's declaration names.

Create Statement Template Item › path Parameters

id

string · uuid · required

financialStatementTemplateItemId

string · uuid · required

Create Statement Template Item › Request Body

effectType

integer · enum · int32 · required

Permitted values (2):

1 — Add (ar: إضافة)
2 — Subtract (ar: طرح)

Enum values:

calcFinancialStatementTemplateItemCode

string

calcLedgerCode

string

Create Statement Template Item › Responses

id

string · uuid

Delete Statement Template Item

DELETE

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the delete-statement-template-item service definition through DELETE /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.
`ERR_ACCTNG_224`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND`	One or more items in the following list is not found. '`{0}`'
`ERR_ACCTNG_229`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_IS_USED_CANNOT_BE_DELETED`	Financial statement template item is used as detail in a different template item. It cannot be delete

Delete Statement Template Item › path Parameters

id

string · uuid · required

financialStatementTemplateItemId

string · uuid · required

Delete Statement Template Item › Responses

No data returned

get-statement-template-item-detail-by-item-id

GET

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details

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<StatementTemplateItemDetailDto>.

Field	Declared type	Nullable
`FinancialStatementTemplateDetailId`	`Guid?`	yes
`CalcLedgerCode`	`string`	no
`CalcFinancialStatementTemplateItemId`	`Guid?`	yes
`EffectType`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.
`ERR_ACCTNG_224`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND`	One or more items in the following list is not found. '`{0}`'

get-statement-template-item-detail-by-item-id › path Parameters

id

string · uuid · required

financialStatementTemplateItemId

string · uuid · required

get-statement-template-item-detail-by-item-id › Responses

object[]

Array of catalog-declared response records.

calcFinancialStatementTemplateItemId

string · uuid

calcLedgerCode

string

effectType

integer · enum · int32

Permitted values (2):

1 — Add (ar: إضافة)
2 — Subtract (ar: طرح)

Enum values:

financialStatementTemplateDetailId

string · uuid

Update Statement Template Item Detail

PUT

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the update-statement-template-item-detail service definition through PUT /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_230`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_DETAIL_NOT_FOUND`	Financial statement template item detail is not found with the given id: '`{0}`'.

Update Statement Template Item Detail › path Parameters

id

string · uuid · required

financialStatementTemplateItemId

string · uuid · required

financialStatementTemplateDetailId

string · uuid · required

Update Statement Template Item Detail › Request Body

effectType

integer · enum · int32 · required

Permitted values (2):

1 — Add (ar: إضافة)
2 — Subtract (ar: طرح)

Enum values:

calcFinancialStatementTemplateItemCode

string

calcLedgerCode

string

Update Statement Template Item Detail › Responses

No data returned

PUT/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}

curl https://dg-sandbox.dgpays.com/accounting-service/financial-statement-templates/:id/items/:financialStatementTemplateItemId/details/:financialStatementTemplateDetailId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "calcFinancialStatementTemplateItemCode": "",
  "calcLedgerCode": "",
  "effectType": 0
}'

Example Request Body

{
  "calcFinancialStatementTemplateItemCode": "",
  "calcLedgerCode": "",
  "effectType": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

Delete Statement Template Item Detail

DELETE

https://dg-sandbox.dgpays.com/accounting-service

/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the delete-statement-template-item-detail service definition through DELETE /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_221`	400	`FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND`	Financial statement template is not found with the given id: '`{0}`'.
`ERR_ACCTNG_224`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND`	One or more items in the following list is not found. '`{0}`'
`ERR_ACCTNG_230`	400	`FINANCIAL_STATEMENT_TEMPLATE_ITEM_DETAIL_NOT_FOUND`	Financial statement template item detail is not found with the given id: '`{0}`'.

Delete Statement Template Item Detail › path Parameters

id

string · uuid · required

financialStatementTemplateItemId

string · uuid · required

financialStatementTemplateDetailId

string · uuid · required

Delete Statement Template Item Detail › Responses

No data returned

extended-properties financial-statements