accounting-entry-definitions

Operations addressed under /accounting-entry-definitions — 15 operations.

get-accounting-entry-definition-list

GET

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

/accounting-entry-definitions

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`IsActive`	`bool`	no
`Name`	`string`	no
`Description`	`string`	no
`IsPreviousReverseEntry`	`bool?`	yes

Member names are the service's declaration names.

get-accounting-entry-definition-list › query Parameters

object

isActive

boolean

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-accounting-entry-definition-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

description

string

id

string · uuid

isActive

boolean

isPreviousReverseEntry

boolean

name

string

create-accounting-entry-definition

POST

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

/accounting-entry-definitions

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	Message
`ERR_ACCTNG_125`	400	There is already an Accounting Entry Definition with the given code '`{0}`'. Accounting Entry Definition Code must be unique.

create-accounting-entry-definition › Request Body

code

string · required

description

string · required

name

string · required

isPreviousReverseEntry

boolean

create-accounting-entry-definition › 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-accounting-entry-definition-by-code

GET

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

/accounting-entry-definitions/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 AccountingEntryDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`IsActive`	`bool`	no
`Name`	`string`	no
`Description`	`string`	no
`IsPreviousReverseEntry`	`bool?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_127`	400	`ACCOUNTING_ENTRY_DEFINITION_NOT_FOUND`	Accounting Entry Definition is not found with the given code '`{0}`'.

get-accounting-entry-definition-by-code › path Parameters

code

string · required

get-accounting-entry-definition-by-code › Responses

code

string

description

string

id

string · uuid

isActive

boolean

isPreviousReverseEntry

boolean

name

string

get-accounting-entry-definition-id-by-code

GET

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

/accounting-entry-definitions/by-code/{code}/id

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

get-accounting-entry-definition-id-by-code › path Parameters

code

string · required

get-accounting-entry-definition-id-by-code › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

id

string · uuid

get-accounting-entry-definition-by-id

GET

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

/accounting-entry-definitions/{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 AccountingEntryDefinitionDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`IsActive`	`bool`	no
`Name`	`string`	no
`Description`	`string`	no
`IsPreviousReverseEntry`	`bool?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.

get-accounting-entry-definition-by-id › path Parameters

id

string · uuid · required

get-accounting-entry-definition-by-id › Responses

code

string

description

id

string · uuid

isActive

isPreviousReverseEntry

boolean

name

string

update-accounting-entry-definition

PUT

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

/accounting-entry-definitions/{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_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.

update-accounting-entry-definition › path Parameters

id

string · uuid · required

update-accounting-entry-definition › Request Body

description

string · required

isActive

boolean · required

name

string · required

isPreviousReverseEntry

boolean

update-accounting-entry-definition › 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

get-accounting-entry-condition-by-definition-id

GET

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

/accounting-entry-definitions/{id}/conditions

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

Field	Declared type	Nullable
`Id`	`Guid?`	yes
`AccountingEntryDefinitionId`	`Guid?`	yes
`ConditionFormula`	`string`	no
`Code`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.

get-accounting-entry-condition-by-definition-id › path Parameters

id

string · uuid · required

get-accounting-entry-condition-by-definition-id › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-accounting-entry-condition-by-definition-id › Responses

object[]

Array of catalog-declared response records.

accountingEntryDefinitionId

string · uuid

code

string

conditionFormula

string

id

string · uuid

create-accounting-entry-condition

POST

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

/accounting-entry-definitions/{id}/conditions

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_122`	400	`ACCOUNTING_ENTRY_CONDITION_CODE_MUST_BE_UNIQUE`	There is already a condition under the accounting entry definition with the same code.
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.

create-accounting-entry-condition › path Parameters

id

string · uuid · required

create-accounting-entry-condition › Request Body

code

string · required

conditionFormula

string · required

create-accounting-entry-condition › Responses

id

string · uuid

get-accounting-entry-condition

GET

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

/accounting-entry-definitions/{id}/conditions/{conditionId}

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

Field	Declared type	Nullable
`Id`	`Guid?`	yes
`AccountingEntryDefinitionId`	`Guid?`	yes
`ConditionFormula`	`string`	no
`Code`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.
`ERR_ACCTNG_128`	400	`ACCOUNTING_ENTRY_CONDITION_IS_NOT_FOUND`	Accounting Entry Condition is not found with the given ConditionId '`{0}`'.

get-accounting-entry-condition › path Parameters

id

string · uuid · required

conditionId

required

get-accounting-entry-condition › Responses

accountingEntryDefinitionId

string · uuid

code

string

conditionFormula

string

id

string · uuid

update-accounting-entry-condition

PUT

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

/accounting-entry-definitions/{id}/conditions/{conditionId}

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_122`	400	`ACCOUNTING_ENTRY_CONDITION_CODE_MUST_BE_UNIQUE`	There is already a condition under the accounting entry definition with the same code.
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.
`ERR_ACCTNG_128`	400	`ACCOUNTING_ENTRY_CONDITION_IS_NOT_FOUND`	Accounting Entry Condition is not found with the given ConditionId '`{0}`'.

update-accounting-entry-condition › path Parameters

id

string · uuid · required

conditionId

string · uuid · required

update-accounting-entry-condition › Request Body

code

string · required

conditionFormula

string · required

update-accounting-entry-condition › Responses

No data returned

delete-accounting-entry-condition

DELETE

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

/accounting-entry-definitions/{id}/conditions/{conditionId}

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_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.
`ERR_ACCTNG_128`	400	`ACCOUNTING_ENTRY_CONDITION_IS_NOT_FOUND`	Accounting Entry Condition is not found with the given ConditionId '`{0}`'.
`ERR_ACCTNG_129`	400	`ACCOUNTING_ENTRY_CONDITION_USED_IN_ACCOUNTING_ENTRY_DEFINITION_DETAIL`	Accounting Entry Condition '`{0}`' is used in Accounting Entry Definition Detail. It cannot be deleted.

delete-accounting-entry-condition › path Parameters

id

string · uuid · required

conditionId

string · uuid · required

delete-accounting-entry-condition › Responses

No data returned

get-accounting-entry-definition-detail-by-definition-id

GET

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

/accounting-entry-definitions/{id}/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<DetailEntryDto>.

Field	Declared type	Nullable
`DetailId`	`Guid`	no
`AccountingEntryConditionId`	`Guid`	no
`AccountingEntryConditionCode`	`string`	no
`FinancialTransactionCode`	`string`	no
`EntryDirection`	`int`	no
`OrdinalPosition`	`int`	no
`RefOrganizationCode`	`string`	no
`RefAccountNumber`	`string`	no
`RefAmount`	`string`	no
`RefCurrencyNumber`	`string`	no
`RefExchangeRate`	`string`	no
`RefExchangeSpreadType`	`string`	no
`RefDescription`	`string`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.

get-accounting-entry-definition-detail-by-definition-id › path Parameters

id

string · uuid · required

get-accounting-entry-definition-detail-by-definition-id › Responses

accountingEntryConditionCode

string

accountingEntryConditionId

string · uuid

detailId

string · uuid

entryDirection

integer · int32

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

Value	Token	Labels
`1`	`Debit`	no label seeded
`2`	`Credit`	no label seeded

financialTransactionCode

string

ordinalPosition

integer · int32

refAccountNumber

string

refAmount

string

refCurrencyNumber

string

refDescription

string

refExchangeRate

string

refExchangeSpreadType

string

refOrganizationCode

string

GET/accounting-entry-definitions/{id}/details

curl https://dg-sandbox.dgpays.com/accounting-service/accounting-entry-definitions/:id/details

Example Responses

{
  "accountingEntryConditionCode": "accountingEntryConditionCode",
  "accountingEntryConditionId": "00000000-0000-0000-0000-000000000000",
  "detailId": "00000000-0000-0000-0000-000000000000",
  "entryDirection": 0,
  "financialTransactionCode": "financialTransactionCode",
  "ordinalPosition": 0,
  "refAccountNumber": "refAccountNumber",
  "refAmount": "refAmount",
  "refCurrencyNumber": "refCurrencyNumber",
  "refDescription": "refDescription",
  "refExchangeRate": "refExchangeRate",
  "refExchangeSpreadType": "refExchangeSpreadType",
  "refOrganizationCode": "refOrganizationCode"
}

json

application/json

update-accounting-entry-definition-detail

PUT

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

/accounting-entry-definitions/{id}/details

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_123`	400	`ACCOUNTING_ENTRY_CONDITION_NOT_FOUND_BY_CODE`	Accounting Entry Condition is not found with the given code '`{0}`'.
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.
`ERR_ACCTNG_130`	400	`SEQUENCE_IS_UNIQUE_VALUE_FOR_ACCOUNTING_ENTRY_DEFINITION`	'sequence' is a unique value for Accounting Entry Definition. It cannot be repeated in Accounting Entry Definition Detail.
`ERR_ACCTNG_131`	400	`DEFINITION_DETAIL_MUST_INCLUDE_AT_LEAST_ONE_CREDIT_OR_DEBIT_LINE`	Accounting Entry Definition Detail must include at least one Credit line and one Debit line.
`ERR_ACCTNG_132`	400	`ENTRYDIRECTION_MUST_BE_COMPATIBLE_WITH_THE_FINANCIAL_TRANSACTION_CONTENT`	'entryDirection' must be compatible with the Financial Transaction '`{0}`' content.
`ERR_ACCTNG_133`	400	`FINANCIAL_TRANSACTION_IS_NOT_EXISTING`	Financial transaction '`{0}`' is not existing. It cannot be used in Accounting Entry Definition Detail.
`ERR_ACCTNG_135`	400	`ACCOUNTING_ENTRY_DEFINITION_DETAIL_IS_NOT_FOUND`	Accounting Entry Definition Detail '`{0}`' is not found.

update-accounting-entry-definition-detail › path Parameters

id

string · uuid · required

update-accounting-entry-definition-detail › Request Body

object[] · required

update-accounting-entry-definition-detail › Responses

No data returned

PUT/accounting-entry-definitions/{id}/details

curl https://dg-sandbox.dgpays.com/accounting-service/accounting-entry-definitions/:id/details \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accountingEntryDefinitionDetails": [
    {
      "accountingEntryConditionCode": "",
      "detailId": "",
      "entryDirection": 0,
      "financialTransactionCode": "",
      "ordinalPosition": 0,
      "refAccountNumber": "",
      "refAmount": "",
      "refCurrencyNumber": "",
      "refDescription": "",
      "refExchangeRate": "",
      "refExchangeSpreadType": "",
      "refOrganizationCode": ""
    }
  ]
}'

Example Request Body

{
  "accountingEntryDefinitionDetails": [
    {
      "accountingEntryConditionCode": "",
      "detailId": "",
      "entryDirection": 0,
      "financialTransactionCode": "",
      "ordinalPosition": 0,
      "refAccountNumber": "",
      "refAmount": "",
      "refCurrencyNumber": "",
      "refDescription": "",
      "refExchangeRate": "",
      "refExchangeSpreadType": "",
      "refOrganizationCode": ""
    }
  ]
}

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-accounting-entry-definition-detail

POST

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

/accounting-entry-definitions/{id}/details

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_123`	400	`ACCOUNTING_ENTRY_CONDITION_NOT_FOUND_BY_CODE`	Accounting Entry Condition is not found with the given code '`{0}`'.
`ERR_ACCTNG_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.
`ERR_ACCTNG_130`	400	`SEQUENCE_IS_UNIQUE_VALUE_FOR_ACCOUNTING_ENTRY_DEFINITION`	'sequence' is a unique value for Accounting Entry Definition. It cannot be repeated in Accounting Entry Definition Detail.
`ERR_ACCTNG_131`	400	`DEFINITION_DETAIL_MUST_INCLUDE_AT_LEAST_ONE_CREDIT_OR_DEBIT_LINE`	Accounting Entry Definition Detail must include at least one Credit line and one Debit line.
`ERR_ACCTNG_132`	400	`ENTRYDIRECTION_MUST_BE_COMPATIBLE_WITH_THE_FINANCIAL_TRANSACTION_CONTENT`	'entryDirection' must be compatible with the Financial Transaction '`{0}`' content.
`ERR_ACCTNG_133`	400	`FINANCIAL_TRANSACTION_IS_NOT_EXISTING`	Financial transaction '`{0}`' is not existing. It cannot be used in Accounting Entry Definition Detail.

create-accounting-entry-definition-detail › path Parameters

id

string · uuid · required

create-accounting-entry-definition-detail › Request Body

object[] · required

create-accounting-entry-definition-detail › Responses

No data returned

POST/accounting-entry-definitions/{id}/details

curl https://dg-sandbox.dgpays.com/accounting-service/accounting-entry-definitions/:id/details \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountingEntryDefinitionDetails": [
    {
      "accountingEntryConditionCode": "",
      "entryDirection": 0,
      "financialTransactionCode": "",
      "ordinalPosition": 0,
      "refAccountNumber": "",
      "refAmount": "",
      "refCurrencyNumber": "",
      "refDescription": "",
      "refExchangeRate": "",
      "refExchangeSpreadType": "",
      "refOrganizationCode": ""
    }
  ]
}'

Example Request Body

{
  "accountingEntryDefinitionDetails": [
    {
      "accountingEntryConditionCode": "",
      "entryDirection": 0,
      "financialTransactionCode": "",
      "ordinalPosition": 0,
      "refAccountNumber": "",
      "refAmount": "",
      "refCurrencyNumber": "",
      "refDescription": "",
      "refExchangeRate": "",
      "refExchangeSpreadType": "",
      "refOrganizationCode": ""
    }
  ]
}

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-accounting-entry-definition-detail

DELETE

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

/accounting-entry-definitions/{id}/details/{detailId}

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_126`	400	`ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND`	Accounting Entry Definition is not found with the given Id '`{0}`'.
`ERR_ACCTNG_131`	400	`DEFINITION_DETAIL_MUST_INCLUDE_AT_LEAST_ONE_CREDIT_OR_DEBIT_LINE`	Accounting Entry Definition Detail must include at least one Credit line and one Debit line.
`ERR_ACCTNG_135`	400	`ACCOUNTING_ENTRY_DEFINITION_DETAIL_IS_NOT_FOUND`	Accounting Entry Definition Detail '`{0}`' is not found.

delete-accounting-entry-definition-detail › path Parameters

id

string · uuid · required

detailId

string · uuid · required

delete-accounting-entry-definition-detail › Responses

No data returned

accounting-entries balances