Cash flow

A cash flow that defines income and expenses

creationDatedate-time

The creation time of the cash flow

Example: 2016-09-06T13:37:50+03:00

descriptionstring

The description of the cash flow

Possible values: <= 1024 characters

idint64

The identifier of the cash flow

lastModifiedDatedate-time

The last modified time of the cash flow

Example: 2016-09-06T13:37:50+03:00

namestringrequired

The name of the cash flow

Possible values: >= 3 characters and <= 64 characters

settings object[]

List of cash flow settings

Array [

allocationMethodstringrequired

The allocation method of the cash flow settings

Possible values: [AVERAGE_BALANCE, NUMBER_OF_ACCOUNTS, PERCENTAGE]

assetGlAccountEncodedKeystring

The asset GL account field value of the cash flow settings

cashFlowIdint64

The identifier of the cash flow

creationDatedate-time

The creation time of the cash flow settings

Example: 2016-09-06T13:37:50+03:00

effectiveDatedaterequired

The effective date of the cash flow settings

Example: 1987-04-26

glAccountEncodedKeystring

The GL account field value of the cash flow settings

idint64

The identifier of the cash flow settings

lastModifiedDatedate-time

The last modified time of the cash flow setting

Example: 2016-09-06T13:37:50+03:00

pools object[]

The pools associations of the cash flow settings

Array [

cashFlowSettingsIdint64

The identifier of the cash flow settings

creationDatedate-time

The creation time of the cash flow pool settings

Example: 2016-09-06T13:37:50+03:00

idint64

The identifier of the cash flow pool settings

lastModifiedDatedate-time

The last modified time of the cash flow pool setting

Example: 2016-09-06T13:37:50+03:00

percentagenumberrequired

The percentage of the income or expense category

poolIdint64

The identifier of the pool

]

sourcestring

The source of the cash flow

Possible values: [ISLAMIC_FINANCE, OTHERS]

]

typestringrequired

The type of the cash flow

Possible values: [INCOME_CATEGORY, EXPENSE_CATEGORY]

Cash flow

{
  "creationDate": "2016-09-06T13:37:50+03:00",
  "description": "string",
  "id": 0,
  "lastModifiedDate": "2016-09-06T13:37:50+03:00",
  "name": "string",
  "settings": [
    {
      "allocationMethod": "AVERAGE_BALANCE",
      "assetGlAccountEncodedKey": "string",
      "cashFlowId": 0,
      "creationDate": "2016-09-06T13:37:50+03:00",
      "effectiveDate": "1987-04-26",
      "glAccountEncodedKey": "string",
      "id": 0,
      "lastModifiedDate": "2016-09-06T13:37:50+03:00",
      "pools": [
        {
          "cashFlowSettingsId": 0,
          "creationDate": "2016-09-06T13:37:50+03:00",
          "id": 0,
          "lastModifiedDate": "2016-09-06T13:37:50+03:00",
          "percentage": 0,
          "poolId": 0
        }
      ],
      "source": "ISLAMIC_FINANCE"
    }
  ],
  "type": "INCOME_CATEGORY"
}