mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-21 15:20:34 +00:00
chore(webapp): document functions
This commit is contained in:
@@ -18,8 +18,8 @@ export const getDefaultARAgingSummaryQuery = () => {
|
|||||||
asDate: moment().endOf('day').format('YYYY-MM-DD'),
|
asDate: moment().endOf('day').format('YYYY-MM-DD'),
|
||||||
agingDaysBefore: 30,
|
agingDaysBefore: 30,
|
||||||
agingPeriods: 3,
|
agingPeriods: 3,
|
||||||
customersIds: [],
|
|
||||||
filterByOption: 'without-zero-balance',
|
filterByOption: 'without-zero-balance',
|
||||||
|
customersIds: [],
|
||||||
branchesIds: [],
|
branchesIds: [],
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
@@ -56,6 +56,7 @@ const parseARAgingSummaryQuery = (locationQuery) => {
|
|||||||
return {
|
return {
|
||||||
...transformed,
|
...transformed,
|
||||||
branchesIds: castArray(transformed.branchesIds),
|
branchesIds: castArray(transformed.branchesIds),
|
||||||
|
customersIds: castArray(transformed.customersIds),
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|||||||
@@ -7,6 +7,9 @@ import { useAppQueryString } from '@/hooks';
|
|||||||
import { getDefaultARAgingSummaryQuery } from '../ARAgingSummary/common';
|
import { getDefaultARAgingSummaryQuery } from '../ARAgingSummary/common';
|
||||||
import { transformToForm } from '@/utils';
|
import { transformToForm } from '@/utils';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default query of customers balance summary.
|
||||||
|
*/
|
||||||
export const getDefaultCustomersBalanceQuery = () => {
|
export const getDefaultCustomersBalanceQuery = () => {
|
||||||
return {
|
return {
|
||||||
asDate: moment().endOf('day').format('YYYY-MM-DD'),
|
asDate: moment().endOf('day').format('YYYY-MM-DD'),
|
||||||
@@ -27,7 +30,6 @@ export const getCustomersBalanceQuerySchema = () => {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Parses the customer balance summary query.
|
* Parses the customer balance summary query.
|
||||||
* @returns
|
|
||||||
*/
|
*/
|
||||||
const parseCustomersBalanceSummaryQuery = (locationQuery) => {
|
const parseCustomersBalanceSummaryQuery = (locationQuery) => {
|
||||||
const defaultQuery = getDefaultARAgingSummaryQuery();
|
const defaultQuery = getDefaultARAgingSummaryQuery();
|
||||||
@@ -38,15 +40,12 @@ const parseCustomersBalanceSummaryQuery = (locationQuery) => {
|
|||||||
};
|
};
|
||||||
return {
|
return {
|
||||||
...transformed,
|
...transformed,
|
||||||
|
|
||||||
//
|
|
||||||
customersIds: castArray(transformed.customersIds),
|
customersIds: castArray(transformed.customersIds),
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
* Getter/setter query state of customers balance summary.
|
||||||
* @returns
|
|
||||||
*/
|
*/
|
||||||
export const useCustomerBalanceSummaryQuery = () => {
|
export const useCustomerBalanceSummaryQuery = () => {
|
||||||
const [locationQuery, setLocationQuery] = useAppQueryString();
|
const [locationQuery, setLocationQuery] = useAppQueryString();
|
||||||
|
|||||||
@@ -3,8 +3,7 @@ import intl from 'react-intl-universal';
|
|||||||
import moment from 'moment';
|
import moment from 'moment';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
* The validation schema of vendors transactions.
|
||||||
* @returns
|
|
||||||
*/
|
*/
|
||||||
export const getVendorTransactionsQuerySchema = () => {
|
export const getVendorTransactionsQuerySchema = () => {
|
||||||
return Yup.object().shape({
|
return Yup.object().shape({
|
||||||
@@ -17,8 +16,7 @@ export const getVendorTransactionsQuerySchema = () => {
|
|||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
* Retrieves the default query of vendors transactions.
|
||||||
* @returns {}
|
|
||||||
*/
|
*/
|
||||||
export const getVendorsTransactionsDefaultQuery = () => ({
|
export const getVendorsTransactionsDefaultQuery = () => ({
|
||||||
fromDate: moment().toDate(),
|
fromDate: moment().toDate(),
|
||||||
|
|||||||
Reference in New Issue
Block a user