View source for B04 - Batch Quantity (Stock Control Report Generator variable)

__NOTOC__
== Syntax ==
 '''B04'''{T/C/O/D, D1-D16, T/O/I}

== Description ==
Calculates the batch quantity at the end of a given date or between 2 given dates depending on the parameters supplied.

== Parameters ==
;T/C/O/D
:A text parameter that can be omitted (it defaults to "T").
:;T
::Total Quantity. The batch quantity with all transactions taken into the calculation. This is usually the same as using the 'C' parameter if your user date is todays date.
:;C
::Current Date. The current quantity of the batch from the date it was entered into the Stock Control to the end of the user date.
:;O
::Original Date. The Opening balance of the Batch. This will be the quantity of the very first batch transaction.
:;D
::Date Range. Used in conjunction with parameter D1-D16. Will calculate the batch quantity from the start date to the end date.
;D1-D16
:A text parameter that can be omitted.
:Restrict to a given date range.
:;D1-D16
::Corresponds to the date range screen.
{{Example|text=
{{DataValue|D1+1D}} where {{DataValue|D1}} is the {{DataPrompt|date range}} and {{DataValue|+1D}} is the {{DataPrompt|date modifier}}.
}}

{{Note|text=
This date range can be modified by using one of the following date modifiers after the date indicator.
}}

=== Date Modifiers ===
==== With offset ====
Eg. {{DataValue|+1D}}, {{DataValue|1Y}}, {{DataValue|-1Y}}

;D
:Days
;M
:Months
;Y
:Years
If you want to add a unit to the date then you should just use the number you want to add and if you want to subtract the units from the date just use a {{DataValue|-}} before the number.

{{Tip|text=
A combination of units can be used. E.g. {{DataValue|-1Y+1M}} would subtract 1 year and then add 1 month. Of course you could just subtract 11 months ({{DataValue|-11M}}).

}}

{{Note|text=
{{DataValue|Month}} will be used as default. E.g. {{DataValue|+2}} will be interpreted as {{DataValue|+2M}} and {{DataValue|-2}} as {{DataValue|-2M}}.

}}

==== Without offset ====
Eg. {{DataValue|+}}, {{DataValue|D}}, {{DataValue|<nowiki>=</nowiki>}}

;=
:User Date
;.
:Machine Date
;-
:Previous Day
;+
:Next Day
;M
:First day of the current month.
;H
:Last day of the current month.
;Y
:First day of the current year.
;R
:Last day of the current year.
;W
:First day of the current week (Mon).
;K
:Last day of the current week (Sun).
A combination of units can be used. E.g. {{DataValue|<nowiki>=--</nowiki>}} would subtract 2 days from the current user date. Another way to write that would be {{DataValue|<nowiki>=-2D</nowiki>}}.

{{Example|text=
;{{DataValue|+1D}}, {{DataValue|+}}
:Add one day from the date supplied.
;{{DataValue|<nowiki>=+1D</nowiki>}}, {{DataValue|<nowiki>=+</nowiki>}}
:Add one day from the user date.
;{{DataValue|<nowiki>=-3MH</nowiki>}}
:The last day in the month three months from the user date.
}}

==== Note ====
If you are using the year or month units you should note if the date supplied was the last day in a month that doesn't exist in the new year calculated the last day in the new month will be used. So don't worry if you add one year to a february date that was set to the last day of that february. The 29th of february in a leap year would be converted to the 28th of february in the new calculated year, unless of course you were adding a multiple of four years to the date, in this case the 29th february would be kept.

;T/O/I
:A text parameter that can be omitted.
:Movement filtering used in conjunction with parameter D1-D16.
:;blank
::No filtering. Includes both internal and external stock movement. See [[B10 - Transaction Internal Movement? (Stock Control Report Generator variable)|B10]].
{{Note|text=
Any date range specified with parameter D1-D16 will be ignored.
}}

:;T
::Only includes external stock movement. Both positive and negative transactions included.
:;O
::Only includes external stock movement with a negative transaction value (Outgoing, eg. sales).
:;I
::Only includes external stock movement with a positive transaction value (Incoming, eg. purchases).

== Returns ==
A numeric value whose typical size is 8 digits plus 3 decimal places.

{{KB_Tags|day, month, year}}
[[Category:Stock Control Report Generator variables]]