In this scope
Docs
Community
Login
equipmentshare/ global/ libs

billing-data

v0.0.3arrow_drop_down
v0.0.3
v0.0.2
v0.0.1
STATUS
None
DOWNLOADS
844
VISIBILITY
Public
PUBLISHED
2 years ago
SIZE
12 KB
### useBillingAssignLineItems
fs
1 contributor
Like
Log in to like
Install billing-data as a package?
Copied
npm i @bit/equipmentshare.global.libs.billing-data
Set Bit as a scoped registryLearn more
npm config set '@bit:registry' https://node.bit.cloud
Component Example
React
React
Vue
Angular
React Native
Add dependency... help_outline
Just 
import
any of the 1 million components
and packages in Bit or NPM to the example.
import Button from '@bit/grommet.grommet.button';
import Lodash from 'lodash';
toggle layout
modifieddraft
chevron_left
chevron_right

@billing/frontend / Exports

@billing/frontend

Table of contents

Interfaces

Type aliases

Variables

Functions

Type aliases

BillingDataContext

F, BillingDataContext: ICoreDataContext<BillingUrlKeyNames>

Defined in: context/billing-data-context.tsx:10

BillingUrlKeyNames

F, BillingUrlKeyNames: invoices | invoiceDetails | ouCharges | ouSettings

Defined in: context/billing-data-context.tsx:4

IInvoiceLineItemUpdate

F, IInvoiceLineItemUpdate: Partial<IInvoiceLineItemCreate>

Defined in: models/invoice.ts:35

IUpdateInvoice

F, IUpdateInvoice: Partial<IInvoice>

Defined in: models/create-invoice.ts:23

InputTypeValue

F, InputTypeValue: typeof InputTypes[keyof typeof InputTypes]

Defined in: models/ou-charge-fields.ts:11

ValidationTypeValue

F, ValidationTypeValue: typeof ValidationTypes[keyof typeof ValidationTypes]

Defined in: models/ou-charge-fields.ts:29

Variables

BillingDataContext

b" BillingDataContext: Context<ICoreDataContext<BillingUrlKeyNames>>

Defined in: context/billing-data-context.tsx:12

InputTypes

b" Const InputTypes: object

Type declaration:

NameType
CHECKBOXstring
DATEstring
DATETIMEstring
MONEYstring
NUMBERstring
PERCENTAGEstring
TEXTstring

Defined in: models/ou-charge-fields.ts:2

ValidationTypes

b" Const ValidationTypes: object

NOTE: Refer to https://github.com/typestack/class-validator#validation-decorators

Type declaration:

NameType
IS_BOOLEANstring
IS_DATE_STRINGstring
IS_DEFINEDstring
IS_FLOATstring
IS_INTstring
IS_MONEYstring
IS_NUMBERstring
IS_OPTIONALstring
IS_PERCENTAGEstring
IS_STRINGstring

Defined in: models/ou-charge-fields.ts:16

Functions

useBillingCudInvoice

b8 ConstuseBillingCudInvoice(paramOptions?: IUseBillingOptions): ICoreCudItemsDataReturn<IInvoice, BillingUrlKeyNames, ICreateInvoice, Partial<IInvoice>>

Parameters:

NameType
paramOptions?IUseBillingOptions

Returns: ICoreCudItemsDataReturn<IInvoice, BillingUrlKeyNames, ICreateInvoice, Partial<IInvoice>>

Defined in: hooks/use-billing-cud-invoice.tsx:12

useBillingCudLineItem

b8 ConstuseBillingCudLineItem(invoiceUuid: string, paramOptions?: IUseBillingOptions): ICoreCudItemsDataReturn<IInvoiceLineItem, BillingUrlKeyNames, IInvoiceLineItemCreate, Partial<IInvoiceLineItemCreate>>

Parameters:

NameType
invoiceUuidstring
paramOptions?IUseBillingOptions

Returns: ICoreCudItemsDataReturn<IInvoiceLineItem, BillingUrlKeyNames, IInvoiceLineItemCreate, Partial<IInvoiceLineItemCreate>>

Defined in: hooks/use-billing-cud-line-item.tsx:11

useBillingCycleBilling

b8 useBillingCycleBilling(paramOptions?: IUseBillingOptions): IBillingCycleBillingDataReturn

useBillingCycleBilling

for creating/updating/deleting invoices

Example

const { createInvoice } = useBillingCycleBilling();

createInvoice(invoice as ICreateInvoicePayload);

Parameters:

NameType
paramOptions?IUseBillingOptions

Returns: IBillingCycleBillingDataReturn

Defined in: hooks/use-billing-cycle-billing.tsx:31

useBillingInvoices

b8 ConstuseBillingInvoices(itemUuid?: null | string, paramOptions?: IUseCoreOptions): ICoreGetItemsDataReturn<IInvoice>

Parameters:

NameType
itemUuid?null \string
paramOptions?IUseCoreOptions

Returns: ICoreGetItemsDataReturn<IInvoice>

Defined in: hooks/use-billing-invoices.tsx:6

useBillingOuCharges

b8 ConstuseBillingOuCharges(ouId: null | string, itemUuid?: null | string, paramOptions?: IUseCoreOptions): ICoreGetItemsDataReturn<IOuCharge>

Parameters:

NameType
ouIdnull \string
itemUuid?null \string
paramOptions?IUseCoreOptions

Returns: ICoreGetItemsDataReturn<IOuCharge>

Defined in: hooks/use-billing-ou-charges.tsx:6

useBillingOuSettings

b8 ConstuseBillingOuSettings(ouId: null | string, itemUuid?: null | string, paramOptions?: IUseCoreOptions): ICoreGetItemsDataReturn<IOuSettings>

Parameters:

NameType
ouIdnull \string
itemUuid?null \string
paramOptions?IUseCoreOptions

Returns: ICoreGetItemsDataReturn<IOuSettings>

Defined in: hooks/use-billing-ou-settings.tsx:6

useBillingPaginatedInvoices

b8 useBillingPaginatedInvoices(params?: IUseBillingPaginatedInvoicesParams): IUseBillingPagintatedInvoicesReturn<IInvoice>

Parameters:

NameType
params?IUseBillingPaginatedInvoicesParams

Returns: IUseBillingPagintatedInvoicesReturn<IInvoice>

Defined in: hooks/use-billing-paginated-invoices.tsx:12

useBillingPagination

b8 useBillingPagination<Entity>(params: IUseBillingPaginationParams): IUseBillingPagintatedInvoicesReturn<Entity>

NOTE: This hook is only compatible with a pagination endpoint that supports both seek and offset.

For example: https://gitlab.internal.equipmentshare.com/global/nodebrick/-/blob/master/packages/nodebrick-api/README.md#seek

Offset pagination:

  • use during initial calls
  • use when jumping to a specific page

Seek pagination:

  • use for clicking previous and next

Type parameters:

NameType
EntityIBaseEntity

Parameters:

NameType
paramsIUseBillingPaginationParams

Returns: IUseBillingPagintatedInvoicesReturn<Entity>

Defined in: hooks/use-billing-pagination.tsx:103

useBillingSendEmail

b8 ConstuseBillingSendEmail(paramOptions?: IUseRentopsOptions): ICoreCudItemsDataReturn<ISendEmailResponseItem, BillingUrlKeyNames, ISendEmail[], ISendEmail[]>

Parameters:

NameType
paramOptions?IUseRentopsOptions

Returns: ICoreCudItemsDataReturn<ISendEmailResponseItem, BillingUrlKeyNames, ISendEmail[], ISendEmail[]>

Defined in: hooks/use-billing-send-email.tsx:11

Help and resources