expense-items

Operations addressed under /expense-items — 5 operations.

aurax-bff-redirect-get-expense-item-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/expense-items

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

Request and response fields are declared on the routing target get-expense-item-list; this entry declares none of its own.

Response body, read from the service source

The route declares its response as IEnumerable<ExpenseItemDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`StartDate`	`DateOnly?`	yes
`EndDate`	`DateOnly?`	yes
`ExpenseType`	`int?`	yes
`ParentExpenseItemId`	`Guid?`	yes
`AccountingEntryDefinitionCode`	`string`	no
`IsLeafLevel`	`bool`	no
`IsActive`	`bool?`	yes
`IsAccrual`	`bool?`	yes
`IsPartialCollection`	`bool?`	yes
`DomainCode`	`string`	no
`CalculationTypes`	`List<ExpenseItemCalculationTypeItem>` (collection)	no
`CalculationTaxes`	`List<ExpenseItemCalculationTaxDto>` (collection)	no
`ExpenseRuleMaps`	`List<ExpenseRuleMapDto>` (collection)	no

Member names are the service's declaration names.

aurax-bff-redirect-get-expense-item-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

aurax-bff-redirect-get-expense-item-list › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

aurax-bff-redirect-create-expense-item-ui-bpm

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/expense-items

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

Request and response fields are declared on the routing target create-expense-item-ui-bpm; this entry declares none of its own.

aurax-bff-redirect-create-expense-item-ui-bpm › Request Body

accountingEntryDefinitionCode

string · required

code

string · required

description

string · required

endDate

string · date · required

expenseType

integer · int32 · required

isAccrual

boolean · required

isPartialCollection

boolean · required

name

string · required

startDate

string · date-time · required

object[]

parentExpenseItemId

string · uuid

aurax-bff-redirect-create-expense-item-ui-bpm › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

POST/expense-items

curl https://dg-sandbox.dgpays.com/aurax-bff-service/expense-items \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "accountingEntryDefinitionCode": "",
  "calculationTaxes": [
    {
      "id": "",
      "taxCondition": 0,
      "taxId": ""
    }
  ],
  "calculationTypes": [
    {
      "calculationType": 0,
      "customerTypes": [
        {
          "customerType": 0,
          "id": ""
        }
      ],
      "formulaDefinitionId": "",
      "id": "",
      "ranges": [
        {
          "constantExpense": 0,
          "currencyNumber": "",
          "id": "",
          "maxConstantExpense": 0,
          "maxExpenseAmount": 0,
          "maxRate": 0,
          "maxTranAmount": 0,
          "minConstantExpense": 0,
          "minExpenseAmount": 0,
          "minRate": 0,
          "minTranAmount": 0,
          "rate": 0
        }
      ]
    }
  ],
  "code": "",
  "description": "",
  "endDate": "",
  "expenseRuleMaps": [
    {
      "expenseRuleId": ""
    }
  ],
  "expenseType": 0,
  "isAccrual": false,
  "isPartialCollection": false,
  "name": "",
  "parentExpenseItemId": "",
  "startDate": ""
}'

Example Request Body

{
  "accountingEntryDefinitionCode": "",
  "calculationTaxes": [
    {
      "id": "",
      "taxCondition": 0,
      "taxId": ""
    }
  ],
  "calculationTypes": [
    {
      "calculationType": 0,
      "customerTypes": [
        {
          "customerType": 0,
          "id": ""
        }
      ],
      "formulaDefinitionId": "",
      "id": "",
      "ranges": [
        {
          "constantExpense": 0,
          "currencyNumber": "",
          "id": "",
          "maxConstantExpense": 0,
          "maxExpenseAmount": 0,
          "maxRate": 0,
          "maxTranAmount": 0,
          "minConstantExpense": 0,
          "minExpenseAmount": 0,
          "minRate": 0,
          "minTranAmount": 0,
          "rate": 0
        }
      ]
    }
  ],
  "code": "",
  "description": "",
  "endDate": "",
  "expenseRuleMaps": [
    {
      "expenseRuleId": ""
    }
  ],
  "expenseType": 0,
  "isAccrual": false,
  "isPartialCollection": false,
  "name": "",
  "parentExpenseItemId": "",
  "startDate": ""
}

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

aurax-bff-redirect-get-expense-item-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/expense-items/{id}

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

Request and response fields are declared on the routing target get-expense-item-by-id; this entry declares none of its own.

Response body, read from the service source

The route declares its response as ExpenseItemDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`Code`	`string`	no
`Name`	`string`	no
`Description`	`string`	no
`StartDate`	`DateOnly?`	yes
`EndDate`	`DateOnly?`	yes
`ExpenseType`	`int?`	yes
`ParentExpenseItemId`	`Guid?`	yes
`AccountingEntryDefinitionCode`	`string`	no
`IsLeafLevel`	`bool`	no
`IsActive`	`bool?`	yes
`IsAccrual`	`bool?`	yes
`IsPartialCollection`	`bool?`	yes
`DomainCode`	`string`	no
`CalculationTypes`	`List<ExpenseItemCalculationTypeItem>` (collection)	no
`CalculationTaxes`	`List<ExpenseItemCalculationTaxDto>` (collection)	no
`ExpenseRuleMaps`	`List<ExpenseRuleMapDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_EXPNS_7`	400	`EXPENSE_ITEM_NOT_FOUND`

aurax-bff-redirect-get-expense-item-by-id › path Parameters

id

string · uuid · required

aurax-bff-redirect-get-expense-item-by-id › Responses

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

No data returned

aurax-bff-redirect-update-expense-item-ui-bpm

PUT

https://dg-sandbox.dgpays.com/aurax-bff-service

/expense-items/{id}

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

Request and response fields are declared on the routing target update-expense-item-ui-bpm; this entry declares none of its own.

aurax-bff-redirect-update-expense-item-ui-bpm › path Parameters

id

string · uuid · required

aurax-bff-redirect-update-expense-item-ui-bpm › Request Body

accountingEntryDefinitionCode

string · required

code

string · required

description

string · required

endDate

string · date · required

expenseType

integer · int32 · required

isAccrual

boolean · required

isActive

boolean · required

isPartialCollection

boolean · required

name

string · required

startDate

string · date-time · required

object[]

parentExpenseItemId

string · uuid

aurax-bff-redirect-update-expense-item-ui-bpm › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

PUT/expense-items/{id}

curl https://dg-sandbox.dgpays.com/aurax-bff-service/expense-items/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "accountingEntryDefinitionCode": "",
  "calculationTaxes": [
    {
      "_rowStatus": 0,
      "id": "",
      "taxCondition": 0,
      "taxId": ""
    }
  ],
  "calculationTypes": [
    {
      "_rowStatus": 0,
      "calculationType": 0,
      "customerTypes": [
        {
          "_rowStatus": 0,
          "customerType": 0,
          "id": "",
          "isActive": false
        }
      ],
      "expenseItemId": "",
      "formulaDefinitionId": "",
      "id": "",
      "isActive": false,
      "ranges": [
        {
          "_rowStatus": 0,
          "constantExpense": 0,
          "currencyNumber": "",
          "id": "",
          "isActive": false,
          "maxConstantExpense": 0,
          "maxExpenseAmount": 0,
          "maxRate": 0,
          "maxTranAmount": 0,
          "minConstantExpense": 0,
          "minExpenseAmount": 0,
          "minRate": 0,
          "minTranAmount": 0,
          "rate": 0
        }
      ]
    }
  ],
  "code": "",
  "description": "",
  "endDate": "",
  "expenseRuleMaps": [
    {
      "_rowStatus": 0,
      "expenseRuleId": "",
      "id": ""
    }
  ],
  "expenseType": 0,
  "isAccrual": false,
  "isActive": false,
  "isPartialCollection": false,
  "name": "",
  "parentExpenseItemId": "",
  "startDate": ""
}'

Example Request Body

{
  "accountingEntryDefinitionCode": "",
  "calculationTaxes": [
    {
      "_rowStatus": 0,
      "id": "",
      "taxCondition": 0,
      "taxId": ""
    }
  ],
  "calculationTypes": [
    {
      "_rowStatus": 0,
      "calculationType": 0,
      "customerTypes": [
        {
          "_rowStatus": 0,
          "customerType": 0,
          "id": "",
          "isActive": false
        }
      ],
      "expenseItemId": "",
      "formulaDefinitionId": "",
      "id": "",
      "isActive": false,
      "ranges": [
        {
          "_rowStatus": 0,
          "constantExpense": 0,
          "currencyNumber": "",
          "id": "",
          "isActive": false,
          "maxConstantExpense": 0,
          "maxExpenseAmount": 0,
          "maxRate": 0,
          "maxTranAmount": 0,
          "minConstantExpense": 0,
          "minExpenseAmount": 0,
          "minRate": 0,
          "minTranAmount": 0,
          "rate": 0
        }
      ]
    }
  ],
  "code": "",
  "description": "",
  "endDate": "",
  "expenseRuleMaps": [
    {
      "_rowStatus": 0,
      "expenseRuleId": "",
      "id": ""
    }
  ],
  "expenseType": 0,
  "isAccrual": false,
  "isActive": false,
  "isPartialCollection": false,
  "name": "",
  "parentExpenseItemId": "",
  "startDate": ""
}

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

aurax-bff-redirect-delete-expense-item-ui-bpm

DELETE

https://dg-sandbox.dgpays.com/aurax-bff-service

/expense-items/{id}

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

Request and response fields are declared on the routing target delete-expense-item-ui-bpm; this entry declares none of its own.

aurax-bff-redirect-delete-expense-item-ui-bpm › path Parameters

id

string · uuid · required

aurax-bff-redirect-delete-expense-item-ui-bpm › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

expense-collections expense-rules