financial-transactions

Operations addressed under /financial-transactions — 6 operations.

get-financial-transaction-list

GET

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

/financial-transactions

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`DebitLedgerCode`	`string`	no
`DebitLedgerMatrixId`	`Guid?`	yes
`DebitLedgerMatrixName`	`string`	no
`DebitLedgerMatrixFieldId`	`Guid?`	yes
`DebitLedgerMatrixFieldName`	`string`	no
`CreditLedgerCode`	`string`	no
`CreditLedgerMatrixId`	`Guid?`	yes
`CreditLedgerMatrixName`	`string`	no
`CreditLedgerMatrixFieldId`	`Guid?`	yes
`CreditLedgerMatrixFieldName`	`string`	no

Member names are the service's declaration names.

get-financial-transaction-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-financial-transaction-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.

code

string

creditLedgerCode

creditLedgerFieldId

string · uuid

creditLedgerMatrixFieldName

string

creditLedgerMatrixId

string · uuid

creditLedgerMatrixName

string

debitLedgerCode

string

debitLedgerFieldId

string · uuid

debitLedgerMatrixFieldName

string

debitLedgerMatrixId

string · uuid

debitLedgerMatrixName

string

description

string

id

string · uuid

name

string

GET/financial-transactions

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions

Example Responses

[
  {
    "code": "code",
    "creditLedgerCode": {},
    "creditLedgerFieldId": "00000000-0000-0000-0000-000000000000",
    "creditLedgerMatrixFieldName": "creditLedgerMatrixFieldName",
    "creditLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
    "creditLedgerMatrixName": "creditLedgerMatrixName",
    "debitLedgerCode": "debitLedgerCode",
    "debitLedgerFieldId": "00000000-0000-0000-0000-000000000000",
    "debitLedgerMatrixFieldName": "debitLedgerMatrixFieldName",
    "debitLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
    "debitLedgerMatrixName": "debitLedgerMatrixName",
    "description": "description",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name"
  }
]

json

application/json

create-financial-transaction

POST

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

/financial-transactions

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_116`	400	`NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_FINANCIAL_TRANSACTION_WITH_SAME_CODE`	It is not allowed to create more than one financial transaction with same code '`{0}`'.
`ERR_ACCTNG_118`	400	`FINANCIAL_TRANSACTION_CODE_WRONG_FORMAT`	Length of the 'code' value cannot exceed 20 characters and cannot include any special characters.

create-financial-transaction › Request Body

code

string · required

creditLedgerCode

string

creditLedgerMatrixFieldId

string · uuid

creditLedgerMatrixId

string · uuid

debitLedgerCode

string

debitLedgerMatrixFieldId

string · uuid

debitLedgerMatrixId

string · uuid

description

string

name

string

create-financial-transaction › 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

POST/financial-transactions

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}'

Example Request Body

{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}

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

get-financial-transaction-by-code

GET

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

/financial-transactions/by-code/{code}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`DebitLedgerCode`	`string`	no
`DebitLedgerMatrixId`	`Guid?`	yes
`DebitLedgerMatrixName`	`string`	no
`DebitLedgerMatrixFieldId`	`Guid?`	yes
`DebitLedgerMatrixFieldName`	`string`	no
`CreditLedgerCode`	`string`	no
`CreditLedgerMatrixId`	`Guid?`	yes
`CreditLedgerMatrixName`	`string`	no
`CreditLedgerMatrixFieldId`	`Guid?`	yes
`CreditLedgerMatrixFieldName`	`string`	no

Member names are the service's declaration names.

get-financial-transaction-by-code › path Parameters

code

string · required

get-financial-transaction-by-code › 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.

code

string

creditLedgerCode

string

creditLedgerMatrixFieldId

string · uuid

creditLedgerMatrixFieldName

string

creditLedgerMatrixId

string · uuid

creditLedgerMatrixName

string

debitLedgerCode

string

debitLedgerMatrixFieldId

string · uuid

debitLedgerMatrixFieldName

string

debitLedgerMatrixId

string · uuid

debitLedgerMatrixName

string

description

string

id

string · uuid

name

string

GET/financial-transactions/by-code/{code}

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions/by-code/:code

Example Responses

{
  "code": "code",
  "creditLedgerCode": "creditLedgerCode",
  "creditLedgerMatrixFieldId": "00000000-0000-0000-0000-000000000000",
  "creditLedgerMatrixFieldName": "creditLedgerMatrixFieldName",
  "creditLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
  "creditLedgerMatrixName": "creditLedgerMatrixName",
  "debitLedgerCode": "debitLedgerCode",
  "debitLedgerMatrixFieldId": "00000000-0000-0000-0000-000000000000",
  "debitLedgerMatrixFieldName": "debitLedgerMatrixFieldName",
  "debitLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
  "debitLedgerMatrixName": "debitLedgerMatrixName",
  "description": "description",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name"
}

json

application/json

get-financial-transaction-by-id

GET

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

/financial-transactions/{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 FinancialTransactionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`DebitLedgerCode`	`string`	no
`DebitLedgerMatrixId`	`Guid?`	yes
`DebitLedgerMatrixName`	`string`	no
`DebitLedgerMatrixFieldId`	`Guid?`	yes
`DebitLedgerMatrixFieldName`	`string`	no
`CreditLedgerCode`	`string`	no
`CreditLedgerMatrixId`	`Guid?`	yes
`CreditLedgerMatrixName`	`string`	no
`CreditLedgerMatrixFieldId`	`Guid?`	yes
`CreditLedgerMatrixFieldName`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_120`	400	`FINANCIAL_TRANSACTION_NOT_FOUND`	Financial Transaction is not found with the given id '`{0}`'.

get-financial-transaction-by-id › path Parameters

id

string · uuid · required

get-financial-transaction-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-financial-transaction

PUT

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

/financial-transactions/{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_116`	400	`NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_FINANCIAL_TRANSACTION_WITH_SAME_CODE`	It is not allowed to create more than one financial transaction with same code '`{0}`'.
`ERR_ACCTNG_118`	400	`FINANCIAL_TRANSACTION_CODE_WRONG_FORMAT`	Length of the 'code' value cannot exceed 20 characters and cannot include any special characters.
`ERR_ACCTNG_120`	400	`FINANCIAL_TRANSACTION_NOT_FOUND`	Financial Transaction is not found with the given id '`{0}`'.

update-financial-transaction › path Parameters

id

string · uuid · required

update-financial-transaction › Request Body

code

string · required

creditLedgerCode

string

creditLedgerMatrixFieldId

string · uuid

creditLedgerMatrixId

string · uuid

debitLedgerCode

string

debitLedgerMatrixFieldId

string · uuid

debitLedgerMatrixId

string · uuid

description

string

name

string

update-financial-transaction › Responses

No data returned

PUT/financial-transactions/{id}

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}'

Example Request Body

{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}

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-financial-transaction

DELETE

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

/financial-transactions/{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_120`	400	`FINANCIAL_TRANSACTION_NOT_FOUND`	Financial Transaction is not found with the given id '`{0}`'.
`ERR_ACCTNG_121`	400	`FINANCIAL_TRANSACTION_IS_USED_IN_ACCOUNTING_ENTRY_DEFINITION_IT_CANNOT_BE_DELETED`	Financial transaction '`{0}`' is used in accounting entry definition.It cannot be deleted.

delete-financial-transaction › path Parameters

id

string · uuid · required

delete-financial-transaction › Responses

No data returned

financial-statements fiscal-year

Accounting Service

financial-transactions

Operations addressed under /financial-transactions — 6 operations.

get-financial-transaction-list

GET

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

/financial-transactions

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`DebitLedgerCode`	`string`	no
`DebitLedgerMatrixId`	`Guid?`	yes
`DebitLedgerMatrixName`	`string`	no
`DebitLedgerMatrixFieldId`	`Guid?`	yes
`DebitLedgerMatrixFieldName`	`string`	no
`CreditLedgerCode`	`string`	no
`CreditLedgerMatrixId`	`Guid?`	yes
`CreditLedgerMatrixName`	`string`	no
`CreditLedgerMatrixFieldId`	`Guid?`	yes
`CreditLedgerMatrixFieldName`	`string`	no

Member names are the service's declaration names.

get-financial-transaction-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-financial-transaction-list › Responses

object[]

Array of catalog-declared response records.

code

string

creditLedgerCode

creditLedgerFieldId

string · uuid

creditLedgerMatrixFieldName

string

creditLedgerMatrixId

string · uuid

creditLedgerMatrixName

string

debitLedgerCode

string

debitLedgerFieldId

string · uuid

debitLedgerMatrixFieldName

string

debitLedgerMatrixId

string · uuid

debitLedgerMatrixName

string

description

string

id

string · uuid

name

string

GET/financial-transactions

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions

Example Responses

[
  {
    "code": "code",
    "creditLedgerCode": {},
    "creditLedgerFieldId": "00000000-0000-0000-0000-000000000000",
    "creditLedgerMatrixFieldName": "creditLedgerMatrixFieldName",
    "creditLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
    "creditLedgerMatrixName": "creditLedgerMatrixName",
    "debitLedgerCode": "debitLedgerCode",
    "debitLedgerFieldId": "00000000-0000-0000-0000-000000000000",
    "debitLedgerMatrixFieldName": "debitLedgerMatrixFieldName",
    "debitLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
    "debitLedgerMatrixName": "debitLedgerMatrixName",
    "description": "description",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "name"
  }
]

json

application/json

create-financial-transaction

POST

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

/financial-transactions

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_116`	400	`NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_FINANCIAL_TRANSACTION_WITH_SAME_CODE`	It is not allowed to create more than one financial transaction with same code '`{0}`'.
`ERR_ACCTNG_118`	400	`FINANCIAL_TRANSACTION_CODE_WRONG_FORMAT`	Length of the 'code' value cannot exceed 20 characters and cannot include any special characters.

create-financial-transaction › Request Body

code

string · required

creditLedgerCode

string

creditLedgerMatrixFieldId

string · uuid

creditLedgerMatrixId

string · uuid

debitLedgerCode

string

debitLedgerMatrixFieldId

string · uuid

debitLedgerMatrixId

string · uuid

description

string

name

string

create-financial-transaction › Responses

No data returned

POST/financial-transactions

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}'

Example Request Body

{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}

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

get-financial-transaction-by-code

GET

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

/financial-transactions/by-code/{code}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`DebitLedgerCode`	`string`	no
`DebitLedgerMatrixId`	`Guid?`	yes
`DebitLedgerMatrixName`	`string`	no
`DebitLedgerMatrixFieldId`	`Guid?`	yes
`DebitLedgerMatrixFieldName`	`string`	no
`CreditLedgerCode`	`string`	no
`CreditLedgerMatrixId`	`Guid?`	yes
`CreditLedgerMatrixName`	`string`	no
`CreditLedgerMatrixFieldId`	`Guid?`	yes
`CreditLedgerMatrixFieldName`	`string`	no

Member names are the service's declaration names.

get-financial-transaction-by-code › path Parameters

code

string · required

get-financial-transaction-by-code › Responses

code

string

creditLedgerCode

string

creditLedgerMatrixFieldId

string · uuid

creditLedgerMatrixFieldName

string

creditLedgerMatrixId

string · uuid

creditLedgerMatrixName

string

debitLedgerCode

string

debitLedgerMatrixFieldId

string · uuid

debitLedgerMatrixFieldName

string

debitLedgerMatrixId

string · uuid

debitLedgerMatrixName

string

description

string

id

string · uuid

name

string

GET/financial-transactions/by-code/{code}

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions/by-code/:code

Example Responses

{
  "code": "code",
  "creditLedgerCode": "creditLedgerCode",
  "creditLedgerMatrixFieldId": "00000000-0000-0000-0000-000000000000",
  "creditLedgerMatrixFieldName": "creditLedgerMatrixFieldName",
  "creditLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
  "creditLedgerMatrixName": "creditLedgerMatrixName",
  "debitLedgerCode": "debitLedgerCode",
  "debitLedgerMatrixFieldId": "00000000-0000-0000-0000-000000000000",
  "debitLedgerMatrixFieldName": "debitLedgerMatrixFieldName",
  "debitLedgerMatrixId": "00000000-0000-0000-0000-000000000000",
  "debitLedgerMatrixName": "debitLedgerMatrixName",
  "description": "description",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name"
}

json

application/json

get-financial-transaction-by-id

GET

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

/financial-transactions/{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 FinancialTransactionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`DebitLedgerCode`	`string`	no
`DebitLedgerMatrixId`	`Guid?`	yes
`DebitLedgerMatrixName`	`string`	no
`DebitLedgerMatrixFieldId`	`Guid?`	yes
`DebitLedgerMatrixFieldName`	`string`	no
`CreditLedgerCode`	`string`	no
`CreditLedgerMatrixId`	`Guid?`	yes
`CreditLedgerMatrixName`	`string`	no
`CreditLedgerMatrixFieldId`	`Guid?`	yes
`CreditLedgerMatrixFieldName`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_120`	400	`FINANCIAL_TRANSACTION_NOT_FOUND`	Financial Transaction is not found with the given id '`{0}`'.

get-financial-transaction-by-id › path Parameters

id

string · uuid · required

get-financial-transaction-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-financial-transaction

PUT

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

/financial-transactions/{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_116`	400	`NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_FINANCIAL_TRANSACTION_WITH_SAME_CODE`	It is not allowed to create more than one financial transaction with same code '`{0}`'.
`ERR_ACCTNG_118`	400	`FINANCIAL_TRANSACTION_CODE_WRONG_FORMAT`	Length of the 'code' value cannot exceed 20 characters and cannot include any special characters.
`ERR_ACCTNG_120`	400	`FINANCIAL_TRANSACTION_NOT_FOUND`	Financial Transaction is not found with the given id '`{0}`'.

update-financial-transaction › path Parameters

id

string · uuid · required

update-financial-transaction › Request Body

code

string · required

creditLedgerCode

string

creditLedgerMatrixFieldId

string · uuid

creditLedgerMatrixId

string · uuid

debitLedgerCode

string

debitLedgerMatrixFieldId

string · uuid

debitLedgerMatrixId

string · uuid

description

string

name

string

update-financial-transaction › Responses

No data returned

PUT/financial-transactions/{id}

curl https://dg-sandbox.dgpays.com/accounting-service/financial-transactions/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}'

Example Request Body

{
  "code": "",
  "creditLedgerCode": "",
  "creditLedgerMatrixFieldId": "",
  "creditLedgerMatrixId": "",
  "debitLedgerCode": "",
  "debitLedgerMatrixFieldId": "",
  "debitLedgerMatrixId": "",
  "description": "",
  "name": ""
}

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-financial-transaction

DELETE

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

/financial-transactions/{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_120`	400	`FINANCIAL_TRANSACTION_NOT_FOUND`	Financial Transaction is not found with the given id '`{0}`'.
`ERR_ACCTNG_121`	400	`FINANCIAL_TRANSACTION_IS_USED_IN_ACCOUNTING_ENTRY_DEFINITION_IT_CANNOT_BE_DELETED`	Financial transaction '`{0}`' is used in accounting entry definition.It cannot be deleted.

delete-financial-transaction › path Parameters

id

string · uuid · required

delete-financial-transaction › Responses

No data returned

financial-statements fiscal-year