billing-data
v0.0.3arrow_drop_down
@billing/frontend / Exports
@billing/frontend
Table of contents
Interfaces
- IBillingCycleBillingDataReturn
- IBranchDetails
- ICreateInvoice
- ICreateInvoiceLineItem
- ICreateInvoiceOrder
- ICrmContactDetails
- ICustomerDetails
- IInvoice
- IInvoiceLineItem
- IInvoiceLineItemCreate
- IInvoiceOrder
- IOrderMetadata
- IOuCharge
- IOuChargeField
- IOuChargeFieldValidation
- IOuSettingItem
- IOuSettings
- ISalespersonDetails
- ISendEmail
- ISendEmailResponseItem
- IUseBillingPagintatedInvoicesReturn
Type aliases
- BillingDataContext
- BillingUrlKeyNames
- IInvoiceLineItemUpdate
- IUpdateInvoice
- InputTypeValue
- ValidationTypeValue
Variables
Functions
- useBillingCudInvoice
- useBillingCudLineItem
- useBillingCycleBilling
- useBillingInvoices
- useBillingOuCharges
- useBillingOuSettings
- useBillingPaginatedInvoices
- useBillingPagination
- useBillingSendEmail
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:
Name | Type |
---|---|
CHECKBOX | string |
DATE | string |
DATETIME | string |
MONEY | string |
NUMBER | string |
PERCENTAGE | string |
TEXT | string |
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:
Name | Type |
---|---|
IS_BOOLEAN | string |
IS_DATE_STRING | string |
IS_DEFINED | string |
IS_FLOAT | string |
IS_INT | string |
IS_MONEY | string |
IS_NUMBER | string |
IS_OPTIONAL | string |
IS_PERCENTAGE | string |
IS_STRING | string |
Defined in: models/ou-charge-fields.ts:16
Functions
useBillingCudInvoice
b8 Const
useBillingCudInvoice(paramOptions?
: IUseBillingOptions): ICoreCudItemsDataReturn<IInvoice, BillingUrlKeyNames, ICreateInvoice, Partial<IInvoice>>
Parameters:
Name | Type |
---|---|
paramOptions? | IUseBillingOptions |
Returns: ICoreCudItemsDataReturn<IInvoice, BillingUrlKeyNames, ICreateInvoice, Partial<IInvoice>>
Defined in: hooks/use-billing-cud-invoice.tsx:12
useBillingCudLineItem
b8 Const
useBillingCudLineItem(invoiceUuid
: string, paramOptions?
: IUseBillingOptions): ICoreCudItemsDataReturn<IInvoiceLineItem, BillingUrlKeyNames, IInvoiceLineItemCreate, Partial<IInvoiceLineItemCreate>>
Parameters:
Name | Type |
---|---|
invoiceUuid | string |
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:
Name | Type |
---|---|
paramOptions? | IUseBillingOptions |
Returns: IBillingCycleBillingDataReturn
Defined in: hooks/use-billing-cycle-billing.tsx:31
useBillingInvoices
b8 Const
useBillingInvoices(itemUuid?
: null | string, paramOptions?
: IUseCoreOptions): ICoreGetItemsDataReturn<IInvoice>
Parameters:
Name | Type | |
---|---|---|
itemUuid? | null \ | string |
paramOptions? | IUseCoreOptions |
Returns: ICoreGetItemsDataReturn<IInvoice>
Defined in: hooks/use-billing-invoices.tsx:6
useBillingOuCharges
b8 Const
useBillingOuCharges(ouId
: null | string, itemUuid?
: null | string, paramOptions?
: IUseCoreOptions): ICoreGetItemsDataReturn<IOuCharge>
Parameters:
Name | Type | |
---|---|---|
ouId | null \ | string |
itemUuid? | null \ | string |
paramOptions? | IUseCoreOptions |
Returns: ICoreGetItemsDataReturn<IOuCharge>
Defined in: hooks/use-billing-ou-charges.tsx:6
useBillingOuSettings
b8 Const
useBillingOuSettings(ouId
: null | string, itemUuid?
: null | string, paramOptions?
: IUseCoreOptions): ICoreGetItemsDataReturn<IOuSettings>
Parameters:
Name | Type | |
---|---|---|
ouId | null \ | 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:
Name | Type |
---|---|
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:
Name | Type |
---|---|
Entity | IBaseEntity |
Parameters:
Name | Type |
---|---|
params | IUseBillingPaginationParams |
Returns: IUseBillingPagintatedInvoicesReturn<Entity>
Defined in: hooks/use-billing-pagination.tsx:103
useBillingSendEmail
b8 Const
useBillingSendEmail(paramOptions?
: IUseRentopsOptions): ICoreCudItemsDataReturn<ISendEmailResponseItem, BillingUrlKeyNames, ISendEmail[], ISendEmail[]>
Parameters:
Name | Type |
---|---|
paramOptions? | IUseRentopsOptions |
Returns: ICoreCudItemsDataReturn<ISendEmailResponseItem, BillingUrlKeyNames, ISendEmail[], ISendEmail[]>
Defined in: hooks/use-billing-send-email.tsx:11