ledger-code-matrix

Operations addressed under /ledger-code-matrix — 15 operations.

get-ledger-matrix-list

GET

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

/ledger-code-matrix

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no
`LedgerMatrixFields`	`IEnumerable<LedgerMatrixFieldDto>` (collection)	no

Member names are the service's declaration names.

get-ledger-matrix-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-ledger-matrix-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

id

string · uuid

object[]

name

string

Creates ledger matrix

POST

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

/ledger-code-matrix

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

Invokes the create-ledger-matrix service definition through POST /ledger-code-matrix.

Turkish display name: Ledger matrix oluşturur

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.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_95`	400	`LEDGER_MATRIX_ALREADY_EXISTS`	It is not allowed to create more than one table with the same name. Name: '`{0}`'.

Creates ledger matrix › Request Body

description

string · required

name

string · required

Creates ledger matrix › 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-ledger-matrix-by-id

GET

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

/ledger-code-matrix/{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 LedgerMatrixDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no
`LedgerMatrixFields`	`IEnumerable<LedgerMatrixFieldDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

get-ledger-matrix-by-id › path Parameters

id

string · uuid · required

get-ledger-matrix-by-id › Responses

description

string

id

string · uuid

name

string

update-ledger-matrix

PUT

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

/ledger-code-matrix/{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_95`	400	`LEDGER_MATRIX_ALREADY_EXISTS`	It is not allowed to create more than one table with the same name. Name: '`{0}`'.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

update-ledger-matrix › path Parameters

id

string · uuid · required

update-ledger-matrix › Request Body

description

string · required

name

string · required

update-ledger-matrix › 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

Deleting Record From Ledger Matrix Table

DELETE

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

/ledger-code-matrix/{id}

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

Invokes the delete-ledger-matrix service definition through DELETE /ledger-code-matrix/{id}.

Turkish display name: Ledger Matrix Tablosundan Kayıt Siler

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.
`ERR_ACCTNG_98`	400	`MATRIX_TABLE_CANNOT_BE_DELETED`	Matrix table has columns. It cannot be deleted.

Deleting Record From Ledger Matrix Table › path Parameters

id

string · uuid · required

Deleting Record From Ledger Matrix Table › Responses

No data returned

get-ledger-matrix-field-by-id

GET

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

/ledger-code-matrix/{id}/by-field-id/{fieldId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`LedgerMatrixId`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no
`LedgerMatrixValues`	`List<LedgerMatrixValueDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_108`	400	`LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND`	Ledger Matrix Field is not found with given id '`{0}`'.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

get-ledger-matrix-field-by-id › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

get-ledger-matrix-field-by-id › Responses

description

string

id

string · uuid

ledgerMatrixId

string · uuid

object[]

name

string

get-ledger-matrix-field-by-ledger-matrix-id

GET

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

/ledger-code-matrix/{id}/fields

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

Field	Declared type	Nullable
`LedgerMatrixId`	`Guid`	no
`FieldId`	`Guid`	no
`Name`	`string`	no
`Description`	`string`	no

Member names are the service's declaration names.

get-ledger-matrix-field-by-ledger-matrix-id › path Parameters

id

string · uuid · required

get-ledger-matrix-field-by-ledger-matrix-id › query Parameters

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-ledger-matrix-field-by-ledger-matrix-id › Responses

object[]

Array of catalog-declared response records.

description

string

fieldId

string · uuid

ledgerMatrixId

string · uuid

name

string

create-ledger-matrix-field

POST

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

/ledger-code-matrix/{id}/fields

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.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_100`	400	`LEDGER_MATRIX_TABLE_COLUMN_ALREADY_EXISTS`	It is not allowed to create more than one column with the same name '`{0}`' in one table.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

create-ledger-matrix-field › path Parameters

id

string · uuid · required

create-ledger-matrix-field › Request Body

description

string · required

name

string · required

create-ledger-matrix-field › Responses

id

string · uuid

get-ledger-matrix-value-list

GET

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

/ledger-code-matrix/{id}/fields/{fieldId}

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

Field	Declared type	Nullable
`ValueId`	`Guid`	no
`MainLedgerCode`	`string`	no
`LedgerCode`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_108`	400	`LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND`	Ledger Matrix Field is not found with given id '`{0}`'.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

get-ledger-matrix-value-list › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

get-ledger-matrix-value-list › Responses

object[]

Array of catalog-declared response records.

ledgerCode

string

mainLedgerCode

string

valueId

string · uuid

update-ledger-matrix-field

PUT

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

/ledger-code-matrix/{id}/fields/{fieldId}

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_100`	400	`LEDGER_MATRIX_TABLE_COLUMN_ALREADY_EXISTS`	It is not allowed to create more than one column with the same name '`{0}`' in one table.
`ERR_ACCTNG_108`	400	`LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND`	Ledger Matrix Field is not found with given id '`{0}`'.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

update-ledger-matrix-field › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

update-ledger-matrix-field › Request Body

description

string · required

name

string · required

update-ledger-matrix-field › Responses

No data returned

delete-ledger-matrix-field

DELETE

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

/ledger-code-matrix/{id}/fields/{fieldId}

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_103`	400	—	Matrix table column '`{0}`' is used in Transaction '`{1}`'. It cannot be deleted.
`ERR_ACCTNG_108`	400	`LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND`	Ledger Matrix Field is not found with given id '`{0}`'.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.
`ERR_ACCTNG_97`	400	—	Matrix table column has. It cannot be deleted.

delete-ledger-matrix-field › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

delete-ledger-matrix-field › Responses

No data returned

create-ledger-matrix-value

POST

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

/ledger-code-matrix/{id}/fields/{fieldId}/values

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

create-ledger-matrix-value › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

create-ledger-matrix-value › Request Body

object[] · required

create-ledger-matrix-value › Responses

No data returned

Updates ledger matrix value

PUT

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

/ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}

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

Invokes the update-ledger-matrix-value service definition through PUT /ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}.

Turkish display name: Ledger matrix value günceller

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_112`	400	`LEDGER_MATRIX_VALUE_IS_NOT_FOUND`	Matrix value is not found with given id '`{0}`'.

Updates ledger matrix value › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

valueId

string · uuid · required

Updates ledger matrix value › Request Body

ledgerCode

string · required

mainLedgerCode

string · required

Updates ledger matrix value › Responses

No data returned

Deletes ledger matrix value

DELETE

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

/ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}

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

Invokes the delete-ledger-matrix-value service definition through DELETE /ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}.

Turkish display name: Ledger matrix value siler

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_108`	400	`LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND`	Ledger Matrix Field is not found with given id '`{0}`'.
`ERR_ACCTNG_112`	400	`LEDGER_MATRIX_VALUE_IS_NOT_FOUND`	Matrix value is not found with given id '`{0}`'.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

Deletes ledger matrix value › path Parameters

id

string · uuid · required

fieldId

string · uuid · required

valueId

string · uuid · required

Deletes ledger matrix value › Responses

No data returned

get-ledger-matrix-value-by-main-ledger-code

GET

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

/ledger-code-matrix/{id}/values/{mainLedgerCode}

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 List<LedgerMatrixValueLedgerDto>.

Field	Declared type	Nullable
`FieldId`	`Guid`	no
`FieldName`	`string`	no
`LedgerCode`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_106`	400	`LEDGER_MATRIX_VALUE_IS_NOT_FOUND_FOR_LEDGER`	Matrix value is not found with the given main ledger '`{0}`'.
`ERR_ACCTNG_96`	400	`LEDGER_MATRIX_TABLE_NOT_FOUND`	Ledger matrix is not found with given id '`{0}`'.

get-ledger-matrix-value-by-main-ledger-code › path Parameters

id

string · uuid · required

mainLedgerCode

string · required

get-ledger-matrix-value-by-main-ledger-code › Responses

object[]

Array of catalog-declared response records.

fieldId

fieldName

ledgerCode

string

ledger-balances ledger-level-formats