Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetFinancialPeriodClosingImpediments

Gets a list of reasons (if any) why this period cannot be closed yet.

The current possible reasons are (which is available in the Type property of each item):

CLOCKED_IN_USER

The user is still clocked in and must be clocked out.

Data

The Data property will contain:

{
  "UserID" : 1,
  "ClockedIn" : "2018-08-01 12:00",
  "FirstName" : "John",
  "LastName"  : "Doe"
}

ACTIVE_USER_TASK

The user task hasn't been completed yet and it's either attached to this financial period, or its past its deadline.

Data

The Data property will contain:

{
    "UserTaskID" : 5546,
    "UserTaskTypeID" : 9,
    "UserID" : null,
    "UserFullName" : null,
    "IsActive" : true,
    "IsCompleted" : false,
    "Deadline" : null,
    "CreationTime" : "2018-08-01"
}

OPEN_CASH_JOURNAL

There is still an open cash journal that needs to be closed before the period can be closed.

Data

The Data property will contain:

{
"CashJournalID" : 3,
"DeviceID" : 1,
"OpeningAmount" : 150.15
}

PCI_QUESTION

The PCI compliancy question has not been answered yet, this is required to close the period if the OrganizationUnit has been configured to require it.

Data

No Data.

NEGATIVE_STOCK

There is negative stock that must be corrected (to at least zero) before the period can be closed.

Data

The Data property will contain:

{
  "ProductID" : 7684,
  "ProductBackendID" : "ABC123",
  "QuantityOnHand" : -10,
  "StockLabelID" : 1,
  "StockLabelName" : "Sellable",
  "OrganizationUnitID" : 182
}

This data can then be used to correct the stock through AdjustStock/MoveStock.

Hierarchy

  • GetFinancialPeriodClosingImpediments

Index

Properties

Properties

FinancialPeriodID

FinancialPeriodID: number

Entity type: FinancialPeriod