Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FinanceAPI

Finance module

Hierarchy

  • default
    • FinanceAPI

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

config

config: ManageConfig

paginate

paginate: (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]) => Promise<unknown[]>

Type declaration

    • (apiMethod: Function, paginateArgs: PaginationOptions, ...methodArgs: Record<string, unknown>[]): Promise<unknown[]>
    • example
       cwm.paginate(cwm.FinanceAPI.getFinanceAgreements, {startPage: 1, pageSize: 500}, {conditions: 'inactiveFlag = false'})

      Parameters

      • apiMethod: Function
      • paginateArgs: PaginationOptions
      • Rest ...methodArgs: Record<string, unknown>[]

      Returns Promise<unknown[]>

request

request: (args: RequestOptions) => Promise<any>

Type declaration

Methods

deleteFinanceAccountingBatchesById

  • deleteFinanceAccountingBatchesById(id: number): Promise<undefined>

deleteFinanceAgreementTypesByParentIdBoardDefaultsById

  • deleteFinanceAgreementTypesByParentIdBoardDefaultsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementTypesByParentIdWorkRoleExclusionsById

  • deleteFinanceAgreementTypesByParentIdWorkRoleExclusionsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementTypesByParentIdWorkTypeExclusionsById

  • deleteFinanceAgreementTypesByParentIdWorkTypeExclusionsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementTypesByParentIdWorkrolesById

  • deleteFinanceAgreementTypesByParentIdWorkrolesById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementTypesByParentIdWorktypesById

  • deleteFinanceAgreementTypesByParentIdWorktypesById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsById

  • deleteFinanceAgreementsById(id: number): Promise<undefined>

deleteFinanceAgreementsByParentIdAdditionsById

  • deleteFinanceAgreementsByParentIdAdditionsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdAdjustmentsById

  • deleteFinanceAgreementsByParentIdAdjustmentsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdBoardDefaultsById

  • deleteFinanceAgreementsByParentIdBoardDefaultsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdConfigurationsById

  • deleteFinanceAgreementsByParentIdConfigurationsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdSitesById

  • deleteFinanceAgreementsByParentIdSitesById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdWorkRoleExclusionsById

  • deleteFinanceAgreementsByParentIdWorkRoleExclusionsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdWorkTypeExclusionsById

  • deleteFinanceAgreementsByParentIdWorkTypeExclusionsById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdWorkrolesById

  • deleteFinanceAgreementsByParentIdWorkrolesById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsByParentIdWorktypesById

  • deleteFinanceAgreementsByParentIdWorktypesById(id: number, parentId: number): Promise<undefined>

deleteFinanceAgreementsTypesById

  • deleteFinanceAgreementsTypesById(id: number): Promise<undefined>

deleteFinanceBillingCyclesById

  • deleteFinanceBillingCyclesById(id: number): Promise<undefined>

deleteFinanceBillingSetupsById

  • deleteFinanceBillingSetupsById(id: number): Promise<undefined>

deleteFinanceBillingSetupsByParentIdRoutingsById

  • deleteFinanceBillingSetupsByParentIdRoutingsById(id: number, parentId: number): Promise<undefined>

deleteFinanceBillingStatusesById

  • deleteFinanceBillingStatusesById(id: number): Promise<undefined>

deleteFinanceBillingTermsById

  • deleteFinanceBillingTermsById(id: number): Promise<undefined>

deleteFinanceCurrenciesById

  • deleteFinanceCurrenciesById(id: number): Promise<undefined>

deleteFinanceDeliveryMethodsById

  • deleteFinanceDeliveryMethodsById(id: number): Promise<undefined>

deleteFinanceGlAccountsById

  • deleteFinanceGlAccountsById(id: number): Promise<undefined>

deleteFinanceGlpathsById

  • deleteFinanceGlpathsById(id: number): Promise<undefined>

deleteFinanceInvoiceEmailTemplatesById

  • deleteFinanceInvoiceEmailTemplatesById(id: number): Promise<undefined>

deleteFinanceInvoiceTemplatesById

  • deleteFinanceInvoiceTemplatesById(id: number): Promise<undefined>

deleteFinanceInvoicesById

  • deleteFinanceInvoicesById(id: number): Promise<undefined>

deleteFinanceInvoicesByParentIdPaymentsById

  • deleteFinanceInvoicesByParentIdPaymentsById(id: number, parentId: number): Promise<undefined>

deleteFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById

  • deleteFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById(id: number, parentId: number, grandparentId: number): Promise<undefined>

deleteFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById

  • deleteFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById(id: number, parentId: number, grandparentId: number): Promise<undefined>

deleteFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById

  • deleteFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById(id: number, parentId: number, grandparentId: number): Promise<undefined>

deleteFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById

  • deleteFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById(id: number, parentId: number, grandparentId: number): Promise<undefined>

deleteFinanceTaxCodesById

  • deleteFinanceTaxCodesById(id: number): Promise<undefined>

deleteFinanceTaxCodesByParentIdExpenseTypeExemptionsById

  • deleteFinanceTaxCodesByParentIdExpenseTypeExemptionsById(id: number, parentId: number): Promise<undefined>

deleteFinanceTaxCodesByParentIdProductTypeExemptionsById

  • deleteFinanceTaxCodesByParentIdProductTypeExemptionsById(id: number, parentId: number): Promise<undefined>

deleteFinanceTaxCodesByParentIdTaxCodeLevelsById

  • deleteFinanceTaxCodesByParentIdTaxCodeLevelsById(id: number, parentId: number): Promise<undefined>

deleteFinanceTaxCodesByParentIdTaxCodeXRefsById

  • deleteFinanceTaxCodesByParentIdTaxCodeXRefsById(id: number, parentId: number): Promise<undefined>

deleteFinanceTaxCodesByParentIdWorkRoleExemptionsById

  • deleteFinanceTaxCodesByParentIdWorkRoleExemptionsById(id: number, parentId: number): Promise<undefined>

getFinanceAccountingBatches

  • getFinanceAccountingBatches(params?: CommonParameters): Promise<{ _info?: {}; batchIdentifier?: string; closedFlag?: null | boolean; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; id?: number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; batchIdentifier?: string; closedFlag?: null | boolean; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; id?: number }[]>

getFinanceAccountingBatchesById

  • getFinanceAccountingBatchesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; batchIdentifier?: string; closedFlag?: null | boolean; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; id?: number }>

  • Parameters

    Returns Promise<{ _info?: {}; batchIdentifier?: string; closedFlag?: null | boolean; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; id?: number }>

getFinanceAccountingBatchesByParentIdEntries

  • getFinanceAccountingBatchesByParentIdEntries(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; accountType?: string; adjustmentDetail?: { _info?: {}; id?: null | number; name?: string }; cost?: number; costOfGoodsSoldAccountNumber?: string; credit?: null | number; debit?: null | number; expense?: { _info?: {}; amount?: number; id?: null | number }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; item?: string; lineItem?: { _info?: {}; id?: null | number; identifier?: string }; name?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesCode?: string; transfer?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; accountType?: string; adjustmentDetail?: { _info?: {}; id?: null | number; name?: string }; cost?: number; costOfGoodsSoldAccountNumber?: string; credit?: null | number; debit?: null | number; expense?: { _info?: {}; amount?: number; id?: null | number }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; item?: string; lineItem?: { _info?: {}; id?: null | number; identifier?: string }; name?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesCode?: string; transfer?: string }[]>

getFinanceAccountingBatchesByParentIdEntriesById

  • getFinanceAccountingBatchesByParentIdEntriesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; accountType?: string; adjustmentDetail?: { _info?: {}; id?: null | number; name?: string }; cost?: number; costOfGoodsSoldAccountNumber?: string; credit?: null | number; debit?: null | number; expense?: { _info?: {}; amount?: number; id?: null | number }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; item?: string; lineItem?: { _info?: {}; id?: null | number; identifier?: string }; name?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesCode?: string; transfer?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; accountType?: string; adjustmentDetail?: { _info?: {}; id?: null | number; name?: string }; cost?: number; costOfGoodsSoldAccountNumber?: string; credit?: null | number; debit?: null | number; expense?: { _info?: {}; amount?: number; id?: null | number }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; item?: string; lineItem?: { _info?: {}; id?: null | number; identifier?: string }; name?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesCode?: string; transfer?: string }>

getFinanceAccountingBatchesByParentIdEntriesCount

  • getFinanceAccountingBatchesByParentIdEntriesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingBatchesCount

  • getFinanceAccountingBatchesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingPackageSetup

  • getFinanceAccountingPackageSetup(params?: CommonParameters): Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }[]>

getFinanceAccountingPackageSetupById

  • getFinanceAccountingPackageSetupById(id: number, params?: CommonParameters): Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }>

getFinanceAccountingPackageSetupCount

  • getFinanceAccountingPackageSetupCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingPackages

  • getFinanceAccountingPackages(params?: CommonParameters): Promise<{ id?: number; identifier?: string; name?: string }[]>

getFinanceAccountingPackagesById

  • getFinanceAccountingPackagesById(id: number, params?: CommonParameters): Promise<{ id?: number; identifier?: string; name?: string }>

getFinanceAccountingPackagesCount

  • getFinanceAccountingPackagesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingUnpostedexpenses

  • getFinanceAccountingUnpostedexpenses(params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmountCovered?: null | number; avalaraTaxFlag?: null | boolean; billableAmount?: null | number; chargeCode?: { _info?: {}; id?: null | number; name?: string }; chargeDescription?: string; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; classification?: null | "NonReimbursable" | "Reimbursable" | "Personal"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; creditAccount?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; dateExpense?: string; departmentId?: null | number; expenseDetailId?: null | number; expenseType?: { _info?: {}; id?: null | number; name?: string }; glType?: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inPolicy?: null | boolean; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; nonBillableAmount?: null | number; paymentMethod?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; projectPhase?: { _info?: {}; id?: null | number; name?: string }; salesTaxAmount?: null | number; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; total?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmountCovered?: null | number; avalaraTaxFlag?: null | boolean; billableAmount?: null | number; chargeCode?: { _info?: {}; id?: null | number; name?: string }; chargeDescription?: string; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; classification?: null | "NonReimbursable" | "Reimbursable" | "Personal"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; creditAccount?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; dateExpense?: string; departmentId?: null | number; expenseDetailId?: null | number; expenseType?: { _info?: {}; id?: null | number; name?: string }; glType?: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inPolicy?: null | boolean; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; nonBillableAmount?: null | number; paymentMethod?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; projectPhase?: { _info?: {}; id?: null | number; name?: string }; salesTaxAmount?: null | number; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; total?: null | number }[]>

getFinanceAccountingUnpostedexpensesById

  • getFinanceAccountingUnpostedexpensesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmountCovered?: null | number; avalaraTaxFlag?: null | boolean; billableAmount?: null | number; chargeCode?: { _info?: {}; id?: null | number; name?: string }; chargeDescription?: string; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; classification?: null | "NonReimbursable" | "Reimbursable" | "Personal"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; creditAccount?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; dateExpense?: string; departmentId?: null | number; expenseDetailId?: null | number; expenseType?: { _info?: {}; id?: null | number; name?: string }; glType?: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inPolicy?: null | boolean; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; nonBillableAmount?: null | number; paymentMethod?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; projectPhase?: { _info?: {}; id?: null | number; name?: string }; salesTaxAmount?: null | number; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; total?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmountCovered?: null | number; avalaraTaxFlag?: null | boolean; billableAmount?: null | number; chargeCode?: { _info?: {}; id?: null | number; name?: string }; chargeDescription?: string; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; classification?: null | "NonReimbursable" | "Reimbursable" | "Personal"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; creditAccount?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; dateExpense?: string; departmentId?: null | number; expenseDetailId?: null | number; expenseType?: { _info?: {}; id?: null | number; name?: string }; glType?: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inPolicy?: null | boolean; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; nonBillableAmount?: null | number; paymentMethod?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; projectPhase?: { _info?: {}; id?: null | number; name?: string }; salesTaxAmount?: null | number; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; ticket?: { _info?: {}; id?: null | number; summary?: string }; total?: null | number }>

getFinanceAccountingUnpostedexpensesByParentIdTaxableLevels

  • getFinanceAccountingUnpostedexpensesByParentIdTaxableLevels(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number }[]>

getFinanceAccountingUnpostedexpensesByParentIdTaxableLevelsById

  • getFinanceAccountingUnpostedexpensesByParentIdTaxableLevelsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number }>

getFinanceAccountingUnpostedexpensesByParentIdTaxableLevelsCount

  • getFinanceAccountingUnpostedexpensesByParentIdTaxableLevelsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingUnpostedexpensesCount

  • getFinanceAccountingUnpostedexpensesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingUnpostedinvoices

  • getFinanceAccountingUnpostedinvoices(params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; avalaraTaxFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingLogId?: null | number; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; createdBy?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; departmentId?: null | number; description?: string; dueDate?: string; dueDays?: string; id?: number; invoiceDate?: string; invoiceNumber?: string; invoiceTaxableFlag?: null | boolean; invoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; salesTaxAmount?: null | number; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; subTotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; total?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; avalaraTaxFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingLogId?: null | number; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; createdBy?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; departmentId?: null | number; description?: string; dueDate?: string; dueDays?: string; id?: number; invoiceDate?: string; invoiceNumber?: string; invoiceTaxableFlag?: null | boolean; invoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; salesTaxAmount?: null | number; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; subTotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; total?: null | number }[]>

getFinanceAccountingUnpostedinvoicesById

  • getFinanceAccountingUnpostedinvoicesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; avalaraTaxFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingLogId?: null | number; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; createdBy?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; departmentId?: null | number; description?: string; dueDate?: string; dueDays?: string; id?: number; invoiceDate?: string; invoiceNumber?: string; invoiceTaxableFlag?: null | boolean; invoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; salesTaxAmount?: null | number; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; subTotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; total?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; avalaraTaxFlag?: null | boolean; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billingLogId?: null | number; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; createdBy?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dateClosed?: string; departmentId?: null | number; description?: string; dueDate?: string; dueDays?: string; id?: number; invoiceDate?: string; invoiceNumber?: string; invoiceTaxableFlag?: null | boolean; invoiceType?: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; salesTaxAmount?: null | number; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; subTotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; total?: null | number }>

getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevels

  • getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevels(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number }[]>

getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevelsById

  • getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevelsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number }>

getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevelsCount

  • getFinanceAccountingUnpostedinvoicesByParentIdTaxableLevelsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingUnpostedinvoicesCount

  • getFinanceAccountingUnpostedinvoicesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingUnpostedprocurement

  • getFinanceAccountingUnpostedprocurement(params?: CommonParameters): Promise<{ _info?: {}; avalaraTaxFlag?: null | boolean; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateClosed?: string; departmentId?: null | number; description?: string; freightCost?: null | number; freightTaxTotal?: null | number; id?: number; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; procurementType?: null | "Adjustment" | "Purchase" | "Transfer"; purchaseDate?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; purchaseOrderTaxableFlag?: null | boolean; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxFreightFlag?: null | boolean; taxTotal?: null | number; total?: null | number; trackingNumber?: string; unpostedProductId?: string; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; avalaraTaxFlag?: null | boolean; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateClosed?: string; departmentId?: null | number; description?: string; freightCost?: null | number; freightTaxTotal?: null | number; id?: number; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; procurementType?: null | "Adjustment" | "Purchase" | "Transfer"; purchaseDate?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; purchaseOrderTaxableFlag?: null | boolean; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxFreightFlag?: null | boolean; taxTotal?: null | number; total?: null | number; trackingNumber?: string; unpostedProductId?: string; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string }[]>

getFinanceAccountingUnpostedprocurementById

  • getFinanceAccountingUnpostedprocurementById(id: number, params?: CommonParameters): Promise<{ _info?: {}; avalaraTaxFlag?: null | boolean; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateClosed?: string; departmentId?: null | number; description?: string; freightCost?: null | number; freightTaxTotal?: null | number; id?: number; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; procurementType?: null | "Adjustment" | "Purchase" | "Transfer"; purchaseDate?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; purchaseOrderTaxableFlag?: null | boolean; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxFreightFlag?: null | boolean; taxTotal?: null | number; total?: null | number; trackingNumber?: string; unpostedProductId?: string; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; avalaraTaxFlag?: null | boolean; billingTerms?: { _info?: {}; id?: null | number; name?: string }; cityTaxAmount?: null | number; cityTaxFlag?: null | boolean; cityTaxXref?: string; compositeTaxAmount?: null | number; compositeTaxFlag?: null | boolean; compositeTaxXref?: string; countryTaxAmount?: null | number; countryTaxFlag?: null | boolean; countryTaxXref?: string; countyTaxAmount?: null | number; countyTaxFlag?: null | boolean; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customer?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; dateClosed?: string; departmentId?: null | number; description?: string; freightCost?: null | number; freightTaxTotal?: null | number; id?: number; itemTaxableFlag?: null | boolean; levelSixTaxAmount?: null | number; levelSixTaxFlag?: null | boolean; levelSixTaxXref?: string; locationId?: null | number; procurementType?: null | "Adjustment" | "Purchase" | "Transfer"; purchaseDate?: string; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; purchaseOrderTaxableFlag?: null | boolean; stateTaxAmount?: null | number; stateTaxFlag?: null | boolean; stateTaxXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxFreightFlag?: null | boolean; taxTotal?: null | number; total?: null | number; trackingNumber?: string; unpostedProductId?: string; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string }>

getFinanceAccountingUnpostedprocurementByParentIdTaxableLevels

  • getFinanceAccountingUnpostedprocurementByParentIdTaxableLevels(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number }[]>

getFinanceAccountingUnpostedprocurementByParentIdTaxableLevelsById

  • getFinanceAccountingUnpostedprocurementByParentIdTaxableLevelsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number }>

getFinanceAccountingUnpostedprocurementByParentIdTaxableLevelsCount

  • getFinanceAccountingUnpostedprocurementByParentIdTaxableLevelsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAccountingUnpostedprocurementCount

  • getFinanceAccountingUnpostedprocurementCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementTypesByParentIdBoardDefaults

  • getFinanceAgreementTypesByParentIdBoardDefaults(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementTypesByParentIdBoardDefaultsById

  • getFinanceAgreementTypesByParentIdBoardDefaultsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementTypesByParentIdBoardDefaultsCount

  • getFinanceAgreementTypesByParentIdBoardDefaultsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementTypesByParentIdWorkRoleExclusions

  • getFinanceAgreementTypesByParentIdWorkRoleExclusions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementTypesByParentIdWorkRoleExclusionsById

  • getFinanceAgreementTypesByParentIdWorkRoleExclusionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementTypesByParentIdWorkRoleExclusionsCount

  • getFinanceAgreementTypesByParentIdWorkRoleExclusionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementTypesByParentIdWorkTypeExclusions

  • getFinanceAgreementTypesByParentIdWorkTypeExclusions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementTypesByParentIdWorkTypeExclusionsById

  • getFinanceAgreementTypesByParentIdWorkTypeExclusionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementTypesByParentIdWorkTypeExclusionsCount

  • getFinanceAgreementTypesByParentIdWorkTypeExclusionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementTypesByParentIdWorkroles

  • getFinanceAgreementTypesByParentIdWorkroles(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementTypesByParentIdWorkrolesById

  • getFinanceAgreementTypesByParentIdWorkrolesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementTypesByParentIdWorkrolesCount

  • getFinanceAgreementTypesByParentIdWorkrolesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementTypesByParentIdWorkrolesInfo

  • getFinanceAgreementTypesByParentIdWorkrolesInfo(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementTypesByParentIdWorkrolesInfoById

  • getFinanceAgreementTypesByParentIdWorkrolesInfoById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementTypesByParentIdWorkrolesInfoCount

  • getFinanceAgreementTypesByParentIdWorkrolesInfoCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementTypesByParentIdWorktypes

  • getFinanceAgreementTypesByParentIdWorktypes(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementTypesByParentIdWorktypesById

  • getFinanceAgreementTypesByParentIdWorktypesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementTypesByParentIdWorktypesCount

  • getFinanceAgreementTypesByParentIdWorktypesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreements

  • getFinanceAgreements(params?: CommonParameters): Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsById

  • getFinanceAgreementsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementsByParentIdAdditions

  • getFinanceAgreementsByParentIdAdditions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }[]>

getFinanceAgreementsByParentIdAdditionsById

  • getFinanceAgreementsByParentIdAdditionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

getFinanceAgreementsByParentIdAdditionsCount

  • getFinanceAgreementsByParentIdAdditionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdAdjustments

  • getFinanceAgreementsByParentIdAdjustments(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }[]>

getFinanceAgreementsByParentIdAdjustmentsById

  • getFinanceAgreementsByParentIdAdjustmentsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

getFinanceAgreementsByParentIdAdjustmentsCount

  • getFinanceAgreementsByParentIdAdjustmentsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdBoardDefaults

  • getFinanceAgreementsByParentIdBoardDefaults(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsByParentIdBoardDefaultsById

  • getFinanceAgreementsByParentIdBoardDefaultsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementsByParentIdBoardDefaultsCount

  • getFinanceAgreementsByParentIdBoardDefaultsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdConfigurations

  • getFinanceAgreementsByParentIdConfigurations(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; deviceIdentifier?: string; id?: null | number }[]>

getFinanceAgreementsByParentIdConfigurationsById

  • getFinanceAgreementsByParentIdConfigurationsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; deviceIdentifier?: string; id?: null | number }>

getFinanceAgreementsByParentIdConfigurationsCount

  • getFinanceAgreementsByParentIdConfigurationsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdSites

  • getFinanceAgreementsByParentIdSites(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsByParentIdSitesById

  • getFinanceAgreementsByParentIdSitesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementsByParentIdSitesCount

  • getFinanceAgreementsByParentIdSitesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdWorkRoleExclusions

  • getFinanceAgreementsByParentIdWorkRoleExclusions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; id?: number; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; id?: number; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsByParentIdWorkRoleExclusionsCount

  • getFinanceAgreementsByParentIdWorkRoleExclusionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdWorkTypeExclusions

  • getFinanceAgreementsByParentIdWorkTypeExclusions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; id?: number; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; id?: number; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsByParentIdWorkTypeExclusionsCount

  • getFinanceAgreementsByParentIdWorkTypeExclusionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdWorkroles

  • getFinanceAgreementsByParentIdWorkroles(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsByParentIdWorkrolesById

  • getFinanceAgreementsByParentIdWorkrolesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementsByParentIdWorkrolesCount

  • getFinanceAgreementsByParentIdWorkrolesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsByParentIdWorktypes

  • getFinanceAgreementsByParentIdWorktypes(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsByParentIdWorktypesById

  • getFinanceAgreementsByParentIdWorktypesById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementsByParentIdWorktypesCount

  • getFinanceAgreementsByParentIdWorktypesCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsCount

  • getFinanceAgreementsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsTypes

  • getFinanceAgreementsTypes(params?: CommonParameters): Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceAgreementsTypesById

  • getFinanceAgreementsTypesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceAgreementsTypesByIdInfo

  • getFinanceAgreementsTypesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; id?: number; inactiveFlag?: null | boolean; name?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; id?: number; inactiveFlag?: null | boolean; name?: string }>

getFinanceAgreementsTypesByIdUsages

  • getFinanceAgreementsTypesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceAgreementsTypesByIdUsagesList

  • getFinanceAgreementsTypesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceAgreementsTypesCount

  • getFinanceAgreementsTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceAgreementsTypesInfo

  • getFinanceAgreementsTypesInfo(params?: CommonParameters): Promise<{ _info?: {}; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; id?: number; inactiveFlag?: null | boolean; name?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; id?: number; inactiveFlag?: null | boolean; name?: string }[]>

getFinanceAgreementsTypesInfoCount

  • getFinanceAgreementsTypesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBatchSetups

  • getFinanceBatchSetups(params?: CommonParameters): Promise<{ _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }[]>

getFinanceBatchSetupsById

  • getFinanceBatchSetupsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }>

getFinanceBatchSetupsCount

  • getFinanceBatchSetupsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingCycles

  • getFinanceBillingCycles(params?: CommonParameters): Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }[]>

getFinanceBillingCyclesById

  • getFinanceBillingCyclesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

  • Parameters

    Returns Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

getFinanceBillingCyclesByIdInfo

  • getFinanceBillingCyclesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: boolean; id?: number; name?: string }>

getFinanceBillingCyclesByIdUsages

  • getFinanceBillingCyclesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceBillingCyclesByIdUsagesList

  • getFinanceBillingCyclesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceBillingCyclesCount

  • getFinanceBillingCyclesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingCyclesInfo

  • getFinanceBillingCyclesInfo(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: boolean; id?: number; name?: string }[]>

getFinanceBillingCyclesInfoCount

  • getFinanceBillingCyclesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingSetups

  • getFinanceBillingSetups(params?: CommonParameters): Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }[]>

getFinanceBillingSetupsById

  • getFinanceBillingSetupsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

getFinanceBillingSetupsByIdInfo

  • getFinanceBillingSetupsByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; remitName?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; remitName?: string }>

getFinanceBillingSetupsByParentIdRoutings

  • getFinanceBillingSetupsByParentIdRoutings(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }[]>

getFinanceBillingSetupsByParentIdRoutingsById

  • getFinanceBillingSetupsByParentIdRoutingsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

getFinanceBillingSetupsByParentIdRoutingsCount

  • getFinanceBillingSetupsByParentIdRoutingsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingSetupsCount

  • getFinanceBillingSetupsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingSetupsInfo

  • getFinanceBillingSetupsInfo(params?: CommonParameters): Promise<{ _info?: {}; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; remitName?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; id?: number; location?: { _info?: {}; id?: null | number; name?: string }; remitName?: string }[]>

getFinanceBillingStatuses

  • getFinanceBillingStatuses(params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }[]>

getFinanceBillingStatusesById

  • getFinanceBillingStatusesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

getFinanceBillingStatusesByIdInfo

  • getFinanceBillingStatusesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name?: string; sortOrder?: null | number }>

getFinanceBillingStatusesByIdUsages

  • getFinanceBillingStatusesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceBillingStatusesByIdUsagesList

  • getFinanceBillingStatusesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceBillingStatusesCount

  • getFinanceBillingStatusesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingStatusesInfo

  • getFinanceBillingStatusesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; inactiveFlag?: null | boolean; name?: string; sortOrder?: null | number }[]>

getFinanceBillingStatusesInfoCount

  • getFinanceBillingStatusesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingTerms

  • getFinanceBillingTerms(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }[]>

getFinanceBillingTermsById

  • getFinanceBillingTermsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }>

getFinanceBillingTermsByIdInfo

  • getFinanceBillingTermsByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getFinanceBillingTermsByIdUsages

  • getFinanceBillingTermsByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceBillingTermsByIdUsagesList

  • getFinanceBillingTermsByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceBillingTermsCount

  • getFinanceBillingTermsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceBillingTermsInfo

  • getFinanceBillingTermsInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getFinanceBillingTermsInfoCount

  • getFinanceBillingTermsInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceCompanyFinance

  • getFinanceCompanyFinance(params?: CommonParameters): Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }[]>

getFinanceCompanyFinanceById

  • getFinanceCompanyFinanceById(id: number, params?: CommonParameters): Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

  • Parameters

    Returns Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

getFinanceCompanyFinanceCount

  • getFinanceCompanyFinanceCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceCurrencies

  • getFinanceCurrencies(params?: CommonParameters): Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }[]>

getFinanceCurrenciesById

  • getFinanceCurrenciesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

getFinanceCurrenciesByIdInfo

  • getFinanceCurrenciesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getFinanceCurrenciesByIdUsages

  • getFinanceCurrenciesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceCurrenciesByIdUsagesList

  • getFinanceCurrenciesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceCurrenciesCount

  • getFinanceCurrenciesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceCurrenciesInfo

  • getFinanceCurrenciesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getFinanceCurrenciesInfoCount

  • getFinanceCurrenciesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceDeliveryMethods

  • getFinanceDeliveryMethods(params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }[]>

getFinanceDeliveryMethodsById

  • getFinanceDeliveryMethodsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

getFinanceDeliveryMethodsCount

  • getFinanceDeliveryMethodsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceGlAccounts

  • getFinanceGlAccounts(params?: CommonParameters): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }[]>

getFinanceGlAccountsById

  • getFinanceGlAccountsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

getFinanceGlAccountsCount

  • getFinanceGlAccountsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceGlAccountsMappedTypes

  • getFinanceGlAccountsMappedTypes(params?: CommonParameters): Promise<{ glType?: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; name?: string; recIdField?: string; sortOrder?: number; table?: string }[]>

  • Parameters

    Returns Promise<{ glType?: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; name?: string; recIdField?: string; sortOrder?: number; table?: string }[]>

getFinanceGlAccountsMappedTypesCount

  • getFinanceGlAccountsMappedTypesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceGlCaptions

  • getFinanceGlCaptions(params?: CommonParameters): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }[]>

  • Parameters

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }[]>

getFinanceGlCaptionsById

  • getFinanceGlCaptionsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }>

  • Parameters

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }>

getFinanceGlCaptionsCount

  • getFinanceGlCaptionsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceGlpaths

  • getFinanceGlpaths(params?: CommonParameters): Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }[]>

getFinanceGlpathsById

  • getFinanceGlpathsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

getFinanceGlpathsCount

getFinanceInfoCurrencyCodes

  • getFinanceInfoCurrencyCodes(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getFinanceInfoCurrencyCodesById

  • getFinanceInfoCurrencyCodesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getFinanceInfoCurrencyCodesCount

  • getFinanceInfoCurrencyCodesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceInfoInvoiceById

  • getFinanceInfoInvoiceById(id: number, params?: CommonParameters): Promise<{ _info?: {}; agreementBillingInfo?: { agreementAmount?: number; agreementName?: string; agreementRecId?: number; agreementType?: string; parentRecId?: number }[]; billingSetup?: { _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }; bundledComponentsInfo?: { _info?: {}; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cost?: null | number; hideDescriptionFlag?: null | boolean; hideExtendedPriceFlag?: null | boolean; hideItemIdentifierFlag?: null | boolean; hidePriceFlag?: null | boolean; hideQuantityFlag?: null | boolean; id?: number; parentProductItem?: { _info?: {}; id?: null | number; name?: string }; price?: null | number; productItem?: { _info?: {}; id?: null | number; name?: string }; quantity: null | number; sequenceNumber?: null | number; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; expenses?: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; amount: null | number; billAmount?: null | number; billableOption?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; businessUnitId?: null | number; chargeToId?: null | number; chargeToType?: null | "ServiceTicket" | "ProjectTicket" | "ChargeCode" | "Activity"; classification?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; date: string; expenseReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; invoiceAmount?: null | number; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; mobileGuid?: null | string; notes?: string; odometerEnd?: null | number; odometerStart?: null | number; paymentMethod?: { _info?: {}; id?: null | number; name?: string }; phase?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; status?: null | "Open" | "Rejected" | "PendingApproval" | "ErrorsCorrected" | "PendingProjectApproval" | "ApprovedByTierOne" | "RejectBySecondTier" | "ApprovedByTierTwo" | "ReadyToBill" | "Billed" | "WrittenOff" | "BilledAgreement"; taxes?: { amount?: null | number; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]; id?: number; invoice?: { _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }; invoiceTemplate?: { _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }; logo?: { _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }; products?: { _info?: {}; addComponentsFlag?: null | boolean; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; billableOption: null | "Billable" | "DoNotBill" | "NoCharge"; businessUnitId?: null | number; bypassForecastUpdate?: null | boolean; calculatedCost?: null | number; calculatedCostFlag?: null | boolean; calculatedPrice?: null | number; calculatedPriceFlag?: null | boolean; cancelledBy?: null | number; cancelledDate?: string; cancelledFlag?: null | boolean; cancelledReason?: string; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cost?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerDescription?: string; description?: string; discount?: null | number; dropshipFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; forecastDetailId?: null | number; forecastStatus?: { _info?: {}; id?: null | number; name?: string }; id?: number; ignorePricingSchedulesFlag?: null | boolean; integrationXRef?: string; internalNotes?: string; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; listPrice?: null | number; locationId?: null | number; minimumStockFlag?: null | boolean; needToOrderQuantity?: null | number; needToPurchaseFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phase?: { _info?: {}; id?: null | number; name?: string }; phaseProductFlag?: null | boolean; poApprovedFlag?: null | boolean; price?: null | number; priceMethod?: null | "FlatRateForRange" | "PercentMarkupFromCost" | "PercentMarkdownFromPrice" | "PricePerUnit"; productClass?: null | "Agreement" | "Bundle" | "Inventory" | "NonInventory" | "Service"; productSuppliedFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseDate?: string; quantity?: null | number; quantityCancelled?: null | number; recurring?: { billCycleId?: null | number; cycleType?: null | "ContractYear" | "CalendarYear"; cycles?: null | number; endDate?: string; recurringCost?: null | number; recurringRevenue?: null | number; startDate?: string }; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; sequenceNumber?: null | number; serialNumberIds?: number[]; shipSet?: string; sla?: { _info?: {}; id?: null | number; name?: string }; specialOrderFlag?: null | boolean; subContractorAmountLimit?: null | number; subContractorShipToId?: null | number; taxableFlag?: null | boolean; ticket?: { _info?: {}; id?: null | number; summary?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorSku?: string; warehouse?: string; warehouseBin?: string; warehouseBinId?: null | number; warehouseId?: null | number }[]; timeEntries?: { _info?: {}; actualHours?: null | number; addToDetailDescriptionFlag?: null | boolean; addToInternalAnalysisFlag?: null | boolean; addToResolutionFlag?: null | boolean; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; agreementHours?: null | number; billableOption?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; businessUnitId?: null | number; chargeToId?: null | number; chargeToType?: null | "ServiceTicket" | "ProjectTicket" | "ChargeCode" | "Activity"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEntered?: string; emailCc?: string; emailCcFlag?: null | boolean; emailContactFlag?: null | boolean; emailResourceFlag?: null | boolean; enteredBy?: string; hourlyRate?: null | number; hoursBilled?: null | number; hoursDeduct?: null | number; id?: number; internalNotes?: string; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; invoiceHours?: null | number; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; mobileGuid?: null | string; notes?: string; overageRate?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; status?: null | "Open" | "Rejected" | "PendingApproval" | "ErrorsCorrected" | "PendingProjectApproval" | "ApprovedByTierOne" | "RejectBySecondTier" | "ApprovedByTierTwo" | "ReadyToBill" | "Billed" | "WrittenOff" | "BilledAgreement"; ticket?: { _info?: {}; id?: null | number; summary?: string }; timeEnd?: string; timeSheet?: { _info?: {}; id?: null | number; name?: string }; timeStart: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[] }>

  • Parameters

    Returns Promise<{ _info?: {}; agreementBillingInfo?: { agreementAmount?: number; agreementName?: string; agreementRecId?: number; agreementType?: string; parentRecId?: number }[]; billingSetup?: { _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }; bundledComponentsInfo?: { _info?: {}; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cost?: null | number; hideDescriptionFlag?: null | boolean; hideExtendedPriceFlag?: null | boolean; hideItemIdentifierFlag?: null | boolean; hidePriceFlag?: null | boolean; hideQuantityFlag?: null | boolean; id?: number; parentProductItem?: { _info?: {}; id?: null | number; name?: string }; price?: null | number; productItem?: { _info?: {}; id?: null | number; name?: string }; quantity: null | number; sequenceNumber?: null | number; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string } }[]; expenses?: { _info?: {}; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; amount: null | number; billAmount?: null | number; billableOption?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; businessUnitId?: null | number; chargeToId?: null | number; chargeToType?: null | "ServiceTicket" | "ProjectTicket" | "ChargeCode" | "Activity"; classification?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; date: string; expenseReport?: { _info?: {}; id?: null | number; name?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; invoiceAmount?: null | number; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; mobileGuid?: null | string; notes?: string; odometerEnd?: null | number; odometerStart?: null | number; paymentMethod?: { _info?: {}; id?: null | number; name?: string }; phase?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; status?: null | "Open" | "Rejected" | "PendingApproval" | "ErrorsCorrected" | "PendingProjectApproval" | "ApprovedByTierOne" | "RejectBySecondTier" | "ApprovedByTierTwo" | "ReadyToBill" | "Billed" | "WrittenOff" | "BilledAgreement"; taxes?: { amount?: null | number; id?: number; type?: { _info?: {}; id?: null | number; name?: string } }[]; ticket?: { _info?: {}; id?: null | number; summary?: string }; type?: { _info?: {}; id?: null | number; name?: string } }[]; id?: number; invoice?: { _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }; invoiceTemplate?: { _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }; logo?: { _info?: {}; fileName?: string; guid?: string; htmlTemplateFlag?: null | boolean; id?: number; imageFlag?: null | boolean; linkFlag?: null | boolean; owner?: string; publicFlag?: null | boolean; readOnlyFlag?: null | boolean; serverFileName?: string; size?: null | number; title?: string; urlFlag?: null | boolean }; products?: { _info?: {}; addComponentsFlag?: null | boolean; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; billableOption: null | "Billable" | "DoNotBill" | "NoCharge"; businessUnitId?: null | number; bypassForecastUpdate?: null | boolean; calculatedCost?: null | number; calculatedCostFlag?: null | boolean; calculatedPrice?: null | number; calculatedPriceFlag?: null | boolean; cancelledBy?: null | number; cancelledDate?: string; cancelledFlag?: null | boolean; cancelledReason?: string; catalogItem?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; cost?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerDescription?: string; description?: string; discount?: null | number; dropshipFlag?: null | boolean; entityType?: { _info?: {}; id?: null | number; name?: string }; forecastDetailId?: null | number; forecastStatus?: { _info?: {}; id?: null | number; name?: string }; id?: number; ignorePricingSchedulesFlag?: null | boolean; integrationXRef?: string; internalNotes?: string; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; listPrice?: null | number; locationId?: null | number; minimumStockFlag?: null | boolean; needToOrderQuantity?: null | number; needToPurchaseFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; phase?: { _info?: {}; id?: null | number; name?: string }; phaseProductFlag?: null | boolean; poApprovedFlag?: null | boolean; price?: null | number; priceMethod?: null | "FlatRateForRange" | "PercentMarkupFromCost" | "PercentMarkdownFromPrice" | "PricePerUnit"; productClass?: null | "Agreement" | "Bundle" | "Inventory" | "NonInventory" | "Service"; productSuppliedFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseDate?: string; quantity?: null | number; quantityCancelled?: null | number; recurring?: { billCycleId?: null | number; cycleType?: null | "ContractYear" | "CalendarYear"; cycles?: null | number; endDate?: string; recurringCost?: null | number; recurringRevenue?: null | number; startDate?: string }; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; sequenceNumber?: null | number; serialNumberIds?: number[]; shipSet?: string; sla?: { _info?: {}; id?: null | number; name?: string }; specialOrderFlag?: null | boolean; subContractorAmountLimit?: null | number; subContractorShipToId?: null | number; taxableFlag?: null | boolean; ticket?: { _info?: {}; id?: null | number; summary?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorSku?: string; warehouse?: string; warehouseBin?: string; warehouseBinId?: null | number; warehouseId?: null | number }[]; timeEntries?: { _info?: {}; actualHours?: null | number; addToDetailDescriptionFlag?: null | boolean; addToInternalAnalysisFlag?: null | boolean; addToResolutionFlag?: null | boolean; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; agreementHours?: null | number; billableOption?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; businessUnitId?: null | number; chargeToId?: null | number; chargeToType?: null | "ServiceTicket" | "ProjectTicket" | "ChargeCode" | "Activity"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; dateEntered?: string; emailCc?: string; emailCcFlag?: null | boolean; emailContactFlag?: null | boolean; emailResourceFlag?: null | boolean; enteredBy?: string; hourlyRate?: null | number; hoursBilled?: null | number; hoursDeduct?: null | number; id?: number; internalNotes?: string; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; invoiceHours?: null | number; locationId?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; mobileGuid?: null | string; notes?: string; overageRate?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; project?: { _info?: {}; id?: null | number; name?: string }; status?: null | "Open" | "Rejected" | "PendingApproval" | "ErrorsCorrected" | "PendingProjectApproval" | "ApprovedByTierOne" | "RejectBySecondTier" | "ApprovedByTierTwo" | "ReadyToBill" | "Billed" | "WrittenOff" | "BilledAgreement"; ticket?: { _info?: {}; id?: null | number; summary?: string }; timeEnd?: string; timeSheet?: { _info?: {}; id?: null | number; name?: string }; timeStart: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }[] }>

getFinanceInfoTaxIntegrations

  • getFinanceInfoTaxIntegrations(params?: CommonParameters): Promise<{ _info?: {}; enabledFlag?: boolean; id?: number; taxIntegrationType?: "Avalara" }[]>

getFinanceInfoTaxIntegrationsById

  • getFinanceInfoTaxIntegrationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; enabledFlag?: boolean; id?: number; taxIntegrationType?: "Avalara" }>

getFinanceInfoTaxIntegrationsCount

  • getFinanceInfoTaxIntegrationsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceInvoiceEmailTemplates

  • getFinanceInvoiceEmailTemplates(params?: CommonParameters): Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }[]>

getFinanceInvoiceEmailTemplatesById

  • getFinanceInvoiceEmailTemplatesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

getFinanceInvoiceEmailTemplatesByIdInfo

  • getFinanceInvoiceEmailTemplatesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }>

getFinanceInvoiceEmailTemplatesByIdUsages

  • getFinanceInvoiceEmailTemplatesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceInvoiceEmailTemplatesByIdUsagesList

  • getFinanceInvoiceEmailTemplatesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceInvoiceEmailTemplatesCount

  • getFinanceInvoiceEmailTemplatesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceInvoiceEmailTemplatesInfo

  • getFinanceInvoiceEmailTemplatesInfo(params?: CommonParameters): Promise<{ _info?: {}; id?: number; name?: string }[]>

getFinanceInvoiceEmailTemplatesInfoCount

  • getFinanceInvoiceEmailTemplatesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceInvoiceTemplateSetups

  • getFinanceInvoiceTemplateSetups(params?: CommonParameters): Promise<{ _info?: {}; customFlag?: null | boolean; id?: number; name?: string }[]>

getFinanceInvoiceTemplateSetupsById

  • getFinanceInvoiceTemplateSetupsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; customFlag?: null | boolean; id?: number; name?: string }>

getFinanceInvoiceTemplateSetupsCount

  • getFinanceInvoiceTemplateSetupsCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceInvoiceTemplates

  • getFinanceInvoiceTemplates(params?: CommonParameters): Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }[]>

  • Parameters

    Returns Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }[]>

getFinanceInvoiceTemplatesById

  • getFinanceInvoiceTemplatesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

  • Parameters

    Returns Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

getFinanceInvoiceTemplatesByIdUsages

  • getFinanceInvoiceTemplatesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceInvoiceTemplatesByIdUsagesList

  • getFinanceInvoiceTemplatesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceInvoiceTemplatesCount

  • getFinanceInvoiceTemplatesCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceInvoices

  • getFinanceInvoices(params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }[]>

getFinanceInvoicesById

  • getFinanceInvoicesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

getFinanceInvoicesByIdPdf

getFinanceInvoicesByParentIdPayments

  • getFinanceInvoicesByParentIdPayments(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }[]>

getFinanceInvoicesByParentIdPaymentsById

  • getFinanceInvoicesByParentIdPaymentsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

getFinanceInvoicesCount

getFinanceTaxCodes

  • getFinanceTaxCodes(params?: CommonParameters): Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }[]>

  • Parameters

    Returns Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }[]>

getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevels

  • getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevels(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById

  • getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsCount

  • getFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsCount(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevels

  • getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevels(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById

  • getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsCount

  • getFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsCount(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevels

  • getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevels(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById

  • getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsCount

  • getFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsCount(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevels

  • getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevels(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById

  • getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById(id: number, parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsCount

  • getFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsCount(parentId: number, grandparentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesById

  • getFinanceTaxCodesById(id: number, params?: CommonParameters): Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

  • Parameters

    Returns Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

getFinanceTaxCodesByIdInfo

  • getFinanceTaxCodesByIdInfo(id: number, params?: CommonParameters): Promise<{ _info?: {}; cancelDate?: string; description?: string; effectiveDate?: string; id?: number; identifier?: string }>

getFinanceTaxCodesByIdUsages

  • getFinanceTaxCodesByIdUsages(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceTaxCodesByIdUsagesList

  • getFinanceTaxCodesByIdUsagesList(id: number, params?: CommonParameters): Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

  • Parameters

    Returns Promise<{ count?: null | number; description?: string; hyperlink?: string; id?: null | number; type?: string; typeKey?: string }[]>

getFinanceTaxCodesByParentIdExpenseTypeExemptions

  • getFinanceTaxCodesByParentIdExpenseTypeExemptions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }[]>

  • Parameters

    Returns Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }[]>

getFinanceTaxCodesByParentIdExpenseTypeExemptionsById

  • getFinanceTaxCodesByParentIdExpenseTypeExemptionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

  • Parameters

    Returns Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

getFinanceTaxCodesByParentIdExpenseTypeExemptionsCount

  • getFinanceTaxCodesByParentIdExpenseTypeExemptionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesByParentIdProductTypeExemptions

  • getFinanceTaxCodesByParentIdProductTypeExemptions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }[]>

getFinanceTaxCodesByParentIdProductTypeExemptionsById

  • getFinanceTaxCodesByParentIdProductTypeExemptionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

getFinanceTaxCodesByParentIdProductTypeExemptionsCount

  • getFinanceTaxCodesByParentIdProductTypeExemptionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesByParentIdTaxCodeLevels

  • getFinanceTaxCodesByParentIdTaxCodeLevels(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }[]>

  • Parameters

    Returns Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }[]>

getFinanceTaxCodesByParentIdTaxCodeLevelsById

  • getFinanceTaxCodesByParentIdTaxCodeLevelsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

  • Parameters

    Returns Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

getFinanceTaxCodesByParentIdTaxCodeLevelsCount

  • getFinanceTaxCodesByParentIdTaxCodeLevelsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesByParentIdTaxCodeXRefs

  • getFinanceTaxCodesByParentIdTaxCodeXRefs(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }[]>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }[]>

getFinanceTaxCodesByParentIdTaxCodeXRefsById

  • getFinanceTaxCodesByParentIdTaxCodeXRefsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

getFinanceTaxCodesByParentIdTaxCodeXRefsCount

  • getFinanceTaxCodesByParentIdTaxCodeXRefsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesByParentIdWorkRoleExemptions

  • getFinanceTaxCodesByParentIdWorkRoleExemptions(parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }[]>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }[]>

getFinanceTaxCodesByParentIdWorkRoleExemptionsById

  • getFinanceTaxCodesByParentIdWorkRoleExemptionsById(id: number, parentId: number, params?: CommonParameters): Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    Returns Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

getFinanceTaxCodesByParentIdWorkRoleExemptionsCount

  • getFinanceTaxCodesByParentIdWorkRoleExemptionsCount(parentId: number, params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxCodesCount

getFinanceTaxCodesInfo

  • getFinanceTaxCodesInfo(params?: CommonParameters): Promise<{ _info?: {}; cancelDate?: string; description?: string; effectiveDate?: string; id?: number; identifier?: string }[]>

getFinanceTaxCodesInfoCount

  • getFinanceTaxCodesInfoCount(params?: CommonParameters): Promise<{ count?: number }>

getFinanceTaxIntegrations

  • getFinanceTaxIntegrations(params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }[]>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }[]>

getFinanceTaxIntegrationsById

  • getFinanceTaxIntegrationsById(id: number, params?: CommonParameters): Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }>

  • Parameters

    Returns Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }>

getFinanceTaxIntegrationsCount

  • getFinanceTaxIntegrationsCount(params?: CommonParameters): Promise<{ count?: number }>

patchFinanceAccountingPackageSetupById

  • patchFinanceAccountingPackageSetupById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }>

patchFinanceAgreementTypesByParentIdBoardDefaultsById

  • patchFinanceAgreementTypesByParentIdBoardDefaultsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementTypesByParentIdWorkrolesById

  • patchFinanceAgreementTypesByParentIdWorkrolesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementTypesByParentIdWorktypesById

  • patchFinanceAgreementTypesByParentIdWorktypesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementsById

  • patchFinanceAgreementsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementsByParentIdAdditionsById

  • patchFinanceAgreementsByParentIdAdditionsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

patchFinanceAgreementsByParentIdAdjustmentsById

  • patchFinanceAgreementsByParentIdAdjustmentsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

patchFinanceAgreementsByParentIdBoardDefaultsById

  • patchFinanceAgreementsByParentIdBoardDefaultsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementsByParentIdSitesById

  • patchFinanceAgreementsByParentIdSitesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementsByParentIdWorkrolesById

  • patchFinanceAgreementsByParentIdWorkrolesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementsByParentIdWorktypesById

  • patchFinanceAgreementsByParentIdWorktypesById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceAgreementsTypesById

  • patchFinanceAgreementsTypesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceBatchSetupsById

  • patchFinanceBatchSetupsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }>

patchFinanceBillingCyclesById

  • patchFinanceBillingCyclesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

patchFinanceBillingSetupsById

  • patchFinanceBillingSetupsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

patchFinanceBillingSetupsByParentIdRoutingsById

  • patchFinanceBillingSetupsByParentIdRoutingsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

patchFinanceBillingStatusesById

  • patchFinanceBillingStatusesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

patchFinanceBillingTermsById

  • patchFinanceBillingTermsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }>

patchFinanceClosedInvoicesById

  • patchFinanceClosedInvoicesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceCompanyFinanceById

  • patchFinanceCompanyFinanceById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; billCompletePmFlag?: null | boolean; billCompleteSrFlag?: null | boolean; billOverrideFlag?: null | boolean; billRestrictPmFlag?: null | boolean; billSrFlag?: null | boolean; billUnapprovedPmFlag?: null | boolean; billUnapprovedSrFlag?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; id?: number }>

patchFinanceCurrenciesById

  • patchFinanceCurrenciesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

patchFinanceDeliveryMethodsById

  • patchFinanceDeliveryMethodsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

patchFinanceGlAccountsById

  • patchFinanceGlAccountsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

patchFinanceGlCaptionsById

  • patchFinanceGlCaptionsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }>

patchFinanceGlpathsById

  • patchFinanceGlpathsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

patchFinanceInvoiceEmailTemplatesById

  • patchFinanceInvoiceEmailTemplatesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

patchFinanceInvoiceTemplatesById

  • patchFinanceInvoiceTemplatesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

patchFinanceInvoicesById

  • patchFinanceInvoicesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

patchFinanceInvoicesByParentIdPaymentsById

  • patchFinanceInvoicesByParentIdPaymentsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

patchFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById

  • patchFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById(id: number, parentId: number, grandparentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById

  • patchFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById(id: number, parentId: number, grandparentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById

  • patchFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById(id: number, parentId: number, grandparentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById

  • patchFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById(id: number, parentId: number, grandparentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceTaxCodesById

  • patchFinanceTaxCodesById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

patchFinanceTaxCodesByParentIdExpenseTypeExemptionsById

  • patchFinanceTaxCodesByParentIdExpenseTypeExemptionsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

patchFinanceTaxCodesByParentIdProductTypeExemptionsById

  • patchFinanceTaxCodesByParentIdProductTypeExemptionsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

patchFinanceTaxCodesByParentIdTaxCodeLevelsById

  • patchFinanceTaxCodesByParentIdTaxCodeLevelsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

patchFinanceTaxCodesByParentIdTaxCodeXRefsById

  • patchFinanceTaxCodesByParentIdTaxCodeXRefsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

patchFinanceTaxCodesByParentIdWorkRoleExemptionsById

  • patchFinanceTaxCodesByParentIdWorkRoleExemptionsById(id: number, parentId: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

patchFinanceTaxIntegrationsById

  • patchFinanceTaxIntegrationsById(id: number, patchOperations: { op?: string; path?: string; value?: {} }[]): Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }>

  • Parameters

    • id: number
    • patchOperations: { op?: string; path?: string; value?: {} }[]

    Returns Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }>

postFinanceAccountingBatches

  • postFinanceAccountingBatches(accountingBatchParameters: { batchIdentifier?: string; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; glInterfaceIdentifier?: string; id?: number; processedRecordIds: (null | number)[]; summarizeExpenses?: null | boolean }): Promise<{ adjustmentTransactions?: { accountNumber?: string; adjustmentDescription?: string; adjustmentDetail?: { accountNumber?: string; cost?: null | number; costAccountNumber?: string; description?: string; glClass?: string; inventoryAccountNumber?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; memo?: string; productAccountNumber?: string; quantity?: null | number; total?: null | number }[]; documentDate?: string; documentType?: string; glClass?: string; glTypeID?: string; id?: string; memo?: string }[]; customers?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxAgencyXref?: string; cityTaxRate?: null | number; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; compositeTaxAgencyXref?: string; compositeTaxRate?: null | number; compositeTaxXref?: string; contact?: { _info?: {}; id?: null | number; name?: string }; countryTaxAgencyXref?: string; countryTaxRate?: null | number; countryTaxXref?: string; countyTaxAgencyXref?: string; countyTaxRate?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dueDays?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxAgencyXref?: string; stateTaxRate?: null | number; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { agencyXref?: string; taxCodeXref?: string; taxLevel?: number; taxRate?: null | number }[]; taxable?: null | boolean }[]; expenseBills?: { apAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; detail?: { accountNumber?: string; billable?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAdvance?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; expenseClass?: { _info?: {}; id?: null | number; name?: string }; glTypeId?: string; id?: number[]; memo?: string; reimbursable?: null | boolean; total?: null | number }[]; documentDate?: string; documentNumber?: string; documentType?: string; glClass?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number; vendorNumber?: string }[]; expenses?: { accountNumber?: string; apAccountNumber?: string; apClass?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number }; periodEndDate?: string; periodStartDate?: string; project?: { _info?: {}; id?: null | number; name?: string }; total?: null | number; vendorNumber?: string }[]; exportSettings?: {}; inventoryTransfers?: { accountNumber?: string; bin?: { _info?: {}; id?: null | number; name?: string }; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glItemId?: string; glTypeId?: string; id?: string; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; locationXref?: string; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; memo?: string; total?: null | number }; priceLevelXref?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxable?: null | boolean; total?: null | number; transferFromBin?: { _info?: {}; id?: null | number; name?: string }; transferFromLocationXref?: string; transferId?: null | number; transferToBin?: { _info?: {}; id?: null | number; name?: string }; transferToLocationXref?: string; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string } }[]; purchaseTransactions?: { apAccountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentNumber?: string; dropshipFlag?: null | boolean; dueDays?: null | number; freightAmount?: null | number; freightPackingSlip?: string; id?: string; memo?: string; packingSlip?: string; purchaseClass?: string; purchaseDate?: string; purchaseDetail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxNote?: string; taxRate?: number; taxable?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseDetailTax?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxableFlag?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseHeaderFreightTaxableFlag?: null | boolean; purchaseHeaderTaxGroup?: string; purchaseHeaderTaxableFlag?: null | boolean; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; shipToTaxGroup?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { taxCodeXref?: string; taxLevel?: number }[]; total?: null | number; useAvalaraTaxFlag?: null | boolean; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string; vendorNumber?: string }[]; transactions?: { accountNumber?: string; agreementPrePaymentFlag?: null | boolean; attention?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; billingType?: string; cityTax?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; companyType?: { _info?: {}; id?: null | number; name?: string }; countyTax?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; detail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; invoiceSummaryOption?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTaxableFlag?: null | boolean; itemTypeXref?: string; locationXref?: string; memo?: string; priceLevelXref?: string; product?: { _info?: {}; description?: string; id?: null | number }; productAccountNumber?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxLevels?: { taxLevel?: number; taxableFlag?: boolean }[]; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxable2Flag?: null | boolean; taxable3Flag?: null | boolean; taxable4Flag?: null | boolean; taxable5Flag?: null | boolean; taxableFlag?: null | boolean; timeEntry?: { _info?: {}; id?: null | number }; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; documentDate?: string; documentNumber?: string; documentType?: string; dueDate?: string; dueDays?: null | number; emailDeliveryFlag?: null | boolean; glClass?: string; glEntryIds?: string; glTypeId?: string; id?: null | number; memo?: string; piggyBackFlag?: null | boolean; printDeliveryFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesRepId?: string; salesRepName?: string; salesTax?: null | number; salesTerritory?: string; sendAvalaraTaxFlag?: null | boolean; shipContact?: string; shipSite?: { _info?: {}; id?: null | number; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToTaxId?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTax?: null | number; stateTaxXref?: string; taxAccountNumber?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxDpAppliedFlag?: null | boolean; taxGroupRate?: null | number; taxId?: string; taxLevels?: { taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number; taxableAmount?: null | number }[]; taxable?: null | boolean; taxableAmount1?: null | number; taxableAmount2?: null | number; taxableAmount3?: null | number; taxableAmount4?: null | number; taxableAmount5?: null | number; taxableTotal?: null | number; total?: null | number; useAvalaraFlag?: null | boolean }[]; vendors?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; dueDays?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNumber?: string }[] }>

  • Parameters

    • accountingBatchParameters: { batchIdentifier?: string; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; glInterfaceIdentifier?: string; id?: number; processedRecordIds: (null | number)[]; summarizeExpenses?: null | boolean }
      • Optional batchIdentifier?: string
        description

        Max length: 50;

      • Optional exportExpensesFlag?: null | boolean
        description

        Batch must export Invoices, Expenses or Products

      • Optional exportInvoicesFlag?: null | boolean
        description

        Batch must export Invoices, Expenses or Products

      • Optional exportProductsFlag?: null | boolean
        description

        Batch must export Invoices, Expenses or Products

      • Optional glInterfaceIdentifier?: string
      • Optional id?: number

        Format: int32

      • processedRecordIds: (null | number)[]
        description

        GL Entry RecIDs

      • Optional summarizeExpenses?: null | boolean

    Returns Promise<{ adjustmentTransactions?: { accountNumber?: string; adjustmentDescription?: string; adjustmentDetail?: { accountNumber?: string; cost?: null | number; costAccountNumber?: string; description?: string; glClass?: string; inventoryAccountNumber?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; memo?: string; productAccountNumber?: string; quantity?: null | number; total?: null | number }[]; documentDate?: string; documentType?: string; glClass?: string; glTypeID?: string; id?: string; memo?: string }[]; customers?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxAgencyXref?: string; cityTaxRate?: null | number; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; compositeTaxAgencyXref?: string; compositeTaxRate?: null | number; compositeTaxXref?: string; contact?: { _info?: {}; id?: null | number; name?: string }; countryTaxAgencyXref?: string; countryTaxRate?: null | number; countryTaxXref?: string; countyTaxAgencyXref?: string; countyTaxRate?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dueDays?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxAgencyXref?: string; stateTaxRate?: null | number; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { agencyXref?: string; taxCodeXref?: string; taxLevel?: number; taxRate?: null | number }[]; taxable?: null | boolean }[]; expenseBills?: { apAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; detail?: { accountNumber?: string; billable?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAdvance?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; expenseClass?: { _info?: {}; id?: null | number; name?: string }; glTypeId?: string; id?: number[]; memo?: string; reimbursable?: null | boolean; total?: null | number }[]; documentDate?: string; documentNumber?: string; documentType?: string; glClass?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number; vendorNumber?: string }[]; expenses?: { accountNumber?: string; apAccountNumber?: string; apClass?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number }; periodEndDate?: string; periodStartDate?: string; project?: { _info?: {}; id?: null | number; name?: string }; total?: null | number; vendorNumber?: string }[]; exportSettings?: {}; inventoryTransfers?: { accountNumber?: string; bin?: { _info?: {}; id?: null | number; name?: string }; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glItemId?: string; glTypeId?: string; id?: string; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; locationXref?: string; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; memo?: string; total?: null | number }; priceLevelXref?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxable?: null | boolean; total?: null | number; transferFromBin?: { _info?: {}; id?: null | number; name?: string }; transferFromLocationXref?: string; transferId?: null | number; transferToBin?: { _info?: {}; id?: null | number; name?: string }; transferToLocationXref?: string; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string } }[]; purchaseTransactions?: { apAccountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentNumber?: string; dropshipFlag?: null | boolean; dueDays?: null | number; freightAmount?: null | number; freightPackingSlip?: string; id?: string; memo?: string; packingSlip?: string; purchaseClass?: string; purchaseDate?: string; purchaseDetail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxNote?: string; taxRate?: number; taxable?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseDetailTax?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxableFlag?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseHeaderFreightTaxableFlag?: null | boolean; purchaseHeaderTaxGroup?: string; purchaseHeaderTaxableFlag?: null | boolean; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; shipToTaxGroup?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { taxCodeXref?: string; taxLevel?: number }[]; total?: null | number; useAvalaraTaxFlag?: null | boolean; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string; vendorNumber?: string }[]; transactions?: { accountNumber?: string; agreementPrePaymentFlag?: null | boolean; attention?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; billingType?: string; cityTax?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; companyType?: { _info?: {}; id?: null | number; name?: string }; countyTax?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; detail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; invoiceSummaryOption?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTaxableFlag?: null | boolean; itemTypeXref?: string; locationXref?: string; memo?: string; priceLevelXref?: string; product?: { _info?: {}; description?: string; id?: null | number }; productAccountNumber?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxLevels?: { taxLevel?: number; taxableFlag?: boolean }[]; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxable2Flag?: null | boolean; taxable3Flag?: null | boolean; taxable4Flag?: null | boolean; taxable5Flag?: null | boolean; taxableFlag?: null | boolean; timeEntry?: { _info?: {}; id?: null | number }; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; documentDate?: string; documentNumber?: string; documentType?: string; dueDate?: string; dueDays?: null | number; emailDeliveryFlag?: null | boolean; glClass?: string; glEntryIds?: string; glTypeId?: string; id?: null | number; memo?: string; piggyBackFlag?: null | boolean; printDeliveryFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesRepId?: string; salesRepName?: string; salesTax?: null | number; salesTerritory?: string; sendAvalaraTaxFlag?: null | boolean; shipContact?: string; shipSite?: { _info?: {}; id?: null | number; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToTaxId?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTax?: null | number; stateTaxXref?: string; taxAccountNumber?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxDpAppliedFlag?: null | boolean; taxGroupRate?: null | number; taxId?: string; taxLevels?: { taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number; taxableAmount?: null | number }[]; taxable?: null | boolean; taxableAmount1?: null | number; taxableAmount2?: null | number; taxableAmount3?: null | number; taxableAmount4?: null | number; taxableAmount5?: null | number; taxableTotal?: null | number; total?: null | number; useAvalaraFlag?: null | boolean }[]; vendors?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; dueDays?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNumber?: string }[] }>

postFinanceAccountingBatchesByIdExport

  • postFinanceAccountingBatchesByIdExport(id: number, batchExportParameters: { batchIdentifier?: string; excludedExpenseIds?: (null | number)[]; excludedInvoiceIds?: (null | number)[]; excludedProductIds?: string[]; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; glInterfaceIdentifier?: string; includedExpenseIds?: (null | number)[]; includedInvoiceIds?: (null | number)[]; includedProductIds?: string[]; locationId?: null | number; summarizeInvoices?: "Default" | "Condensed" | "Detailed"; thruDate?: string }): Promise<{ adjustmentTransactions?: { accountNumber?: string; adjustmentDescription?: string; adjustmentDetail?: { accountNumber?: string; cost?: null | number; costAccountNumber?: string; description?: string; glClass?: string; inventoryAccountNumber?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; memo?: string; productAccountNumber?: string; quantity?: null | number; total?: null | number }[]; documentDate?: string; documentType?: string; glClass?: string; glTypeID?: string; id?: string; memo?: string }[]; customers?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxAgencyXref?: string; cityTaxRate?: null | number; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; compositeTaxAgencyXref?: string; compositeTaxRate?: null | number; compositeTaxXref?: string; contact?: { _info?: {}; id?: null | number; name?: string }; countryTaxAgencyXref?: string; countryTaxRate?: null | number; countryTaxXref?: string; countyTaxAgencyXref?: string; countyTaxRate?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dueDays?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxAgencyXref?: string; stateTaxRate?: null | number; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { agencyXref?: string; taxCodeXref?: string; taxLevel?: number; taxRate?: null | number }[]; taxable?: null | boolean }[]; expenseBills?: { apAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; detail?: { accountNumber?: string; billable?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAdvance?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; expenseClass?: { _info?: {}; id?: null | number; name?: string }; glTypeId?: string; id?: number[]; memo?: string; reimbursable?: null | boolean; total?: null | number }[]; documentDate?: string; documentNumber?: string; documentType?: string; glClass?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number; vendorNumber?: string }[]; expenses?: { accountNumber?: string; apAccountNumber?: string; apClass?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number }; periodEndDate?: string; periodStartDate?: string; project?: { _info?: {}; id?: null | number; name?: string }; total?: null | number; vendorNumber?: string }[]; exportSettings?: {}; inventoryTransfers?: { accountNumber?: string; bin?: { _info?: {}; id?: null | number; name?: string }; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glItemId?: string; glTypeId?: string; id?: string; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; locationXref?: string; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; memo?: string; total?: null | number }; priceLevelXref?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxable?: null | boolean; total?: null | number; transferFromBin?: { _info?: {}; id?: null | number; name?: string }; transferFromLocationXref?: string; transferId?: null | number; transferToBin?: { _info?: {}; id?: null | number; name?: string }; transferToLocationXref?: string; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string } }[]; purchaseTransactions?: { apAccountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentNumber?: string; dropshipFlag?: null | boolean; dueDays?: null | number; freightAmount?: null | number; freightPackingSlip?: string; id?: string; memo?: string; packingSlip?: string; purchaseClass?: string; purchaseDate?: string; purchaseDetail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxNote?: string; taxRate?: number; taxable?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseDetailTax?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxableFlag?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseHeaderFreightTaxableFlag?: null | boolean; purchaseHeaderTaxGroup?: string; purchaseHeaderTaxableFlag?: null | boolean; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; shipToTaxGroup?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { taxCodeXref?: string; taxLevel?: number }[]; total?: null | number; useAvalaraTaxFlag?: null | boolean; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string; vendorNumber?: string }[]; transactions?: { accountNumber?: string; agreementPrePaymentFlag?: null | boolean; attention?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; billingType?: string; cityTax?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; companyType?: { _info?: {}; id?: null | number; name?: string }; countyTax?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; detail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; invoiceSummaryOption?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTaxableFlag?: null | boolean; itemTypeXref?: string; locationXref?: string; memo?: string; priceLevelXref?: string; product?: { _info?: {}; description?: string; id?: null | number }; productAccountNumber?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxLevels?: { taxLevel?: number; taxableFlag?: boolean }[]; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxable2Flag?: null | boolean; taxable3Flag?: null | boolean; taxable4Flag?: null | boolean; taxable5Flag?: null | boolean; taxableFlag?: null | boolean; timeEntry?: { _info?: {}; id?: null | number }; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; documentDate?: string; documentNumber?: string; documentType?: string; dueDate?: string; dueDays?: null | number; emailDeliveryFlag?: null | boolean; glClass?: string; glEntryIds?: string; glTypeId?: string; id?: null | number; memo?: string; piggyBackFlag?: null | boolean; printDeliveryFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesRepId?: string; salesRepName?: string; salesTax?: null | number; salesTerritory?: string; sendAvalaraTaxFlag?: null | boolean; shipContact?: string; shipSite?: { _info?: {}; id?: null | number; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToTaxId?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTax?: null | number; stateTaxXref?: string; taxAccountNumber?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxDpAppliedFlag?: null | boolean; taxGroupRate?: null | number; taxId?: string; taxLevels?: { taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number; taxableAmount?: null | number }[]; taxable?: null | boolean; taxableAmount1?: null | number; taxableAmount2?: null | number; taxableAmount3?: null | number; taxableAmount4?: null | number; taxableAmount5?: null | number; taxableTotal?: null | number; total?: null | number; useAvalaraFlag?: null | boolean }[]; vendors?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; dueDays?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNumber?: string }[] }>

  • Parameters

    • id: number
    • batchExportParameters: { batchIdentifier?: string; excludedExpenseIds?: (null | number)[]; excludedInvoiceIds?: (null | number)[]; excludedProductIds?: string[]; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; glInterfaceIdentifier?: string; includedExpenseIds?: (null | number)[]; includedInvoiceIds?: (null | number)[]; includedProductIds?: string[]; locationId?: null | number; summarizeInvoices?: "Default" | "Condensed" | "Detailed"; thruDate?: string }
      • Optional batchIdentifier?: string
        description

        Max length: 50;

      • Optional excludedExpenseIds?: (null | number)[]
      • Optional excludedInvoiceIds?: (null | number)[]
      • Optional excludedProductIds?: string[]
      • Optional exportExpensesFlag?: null | boolean
        description

        Batch export must include invoices, expenses, or products (procurement)

      • Optional exportInvoicesFlag?: null | boolean
        description

        Batch export must include invoices, expenses, or products (procurement)

      • Optional exportProductsFlag?: null | boolean
        description

        Batch export must include invoices, expenses, or products (procurement)

      • Optional glInterfaceIdentifier?: string
      • Optional includedExpenseIds?: (null | number)[]
      • Optional includedInvoiceIds?: (null | number)[]
      • Optional includedProductIds?: string[]
      • Optional locationId?: null | number

        Format: int32

      • Optional summarizeInvoices?: "Default" | "Condensed" | "Detailed"
      • Optional thruDate?: string

        Format: date-time

    Returns Promise<{ adjustmentTransactions?: { accountNumber?: string; adjustmentDescription?: string; adjustmentDetail?: { accountNumber?: string; cost?: null | number; costAccountNumber?: string; description?: string; glClass?: string; inventoryAccountNumber?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; memo?: string; productAccountNumber?: string; quantity?: null | number; total?: null | number }[]; documentDate?: string; documentType?: string; glClass?: string; glTypeID?: string; id?: string; memo?: string }[]; customers?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxAgencyXref?: string; cityTaxRate?: null | number; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; compositeTaxAgencyXref?: string; compositeTaxRate?: null | number; compositeTaxXref?: string; contact?: { _info?: {}; id?: null | number; name?: string }; countryTaxAgencyXref?: string; countryTaxRate?: null | number; countryTaxXref?: string; countyTaxAgencyXref?: string; countyTaxRate?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dueDays?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxAgencyXref?: string; stateTaxRate?: null | number; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { agencyXref?: string; taxCodeXref?: string; taxLevel?: number; taxRate?: null | number }[]; taxable?: null | boolean }[]; expenseBills?: { apAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; detail?: { accountNumber?: string; billable?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAdvance?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; expenseClass?: { _info?: {}; id?: null | number; name?: string }; glTypeId?: string; id?: number[]; memo?: string; reimbursable?: null | boolean; total?: null | number }[]; documentDate?: string; documentNumber?: string; documentType?: string; glClass?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number; vendorNumber?: string }[]; expenses?: { accountNumber?: string; apAccountNumber?: string; apClass?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number }; periodEndDate?: string; periodStartDate?: string; project?: { _info?: {}; id?: null | number; name?: string }; total?: null | number; vendorNumber?: string }[]; exportSettings?: {}; inventoryTransfers?: { accountNumber?: string; bin?: { _info?: {}; id?: null | number; name?: string }; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glItemId?: string; glTypeId?: string; id?: string; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; locationXref?: string; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; memo?: string; total?: null | number }; priceLevelXref?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxable?: null | boolean; total?: null | number; transferFromBin?: { _info?: {}; id?: null | number; name?: string }; transferFromLocationXref?: string; transferId?: null | number; transferToBin?: { _info?: {}; id?: null | number; name?: string }; transferToLocationXref?: string; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string } }[]; purchaseTransactions?: { apAccountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentNumber?: string; dropshipFlag?: null | boolean; dueDays?: null | number; freightAmount?: null | number; freightPackingSlip?: string; id?: string; memo?: string; packingSlip?: string; purchaseClass?: string; purchaseDate?: string; purchaseDetail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxNote?: string; taxRate?: number; taxable?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseDetailTax?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxableFlag?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseHeaderFreightTaxableFlag?: null | boolean; purchaseHeaderTaxGroup?: string; purchaseHeaderTaxableFlag?: null | boolean; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; shipToTaxGroup?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { taxCodeXref?: string; taxLevel?: number }[]; total?: null | number; useAvalaraTaxFlag?: null | boolean; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string; vendorNumber?: string }[]; transactions?: { accountNumber?: string; agreementPrePaymentFlag?: null | boolean; attention?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; billingType?: string; cityTax?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; companyType?: { _info?: {}; id?: null | number; name?: string }; countyTax?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; detail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; invoiceSummaryOption?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTaxableFlag?: null | boolean; itemTypeXref?: string; locationXref?: string; memo?: string; priceLevelXref?: string; product?: { _info?: {}; description?: string; id?: null | number }; productAccountNumber?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxLevels?: { taxLevel?: number; taxableFlag?: boolean }[]; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxable2Flag?: null | boolean; taxable3Flag?: null | boolean; taxable4Flag?: null | boolean; taxable5Flag?: null | boolean; taxableFlag?: null | boolean; timeEntry?: { _info?: {}; id?: null | number }; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; documentDate?: string; documentNumber?: string; documentType?: string; dueDate?: string; dueDays?: null | number; emailDeliveryFlag?: null | boolean; glClass?: string; glEntryIds?: string; glTypeId?: string; id?: null | number; memo?: string; piggyBackFlag?: null | boolean; printDeliveryFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesRepId?: string; salesRepName?: string; salesTax?: null | number; salesTerritory?: string; sendAvalaraTaxFlag?: null | boolean; shipContact?: string; shipSite?: { _info?: {}; id?: null | number; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToTaxId?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTax?: null | number; stateTaxXref?: string; taxAccountNumber?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxDpAppliedFlag?: null | boolean; taxGroupRate?: null | number; taxId?: string; taxLevels?: { taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number; taxableAmount?: null | number }[]; taxable?: null | boolean; taxableAmount1?: null | number; taxableAmount2?: null | number; taxableAmount3?: null | number; taxableAmount4?: null | number; taxableAmount5?: null | number; taxableTotal?: null | number; total?: null | number; useAvalaraFlag?: null | boolean }[]; vendors?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; dueDays?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNumber?: string }[] }>

postFinanceAccountingExport

  • postFinanceAccountingExport(batchExportParameters: { batchIdentifier?: string; excludedExpenseIds?: (null | number)[]; excludedInvoiceIds?: (null | number)[]; excludedProductIds?: string[]; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; glInterfaceIdentifier?: string; includedExpenseIds?: (null | number)[]; includedInvoiceIds?: (null | number)[]; includedProductIds?: string[]; locationId?: null | number; summarizeInvoices?: "Default" | "Condensed" | "Detailed"; thruDate?: string }): Promise<{ adjustmentTransactions?: { accountNumber?: string; adjustmentDescription?: string; adjustmentDetail?: { accountNumber?: string; cost?: null | number; costAccountNumber?: string; description?: string; glClass?: string; inventoryAccountNumber?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; memo?: string; productAccountNumber?: string; quantity?: null | number; total?: null | number }[]; documentDate?: string; documentType?: string; glClass?: string; glTypeID?: string; id?: string; memo?: string }[]; customers?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxAgencyXref?: string; cityTaxRate?: null | number; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; compositeTaxAgencyXref?: string; compositeTaxRate?: null | number; compositeTaxXref?: string; contact?: { _info?: {}; id?: null | number; name?: string }; countryTaxAgencyXref?: string; countryTaxRate?: null | number; countryTaxXref?: string; countyTaxAgencyXref?: string; countyTaxRate?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dueDays?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxAgencyXref?: string; stateTaxRate?: null | number; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { agencyXref?: string; taxCodeXref?: string; taxLevel?: number; taxRate?: null | number }[]; taxable?: null | boolean }[]; expenseBills?: { apAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; detail?: { accountNumber?: string; billable?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAdvance?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; expenseClass?: { _info?: {}; id?: null | number; name?: string }; glTypeId?: string; id?: number[]; memo?: string; reimbursable?: null | boolean; total?: null | number }[]; documentDate?: string; documentNumber?: string; documentType?: string; glClass?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number; vendorNumber?: string }[]; expenses?: { accountNumber?: string; apAccountNumber?: string; apClass?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number }; periodEndDate?: string; periodStartDate?: string; project?: { _info?: {}; id?: null | number; name?: string }; total?: null | number; vendorNumber?: string }[]; exportSettings?: {}; inventoryTransfers?: { accountNumber?: string; bin?: { _info?: {}; id?: null | number; name?: string }; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glItemId?: string; glTypeId?: string; id?: string; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; locationXref?: string; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; memo?: string; total?: null | number }; priceLevelXref?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxable?: null | boolean; total?: null | number; transferFromBin?: { _info?: {}; id?: null | number; name?: string }; transferFromLocationXref?: string; transferId?: null | number; transferToBin?: { _info?: {}; id?: null | number; name?: string }; transferToLocationXref?: string; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string } }[]; purchaseTransactions?: { apAccountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentNumber?: string; dropshipFlag?: null | boolean; dueDays?: null | number; freightAmount?: null | number; freightPackingSlip?: string; id?: string; memo?: string; packingSlip?: string; purchaseClass?: string; purchaseDate?: string; purchaseDetail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxNote?: string; taxRate?: number; taxable?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseDetailTax?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxableFlag?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseHeaderFreightTaxableFlag?: null | boolean; purchaseHeaderTaxGroup?: string; purchaseHeaderTaxableFlag?: null | boolean; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; shipToTaxGroup?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { taxCodeXref?: string; taxLevel?: number }[]; total?: null | number; useAvalaraTaxFlag?: null | boolean; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string; vendorNumber?: string }[]; transactions?: { accountNumber?: string; agreementPrePaymentFlag?: null | boolean; attention?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; billingType?: string; cityTax?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; companyType?: { _info?: {}; id?: null | number; name?: string }; countyTax?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; detail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; invoiceSummaryOption?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTaxableFlag?: null | boolean; itemTypeXref?: string; locationXref?: string; memo?: string; priceLevelXref?: string; product?: { _info?: {}; description?: string; id?: null | number }; productAccountNumber?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxLevels?: { taxLevel?: number; taxableFlag?: boolean }[]; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxable2Flag?: null | boolean; taxable3Flag?: null | boolean; taxable4Flag?: null | boolean; taxable5Flag?: null | boolean; taxableFlag?: null | boolean; timeEntry?: { _info?: {}; id?: null | number }; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; documentDate?: string; documentNumber?: string; documentType?: string; dueDate?: string; dueDays?: null | number; emailDeliveryFlag?: null | boolean; glClass?: string; glEntryIds?: string; glTypeId?: string; id?: null | number; memo?: string; piggyBackFlag?: null | boolean; printDeliveryFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesRepId?: string; salesRepName?: string; salesTax?: null | number; salesTerritory?: string; sendAvalaraTaxFlag?: null | boolean; shipContact?: string; shipSite?: { _info?: {}; id?: null | number; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToTaxId?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTax?: null | number; stateTaxXref?: string; taxAccountNumber?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxDpAppliedFlag?: null | boolean; taxGroupRate?: null | number; taxId?: string; taxLevels?: { taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number; taxableAmount?: null | number }[]; taxable?: null | boolean; taxableAmount1?: null | number; taxableAmount2?: null | number; taxableAmount3?: null | number; taxableAmount4?: null | number; taxableAmount5?: null | number; taxableTotal?: null | number; total?: null | number; useAvalaraFlag?: null | boolean }[]; vendors?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; dueDays?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNumber?: string }[] }>

  • Parameters

    • batchExportParameters: { batchIdentifier?: string; excludedExpenseIds?: (null | number)[]; excludedInvoiceIds?: (null | number)[]; excludedProductIds?: string[]; exportExpensesFlag?: null | boolean; exportInvoicesFlag?: null | boolean; exportProductsFlag?: null | boolean; glInterfaceIdentifier?: string; includedExpenseIds?: (null | number)[]; includedInvoiceIds?: (null | number)[]; includedProductIds?: string[]; locationId?: null | number; summarizeInvoices?: "Default" | "Condensed" | "Detailed"; thruDate?: string }
      • Optional batchIdentifier?: string
        description

        Max length: 50;

      • Optional excludedExpenseIds?: (null | number)[]
      • Optional excludedInvoiceIds?: (null | number)[]
      • Optional excludedProductIds?: string[]
      • Optional exportExpensesFlag?: null | boolean
        description

        Batch export must include invoices, expenses, or products (procurement)

      • Optional exportInvoicesFlag?: null | boolean
        description

        Batch export must include invoices, expenses, or products (procurement)

      • Optional exportProductsFlag?: null | boolean
        description

        Batch export must include invoices, expenses, or products (procurement)

      • Optional glInterfaceIdentifier?: string
      • Optional includedExpenseIds?: (null | number)[]
      • Optional includedInvoiceIds?: (null | number)[]
      • Optional includedProductIds?: string[]
      • Optional locationId?: null | number

        Format: int32

      • Optional summarizeInvoices?: "Default" | "Condensed" | "Detailed"
      • Optional thruDate?: string

        Format: date-time

    Returns Promise<{ adjustmentTransactions?: { accountNumber?: string; adjustmentDescription?: string; adjustmentDetail?: { accountNumber?: string; cost?: null | number; costAccountNumber?: string; description?: string; glClass?: string; inventoryAccountNumber?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; memo?: string; productAccountNumber?: string; quantity?: null | number; total?: null | number }[]; documentDate?: string; documentType?: string; glClass?: string; glTypeID?: string; id?: string; memo?: string }[]; customers?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxAgencyXref?: string; cityTaxRate?: null | number; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; compositeTaxAgencyXref?: string; compositeTaxRate?: null | number; compositeTaxXref?: string; contact?: { _info?: {}; id?: null | number; name?: string }; countryTaxAgencyXref?: string; countryTaxRate?: null | number; countryTaxXref?: string; countyTaxAgencyXref?: string; countyTaxRate?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; dueDays?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxAgencyXref?: string; stateTaxRate?: null | number; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { agencyXref?: string; taxCodeXref?: string; taxLevel?: number; taxRate?: null | number }[]; taxable?: null | boolean }[]; expenseBills?: { apAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; detail?: { accountNumber?: string; billable?: null | boolean; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAdvance?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; expenseClass?: { _info?: {}; id?: null | number; name?: string }; glTypeId?: string; id?: number[]; memo?: string; reimbursable?: null | boolean; total?: null | number }[]; documentDate?: string; documentNumber?: string; documentType?: string; glClass?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number; vendorNumber?: string }[]; expenses?: { accountNumber?: string; apAccountNumber?: string; apClass?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; memo?: string; total?: null | number }; periodEndDate?: string; periodStartDate?: string; project?: { _info?: {}; id?: null | number; name?: string }; total?: null | number; vendorNumber?: string }[]; exportSettings?: {}; inventoryTransfers?: { accountNumber?: string; bin?: { _info?: {}; id?: null | number; name?: string }; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; glClass?: string; glItemId?: string; glTypeId?: string; id?: string; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; locationXref?: string; memo?: string; offset?: { accountNumber?: string; description?: string; documentDate?: string; documentType?: string; glClass?: string; glTypeId?: string; id?: null | number; memo?: string; total?: null | number }; priceLevelXref?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxable?: null | boolean; total?: null | number; transferFromBin?: { _info?: {}; id?: null | number; name?: string }; transferFromLocationXref?: string; transferId?: null | number; transferToBin?: { _info?: {}; id?: null | number; name?: string }; transferToLocationXref?: string; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouse?: { _info?: {}; id?: null | number; lockedFlag?: boolean; name?: string } }[]; purchaseTransactions?: { apAccountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; cityTaxXref?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyType?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentNumber?: string; dropshipFlag?: null | boolean; dueDays?: null | number; freightAmount?: null | number; freightPackingSlip?: string; id?: string; memo?: string; packingSlip?: string; purchaseClass?: string; purchaseDate?: string; purchaseDetail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxNote?: string; taxRate?: number; taxable?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseDetailTax?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; documentDate?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTypeXref?: string; lineNumber?: number; locationXref?: string; memo?: string; priceLevelXref?: string; purchaseHeaderTaxGroup?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxableFlag?: null | boolean; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; vendorAccountNumber?: string; vendorNumber?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; purchaseHeaderFreightTaxableFlag?: null | boolean; purchaseHeaderTaxGroup?: string; purchaseHeaderTaxableFlag?: null | boolean; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToContact?: { _info?: {}; id?: null | number; name?: string }; shipToSite?: { _info?: {}; id?: null | number; name?: string }; shipToTaxGroup?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTaxXref?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxGroupRate?: null | number; taxLevels?: { taxCodeXref?: string; taxLevel?: number }[]; total?: null | number; useAvalaraTaxFlag?: null | boolean; vendorAccountNumber?: string; vendorInvoiceDate?: string; vendorInvoiceNumber?: string; vendorNumber?: string }[]; transactions?: { accountNumber?: string; agreementPrePaymentFlag?: null | boolean; attention?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; billingTermsXref?: string; billingType?: string; cityTax?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyAccountNumber?: string; companyType?: { _info?: {}; id?: null | number; name?: string }; countyTax?: null | number; countyTaxXref?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; detail?: { accountNumber?: string; cogsXref?: string; cost?: null | number; costAccountNumber?: string; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; description?: string; documentDate?: string; documentType?: string; dropShippedFlag?: null | boolean; glClass?: string; glItemId?: string; glTypeId?: string; id?: null | number; inventoryAccountNumber?: string; inventoryXref?: string; invoiceSummaryOption?: string; item?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; itemCost?: null | number; itemDescription?: string; itemPrice?: null | number; itemTaxableFlag?: null | boolean; itemTypeXref?: string; locationXref?: string; memo?: string; priceLevelXref?: string; product?: { _info?: {}; description?: string; id?: null | number }; productAccountNumber?: string; quantity?: null | number; salesCode?: string; salesDescription?: string; serialNumbers?: string; serializedFlag?: null | boolean; shipmentMethod?: { _info?: {}; id?: null | number; name?: string }; subCategory?: { _info?: {}; id?: null | number; name?: string }; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxCodeXref?: string; taxLevels?: { taxLevel?: number; taxableFlag?: boolean }[]; taxNote?: string; taxRate?: null | number; taxRatePercent?: null | number; taxable2Flag?: null | boolean; taxable3Flag?: null | boolean; taxable4Flag?: null | boolean; taxable5Flag?: null | boolean; taxableFlag?: null | boolean; timeEntry?: { _info?: {}; id?: null | number }; total?: null | number; unitOfMeasure?: { _info?: {}; id?: null | number; name?: string }; uomScheduleXref?: string; warehouseBin?: { _info?: {}; id?: null | number; name?: string }; warehouseSite?: { _info?: {}; id?: null | number; name?: string } }[]; documentDate?: string; documentNumber?: string; documentType?: string; dueDate?: string; dueDays?: null | number; emailDeliveryFlag?: null | boolean; glClass?: string; glEntryIds?: string; glTypeId?: string; id?: null | number; memo?: string; piggyBackFlag?: null | boolean; printDeliveryFlag?: null | boolean; project?: { _info?: {}; id?: null | number; name?: string }; purchaseOrder?: { _info?: {}; id?: null | number; name?: string }; salesRepId?: string; salesRepName?: string; salesTax?: null | number; salesTerritory?: string; sendAvalaraTaxFlag?: null | boolean; shipContact?: string; shipSite?: { _info?: {}; id?: null | number; name?: string }; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shipToCompanyAccountNumber?: string; shipToCompanyType?: { _info?: {}; id?: null | number; name?: string }; shipToTaxId?: string; site?: { _info?: {}; id?: null | number; name?: string }; stateTax?: null | number; stateTaxXref?: string; taxAccountNumber?: string; taxAgencyXref?: string; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxDpAppliedFlag?: null | boolean; taxGroupRate?: null | number; taxId?: string; taxLevels?: { taxAmount?: null | number; taxCodeXref?: string; taxLevel?: number; taxableAmount?: null | number }[]; taxable?: null | boolean; taxableAmount1?: null | number; taxableAmount2?: null | number; taxableAmount3?: null | number; taxableAmount4?: null | number; taxableAmount5?: null | number; taxableTotal?: null | number; total?: null | number; useAvalaraFlag?: null | boolean }[]; vendors?: { accountNumber?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; dueDays?: null | number; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; site?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; vendor?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; vendorNumber?: string }[] }>

postFinanceAgreementTypesByParentIdBoardDefaults

  • postFinanceAgreementTypesByParentIdBoardDefaults(parentId: number, boardDefault: { _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • boardDefault: { _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional board?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • location: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional serviceType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementTypesByParentIdWorkRoleExclusions

  • postFinanceAgreementTypesByParentIdWorkRoleExclusions(parentId: number, workRoleExclusion: { _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workRoleExclusion: { _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementTypesByParentIdWorkTypeExclusions

  • postFinanceAgreementTypesByParentIdWorkTypeExclusions(parentId: number, workTypeExclusion: { _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workTypeExclusion: { _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementTypesByParentIdWorkroles

  • postFinanceAgreementTypesByParentIdWorkroles(parentId: number, workRole: { _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workRole: { _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional id?: number

        Format: int32

      • Optional limitTo?: null | number

        Format: double

      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementTypesByParentIdWorktypes

  • postFinanceAgreementTypesByParentIdWorktypes(parentId: number, workType: { _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workType: { _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional hoursMax?: null | number

        Format: double

      • Optional hoursMin?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional limitTo?: null | number

        Format: double

      • Optional overageRate?: null | number

        Format: double

      • overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional roundBillHours?: null | number

        Format: double

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreements

  • postFinanceAgreements(agreement: { _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • agreement: { _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"
      • Optional allowOverruns?: null | boolean
      • Optional applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"
      • Optional applicationLimit?: null | number

        Format: double

      • Optional applicationUnits?: null | "Amount" | "Hours" | "Incidents"
      • Optional applicationUnlimitedFlag?: null | boolean
      • Optional autoInvoiceFlag?: null | boolean
      • Optional billAmount?: null | number

        Format: double

      • Optional billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
        description

        Required On Updates;

      • Optional billOneTimeFlag?: null | boolean
      • Optional billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
        description

        Required On Updates;

      • Optional billStartDate?: string

        Format: date-time

      • Optional billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
        description

        Required On Updates;

      • Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional billToContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billToSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billableExpenseInvoice?: null | boolean
      • Optional billableProductInvoice?: null | boolean
      • Optional billableTimeInvoice?: null | boolean
      • Optional billingCycle?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bottomComment?: null | boolean
      • Optional cancelledFlag?: null | boolean
      • Optional carryOverUnused?: null | boolean
      • Optional chargeToFirm?: null | boolean
      • Optional compHourlyRate?: null | number

        Format: double

      • Optional compLimitAmount?: null | number

        Format: double

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional coverAgreementExpense?: null | boolean
      • Optional coverAgreementProduct?: null | boolean
      • Optional coverAgreementTime?: null | boolean
      • Optional coverSalesTax?: null | boolean
      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional customerPO?: string
        description

        Max length: 50;

      • Optional dateCancelled?: string

        Format: date-time

      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"
      • Optional employeeCompRate?: null | "Actual" | "Hourly"
        description

        Required On Updates;

      • Optional endDate?: string

        Format: date-time

      • Optional expireWhenZero?: null | boolean
      • Optional expiredDays?: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • Optional internalNotes?: string
      • Optional invoiceDescription?: string
      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional invoicingCycle?: null | "ContractYear" | "CalendarYear"
        description

        Required On Updates;

      • Optional limit?: null | number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • name: string
        description

        Max length: 100;

      • Optional nextInvoiceDate?: string
      • Optional noEndingDateFlag?: null | boolean
      • Optional oneTimeFlag?: null | boolean
      • Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional type?: string
      • Optional periodType?: null | "Current" | "Future" | "Both" | "Undefined"
      • Optional projectType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional prorateFirstBill?: null | number

        Format: double

      • Optional prorateFlag?: null | boolean
      • Optional reasonCancelled?: string
        description

        Max length: 100;

      • Optional restrictDepartmentFlag?: null | boolean
      • Optional restrictDownPayment?: null | boolean
      • Optional restrictLocationFlag?: null | boolean
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional sla?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional startDate?: string

        Format: date-time

      • Optional subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional subContractContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxable?: null | boolean
      • Optional topComment?: null | boolean
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workOrder?: string
        description

        Max length: 20;

      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementsByParentIdAdditions

  • postFinanceAgreementsByParentIdAdditions(parentId: number, addition: { _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }): Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

  • Parameters

    • parentId: number
    • addition: { _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"
      • billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"
      • Optional billedQuantity?: null | number

        Format: double

      • Optional cancelledDate?: string

        Format: date-time

      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional description?: string
      • Optional effectiveDate?: string

        Format: date-time

      • Optional extCost?: null | number

        Format: double

      • Optional extPrice?: null | number

        Format: double

      • Optional extendedProrateCost?: null | number

        Format: double

      • Optional extendedProratePrice?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional invoiceDescription?: string
        description

        Max length: 6000;

      • Optional invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional description?: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional showPriceFlag?: boolean
        • Optional showSubItemsFlag?: boolean
      • Optional lessIncluded?: null | number

        Format: double

      • Optional margin?: null | number

        Format: double

      • Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional prorateCost?: null | number

        Format: double

      • Optional prorateCurrentPeriodFlag?: null | boolean
      • Optional proratePrice?: null | number

        Format: double

      • Optional purchaseItemFlag?: null | boolean
      • Optional quantity?: null | number

        Format: double

      • Optional sequenceNumber?: null | number

        Format: double

      • Optional serialNumber?: string
        description

        Max length: 50;

      • Optional specialOrderFlag?: null | boolean
      • Optional taxableFlag?: null | boolean
      • Optional unitCost?: null | number

        Format: double

      • Optional unitPrice?: null | number

        Format: double

      • Optional uom?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

postFinanceAgreementsByParentIdAdjustments

  • postFinanceAgreementsByParentIdAdjustments(parentId: number, adjustment: { _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }): Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

  • Parameters

    • parentId: number
    • adjustment: { _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional amount?: null | number

        Format: double

      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional description?: string
        description

        Max length: 1000;

      • Optional effectiveDate?: string

        Format: date-time

      • Optional id?: number

        Format: int32

    Returns Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

postFinanceAgreementsByParentIdBoardDefaults

  • postFinanceAgreementsByParentIdBoardDefaults(parentId: number, boardDefault: { _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • boardDefault: { _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional board?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional serviceType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementsByParentIdConfigurations

  • postFinanceAgreementsByParentIdConfigurations(parentId: number, configuration: { _info?: {}; deviceIdentifier?: string; id?: null | number }): Promise<{ _info?: {}; deviceIdentifier?: string; id?: null | number }>

  • Parameters

    • parentId: number
    • configuration: { _info?: {}; deviceIdentifier?: string; id?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional deviceIdentifier?: string
      • Optional id?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; deviceIdentifier?: string; id?: null | number }>

postFinanceAgreementsByParentIdSites

  • postFinanceAgreementsByParentIdSites(parentId: number, site: { _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • site: { _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional id?: number

        Format: int32

      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementsByParentIdWorkRoleExclusions

  • postFinanceAgreementsByParentIdWorkRoleExclusions(parentId: number, workRoleExclusion: { _info?: {}; agreementId?: null | number; id?: number; workRole?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; id?: number; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workRoleExclusion: { _info?: {}; agreementId?: null | number; id?: number; workRole?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; id?: number; workRole?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementsByParentIdWorkTypeExclusions

  • postFinanceAgreementsByParentIdWorkTypeExclusions(parentId: number, workTypeExclusion: { _info?: {}; agreementId?: null | number; id?: number; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; id?: number; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workTypeExclusion: { _info?: {}; agreementId?: null | number; id?: number; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; id?: number; workType?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementsByParentIdWorkroles

  • postFinanceAgreementsByParentIdWorkroles(parentId: number, workRole: { _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workRole: { _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional id?: number

        Format: int32

      • Optional limitTo?: null | number

        Format: double

      • Optional locationId?: null | number

        Format: int32

      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementsByParentIdWorktypes

  • postFinanceAgreementsByParentIdWorktypes(parentId: number, workType: { _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workType: { _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional agreementLimit?: null | number

        Format: double

      • billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional hoursMax?: null | number

        Format: double

      • Optional hoursMin?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional locationId?: null | number

        Format: int32

      • Optional overageRate?: null | number

        Format: double

      • Optional overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional roundBillHours?: null | number

        Format: double

      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceAgreementsTypes

  • postFinanceAgreementsTypes(agreementType: { _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • agreementType: { _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllWorkRoleExclusions?: null | boolean
      • Optional addAllWorkTypeExclusions?: null | boolean
      • Optional allowOverrunsFlag?: null | boolean
      • Optional applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"
      • Optional applicationLimit?: null | number

        Format: double

      • Optional applicationUnits?: null | "Amount" | "Hours" | "Incidents"
      • Optional applicationUnlimitedFlag?: null | boolean
      • Optional autoInvoiceFlag?: null | boolean
      • Optional billAmount?: null | number

        Format: double

      • billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional billOneTimeFlag?: null | boolean
      • billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional billableExpenseInvoiceFlag?: null | boolean
      • Optional billableProductInvoiceFlag?: null | boolean
      • Optional billableTimeInvoiceFlag?: null | boolean
      • Optional billingCycle?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bottomCommentFlag?: null | boolean
      • Optional carryOverUnusedFlag?: null | boolean
      • Optional chargeToFirmFlag?: null | boolean
      • Optional compHourlyRate?: null | number

        Format: double

      • Optional compLimitAmount?: null | number

        Format: double

      • Optional copyWorkRolesFlag?: null | boolean
      • Optional copyWorkTypesFlag?: null | boolean
      • Optional coverAgreementExpenseFlag?: null | boolean
      • Optional coverAgreementProductFlag?: null | boolean
      • Optional coverAgreementTimeFlag?: null | boolean
      • Optional coverSalesTaxFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional emailTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"
      • employeeCompRate: null | "Actual" | "Hourly"
      • Optional exclusionWorkRoleIds?: number[]
      • Optional exclusionWorkTypeIds?: number[]
      • Optional expireWhenZero?: null | boolean
      • Optional expiredDays?: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional integrationXRef?: string
        description

        Max length: 50;

      • Optional invoiceDescription?: string
        description

        Max length: 4000;

      • Optional invoicePreSuffix?: string
        description

        Max length: 5;

      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • invoicingCycle: null | "ContractYear" | "CalendarYear"
      • Optional limit?: null | number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • name: string
        description

        Max length: 50;

      • Optional oneTimeFlag?: null | boolean
      • Optional prePaymentFlag?: null | boolean
      • Optional prefixSuffixOption?: null | "Prefix" | "Suffix"
      • Optional projectType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional prorateFlag?: null | boolean
      • Optional removeAllWorkRoleExclusions?: null | boolean
      • Optional removeAllWorkTypeExclusions?: null | boolean
      • Optional restrictDepartmentFlag?: null | boolean
      • Optional restrictDownPaymentFlag?: null | boolean
      • Optional restrictLocationFlag?: null | boolean
      • Optional sla?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableFlag?: null | boolean
      • Optional topCommentFlag?: null | boolean
      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceBillingCycles

  • postFinanceBillingCycles(billingCycle: { _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }): Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

  • Parameters

    • billingCycle: { _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"
      • Optional defaultFlag?: boolean
      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 5;

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

postFinanceBillingSetups

  • postFinanceBillingSetups(billingSetup: { _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }): Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

  • Parameters

    • billingSetup: { _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressOne?: string
        description

        Max length: 50;

      • Optional addressTwo?: string
        description

        Max length: 50;

      • Optional agreementInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional allowRestrictedDeptOnRoutingFlag?: null | boolean
      • Optional billProductAfterShipFlag?: null | boolean
      • Optional billProjectCompleteFlag?: null | boolean
      • Optional billProjectUnapprovedFlag?: null | boolean
      • Optional billSalesOrderCompleteFlag?: null | boolean
      • Optional billTicketCompleteFlag?: null | boolean
      • Optional billTicketSeparatelyFlag?: null | boolean
      • Optional billTicketUnapprovedFlag?: null | boolean
      • Optional businessNumber?: string
        description

        Max length: 50;

      • Optional chargeAdjToFirmFlag?: null | boolean
      • Optional city?: string
        description

        Max length: 50;

      • Optional companyCode?: string
        description

        Max length: 250;

      • Optional copyAgreementProductsFlag?: null | boolean
      • Optional copyNonServiceProductsFlag?: null | boolean
      • Optional copyServiceProductsFlag?: null | boolean
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customLabel?: string
        description

        Max length: 50;

      • Optional customText?: string
        description

        Max length: 500;

      • Optional deliveryReceiptFlag?: null | boolean
      • Optional disableRoutingEmailFlag?: null | boolean
      • Optional displayTaxFlag?: null | boolean
      • Optional downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • emailTemplate: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional excludeAvalaraFlag?: null | boolean
      • Optional excludeDoNotBillExpenseFlag?: null | boolean
      • Optional excludeDoNotBillProductFlag?: null | boolean
      • Optional excludeDoNotBillTimeFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional invoiceFooter?: string
        description

        Max length: 500;

      • invoiceTitle: string
        description

        Max length: 50;

      • Optional localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • location: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional miscInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional noWatermarkFlag?: null | boolean
      • Optional overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • payableName: string
        description

        Max length: 50;

      • Optional phone?: string
        description

        Max length: 15;

      • Optional prefixSuffixFlag?: null | "Prefix" | "Suffix"
      • Optional prefixSuffixText?: string
        description

        Max length: 5;

      • Optional printLogoFlag?: null | boolean
      • Optional progressInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional progressTimeFlag?: null | boolean
      • Optional quoteFooter?: string
        description

        Max length: 1000;

      • Optional readReceiptFlag?: null | boolean
      • remitName: string
        description

        Max length: 50;

      • Optional restrictDownpaymentFlag?: null | boolean
      • Optional restrictProjectDownpaymentFlag?: null | boolean
      • Optional salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional topcomment?: string
        description

        Max length: 4000;

      • Optional zip?: string
        description

        Max length: 12;

    Returns Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

postFinanceBillingSetupsByParentIdRoutings

  • postFinanceBillingSetupsByParentIdRoutings(parentId: number, billingSetupRouting: { _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }): Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

  • Parameters

    • parentId: number
    • billingSetupRouting: { _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"
      • sequenceNumber: null | number

        Format: int32

    Returns Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

postFinanceBillingStatuses

  • postFinanceBillingStatuses(billingStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

  • Parameters

    • billingStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional closedFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 30;

      • Optional sentFlag?: null | boolean
      • Optional sortOrder?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

postFinanceBillingTerms

  • postFinanceBillingTerms(billingTerms: { _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }>

  • Parameters

    • billingTerms: { _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • dueDays: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional termsXref?: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }>

postFinanceCurrencies

  • postFinanceCurrencies(currency: { _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }): Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

  • Parameters

    • currency: { _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional currencyCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • currencyIdentifier: string
        description

        Max length: 10;

      • Optional decimalSeparator?: string
        description

        Max length: 1;

      • Optional displayIdFlag?: null | boolean
      • Optional displaySymbolFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional negativeParenthesesFlag?: null | boolean
      • Optional numberOfDecimals?: null | number

        Format: int32

      • Optional reportFormat?: string
      • Optional rightAlign?: null | boolean
      • Optional symbol?: string
        description

        Max length: 10;

      • Optional thousandsSeparator?: string
        description

        Max length: 1;

    Returns Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

postFinanceDeliveryMethods

  • postFinanceDeliveryMethods(deliveryMethod: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

  • Parameters

    • deliveryMethod: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional emailFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional integrationActiveFlag?: null | boolean
      • Optional integrationEmailFlag?: null | boolean
      • Optional integrationPrintFlag?: null | boolean
      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

postFinanceGlAccounts

  • postFinanceGlAccounts(glAccount: { _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

  • Parameters

    • glAccount: { _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional cogs1?: string
        description

        Max length: 255;

      • Optional cogs10?: string
        description

        Max length: 255;

      • Optional cogs2?: string
        description

        Max length: 255;

      • Optional cogs3?: string
        description

        Max length: 255;

      • Optional cogs4?: string
        description

        Max length: 255;

      • Optional cogs5?: string
        description

        Max length: 255;

      • Optional cogs6?: string
        description

        Max length: 255;

      • Optional cogs7?: string
        description

        Max length: 255;

      • Optional cogs8?: string
        description

        Max length: 255;

      • Optional cogs9?: string
        description

        Max length: 255;

      • glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"
      • Optional id?: number

        Format: int32

      • Optional inventory?: string
        description

        Max length: 255;

      • mappedRecord: { id?: null | number; name?: string }
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • mappedType: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional productId?: string
        description

        Max length: 255;

      • Optional salesCode?: string
        description

        Max length: 255;

      • Optional segment1?: string
        description

        Max length: 255;

      • Optional segment10?: string
        description

        Max length: 255;

      • Optional segment2?: string
        description

        Max length: 255;

      • Optional segment3?: string
        description

        Max length: 255;

      • Optional segment4?: string
        description

        Max length: 255;

      • Optional segment5?: string
        description

        Max length: 255;

      • Optional segment6?: string
        description

        Max length: 255;

      • Optional segment7?: string
        description

        Max length: 255;

      • Optional segment8?: string
        description

        Max length: 255;

      • Optional segment9?: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

postFinanceGlpaths

  • postFinanceGlpaths(gLPath: { _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }): Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

  • Parameters

    • gLPath: { _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional databaseName?: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional lastPaymentSync?: string

        Format: date-time

      • Optional lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional path?: string
        description

        Max length: 255;

      • Optional sqlServerName?: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

postFinanceInvoiceEmailTemplates

  • postFinanceInvoiceEmailTemplates(invoiceEmailTemplate: { _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }): Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

  • Parameters

    • invoiceEmailTemplate: { _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional attachInvoiceFlag?: null | boolean
      • Optional body?: string
      • Optional copySenderFlag?: null | boolean
      • Optional emailAddress?: string
        description

        From fields (first name, last name, email address) are required if useSenderFlag is false Max length: 100;

      • Optional firstName?: string
        description

        From fields (first name, last name, email address) are required if useSenderFlag is false Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional invoiceStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional lastName?: string
        description

        From fields (first name, last name, email address) are required if useSenderFlag is false Max length: 100;

      • name: string
        description

        Max length: 50;

      • Optional serviceSurvey?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • subject: string
        description

        Max length: 200;

      • Optional useSenderFlag?: null | boolean

    Returns Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

postFinanceInvoiceTemplates

  • postFinanceInvoiceTemplates(invoiceTemplate: { _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }): Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

  • Parameters

    • invoiceTemplate: { _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional adjustmentAgrTypeVisibleFlag?: null | boolean
      • Optional adjustmentAmountCaption?: string
        description

        Max length: 50;

      • Optional adjustmentAmountVisibleFlag?: null | boolean
      • Optional adjustmentDescriptionCaption?: string
        description

        Max length: 50;

      • Optional adjustmentDescriptionVisibleFlag?: null | boolean
      • Optional adjustmentPriceCaption?: string
        description

        Max length: 50;

      • Optional adjustmentPriceVisibleFlag?: null | boolean
      • Optional adjustmentQuantityCaption?: string
        description

        Max length: 50;

      • Optional adjustmentQuantityVisibleFlag?: null | boolean
      • Optional adjustmentTotalVisibleFlag?: null | boolean
      • Optional creditCreditAmountCaption?: string
        description

        Max length: 50;

      • Optional creditCreditAmountVisibleFlag?: null | boolean
      • Optional creditRemainingAmountCaption?: string
        description

        Max length: 50;

      • Optional creditRemainingAmountVisibleFlag?: null | boolean
      • Optional currencyIdVisibleFlag?: null | boolean
      • Optional currencySymbolVisibleFlag?: null | boolean
      • Optional expenseDetailAgreementExtAmountVisibleFlag?: null | boolean
      • Optional expenseDetailAgreementVisibleFlag?: null | boolean
      • Optional expenseDetailBillableVisibleFlag?: null | boolean
      • Optional expenseDetailContactsVisibleFlag?: null | boolean
      • Optional expenseDetailExtAmountVisibleFlag?: null | boolean
      • Optional expenseDetailMembersVisibleFlag?: null | boolean
      • Optional expenseDetailNonbillableCaption?: string
        description

        Max length: 50;

      • Optional expenseDetailNotesVisibleFlag?: null | boolean
      • Optional expenseDetailPmPhaseVisibleFlag?: null | boolean
      • Optional expenseDetailPmSummaryVisibleFlag?: null | boolean
      • Optional expenseDetailPrimarySortDirection?: string
      • Optional expenseDetailPrimarySortField?: string
      • Optional expenseDetailSecondarySortDirection?: string
      • Optional expenseDetailSecondarySortField?: string
      • Optional expenseDetailSrAddressVisibleFlag?: null | boolean
      • Optional expenseDetailSrContactVisibleFlag?: null | boolean
      • Optional expenseDetailSrTicketSummaryVisibleFlag?: null | boolean
      • Optional expenseDetailSubtotalVisibleFlag?: null | boolean
      • Optional expenseDetailTicketNumberVisibleFlag?: null | boolean
      • Optional expenseDetailVisibleFlag?: null | boolean
      • Optional expensesAmountCaption?: string
        description

        Max length: 50;

      • Optional expensesAmountVisibleFlag?: null | boolean
      • Optional expensesCollapsedFlag?: null | boolean
      • Optional expensesStaffCaption?: string
        description

        Max length: 50;

      • Optional expensesStaffVisibleFlag?: null | boolean
      • Optional expensesTotalVisibleFlag?: null | boolean
      • Optional expensesTypeCaption?: string
        description

        Max length: 50;

      • Optional expensesTypeVisibleFlag?: null | boolean
      • Optional headerAccountCaption?: string
        description

        Max length: 50;

      • Optional headerAccountVisibleFlag?: null | boolean
      • Optional headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"
      • Optional headerDueDateCaption?: string
        description

        Max length: 50;

      • Optional headerDueDateVisibleFlag?: null | boolean
      • Optional headerHoursBasedExtendedAmountVisibleFlag?: null | boolean
      • Optional headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"
      • Optional headerPoNumberCaption?: string
        description

        Max length: 50;

      • Optional headerPoNumberVisibleFlag?: null | boolean
      • Optional headerReferenceCaption?: string
        description

        Max length: 50;

      • Optional headerReferenceVisibleFlag?: null | boolean
      • Optional headerShipToCaption?: string
        description

        Max length: 50;

      • Optional headerShipToVisibleFlag?: null | boolean
      • Optional headerTaxIdCaption?: string
        description

        Max length: 50;

      • Optional headerTaxIdVisibleFlag?: null | boolean
      • Optional headerTermsCaption?: string
        description

        Max length: 50;

      • Optional headerTermsVisibleFlag?: null | boolean
      • Optional headerTitleCaption?: string
        description

        Max length: 50;

      • Optional headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"
      • Optional headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"
      • Optional headerTitleVisibleFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional invoiceBalanceDueCaption?: string
        description

        Max length: 50;

      • Optional invoiceBalanceDueVisibleFlag?: null | boolean
      • Optional invoiceCreditAmountCaption?: string
        description

        Max length: 50;

      • Optional invoiceCreditAmountVisibleFlag?: null | boolean
      • Optional invoicePaymentAmountCaption?: string
        description

        Max length: 50;

      • Optional invoicePaymentAmountVisibleFlag?: null | boolean
      • Optional logoVisibleFlag?: null | boolean
      • Optional marginBottom?: null | number

        Format: double

      • Optional marginLeft?: null | number

        Format: double

      • Optional marginRight?: null | number

        Format: double

      • Optional marginTop?: null | number

        Format: double

      • name: string
        description

        Max length: 50;

      • Optional otherChargesAmountCaption?: string
        description

        Max length: 50;

      • Optional otherChargesAmountVisibleFlag?: null | boolean
      • Optional otherChargesCollapsedFlag?: null | boolean
      • Optional otherChargesDescriptionCaption?: string
        description

        Max length: 50;

      • Optional otherChargesDescriptionVisibleFlag?: null | boolean
      • Optional otherChargesDisplaySixDecimals?: null | boolean
      • Optional otherChargesItemIdVisibleFlag?: null | boolean
      • Optional otherChargesPriceCaption?: string
        description

        Max length: 50;

      • Optional otherChargesPriceVisibleFlag?: null | boolean
      • Optional otherChargesQuantityCaption?: string
        description

        Max length: 50;

      • Optional otherChargesQuantityVisibleFlag?: null | boolean
      • Optional otherChargesSerialNumberVisibleFlag?: null | boolean
      • Optional otherChargesTotalVisibleFlag?: null | boolean
      • Optional payableCaption?: string
        description

        Max length: 1000;

      • Optional portalFlag?: null | boolean
      • Optional projectHeaderAmountCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderAmountVisibleFlag?: null | boolean
      • Optional projectHeaderBillingMethodCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderBillingMethodVisibleFlag?: null | boolean
      • Optional projectHeaderBillingTypeCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderBillingTypeVisibleFlag?: null | boolean
      • Optional projectHeaderCompanyNameCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderCompanyNameVisibleFlag?: null | boolean
      • Optional projectHeaderContactNameCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderContactNameVisibleFlag?: null | boolean
      • Optional projectHeaderOriginalDownpaymentCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean
      • Optional projectHeaderProjectNameCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderProjectNameVisibleFlag?: null | boolean
      • Optional remitToVisibleFlag?: null | boolean
      • Optional serviceHeaderAmountCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderAmountVisibleFlag?: null | boolean
      • Optional serviceHeaderBillingMethodCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderBillingMethodVisibleFlag?: null | boolean
      • Optional serviceHeaderBundledTicketsVisibleFlag?: null | boolean
      • Optional serviceHeaderClosedTasksVisibleFlag?: null | boolean
      • Optional serviceHeaderCompanyNameCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderCompanyNameVisibleFlag?: null | boolean
      • Optional serviceHeaderContactNameCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderContactNameVisibleFlag?: null | boolean
      • Optional serviceHeaderDetailDescriptionCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderDetailDescriptionVisibleFlag?: null | boolean
      • Optional serviceHeaderOpenTasksVisibleFlag?: null | boolean
      • Optional serviceHeaderResolutionCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderResolutionVisibleFlag?: null | boolean
      • Optional serviceHeaderSummaryCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderSummaryVisibleFlag?: null | boolean
      • Optional serviceHeaderTicketNumberCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderTicketNumberVisibleFlag?: null | boolean
      • Optional servicesAmountCaption?: string
        description

        Max length: 50;

      • Optional servicesAmountVisibleFlag?: null | boolean
      • Optional servicesCollapsedFlag?: null | boolean
      • Optional servicesHoursCaption?: string
        description

        Max length: 50;

      • Optional servicesHoursVisibleFlag?: null | boolean
      • Optional servicesMemberNameCaption?: string
        description

        Max length: 50;

      • Optional servicesMemberNameVisibleFlag?: null | boolean
      • Optional servicesRateCaption?: string
        description

        Max length: 50;

      • Optional servicesRateVisibleFlag?: null | boolean
      • Optional servicesStaffCaption?: string
        description

        Max length: 50;

      • Optional servicesStaffVisibleFlag?: null | boolean
      • Optional servicesTotalVisibleFlag?: null | boolean
      • Optional servicesWorkRoleCaption?: string
        description

        Max length: 50;

      • Optional servicesWorkRoleVisibleFlag?: null | boolean
      • Optional servicesWorkTypeCaption?: string
        description

        Max length: 50;

      • Optional servicesWorkTypeVisibleFlag?: null | boolean
      • Optional timeDetailAgreementVisibleFlag?: null | boolean
      • Optional timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean
      • Optional timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean
      • Optional timeDetailAmountBasedHoursVisibleFlag?: null | boolean
      • Optional timeDetailBillableVisibleFlag?: null | boolean
      • Optional timeDetailContactsVisibleFlag?: null | boolean
      • Optional timeDetailDatesVisibleFlag?: null | boolean
      • Optional timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean
      • Optional timeDetailExtendedAmountVisibleFlag?: null | boolean
      • Optional timeDetailHourlyRateVisibleFlag?: null | boolean
      • Optional timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean
      • Optional timeDetailHoursBasedHoursVisibleFlag?: null | boolean
      • Optional timeDetailHoursVisibleFlag?: null | boolean
      • Optional timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean
      • Optional timeDetailMembersVisibleFlag?: null | boolean
      • Optional timeDetailNonBillableCaption?: string
        description

        Max length: 50;

      • Optional timeDetailNotesVisibleFlag?: null | boolean
      • Optional timeDetailPmPhaseVisibleFlag?: null | boolean
      • Optional timeDetailPmSummaryVisibleFlag?: null | boolean
      • Optional timeDetailPrimarySortDirection?: string
      • Optional timeDetailPrimarySortField?: string
      • Optional timeDetailSRAddressVisibleFlag?: null | boolean
      • Optional timeDetailSRContactVisibleFlag?: null | boolean
      • Optional timeDetailSRTicketSummaryVisibleFlag?: null | boolean
      • Optional timeDetailSecondarySortDirection?: string
      • Optional timeDetailSecondarySortField?: string
      • Optional timeDetailStartEndTimeVisibleFlag?: null | boolean
      • Optional timeDetailSubtotalVisibleFlag?: null | boolean
      • Optional timeDetailTicketNumberVisibleFlag?: null | boolean
      • Optional timeDetailVisibleFlag?: null | boolean

    Returns Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

postFinanceInvoices

  • postFinanceInvoices(invoice: { _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }): Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

  • Parameters

    • invoice: { _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountNumber?: string
      • Optional addToBatchEmailList?: null | boolean
      • Optional adjustedBy?: string
      • Optional adjustmentReason?: string
      • Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional type?: string
      • Optional agreementAmount?: null | number

        Format: double

      • Optional applyToId?: null | number

        Format: int32

      • Optional applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"
      • Optional attention?: string
        description

        Max length: 60;

      • Optional balance?: null | number

        Format: double

      • Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional billingSetupReference?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingSiteAddressLine1?: string
      • Optional billingSiteAddressLine2?: string
      • Optional billingSiteCity?: string
      • Optional billingSiteCountry?: string
      • Optional billingSiteState?: string
      • Optional billingSiteZip?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bottomComment?: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional credits?: null | number

        Format: double

      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional customerPO?: string
        description

        Max length: 50;

      • Optional date?: string

        Format: date-time

      • Optional departmentId?: null | number

        Format: int32

        description

        departmentId is only required for special invoices

      • Optional downpaymentApplied?: null | number

        Format: double

      • Optional downpaymentPreviouslyTaxedFlag?: null | boolean
      • Optional dueDate?: string

        Format: date-time

      • Optional emailTemplateId?: null | number

        Format: int32

        description

        Can be obtained via InvoiceEmailTemplate report

      • Optional expenseTotal?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional internalNotes?: string
      • Optional invoiceNumber?: string
        description

        Max length: 15; Required On Updates;

      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional locationId?: null | number

        Format: int32

        description

        Required On Updates;

      • Optional overrideDownPaymentAmountFlag?: null | boolean
      • Optional payments?: null | number

        Format: double

      • Optional phase?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional previousProgressApplied?: null | number

        Format: double

      • Optional productTotal?: null | number

        Format: double

      • Optional project?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional reference?: string
        description

        Max length: 50;

      • Optional remainingDownpayment?: null | number

        Format: double

      • Optional restrictDownpaymentFlag?: null | boolean
      • Optional salesOrder?: { _info?: {}; id?: null | number; identifier?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
      • Optional salesTax?: null | number

        Format: double

      • Optional serviceAdjustmentAmount?: null | number

        Format: double

      • Optional serviceTotal?: null | number

        Format: double

      • Optional shipToAttention?: string
        description

        Max length: 60;

      • Optional shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional shippingSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional shippingSiteAddressLine1?: string
      • Optional shippingSiteAddressLine2?: string
      • Optional shippingSiteCity?: string
      • Optional shippingSiteCountry?: string
      • Optional shippingSiteState?: string
      • Optional shippingSiteZip?: string
      • Optional specialInvoiceFlag?: null | boolean
      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional subtotal?: null | number

        Format: double

      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableFlag?: null | boolean
      • Optional templateSetupId?: null | number

        Format: int32

        description

        Can be obtained via InvoiceTemplate report

      • Optional territoryId?: null | number

        Format: int32

      • Optional ticket?: { _info?: {}; id?: null | number; summary?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional summary?: string
      • Optional topComment?: string
      • Optional total?: null | number

        Format: double

      • type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"

    Returns Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

postFinanceInvoicesByParentIdPayments

  • postFinanceInvoicesByParentIdPayments(parentId: number, payment: { _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }): Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

  • Parameters

    • parentId: number
    • payment: { _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional amount?: null | number

        Format: double

      • Optional appliedBy?: string
      • Optional credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional applyToType?: string
        • Optional billingType?: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
      • Optional id?: number

        Format: int32

      • Optional invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional applyToType?: string
        • Optional billingType?: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
      • Optional paymentDate?: string

        Format: date-time

      • Optional type?: string

    Returns Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

postFinanceTaxCodes

  • postFinanceTaxCodes(taxCode: { _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }): Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

  • Parameters

    • taxCode: { _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllExpenseTypes?: null | boolean
      • Optional addAllProductTypes?: null | boolean
      • Optional addAllWorkRoles?: null | boolean
      • Optional canadaCalculateGSTFlag?: null | boolean
      • Optional cancelDate?: string

        Format: date-time

      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional displayOnInvoiceFlag?: null | boolean
      • effectiveDate: string

        Format: date-time

      • Optional expenseTypeIds?: number[]
        description

        Array of expense type exemptions for the tax code

      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 8;

      • invoiceCaption: string
        description

        Max length: 25;

      • Optional levelFiveAgencyXref?: string
        description

        Max length: 100;

      • Optional levelFiveApplySingleUnitFlag?: null | boolean
      • Optional levelFiveApplySingleUnitMax?: null | number

        Format: double

      • Optional levelFiveApplySingleUnitMin?: null | number

        Format: double

      • Optional levelFiveCaption?: string
        description

        Max length: 25;

      • Optional levelFiveExpensesFlag?: null | boolean
      • Optional levelFiveProductsFlag?: null | boolean
      • Optional levelFiveRate?: null | number

        Format: double

      • Optional levelFiveRateType?: null | "Percent" | "Amount"
      • Optional levelFiveServicesFlag?: null | boolean
      • Optional levelFiveTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelFiveTaxableMax?: null | number

        Format: double

      • Optional levelFourAgencyXref?: string
        description

        Max length: 100;

      • Optional levelFourApplySingleUnitFlag?: null | boolean
      • Optional levelFourApplySingleUnitMax?: null | number

        Format: double

      • Optional levelFourApplySingleUnitMin?: null | number

        Format: double

      • Optional levelFourCaption?: string
        description

        Max length: 25;

      • Optional levelFourExpensesFlag?: null | boolean
      • Optional levelFourProductsFlag?: null | boolean
      • Optional levelFourRate?: null | number

        Format: double

      • Optional levelFourRateType?: null | "Percent" | "Amount"
      • Optional levelFourServicesFlag?: null | boolean
      • Optional levelFourTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelFourTaxableMax?: null | number

        Format: double

      • Optional levelOneAgencyXref?: string
        description

        Max length: 100;

      • Optional levelOneApplySingleUnitFlag?: null | boolean
      • Optional levelOneApplySingleUnitMax?: null | number

        Format: double

      • Optional levelOneApplySingleUnitMin?: null | number

        Format: double

      • Optional levelOneCaption?: string
        description

        Max length: 25;

      • Optional levelOneExpensesFlag?: null | boolean
      • Optional levelOneProductsFlag?: null | boolean
      • Optional levelOneRate?: null | number

        Format: double

      • Optional levelOneRateType?: null | "Percent" | "Amount"
      • Optional levelOneServicesFlag?: null | boolean
      • Optional levelOneTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelOneTaxableMax?: null | number

        Format: double

      • Optional levelSixAgencyXref?: string
        description

        Max length: 100;

      • Optional levelSixApplySingleUnitFlag?: null | boolean
      • Optional levelSixApplySingleUnitMax?: null | number

        Format: double

      • Optional levelSixApplySingleUnitMin?: null | number

        Format: double

      • Optional levelSixCaption?: string
        description

        Max length: 25;

      • Optional levelSixExpensesFlag?: null | boolean
      • Optional levelSixProductsFlag?: null | boolean
      • Optional levelSixRate?: null | number

        Format: double

      • Optional levelSixRateType?: null | "Percent" | "Amount"
      • Optional levelSixServicesFlag?: null | boolean
      • Optional levelSixTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelSixTaxableMax?: null | number

        Format: double

      • Optional levelThreeAgencyXref?: string
        description

        Max length: 100;

      • Optional levelThreeApplySingleUnitFlag?: null | boolean
      • Optional levelThreeApplySingleUnitMax?: null | number

        Format: double

      • Optional levelThreeApplySingleUnitMin?: null | number

        Format: double

      • Optional levelThreeCaption?: string
        description

        Max length: 25;

      • Optional levelThreeExpensesFlag?: null | boolean
      • Optional levelThreeProductsFlag?: null | boolean
      • Optional levelThreeRate?: null | number

        Format: double

      • Optional levelThreeRateType?: null | "Percent" | "Amount"
      • Optional levelThreeServicesFlag?: null | boolean
      • Optional levelThreeTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelThreeTaxableMax?: null | number

        Format: double

      • Optional levelTwoAgencyXref?: string
        description

        Max length: 100;

      • Optional levelTwoApplySingleUnitFlag?: null | boolean
      • Optional levelTwoApplySingleUnitMax?: null | number

        Format: double

      • Optional levelTwoApplySingleUnitMin?: null | number

        Format: double

      • Optional levelTwoCaption?: string
        description

        Max length: 25;

      • Optional levelTwoExpensesFlag?: null | boolean
      • Optional levelTwoProductsFlag?: null | boolean
      • Optional levelTwoRate?: null | number

        Format: double

      • Optional levelTwoRateType?: null | "Percent" | "Amount"
      • Optional levelTwoServicesFlag?: null | boolean
      • Optional levelTwoTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelTwoTaxableMax?: null | number

        Format: double

      • Optional productTypeIds?: number[]
        description

        Array of product type exemptions for the tax code

      • Optional removeAllExpenseTypes?: null | boolean
      • Optional removeAllProductTypes?: null | boolean
      • Optional removeAllWorkRoles?: null | boolean
      • Optional workRoleIds?: number[]
        description

        Array of work role exemptions for the tax code

    Returns Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

postFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevels

  • postFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevels(parentId: number, grandparentId: number, taxableExpenseTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • taxableExpenseTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevels

  • postFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevels(parentId: number, grandparentId: number, taxableProductTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • taxableProductTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevels

  • postFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevels(parentId: number, grandparentId: number, taxableXRefLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • taxableXRefLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevels

  • postFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevels(parentId: number, grandparentId: number, taxableWorkRoleLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • grandparentId: number
    • taxableWorkRoleLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

postFinanceTaxCodesByIdCopy

  • postFinanceTaxCodesByIdCopy(id: number): Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

  • Parameters

    • id: number

    Returns Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

postFinanceTaxCodesByParentIdExpenseTypeExemptions

  • postFinanceTaxCodesByParentIdExpenseTypeExemptions(parentId: number, expenseTypeExemption: { _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }): Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

  • Parameters

    • parentId: number
    • expenseTypeExemption: { _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • expenseType: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional taxableLevels?: number[]

    Returns Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

postFinanceTaxCodesByParentIdProductTypeExemptions

  • postFinanceTaxCodesByParentIdProductTypeExemptions(parentId: number, productTypeExemption: { _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }): Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    • parentId: number
    • productTypeExemption: { _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • productType: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableLevels?: number[]

    Returns Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

postFinanceTaxCodesByParentIdTaxCodeLevels

  • postFinanceTaxCodesByParentIdTaxCodeLevels(parentId: number, taxCodeLevel: { _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }): Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

  • Parameters

    • parentId: number
    • taxCodeLevel: { _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agencyXref?: string
        description

        Max length: 100;

      • Optional caption?: string
        description

        Max length: 25;

      • Optional id?: number

        Format: int32

      • rateType: null | "Percent" | "Amount"
      • Optional singleUnitFlag?: null | boolean
      • Optional singleUnitMaximum?: null | number

        Format: double

      • Optional singleUnitMinimum?: null | number

        Format: double

      • Optional taxCodeXref?: string
        description

        Max length: 50;

      • Optional taxExpensesFlag?: null | boolean
      • Optional taxLevel?: number

        Format: int32

      • Optional taxProductsFlag?: null | boolean
      • taxRate: null | number

        Format: double

      • Optional taxServicesFlag?: null | boolean
      • Optional taxableMax?: null | number

        Format: double

    Returns Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

postFinanceTaxCodesByParentIdTaxCodeXRefs

  • postFinanceTaxCodesByParentIdTaxCodeXRefs(parentId: number, taxCodeXRef: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    • parentId: number
    • taxCodeXRef: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional levelFive?: null | "NonTaxable" | "Taxable"
      • Optional levelFour?: null | "NonTaxable" | "Taxable"
      • Optional levelOne?: null | "NonTaxable" | "Taxable"
      • Optional levelSix?: null | "NonTaxable" | "Taxable"
      • Optional levelThree?: null | "NonTaxable" | "Taxable"
      • Optional levelTwo?: null | "NonTaxable" | "Taxable"
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableLevels?: number[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

postFinanceTaxCodesByParentIdWorkRoleExemptions

  • postFinanceTaxCodesByParentIdWorkRoleExemptions(parentId: number, workRoleExemption: { _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • parentId: number
    • workRoleExemption: { _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxableLevels?: number[]
      • workRole: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAccountingPackageSetupById

  • putFinanceAccountingPackageSetupById(id: number, accountingPackageSetup: { accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }): Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }>

  • Parameters

    • id: number
    • accountingPackageSetup: { accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }
      • Optional accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"
        • Optional name?: string
      • Optional directTransferFlag?: null | boolean
      • Optional enableTaxGroupsFlag?: null | boolean
      • Optional expenseFormat?: null | "Default" | "Condensed"
      • Optional id?: number

        Format: int32

      • Optional includeCogsDropShipFlag?: null | boolean
      • Optional includeCogsEntriesFlag?: null | boolean
      • Optional includeExpensesFlag?: null | boolean
      • Optional includeInvoicesFlag?: null | boolean
      • Optional includeItemsFlag?: null | boolean
      • Optional includeSalesTaxFlag?: null | boolean
      • Optional inventorySOHFlag?: null | boolean
      • Optional invoiceFormat?: null | "Default" | "Condensed" | "Detailed"
      • Optional sendComponentAmountFlag?: null | boolean
      • Optional sendUomFlag?: null | boolean
      • Optional suppressMemoFlag?: null | boolean
      • Optional syncPaymentInfoFlag?: null | boolean
      • Optional transferExpensesAsBillFlag?: null | boolean
      • Optional zeroDollarTaxAmountsFlag?: null | boolean

    Returns Promise<{ accountingPackage?: { _info?: {}; id?: null | number; identifier?: null | "QB99" | "Mas200" | "GPlains" | "SBA" | "Mas200v4" | "Other"; name?: string }; directTransferFlag?: null | boolean; enableTaxGroupsFlag?: null | boolean; expenseFormat?: null | "Default" | "Condensed"; id?: number; includeCogsDropShipFlag?: null | boolean; includeCogsEntriesFlag?: null | boolean; includeExpensesFlag?: null | boolean; includeInvoicesFlag?: null | boolean; includeItemsFlag?: null | boolean; includeSalesTaxFlag?: null | boolean; inventorySOHFlag?: null | boolean; invoiceFormat?: null | "Default" | "Condensed" | "Detailed"; sendComponentAmountFlag?: null | boolean; sendUomFlag?: null | boolean; suppressMemoFlag?: null | boolean; syncPaymentInfoFlag?: null | boolean; transferExpensesAsBillFlag?: null | boolean; zeroDollarTaxAmountsFlag?: null | boolean }>

putFinanceAgreementTypesByParentIdBoardDefaultsById

  • putFinanceAgreementTypesByParentIdBoardDefaultsById(id: number, parentId: number, boardDefault: { _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • boardDefault: { _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional board?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional id?: number

        Format: int32

      • location: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional serviceType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; id?: number; location: { _info?: {}; id?: null | number; name?: string }; serviceType?: { _info?: {}; id?: null | number; name?: string }; type?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementTypesByParentIdWorkrolesById

  • putFinanceAgreementTypesByParentIdWorkrolesById(id: number, parentId: number, workRole: { _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • workRole: { _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional id?: number

        Format: int32

      • Optional limitTo?: null | number

        Format: double

      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; type?: { _info?: {}; id?: null | number; name?: string }; workRole?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementTypesByParentIdWorktypesById

  • putFinanceAgreementTypesByParentIdWorktypesById(id: number, parentId: number, workType: { _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • workType: { _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional hoursMax?: null | number

        Format: double

      • Optional hoursMin?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional limitTo?: null | number

        Format: double

      • Optional overageRate?: null | number

        Format: double

      • overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional roundBillHours?: null | number

        Format: double

      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; limitTo?: null | number; overageRate?: null | number; overageRateType: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; type?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementsById

  • putFinanceAgreementsById(id: number, agreement: { _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • agreement: { _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"
      • Optional allowOverruns?: null | boolean
      • Optional applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"
      • Optional applicationLimit?: null | number

        Format: double

      • Optional applicationUnits?: null | "Amount" | "Hours" | "Incidents"
      • Optional applicationUnlimitedFlag?: null | boolean
      • Optional autoInvoiceFlag?: null | boolean
      • Optional billAmount?: null | number

        Format: double

      • Optional billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
        description

        Required On Updates;

      • Optional billOneTimeFlag?: null | boolean
      • Optional billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
        description

        Required On Updates;

      • Optional billStartDate?: string

        Format: date-time

      • Optional billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
        description

        Required On Updates;

      • Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional billToContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billToSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billableExpenseInvoice?: null | boolean
      • Optional billableProductInvoice?: null | boolean
      • Optional billableTimeInvoice?: null | boolean
      • Optional billingCycle?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bottomComment?: null | boolean
      • Optional cancelledFlag?: null | boolean
      • Optional carryOverUnused?: null | boolean
      • Optional chargeToFirm?: null | boolean
      • Optional compHourlyRate?: null | number

        Format: double

      • Optional compLimitAmount?: null | number

        Format: double

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional companyLocation?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional contact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional coverAgreementExpense?: null | boolean
      • Optional coverAgreementProduct?: null | boolean
      • Optional coverAgreementTime?: null | boolean
      • Optional coverSalesTax?: null | boolean
      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional customerPO?: string
        description

        Max length: 50;

      • Optional dateCancelled?: string

        Format: date-time

      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"
      • Optional employeeCompRate?: null | "Actual" | "Hourly"
        description

        Required On Updates;

      • Optional endDate?: string

        Format: date-time

      • Optional expireWhenZero?: null | boolean
      • Optional expiredDays?: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • Optional internalNotes?: string
      • Optional invoiceDescription?: string
      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional invoicingCycle?: null | "ContractYear" | "CalendarYear"
        description

        Required On Updates;

      • Optional limit?: null | number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • name: string
        description

        Max length: 100;

      • Optional nextInvoiceDate?: string
      • Optional noEndingDateFlag?: null | boolean
      • Optional oneTimeFlag?: null | boolean
      • Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional type?: string
      • Optional periodType?: null | "Current" | "Future" | "Both" | "Undefined"
      • Optional projectType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional prorateFirstBill?: null | number

        Format: double

      • Optional prorateFlag?: null | boolean
      • Optional reasonCancelled?: string
        description

        Max length: 100;

      • Optional restrictDepartmentFlag?: null | boolean
      • Optional restrictDownPayment?: null | boolean
      • Optional restrictLocationFlag?: null | boolean
      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional sla?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional startDate?: string

        Format: date-time

      • Optional subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional subContractContact?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxable?: null | boolean
      • Optional topComment?: null | boolean
      • Optional type?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workOrder?: string
        description

        Max length: 20;

      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; allowOverruns?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billStartDate?: string; billTime?: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billToContact?: { _info?: {}; id?: null | number; name?: string }; billToSite?: { _info?: {}; id?: null | number; name?: string }; billableExpenseInvoice?: null | boolean; billableProductInvoice?: null | boolean; billableTimeInvoice?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: null | boolean; cancelledFlag?: null | boolean; carryOverUnused?: null | boolean; chargeToFirm?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; companyLocation?: { _info?: {}; id?: null | number; name?: string }; contact?: { _info?: {}; id?: null | number; name?: string }; coverAgreementExpense?: null | boolean; coverAgreementProduct?: null | boolean; coverAgreementTime?: null | boolean; coverSalesTax?: null | boolean; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; dateCancelled?: string; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; employeeCompNotExceed?: null | "Percent" | "Amount" | "Billing"; employeeCompRate?: null | "Actual" | "Hourly"; endDate?: string; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; internalNotes?: string; invoiceDescription?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle?: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; nextInvoiceDate?: string; noEndingDateFlag?: null | boolean; oneTimeFlag?: null | boolean; opportunity?: { _info?: {}; id?: null | number; name?: string }; parentAgreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; periodType?: null | "Current" | "Future" | "Both" | "Undefined"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFirstBill?: null | number; prorateFlag?: null | boolean; reasonCancelled?: string; restrictDepartmentFlag?: null | boolean; restrictDownPayment?: null | boolean; restrictLocationFlag?: null | boolean; site?: { _info?: {}; id?: null | number; name?: string }; sla?: { _info?: {}; id?: null | number; name?: string }; startDate?: string; subContractCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; subContractContact?: { _info?: {}; id?: null | number; name?: string }; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxable?: null | boolean; topComment?: null | boolean; type?: { _info?: {}; id?: null | number; name?: string }; workOrder?: string; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementsByParentIdAdditionsById

  • putFinanceAgreementsByParentIdAdditionsById(id: number, parentId: number, addition: { _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }): Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

  • Parameters

    • id: number
    • parentId: number
    • addition: { _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"
      • billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"
      • Optional billedQuantity?: null | number

        Format: double

      • Optional cancelledDate?: string

        Format: date-time

      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional description?: string
      • Optional effectiveDate?: string

        Format: date-time

      • Optional extCost?: null | number

        Format: double

      • Optional extPrice?: null | number

        Format: double

      • Optional extendedProrateCost?: null | number

        Format: double

      • Optional extendedProratePrice?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional invoiceDescription?: string
        description

        Max length: 6000;

      • Optional invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional description?: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional showPriceFlag?: boolean
        • Optional showSubItemsFlag?: boolean
      • Optional lessIncluded?: null | number

        Format: double

      • Optional margin?: null | number

        Format: double

      • Optional opportunity?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional serializedFlag?: null | boolean
      • Optional prorateCost?: null | number

        Format: double

      • Optional prorateCurrentPeriodFlag?: null | boolean
      • Optional proratePrice?: null | number

        Format: double

      • Optional purchaseItemFlag?: null | boolean
      • Optional quantity?: null | number

        Format: double

      • Optional sequenceNumber?: null | number

        Format: double

      • Optional serialNumber?: string
        description

        Max length: 50;

      • Optional specialOrderFlag?: null | boolean
      • Optional taxableFlag?: null | boolean
      • Optional unitCost?: null | number

        Format: double

      • Optional unitPrice?: null | number

        Format: double

      • Optional uom?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementStatus?: null | "Active" | "Cancelled" | "Expired" | "Inactive"; billCustomer: null | "Billable" | "DoNotBill" | "NoCharge"; billedQuantity?: null | number; cancelledDate?: string; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; extCost?: null | number; extPrice?: null | number; extendedProrateCost?: null | number; extendedProratePrice?: null | number; id?: number; invoiceDescription?: string; invoiceGrouping?: { _info?: {}; description?: string; id?: null | number; name?: string; showPriceFlag?: boolean; showSubItemsFlag?: boolean }; lessIncluded?: null | number; margin?: null | number; opportunity?: { _info?: {}; id?: null | number; name?: string }; product?: { _info?: {}; id?: null | number; identifier?: string; serializedFlag?: null | boolean }; prorateCost?: null | number; prorateCurrentPeriodFlag?: null | boolean; proratePrice?: null | number; purchaseItemFlag?: null | boolean; quantity?: null | number; sequenceNumber?: null | number; serialNumber?: string; specialOrderFlag?: null | boolean; taxableFlag?: null | boolean; unitCost?: null | number; unitPrice?: null | number; uom?: string }>

putFinanceAgreementsByParentIdAdjustmentsById

  • putFinanceAgreementsByParentIdAdjustmentsById(id: number, parentId: number, adjustment: { _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }): Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

  • Parameters

    • id: number
    • parentId: number
    • adjustment: { _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional amount?: null | number

        Format: double

      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional description?: string
        description

        Max length: 1000;

      • Optional effectiveDate?: string

        Format: date-time

      • Optional id?: number

        Format: int32

    Returns Promise<{ _info?: {}; agreementId?: null | number; amount?: null | number; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; description?: string; effectiveDate?: string; id?: number }>

putFinanceAgreementsByParentIdBoardDefaultsById

  • putFinanceAgreementsByParentIdBoardDefaultsById(id: number, parentId: number, boardDefault: { _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • boardDefault: { _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional board?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional serviceType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; board?: { _info?: {}; id?: null | number; name?: string }; defaultFlag?: null | boolean; id?: number; serviceType?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementsByParentIdSitesById

  • putFinanceAgreementsByParentIdSitesById(id: number, parentId: number, site: { _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • site: { _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional id?: number

        Format: int32

      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; id?: number; site?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementsByParentIdWorkrolesById

  • putFinanceAgreementsByParentIdWorkrolesById(id: number, parentId: number, workRole: { _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • workRole: { _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional id?: number

        Format: int32

      • Optional limitTo?: null | number

        Format: double

      • Optional locationId?: null | number

        Format: int32

      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; effectiveDate?: string; endingDate?: string; id?: number; limitTo?: null | number; locationId?: null | number; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; workRole?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementsByParentIdWorktypesById

  • putFinanceAgreementsByParentIdWorktypesById(id: number, parentId: number, workType: { _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • workType: { _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agreementId?: null | number

        Format: int32

      • Optional agreementLimit?: null | number

        Format: double

      • billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional effectiveDate?: string

        Format: date-time

      • Optional endingDate?: string

        Format: date-time

      • Optional hoursMax?: null | number

        Format: double

      • Optional hoursMin?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional locationId?: null | number

        Format: int32

      • Optional overageRate?: null | number

        Format: double

      • Optional overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional rate?: null | number

        Format: double

      • rateType: null | "Custom" | "AdjAmount" | "Multiplier"
      • Optional roundBillHours?: null | number

        Format: double

      • Optional site?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; agreementId?: null | number; agreementLimit?: null | number; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; effectiveDate?: string; endingDate?: string; hoursMax?: null | number; hoursMin?: null | number; id?: number; locationId?: null | number; overageRate?: null | number; overageRateType?: null | "Custom" | "AdjAmount" | "Multiplier"; rate?: null | number; rateType: null | "Custom" | "AdjAmount" | "Multiplier"; roundBillHours?: null | number; site?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceAgreementsTypesById

  • putFinanceAgreementsTypesById(id: number, agreementType: { _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • agreementType: { _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllWorkRoleExclusions?: null | boolean
      • Optional addAllWorkTypeExclusions?: null | boolean
      • Optional allowOverrunsFlag?: null | boolean
      • Optional applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"
      • Optional applicationLimit?: null | number

        Format: double

      • Optional applicationUnits?: null | "Amount" | "Hours" | "Incidents"
      • Optional applicationUnlimitedFlag?: null | boolean
      • Optional autoInvoiceFlag?: null | boolean
      • Optional billAmount?: null | number

        Format: double

      • billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional billOneTimeFlag?: null | boolean
      • billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"
      • Optional billableExpenseInvoiceFlag?: null | boolean
      • Optional billableProductInvoiceFlag?: null | boolean
      • Optional billableTimeInvoiceFlag?: null | boolean
      • Optional billingCycle?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bottomCommentFlag?: null | boolean
      • Optional carryOverUnusedFlag?: null | boolean
      • Optional chargeToFirmFlag?: null | boolean
      • Optional compHourlyRate?: null | number

        Format: double

      • Optional compLimitAmount?: null | number

        Format: double

      • Optional copyWorkRolesFlag?: null | boolean
      • Optional copyWorkTypesFlag?: null | boolean
      • Optional coverAgreementExpenseFlag?: null | boolean
      • Optional coverAgreementProductFlag?: null | boolean
      • Optional coverAgreementTimeFlag?: null | boolean
      • Optional coverSalesTaxFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional emailTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"
      • employeeCompRate: null | "Actual" | "Hourly"
      • Optional exclusionWorkRoleIds?: number[]
      • Optional exclusionWorkTypeIds?: number[]
      • Optional expireWhenZero?: null | boolean
      • Optional expiredDays?: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • Optional integrationXRef?: string
        description

        Max length: 50;

      • Optional invoiceDescription?: string
        description

        Max length: 4000;

      • Optional invoicePreSuffix?: string
        description

        Max length: 5;

      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • invoicingCycle: null | "ContractYear" | "CalendarYear"
      • Optional limit?: null | number

        Format: int32

      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • name: string
        description

        Max length: 50;

      • Optional oneTimeFlag?: null | boolean
      • Optional prePaymentFlag?: null | boolean
      • Optional prefixSuffixOption?: null | "Prefix" | "Suffix"
      • Optional projectType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional prorateFlag?: null | boolean
      • Optional removeAllWorkRoleExclusions?: null | boolean
      • Optional removeAllWorkTypeExclusions?: null | boolean
      • Optional restrictDepartmentFlag?: null | boolean
      • Optional restrictDownPaymentFlag?: null | boolean
      • Optional restrictLocationFlag?: null | boolean
      • Optional sla?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableFlag?: null | boolean
      • Optional topCommentFlag?: null | boolean
      • Optional workRole?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional workType?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; addAllWorkRoleExclusions?: null | boolean; addAllWorkTypeExclusions?: null | boolean; allowOverrunsFlag?: null | boolean; applicationCycle?: null | "Contract2Weeks" | "Contract4Weeks" | "ContractYear" | "CalendarMonth" | "CalendarQuarter" | "CalendarWeek" | "ContractQuarter" | "CalendarYear"; applicationLimit?: null | number; applicationUnits?: null | "Amount" | "Hours" | "Incidents"; applicationUnlimitedFlag?: null | boolean; autoInvoiceFlag?: null | boolean; billAmount?: null | number; billExpenses: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billOneTimeFlag?: null | boolean; billProducts: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billTime: null | "Billable" | "DoNotBill" | "NoCharge" | "NoDefault"; billableExpenseInvoiceFlag?: null | boolean; billableProductInvoiceFlag?: null | boolean; billableTimeInvoiceFlag?: null | boolean; billingCycle?: { _info?: {}; id?: null | number; name?: string }; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomCommentFlag?: null | boolean; carryOverUnusedFlag?: null | boolean; chargeToFirmFlag?: null | boolean; compHourlyRate?: null | number; compLimitAmount?: null | number; copyWorkRolesFlag?: null | boolean; copyWorkTypesFlag?: null | boolean; coverAgreementExpenseFlag?: null | boolean; coverAgreementProductFlag?: null | boolean; coverAgreementTimeFlag?: null | boolean; coverSalesTaxFlag?: null | boolean; defaultFlag?: null | boolean; department?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; emailTemplate?: { _info?: {}; id?: null | number; name?: string }; employeeCompNotExceed: null | "Percent" | "Amount" | "Billing"; employeeCompRate: null | "Actual" | "Hourly"; exclusionWorkRoleIds?: number[]; exclusionWorkTypeIds?: number[]; expireWhenZero?: null | boolean; expiredDays?: null | number; id?: number; inactiveFlag?: null | boolean; integrationXRef?: string; invoiceDescription?: string; invoicePreSuffix?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; invoicingCycle: null | "ContractYear" | "CalendarYear"; limit?: null | number; location?: { _info?: {}; id?: null | number; name?: string }; name: string; oneTimeFlag?: null | boolean; prePaymentFlag?: null | boolean; prefixSuffixOption?: null | "Prefix" | "Suffix"; projectType?: { _info?: {}; id?: null | number; name?: string }; prorateFlag?: null | boolean; removeAllWorkRoleExclusions?: null | boolean; removeAllWorkTypeExclusions?: null | boolean; restrictDepartmentFlag?: null | boolean; restrictDownPaymentFlag?: null | boolean; restrictLocationFlag?: null | boolean; sla?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; topCommentFlag?: null | boolean; workRole?: { _info?: {}; id?: null | number; name?: string }; workType?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceBatchSetupsById

  • putFinanceBatchSetupsById(id: number, batchSetup: { _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }): Promise<{ _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }>

  • Parameters

    • id: number
    • batchSetup: { _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }
      • Optional _info?: {}
        • [key: string]: string
      • daysInAdvance: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • nextRunDate: string

        Format: date-time

    Returns Promise<{ _info?: {}; daysInAdvance: null | number; id?: number; nextRunDate: string }>

putFinanceBillingCyclesById

  • putFinanceBillingCyclesById(id: number, billingCycle: { _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }): Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

  • Parameters

    • id: number
    • billingCycle: { _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"
      • Optional defaultFlag?: boolean
      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 5;

      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; billingOptions: null | "BiMonthly" | "BiWeekly" | "Monthly" | "NotRecurring" | "Quarterly" | "SemiAnnual" | "Weekly" | "Yearly"; defaultFlag?: boolean; id?: number; identifier: string; name: string }>

putFinanceBillingSetupsById

  • putFinanceBillingSetupsById(id: number, billingSetup: { _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }): Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

  • Parameters

    • id: number
    • billingSetup: { _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addressOne?: string
        description

        Max length: 50;

      • Optional addressTwo?: string
        description

        Max length: 50;

      • Optional agreementInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional allowRestrictedDeptOnRoutingFlag?: null | boolean
      • Optional billProductAfterShipFlag?: null | boolean
      • Optional billProjectCompleteFlag?: null | boolean
      • Optional billProjectUnapprovedFlag?: null | boolean
      • Optional billSalesOrderCompleteFlag?: null | boolean
      • Optional billTicketCompleteFlag?: null | boolean
      • Optional billTicketSeparatelyFlag?: null | boolean
      • Optional billTicketUnapprovedFlag?: null | boolean
      • Optional businessNumber?: string
        description

        Max length: 50;

      • Optional chargeAdjToFirmFlag?: null | boolean
      • Optional city?: string
        description

        Max length: 50;

      • Optional companyCode?: string
        description

        Max length: 250;

      • Optional copyAgreementProductsFlag?: null | boolean
      • Optional copyNonServiceProductsFlag?: null | boolean
      • Optional copyServiceProductsFlag?: null | boolean
      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customLabel?: string
        description

        Max length: 50;

      • Optional customText?: string
        description

        Max length: 500;

      • Optional deliveryReceiptFlag?: null | boolean
      • Optional disableRoutingEmailFlag?: null | boolean
      • Optional displayTaxFlag?: null | boolean
      • Optional downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • emailTemplate: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional excludeAvalaraFlag?: null | boolean
      • Optional excludeDoNotBillExpenseFlag?: null | boolean
      • Optional excludeDoNotBillProductFlag?: null | boolean
      • Optional excludeDoNotBillTimeFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional invoiceFooter?: string
        description

        Max length: 500;

      • invoiceTitle: string
        description

        Max length: 50;

      • Optional localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • location: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional miscInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional noWatermarkFlag?: null | boolean
      • Optional overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • payableName: string
        description

        Max length: 50;

      • Optional phone?: string
        description

        Max length: 15;

      • Optional prefixSuffixFlag?: null | "Prefix" | "Suffix"
      • Optional prefixSuffixText?: string
        description

        Max length: 5;

      • Optional printLogoFlag?: null | boolean
      • Optional progressInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional progressTimeFlag?: null | boolean
      • Optional quoteFooter?: string
        description

        Max length: 1000;

      • Optional readReceiptFlag?: null | boolean
      • remitName: string
        description

        Max length: 50;

      • Optional restrictDownpaymentFlag?: null | boolean
      • Optional restrictProjectDownpaymentFlag?: null | boolean
      • Optional salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

          description

          Invoice Template Setup Id

        • Optional name?: string
      • Optional state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional topcomment?: string
        description

        Max length: 4000;

      • Optional zip?: string
        description

        Max length: 12;

    Returns Promise<{ _info?: {}; addressOne?: string; addressTwo?: string; agreementInvoice?: { _info?: {}; id?: null | number; name?: string }; allowRestrictedDeptOnRoutingFlag?: null | boolean; billProductAfterShipFlag?: null | boolean; billProjectCompleteFlag?: null | boolean; billProjectUnapprovedFlag?: null | boolean; billSalesOrderCompleteFlag?: null | boolean; billTicketCompleteFlag?: null | boolean; billTicketSeparatelyFlag?: null | boolean; billTicketUnapprovedFlag?: null | boolean; businessNumber?: string; chargeAdjToFirmFlag?: null | boolean; city?: string; companyCode?: string; copyAgreementProductsFlag?: null | boolean; copyNonServiceProductsFlag?: null | boolean; copyServiceProductsFlag?: null | boolean; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; creditMemoInvoice?: { _info?: {}; id?: null | number; name?: string }; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customLabel?: string; customText?: string; deliveryReceiptFlag?: null | boolean; disableRoutingEmailFlag?: null | boolean; displayTaxFlag?: null | boolean; downPaymentInvoice?: { _info?: {}; id?: null | number; name?: string }; emailTemplate: { _info?: {}; id?: null | number; name?: string }; excludeAvalaraFlag?: null | boolean; excludeDoNotBillExpenseFlag?: null | boolean; excludeDoNotBillProductFlag?: null | boolean; excludeDoNotBillTimeFlag?: null | boolean; id?: number; invoiceFooter?: string; invoiceTitle: string; localizedCountry?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location: { _info?: {}; id?: null | number; name?: string }; miscInvoice?: { _info?: {}; id?: null | number; name?: string }; noWatermarkFlag?: null | boolean; overallInvoiceDefault?: { _info?: {}; id?: null | number; name?: string }; payableName: string; phone?: string; prefixSuffixFlag?: null | "Prefix" | "Suffix"; prefixSuffixText?: string; printLogoFlag?: null | boolean; progressInvoice?: { _info?: {}; id?: null | number; name?: string }; progressTimeFlag?: null | boolean; quoteFooter?: string; readReceiptFlag?: null | boolean; remitName: string; restrictDownpaymentFlag?: null | boolean; restrictProjectDownpaymentFlag?: null | boolean; salesOrderInvoice?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceActual?: { _info?: {}; id?: null | number; name?: string }; standardInvoiceFixed?: { _info?: {}; id?: null | number; name?: string }; state?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; topcomment?: string; zip?: string }>

putFinanceBillingSetupsByParentIdRoutingsById

  • putFinanceBillingSetupsByParentIdRoutingsById(id: number, parentId: number, billingSetupRouting: { _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }): Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • billingSetupRouting: { _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"
      • Optional member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"
      • sequenceNumber: null | number

        Format: int32

    Returns Promise<{ _info?: {}; id?: number; invoiceRule: null | "All" | "Project" | "Agreement" | "Standard"; member?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; routingRule: null | "Member" | "Project" | "Location" | "Department" | "Territory" | "Account" | "Creator" | "Sales"; sequenceNumber: null | number }>

putFinanceBillingStatusesById

  • putFinanceBillingStatusesById(id: number, billingStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }): Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

  • Parameters

    • id: number
    • billingStatus: { _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional closedFlag?: null | boolean
      • Optional defaultFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional inactiveFlag?: null | boolean
      • name: string
        description

        Max length: 30;

      • Optional sentFlag?: null | boolean
      • Optional sortOrder?: null | number

        Format: int32

    Returns Promise<{ _info?: {}; closedFlag?: null | boolean; defaultFlag?: null | boolean; id?: number; inactiveFlag?: null | boolean; name: string; sentFlag?: null | boolean; sortOrder?: null | number }>

putFinanceBillingTermsById

  • putFinanceBillingTermsById(id: number, billingTerms: { _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }>

  • Parameters

    • id: number
    • billingTerms: { _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • dueDays: null | number

        Format: int32

      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional termsXref?: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; dueDays: null | number; id?: number; name: string; termsXref?: string }>

putFinanceClosedInvoicesById

  • putFinanceClosedInvoicesById(id: number, closedInvoice: { _info?: {}; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • closedInvoice: { _info?: {}; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; status?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceCurrenciesById

  • putFinanceCurrenciesById(id: number, currency: { _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }): Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

  • Parameters

    • id: number
    • currency: { _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional currencyCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • currencyIdentifier: string
        description

        Max length: 10;

      • Optional decimalSeparator?: string
        description

        Max length: 1;

      • Optional displayIdFlag?: null | boolean
      • Optional displaySymbolFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • name: string
        description

        Max length: 50;

      • Optional negativeParenthesesFlag?: null | boolean
      • Optional numberOfDecimals?: null | number

        Format: int32

      • Optional reportFormat?: string
      • Optional rightAlign?: null | boolean
      • Optional symbol?: string
        description

        Max length: 10;

      • Optional thousandsSeparator?: string
        description

        Max length: 1;

    Returns Promise<{ _info?: {}; currencyCode?: { _info?: {}; id?: null | number; name?: string }; currencyIdentifier: string; decimalSeparator?: string; displayIdFlag?: null | boolean; displaySymbolFlag?: null | boolean; id?: number; name: string; negativeParenthesesFlag?: null | boolean; numberOfDecimals?: null | number; reportFormat?: string; rightAlign?: null | boolean; symbol?: string; thousandsSeparator?: string }>

putFinanceDeliveryMethodsById

  • putFinanceDeliveryMethodsById(id: number, deliveryMethod: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }): Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

  • Parameters

    • id: number
    • deliveryMethod: { _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • Optional emailFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional integrationActiveFlag?: null | boolean
      • Optional integrationEmailFlag?: null | boolean
      • Optional integrationPrintFlag?: null | boolean
      • name: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; emailFlag?: null | boolean; id?: number; integrationActiveFlag?: null | boolean; integrationEmailFlag?: null | boolean; integrationPrintFlag?: null | boolean; name: string }>

putFinanceGlAccountsById

  • putFinanceGlAccountsById(id: number, glAccount: { _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

  • Parameters

    • id: number
    • glAccount: { _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional cogs1?: string
        description

        Max length: 255;

      • Optional cogs10?: string
        description

        Max length: 255;

      • Optional cogs2?: string
        description

        Max length: 255;

      • Optional cogs3?: string
        description

        Max length: 255;

      • Optional cogs4?: string
        description

        Max length: 255;

      • Optional cogs5?: string
        description

        Max length: 255;

      • Optional cogs6?: string
        description

        Max length: 255;

      • Optional cogs7?: string
        description

        Max length: 255;

      • Optional cogs8?: string
        description

        Max length: 255;

      • Optional cogs9?: string
        description

        Max length: 255;

      • glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"
      • Optional id?: number

        Format: int32

      • Optional inventory?: string
        description

        Max length: 255;

      • mappedRecord: { id?: null | number; name?: string }
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • mappedType: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional productId?: string
        description

        Max length: 255;

      • Optional salesCode?: string
        description

        Max length: 255;

      • Optional segment1?: string
        description

        Max length: 255;

      • Optional segment10?: string
        description

        Max length: 255;

      • Optional segment2?: string
        description

        Max length: 255;

      • Optional segment3?: string
        description

        Max length: 255;

      • Optional segment4?: string
        description

        Max length: 255;

      • Optional segment5?: string
        description

        Max length: 255;

      • Optional segment6?: string
        description

        Max length: 255;

      • Optional segment7?: string
        description

        Max length: 255;

      • Optional segment8?: string
        description

        Max length: 255;

      • Optional segment9?: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; glType: null | "AP" | "AR" | "EE" | "EI" | "EO" | "IA" | "IT" | "P" | "PF" | "R" | "RA" | "RD" | "RE" | "RP" | "ST" | "SD" | "ET" | "FT" | "PT"; id?: number; inventory?: string; mappedRecord: { id?: null | number; name?: string }; mappedType: { _info?: {}; id?: null | number; name?: string }; productId?: string; salesCode?: string; segment1?: string; segment10?: string; segment2?: string; segment3?: string; segment4?: string; segment5?: string; segment6?: string; segment7?: string; segment8?: string; segment9?: string }>

putFinanceGlCaptionsById

  • putFinanceGlCaptionsById(id: number, glCaption: { _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }): Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }>

  • Parameters

    • id: number
    • glCaption: { _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }
      • Optional _info?: {}
        • [key: string]: string
      • Optional cogs1?: string
        description

        Max length: 255;

      • Optional cogs10?: string
        description

        Max length: 255;

      • Optional cogs2?: string
        description

        Max length: 255;

      • Optional cogs3?: string
        description

        Max length: 255;

      • Optional cogs4?: string
        description

        Max length: 255;

      • Optional cogs5?: string
        description

        Max length: 255;

      • Optional cogs6?: string
        description

        Max length: 255;

      • Optional cogs7?: string
        description

        Max length: 255;

      • Optional cogs8?: string
        description

        Max length: 255;

      • Optional cogs9?: string
        description

        Max length: 255;

      • Optional id?: number

        Format: int32

      • Optional segment1?: string
        description

        Max length: 255;

      • Optional segment10?: string
        description

        Max length: 255;

      • Optional segment10type?: null | "Account" | "Class"
      • Optional segment1type?: null | "Account" | "Class"
      • Optional segment2?: string
        description

        Max length: 255;

      • Optional segment2type?: null | "Account" | "Class"
      • Optional segment3?: string
        description

        Max length: 255;

      • Optional segment3type?: null | "Account" | "Class"
      • Optional segment4?: string
        description

        Max length: 255;

      • Optional segment4type?: null | "Account" | "Class"
      • Optional segment5?: string
        description

        Max length: 255;

      • Optional segment5type?: null | "Account" | "Class"
      • Optional segment6?: string
        description

        Max length: 255;

      • Optional segment6type?: null | "Account" | "Class"
      • Optional segment7?: string
        description

        Max length: 255;

      • Optional segment7type?: null | "Account" | "Class"
      • Optional segment8?: string
        description

        Max length: 255;

      • Optional segment8type?: null | "Account" | "Class"
      • Optional segment9?: string
        description

        Max length: 255;

      • Optional segment9type?: null | "Account" | "Class"

    Returns Promise<{ _info?: {}; cogs1?: string; cogs10?: string; cogs2?: string; cogs3?: string; cogs4?: string; cogs5?: string; cogs6?: string; cogs7?: string; cogs8?: string; cogs9?: string; id?: number; segment1?: string; segment10?: string; segment10type?: null | "Account" | "Class"; segment1type?: null | "Account" | "Class"; segment2?: string; segment2type?: null | "Account" | "Class"; segment3?: string; segment3type?: null | "Account" | "Class"; segment4?: string; segment4type?: null | "Account" | "Class"; segment5?: string; segment5type?: null | "Account" | "Class"; segment6?: string; segment6type?: null | "Account" | "Class"; segment7?: string; segment7type?: null | "Account" | "Class"; segment8?: string; segment8type?: null | "Account" | "Class"; segment9?: string; segment9type?: null | "Account" | "Class" }>

putFinanceGlpathsById

  • putFinanceGlpathsById(id: number, gLPath: { _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }): Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

  • Parameters

    • id: number
    • gLPath: { _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional databaseName?: string
        description

        Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional lastPaymentSync?: string

        Format: date-time

      • Optional lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional location?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional path?: string
        description

        Max length: 255;

      • Optional sqlServerName?: string
        description

        Max length: 255;

    Returns Promise<{ _info?: {}; databaseName?: string; id?: number; lastPaymentSync?: string; lastPaymentSyncBy?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; location?: { _info?: {}; id?: null | number; name?: string }; path?: string; sqlServerName?: string }>

putFinanceInvoiceEmailTemplatesById

  • putFinanceInvoiceEmailTemplatesById(id: number, invoiceEmailTemplate: { _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }): Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

  • Parameters

    • id: number
    • invoiceEmailTemplate: { _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional attachInvoiceFlag?: null | boolean
      • Optional body?: string
      • Optional copySenderFlag?: null | boolean
      • Optional emailAddress?: string
        description

        From fields (first name, last name, email address) are required if useSenderFlag is false Max length: 100;

      • Optional firstName?: string
        description

        From fields (first name, last name, email address) are required if useSenderFlag is false Max length: 100;

      • Optional id?: number

        Format: int32

      • Optional invoiceStatus?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional lastName?: string
        description

        From fields (first name, last name, email address) are required if useSenderFlag is false Max length: 100;

      • name: string
        description

        Max length: 50;

      • Optional serviceSurvey?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • subject: string
        description

        Max length: 200;

      • Optional useSenderFlag?: null | boolean

    Returns Promise<{ _info?: {}; attachInvoiceFlag?: null | boolean; body?: string; copySenderFlag?: null | boolean; emailAddress?: string; firstName?: string; id?: number; invoiceStatus?: { _info?: {}; id?: null | number; name?: string }; lastName?: string; name: string; serviceSurvey?: { _info?: {}; id?: null | number; name?: string }; subject: string; useSenderFlag?: null | boolean }>

putFinanceInvoiceTemplatesById

  • putFinanceInvoiceTemplatesById(id: number, invoiceTemplate: { _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }): Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

  • Parameters

    • id: number
    • invoiceTemplate: { _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }
      • Optional _info?: {}
        • [key: string]: string
      • Optional adjustmentAgrTypeVisibleFlag?: null | boolean
      • Optional adjustmentAmountCaption?: string
        description

        Max length: 50;

      • Optional adjustmentAmountVisibleFlag?: null | boolean
      • Optional adjustmentDescriptionCaption?: string
        description

        Max length: 50;

      • Optional adjustmentDescriptionVisibleFlag?: null | boolean
      • Optional adjustmentPriceCaption?: string
        description

        Max length: 50;

      • Optional adjustmentPriceVisibleFlag?: null | boolean
      • Optional adjustmentQuantityCaption?: string
        description

        Max length: 50;

      • Optional adjustmentQuantityVisibleFlag?: null | boolean
      • Optional adjustmentTotalVisibleFlag?: null | boolean
      • Optional creditCreditAmountCaption?: string
        description

        Max length: 50;

      • Optional creditCreditAmountVisibleFlag?: null | boolean
      • Optional creditRemainingAmountCaption?: string
        description

        Max length: 50;

      • Optional creditRemainingAmountVisibleFlag?: null | boolean
      • Optional currencyIdVisibleFlag?: null | boolean
      • Optional currencySymbolVisibleFlag?: null | boolean
      • Optional expenseDetailAgreementExtAmountVisibleFlag?: null | boolean
      • Optional expenseDetailAgreementVisibleFlag?: null | boolean
      • Optional expenseDetailBillableVisibleFlag?: null | boolean
      • Optional expenseDetailContactsVisibleFlag?: null | boolean
      • Optional expenseDetailExtAmountVisibleFlag?: null | boolean
      • Optional expenseDetailMembersVisibleFlag?: null | boolean
      • Optional expenseDetailNonbillableCaption?: string
        description

        Max length: 50;

      • Optional expenseDetailNotesVisibleFlag?: null | boolean
      • Optional expenseDetailPmPhaseVisibleFlag?: null | boolean
      • Optional expenseDetailPmSummaryVisibleFlag?: null | boolean
      • Optional expenseDetailPrimarySortDirection?: string
      • Optional expenseDetailPrimarySortField?: string
      • Optional expenseDetailSecondarySortDirection?: string
      • Optional expenseDetailSecondarySortField?: string
      • Optional expenseDetailSrAddressVisibleFlag?: null | boolean
      • Optional expenseDetailSrContactVisibleFlag?: null | boolean
      • Optional expenseDetailSrTicketSummaryVisibleFlag?: null | boolean
      • Optional expenseDetailSubtotalVisibleFlag?: null | boolean
      • Optional expenseDetailTicketNumberVisibleFlag?: null | boolean
      • Optional expenseDetailVisibleFlag?: null | boolean
      • Optional expensesAmountCaption?: string
        description

        Max length: 50;

      • Optional expensesAmountVisibleFlag?: null | boolean
      • Optional expensesCollapsedFlag?: null | boolean
      • Optional expensesStaffCaption?: string
        description

        Max length: 50;

      • Optional expensesStaffVisibleFlag?: null | boolean
      • Optional expensesTotalVisibleFlag?: null | boolean
      • Optional expensesTypeCaption?: string
        description

        Max length: 50;

      • Optional expensesTypeVisibleFlag?: null | boolean
      • Optional headerAccountCaption?: string
        description

        Max length: 50;

      • Optional headerAccountVisibleFlag?: null | boolean
      • Optional headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"
      • Optional headerDueDateCaption?: string
        description

        Max length: 50;

      • Optional headerDueDateVisibleFlag?: null | boolean
      • Optional headerHoursBasedExtendedAmountVisibleFlag?: null | boolean
      • Optional headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"
      • Optional headerPoNumberCaption?: string
        description

        Max length: 50;

      • Optional headerPoNumberVisibleFlag?: null | boolean
      • Optional headerReferenceCaption?: string
        description

        Max length: 50;

      • Optional headerReferenceVisibleFlag?: null | boolean
      • Optional headerShipToCaption?: string
        description

        Max length: 50;

      • Optional headerShipToVisibleFlag?: null | boolean
      • Optional headerTaxIdCaption?: string
        description

        Max length: 50;

      • Optional headerTaxIdVisibleFlag?: null | boolean
      • Optional headerTermsCaption?: string
        description

        Max length: 50;

      • Optional headerTermsVisibleFlag?: null | boolean
      • Optional headerTitleCaption?: string
        description

        Max length: 50;

      • Optional headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"
      • Optional headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"
      • Optional headerTitleVisibleFlag?: null | boolean
      • Optional id?: number

        Format: int32

      • Optional invoiceBalanceDueCaption?: string
        description

        Max length: 50;

      • Optional invoiceBalanceDueVisibleFlag?: null | boolean
      • Optional invoiceCreditAmountCaption?: string
        description

        Max length: 50;

      • Optional invoiceCreditAmountVisibleFlag?: null | boolean
      • Optional invoicePaymentAmountCaption?: string
        description

        Max length: 50;

      • Optional invoicePaymentAmountVisibleFlag?: null | boolean
      • Optional logoVisibleFlag?: null | boolean
      • Optional marginBottom?: null | number

        Format: double

      • Optional marginLeft?: null | number

        Format: double

      • Optional marginRight?: null | number

        Format: double

      • Optional marginTop?: null | number

        Format: double

      • name: string
        description

        Max length: 50;

      • Optional otherChargesAmountCaption?: string
        description

        Max length: 50;

      • Optional otherChargesAmountVisibleFlag?: null | boolean
      • Optional otherChargesCollapsedFlag?: null | boolean
      • Optional otherChargesDescriptionCaption?: string
        description

        Max length: 50;

      • Optional otherChargesDescriptionVisibleFlag?: null | boolean
      • Optional otherChargesDisplaySixDecimals?: null | boolean
      • Optional otherChargesItemIdVisibleFlag?: null | boolean
      • Optional otherChargesPriceCaption?: string
        description

        Max length: 50;

      • Optional otherChargesPriceVisibleFlag?: null | boolean
      • Optional otherChargesQuantityCaption?: string
        description

        Max length: 50;

      • Optional otherChargesQuantityVisibleFlag?: null | boolean
      • Optional otherChargesSerialNumberVisibleFlag?: null | boolean
      • Optional otherChargesTotalVisibleFlag?: null | boolean
      • Optional payableCaption?: string
        description

        Max length: 1000;

      • Optional portalFlag?: null | boolean
      • Optional projectHeaderAmountCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderAmountVisibleFlag?: null | boolean
      • Optional projectHeaderBillingMethodCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderBillingMethodVisibleFlag?: null | boolean
      • Optional projectHeaderBillingTypeCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderBillingTypeVisibleFlag?: null | boolean
      • Optional projectHeaderCompanyNameCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderCompanyNameVisibleFlag?: null | boolean
      • Optional projectHeaderContactNameCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderContactNameVisibleFlag?: null | boolean
      • Optional projectHeaderOriginalDownpaymentCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean
      • Optional projectHeaderProjectNameCaption?: string
        description

        Max length: 50;

      • Optional projectHeaderProjectNameVisibleFlag?: null | boolean
      • Optional remitToVisibleFlag?: null | boolean
      • Optional serviceHeaderAmountCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderAmountVisibleFlag?: null | boolean
      • Optional serviceHeaderBillingMethodCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderBillingMethodVisibleFlag?: null | boolean
      • Optional serviceHeaderBundledTicketsVisibleFlag?: null | boolean
      • Optional serviceHeaderClosedTasksVisibleFlag?: null | boolean
      • Optional serviceHeaderCompanyNameCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderCompanyNameVisibleFlag?: null | boolean
      • Optional serviceHeaderContactNameCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderContactNameVisibleFlag?: null | boolean
      • Optional serviceHeaderDetailDescriptionCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderDetailDescriptionVisibleFlag?: null | boolean
      • Optional serviceHeaderOpenTasksVisibleFlag?: null | boolean
      • Optional serviceHeaderResolutionCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderResolutionVisibleFlag?: null | boolean
      • Optional serviceHeaderSummaryCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderSummaryVisibleFlag?: null | boolean
      • Optional serviceHeaderTicketNumberCaption?: string
        description

        Max length: 50;

      • Optional serviceHeaderTicketNumberVisibleFlag?: null | boolean
      • Optional servicesAmountCaption?: string
        description

        Max length: 50;

      • Optional servicesAmountVisibleFlag?: null | boolean
      • Optional servicesCollapsedFlag?: null | boolean
      • Optional servicesHoursCaption?: string
        description

        Max length: 50;

      • Optional servicesHoursVisibleFlag?: null | boolean
      • Optional servicesMemberNameCaption?: string
        description

        Max length: 50;

      • Optional servicesMemberNameVisibleFlag?: null | boolean
      • Optional servicesRateCaption?: string
        description

        Max length: 50;

      • Optional servicesRateVisibleFlag?: null | boolean
      • Optional servicesStaffCaption?: string
        description

        Max length: 50;

      • Optional servicesStaffVisibleFlag?: null | boolean
      • Optional servicesTotalVisibleFlag?: null | boolean
      • Optional servicesWorkRoleCaption?: string
        description

        Max length: 50;

      • Optional servicesWorkRoleVisibleFlag?: null | boolean
      • Optional servicesWorkTypeCaption?: string
        description

        Max length: 50;

      • Optional servicesWorkTypeVisibleFlag?: null | boolean
      • Optional timeDetailAgreementVisibleFlag?: null | boolean
      • Optional timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean
      • Optional timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean
      • Optional timeDetailAmountBasedHoursVisibleFlag?: null | boolean
      • Optional timeDetailBillableVisibleFlag?: null | boolean
      • Optional timeDetailContactsVisibleFlag?: null | boolean
      • Optional timeDetailDatesVisibleFlag?: null | boolean
      • Optional timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean
      • Optional timeDetailExtendedAmountVisibleFlag?: null | boolean
      • Optional timeDetailHourlyRateVisibleFlag?: null | boolean
      • Optional timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean
      • Optional timeDetailHoursBasedHoursVisibleFlag?: null | boolean
      • Optional timeDetailHoursVisibleFlag?: null | boolean
      • Optional timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean
      • Optional timeDetailMembersVisibleFlag?: null | boolean
      • Optional timeDetailNonBillableCaption?: string
        description

        Max length: 50;

      • Optional timeDetailNotesVisibleFlag?: null | boolean
      • Optional timeDetailPmPhaseVisibleFlag?: null | boolean
      • Optional timeDetailPmSummaryVisibleFlag?: null | boolean
      • Optional timeDetailPrimarySortDirection?: string
      • Optional timeDetailPrimarySortField?: string
      • Optional timeDetailSRAddressVisibleFlag?: null | boolean
      • Optional timeDetailSRContactVisibleFlag?: null | boolean
      • Optional timeDetailSRTicketSummaryVisibleFlag?: null | boolean
      • Optional timeDetailSecondarySortDirection?: string
      • Optional timeDetailSecondarySortField?: string
      • Optional timeDetailStartEndTimeVisibleFlag?: null | boolean
      • Optional timeDetailSubtotalVisibleFlag?: null | boolean
      • Optional timeDetailTicketNumberVisibleFlag?: null | boolean
      • Optional timeDetailVisibleFlag?: null | boolean

    Returns Promise<{ _info?: {}; adjustmentAgrTypeVisibleFlag?: null | boolean; adjustmentAmountCaption?: string; adjustmentAmountVisibleFlag?: null | boolean; adjustmentDescriptionCaption?: string; adjustmentDescriptionVisibleFlag?: null | boolean; adjustmentPriceCaption?: string; adjustmentPriceVisibleFlag?: null | boolean; adjustmentQuantityCaption?: string; adjustmentQuantityVisibleFlag?: null | boolean; adjustmentTotalVisibleFlag?: null | boolean; creditCreditAmountCaption?: string; creditCreditAmountVisibleFlag?: null | boolean; creditRemainingAmountCaption?: string; creditRemainingAmountVisibleFlag?: null | boolean; currencyIdVisibleFlag?: null | boolean; currencySymbolVisibleFlag?: null | boolean; expenseDetailAgreementExtAmountVisibleFlag?: null | boolean; expenseDetailAgreementVisibleFlag?: null | boolean; expenseDetailBillableVisibleFlag?: null | boolean; expenseDetailContactsVisibleFlag?: null | boolean; expenseDetailExtAmountVisibleFlag?: null | boolean; expenseDetailMembersVisibleFlag?: null | boolean; expenseDetailNonbillableCaption?: string; expenseDetailNotesVisibleFlag?: null | boolean; expenseDetailPmPhaseVisibleFlag?: null | boolean; expenseDetailPmSummaryVisibleFlag?: null | boolean; expenseDetailPrimarySortDirection?: string; expenseDetailPrimarySortField?: string; expenseDetailSecondarySortDirection?: string; expenseDetailSecondarySortField?: string; expenseDetailSrAddressVisibleFlag?: null | boolean; expenseDetailSrContactVisibleFlag?: null | boolean; expenseDetailSrTicketSummaryVisibleFlag?: null | boolean; expenseDetailSubtotalVisibleFlag?: null | boolean; expenseDetailTicketNumberVisibleFlag?: null | boolean; expenseDetailVisibleFlag?: null | boolean; expensesAmountCaption?: string; expensesAmountVisibleFlag?: null | boolean; expensesCollapsedFlag?: null | boolean; expensesStaffCaption?: string; expensesStaffVisibleFlag?: null | boolean; expensesTotalVisibleFlag?: null | boolean; expensesTypeCaption?: string; expensesTypeVisibleFlag?: null | boolean; headerAccountCaption?: string; headerAccountVisibleFlag?: null | boolean; headerAddressPosition?: null | "Center" | "LeftSide" | "RightSide"; headerDueDateCaption?: string; headerDueDateVisibleFlag?: null | boolean; headerHoursBasedExtendedAmountVisibleFlag?: null | boolean; headerLogoPosition?: null | "Center" | "LeftSide" | "RightSide"; headerPoNumberCaption?: string; headerPoNumberVisibleFlag?: null | boolean; headerReferenceCaption?: string; headerReferenceVisibleFlag?: null | boolean; headerShipToCaption?: string; headerShipToVisibleFlag?: null | boolean; headerTaxIdCaption?: string; headerTaxIdVisibleFlag?: null | boolean; headerTermsCaption?: string; headerTermsVisibleFlag?: null | boolean; headerTitleCaption?: string; headerTitleFont?: null | "Regular" | "RegularBold" | "Large" | "LargeBold" | "ExtraLarge" | "ExtraLargeBold"; headerTitlePosition?: null | "Center" | "LeftSide" | "RightSide"; headerTitleVisibleFlag?: null | boolean; id?: number; invoiceBalanceDueCaption?: string; invoiceBalanceDueVisibleFlag?: null | boolean; invoiceCreditAmountCaption?: string; invoiceCreditAmountVisibleFlag?: null | boolean; invoicePaymentAmountCaption?: string; invoicePaymentAmountVisibleFlag?: null | boolean; logoVisibleFlag?: null | boolean; marginBottom?: null | number; marginLeft?: null | number; marginRight?: null | number; marginTop?: null | number; name: string; otherChargesAmountCaption?: string; otherChargesAmountVisibleFlag?: null | boolean; otherChargesCollapsedFlag?: null | boolean; otherChargesDescriptionCaption?: string; otherChargesDescriptionVisibleFlag?: null | boolean; otherChargesDisplaySixDecimals?: null | boolean; otherChargesItemIdVisibleFlag?: null | boolean; otherChargesPriceCaption?: string; otherChargesPriceVisibleFlag?: null | boolean; otherChargesQuantityCaption?: string; otherChargesQuantityVisibleFlag?: null | boolean; otherChargesSerialNumberVisibleFlag?: null | boolean; otherChargesTotalVisibleFlag?: null | boolean; payableCaption?: string; portalFlag?: null | boolean; projectHeaderAmountCaption?: string; projectHeaderAmountVisibleFlag?: null | boolean; projectHeaderBillingMethodCaption?: string; projectHeaderBillingMethodVisibleFlag?: null | boolean; projectHeaderBillingTypeCaption?: string; projectHeaderBillingTypeVisibleFlag?: null | boolean; projectHeaderCompanyNameCaption?: string; projectHeaderCompanyNameVisibleFlag?: null | boolean; projectHeaderContactNameCaption?: string; projectHeaderContactNameVisibleFlag?: null | boolean; projectHeaderOriginalDownpaymentCaption?: string; projectHeaderOriginalDownpaymentVisibleFlag?: null | boolean; projectHeaderProjectNameCaption?: string; projectHeaderProjectNameVisibleFlag?: null | boolean; remitToVisibleFlag?: null | boolean; serviceHeaderAmountCaption?: string; serviceHeaderAmountVisibleFlag?: null | boolean; serviceHeaderBillingMethodCaption?: string; serviceHeaderBillingMethodVisibleFlag?: null | boolean; serviceHeaderBundledTicketsVisibleFlag?: null | boolean; serviceHeaderClosedTasksVisibleFlag?: null | boolean; serviceHeaderCompanyNameCaption?: string; serviceHeaderCompanyNameVisibleFlag?: null | boolean; serviceHeaderContactNameCaption?: string; serviceHeaderContactNameVisibleFlag?: null | boolean; serviceHeaderDetailDescriptionCaption?: string; serviceHeaderDetailDescriptionVisibleFlag?: null | boolean; serviceHeaderOpenTasksVisibleFlag?: null | boolean; serviceHeaderResolutionCaption?: string; serviceHeaderResolutionVisibleFlag?: null | boolean; serviceHeaderSummaryCaption?: string; serviceHeaderSummaryVisibleFlag?: null | boolean; serviceHeaderTicketNumberCaption?: string; serviceHeaderTicketNumberVisibleFlag?: null | boolean; servicesAmountCaption?: string; servicesAmountVisibleFlag?: null | boolean; servicesCollapsedFlag?: null | boolean; servicesHoursCaption?: string; servicesHoursVisibleFlag?: null | boolean; servicesMemberNameCaption?: string; servicesMemberNameVisibleFlag?: null | boolean; servicesRateCaption?: string; servicesRateVisibleFlag?: null | boolean; servicesStaffCaption?: string; servicesStaffVisibleFlag?: null | boolean; servicesTotalVisibleFlag?: null | boolean; servicesWorkRoleCaption?: string; servicesWorkRoleVisibleFlag?: null | boolean; servicesWorkTypeCaption?: string; servicesWorkTypeVisibleFlag?: null | boolean; timeDetailAgreementVisibleFlag?: null | boolean; timeDetailAmountBasedExtAmountVisibleFlag?: null | boolean; timeDetailAmountBasedHourlyRateVisibleFlag?: null | boolean; timeDetailAmountBasedHoursVisibleFlag?: null | boolean; timeDetailBillableVisibleFlag?: null | boolean; timeDetailContactsVisibleFlag?: null | boolean; timeDetailDatesVisibleFlag?: null | boolean; timeDetailDollarAmountsOnHourseBasedVisibleFlag?: null | boolean; timeDetailExtendedAmountVisibleFlag?: null | boolean; timeDetailHourlyRateVisibleFlag?: null | boolean; timeDetailHoursBasedExtAmountVisibleFlag?: null | boolean; timeDetailHoursBasedHoursVisibleFlag?: null | boolean; timeDetailHoursVisibleFlag?: null | boolean; timeDetailHoursbasedHourlyRateVisibleFlag?: null | boolean; timeDetailMembersVisibleFlag?: null | boolean; timeDetailNonBillableCaption?: string; timeDetailNotesVisibleFlag?: null | boolean; timeDetailPmPhaseVisibleFlag?: null | boolean; timeDetailPmSummaryVisibleFlag?: null | boolean; timeDetailPrimarySortDirection?: string; timeDetailPrimarySortField?: string; timeDetailSRAddressVisibleFlag?: null | boolean; timeDetailSRContactVisibleFlag?: null | boolean; timeDetailSRTicketSummaryVisibleFlag?: null | boolean; timeDetailSecondarySortDirection?: string; timeDetailSecondarySortField?: string; timeDetailStartEndTimeVisibleFlag?: null | boolean; timeDetailSubtotalVisibleFlag?: null | boolean; timeDetailTicketNumberVisibleFlag?: null | boolean; timeDetailVisibleFlag?: null | boolean }>

putFinanceInvoicesById

  • putFinanceInvoicesById(id: number, invoice: { _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }): Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

  • Parameters

    • id: number
    • invoice: { _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountNumber?: string
      • Optional addToBatchEmailList?: null | boolean
      • Optional adjustedBy?: string
      • Optional adjustmentReason?: string
      • Optional agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional type?: string
      • Optional agreementAmount?: null | number

        Format: double

      • Optional applyToId?: null | number

        Format: int32

      • Optional applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"
      • Optional attention?: string
        description

        Max length: 60;

      • Optional balance?: null | number

        Format: double

      • Optional billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional billingSetupReference?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional billingSiteAddressLine1?: string
      • Optional billingSiteAddressLine2?: string
      • Optional billingSiteCity?: string
      • Optional billingSiteCountry?: string
      • Optional billingSiteState?: string
      • Optional billingSiteZip?: string
      • Optional billingTerms?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional bottomComment?: string
      • Optional company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional credits?: null | number

        Format: double

      • Optional currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional currencyCode?: string
        • Optional currencyIdentifier?: string
        • Optional decimalSeparator?: string
        • Optional displayIdFlag?: boolean
        • Optional displaySymbolFlag?: boolean
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
        • Optional negativeParenthesesFlag?: boolean
        • Optional numberOfDecimals?: number

          Format: int32

        • Optional rightAlign?: boolean
        • Optional symbol?: string
        • Optional thousandsSeparator?: string
      • Optional customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]
      • Optional customerPO?: string
        description

        Max length: 50;

      • Optional date?: string

        Format: date-time

      • Optional departmentId?: null | number

        Format: int32

        description

        departmentId is only required for special invoices

      • Optional downpaymentApplied?: null | number

        Format: double

      • Optional downpaymentPreviouslyTaxedFlag?: null | boolean
      • Optional dueDate?: string

        Format: date-time

      • Optional emailTemplateId?: null | number

        Format: int32

        description

        Can be obtained via InvoiceEmailTemplate report

      • Optional expenseTotal?: null | number

        Format: double

      • Optional id?: number

        Format: int32

      • Optional internalNotes?: string
      • Optional invoiceNumber?: string
        description

        Max length: 15; Required On Updates;

      • Optional invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional locationId?: null | number

        Format: int32

        description

        Required On Updates;

      • Optional overrideDownPaymentAmountFlag?: null | boolean
      • Optional payments?: null | number

        Format: double

      • Optional phase?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional previousProgressApplied?: null | number

        Format: double

      • Optional productTotal?: null | number

        Format: double

      • Optional project?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional reference?: string
        description

        Max length: 50;

      • Optional remainingDownpayment?: null | number

        Format: double

      • Optional restrictDownpaymentFlag?: null | boolean
      • Optional salesOrder?: { _info?: {}; id?: null | number; identifier?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
      • Optional salesTax?: null | number

        Format: double

      • Optional serviceAdjustmentAmount?: null | number

        Format: double

      • Optional serviceTotal?: null | number

        Format: double

      • Optional shipToAttention?: string
        description

        Max length: 60;

      • Optional shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional shippingSite?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional shippingSiteAddressLine1?: string
      • Optional shippingSiteAddressLine2?: string
      • Optional shippingSiteCity?: string
      • Optional shippingSiteCountry?: string
      • Optional shippingSiteState?: string
      • Optional shippingSiteZip?: string
      • Optional specialInvoiceFlag?: null | boolean
      • Optional status?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional subtotal?: null | number

        Format: double

      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableFlag?: null | boolean
      • Optional templateSetupId?: null | number

        Format: int32

        description

        Can be obtained via InvoiceTemplate report

      • Optional territoryId?: null | number

        Format: int32

      • Optional ticket?: { _info?: {}; id?: null | number; summary?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional summary?: string
      • Optional topComment?: string
      • Optional total?: null | number

        Format: double

      • type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard"

    Returns Promise<{ _info?: {}; accountNumber?: string; addToBatchEmailList?: null | boolean; adjustedBy?: string; adjustmentReason?: string; agreement?: { _info?: {}; id?: null | number; name?: string; type?: string }; agreementAmount?: null | number; applyToId?: null | number; applyToType?: null | "All" | "Project" | "SalesOrder" | "Agreement" | "Ticket" | "ProjectPhase"; attention?: string; balance?: null | number; billToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; billingSetupReference?: { _info?: {}; id?: null | number; name?: string }; billingSite?: { _info?: {}; id?: null | number; name?: string }; billingSiteAddressLine1?: string; billingSiteAddressLine2?: string; billingSiteCity?: string; billingSiteCountry?: string; billingSiteState?: string; billingSiteZip?: string; billingTerms?: { _info?: {}; id?: null | number; name?: string }; bottomComment?: string; company?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; credits?: null | number; currency?: { _info?: {}; currencyCode?: string; currencyIdentifier?: string; decimalSeparator?: string; displayIdFlag?: boolean; displaySymbolFlag?: boolean; id?: null | number; name?: string; negativeParenthesesFlag?: boolean; numberOfDecimals?: number; rightAlign?: boolean; symbol?: string; thousandsSeparator?: string }; customFields?: { caption?: string; entryMethod?: null | "Date" | "EntryField" | "List" | "Option"; id?: null | number; numberOfDecimals?: null | number; type?: null | "TextArea" | "Button" | "Currency" | "Date" | "Hyperlink" | "IPAddress" | "Checkbox" | "Number" | "Percent" | "Text" | "Password"; value?: {} }[]; customerPO?: string; date?: string; departmentId?: null | number; downpaymentApplied?: null | number; downpaymentPreviouslyTaxedFlag?: null | boolean; dueDate?: string; emailTemplateId?: null | number; expenseTotal?: null | number; id?: number; internalNotes?: string; invoiceNumber?: string; invoiceTemplate?: { _info?: {}; id?: null | number; name?: string }; locationId?: null | number; overrideDownPaymentAmountFlag?: null | boolean; payments?: null | number; phase?: { _info?: {}; id?: null | number; name?: string }; previousProgressApplied?: null | number; productTotal?: null | number; project?: { _info?: {}; id?: null | number; name?: string }; reference?: string; remainingDownpayment?: null | number; restrictDownpaymentFlag?: null | boolean; salesOrder?: { _info?: {}; id?: null | number; identifier?: string }; salesTax?: null | number; serviceAdjustmentAmount?: null | number; serviceTotal?: null | number; shipToAttention?: string; shipToCompany?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; shippingSite?: { _info?: {}; id?: null | number; name?: string }; shippingSiteAddressLine1?: string; shippingSiteAddressLine2?: string; shippingSiteCity?: string; shippingSiteCountry?: string; shippingSiteState?: string; shippingSiteZip?: string; specialInvoiceFlag?: null | boolean; status?: { _info?: {}; id?: null | number; name?: string }; subtotal?: null | number; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableFlag?: null | boolean; templateSetupId?: null | number; territoryId?: null | number; ticket?: { _info?: {}; id?: null | number; summary?: string }; topComment?: string; total?: null | number; type: null | "Agreement" | "CreditMemo" | "DownPayment" | "Miscellaneous" | "Progress" | "Standard" }>

putFinanceInvoicesByParentIdPaymentsById

  • putFinanceInvoicesByParentIdPaymentsById(id: number, parentId: number, payment: { _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }): Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

  • Parameters

    • id: number
    • parentId: number
    • payment: { _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional amount?: null | number

        Format: double

      • Optional appliedBy?: string
      • Optional credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional applyToType?: string
        • Optional billingType?: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
      • Optional id?: number

        Format: int32

      • Optional invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional applyToType?: string
        • Optional billingType?: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
      • Optional paymentDate?: string

        Format: date-time

      • Optional type?: string

    Returns Promise<{ _info?: {}; amount?: null | number; appliedBy?: string; credit?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; id?: number; invoice?: { _info?: {}; applyToType?: string; billingType?: string; id?: null | number; identifier?: string }; paymentDate?: string; type?: string }>

putFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById

  • putFinanceTaxCodesByGrandparentIdExpenseTypeExemptionsByParentIdTaxableExpenseTypeLevelsById(id: number, parentId: number, grandparentId: number, taxableExpenseTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • taxableExpenseTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById

  • putFinanceTaxCodesByGrandparentIdProductTypeExemptionsByParentIdTaxableProductTypeLevelsById(id: number, parentId: number, grandparentId: number, taxableProductTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • taxableProductTypeLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById

  • putFinanceTaxCodesByGrandparentIdTaxCodeXRefsByParentIdTaxableXRefLevelsById(id: number, parentId: number, grandparentId: number, taxableXRefLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • taxableXRefLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById

  • putFinanceTaxCodesByGrandparentIdWorkRoleExemptionsByParentIdTaxableWorkRoleLevelsById(id: number, parentId: number, grandparentId: number, taxableWorkRoleLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • grandparentId: number
    • taxableWorkRoleLevel: { _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxCodeLevel?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxCodeLevel?: { _info?: {}; id?: null | number; name?: string } }>

putFinanceTaxCodesById

  • putFinanceTaxCodesById(id: number, taxCode: { _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }): Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

  • Parameters

    • id: number
    • taxCode: { _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional addAllExpenseTypes?: null | boolean
      • Optional addAllProductTypes?: null | boolean
      • Optional addAllWorkRoles?: null | boolean
      • Optional canadaCalculateGSTFlag?: null | boolean
      • Optional cancelDate?: string

        Format: date-time

      • Optional country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional identifier?: string
        • Optional name?: string
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional displayOnInvoiceFlag?: null | boolean
      • effectiveDate: string

        Format: date-time

      • Optional expenseTypeIds?: number[]
        description

        Array of expense type exemptions for the tax code

      • Optional id?: number

        Format: int32

      • identifier: string
        description

        Max length: 8;

      • invoiceCaption: string
        description

        Max length: 25;

      • Optional levelFiveAgencyXref?: string
        description

        Max length: 100;

      • Optional levelFiveApplySingleUnitFlag?: null | boolean
      • Optional levelFiveApplySingleUnitMax?: null | number

        Format: double

      • Optional levelFiveApplySingleUnitMin?: null | number

        Format: double

      • Optional levelFiveCaption?: string
        description

        Max length: 25;

      • Optional levelFiveExpensesFlag?: null | boolean
      • Optional levelFiveProductsFlag?: null | boolean
      • Optional levelFiveRate?: null | number

        Format: double

      • Optional levelFiveRateType?: null | "Percent" | "Amount"
      • Optional levelFiveServicesFlag?: null | boolean
      • Optional levelFiveTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelFiveTaxableMax?: null | number

        Format: double

      • Optional levelFourAgencyXref?: string
        description

        Max length: 100;

      • Optional levelFourApplySingleUnitFlag?: null | boolean
      • Optional levelFourApplySingleUnitMax?: null | number

        Format: double

      • Optional levelFourApplySingleUnitMin?: null | number

        Format: double

      • Optional levelFourCaption?: string
        description

        Max length: 25;

      • Optional levelFourExpensesFlag?: null | boolean
      • Optional levelFourProductsFlag?: null | boolean
      • Optional levelFourRate?: null | number

        Format: double

      • Optional levelFourRateType?: null | "Percent" | "Amount"
      • Optional levelFourServicesFlag?: null | boolean
      • Optional levelFourTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelFourTaxableMax?: null | number

        Format: double

      • Optional levelOneAgencyXref?: string
        description

        Max length: 100;

      • Optional levelOneApplySingleUnitFlag?: null | boolean
      • Optional levelOneApplySingleUnitMax?: null | number

        Format: double

      • Optional levelOneApplySingleUnitMin?: null | number

        Format: double

      • Optional levelOneCaption?: string
        description

        Max length: 25;

      • Optional levelOneExpensesFlag?: null | boolean
      • Optional levelOneProductsFlag?: null | boolean
      • Optional levelOneRate?: null | number

        Format: double

      • Optional levelOneRateType?: null | "Percent" | "Amount"
      • Optional levelOneServicesFlag?: null | boolean
      • Optional levelOneTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelOneTaxableMax?: null | number

        Format: double

      • Optional levelSixAgencyXref?: string
        description

        Max length: 100;

      • Optional levelSixApplySingleUnitFlag?: null | boolean
      • Optional levelSixApplySingleUnitMax?: null | number

        Format: double

      • Optional levelSixApplySingleUnitMin?: null | number

        Format: double

      • Optional levelSixCaption?: string
        description

        Max length: 25;

      • Optional levelSixExpensesFlag?: null | boolean
      • Optional levelSixProductsFlag?: null | boolean
      • Optional levelSixRate?: null | number

        Format: double

      • Optional levelSixRateType?: null | "Percent" | "Amount"
      • Optional levelSixServicesFlag?: null | boolean
      • Optional levelSixTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelSixTaxableMax?: null | number

        Format: double

      • Optional levelThreeAgencyXref?: string
        description

        Max length: 100;

      • Optional levelThreeApplySingleUnitFlag?: null | boolean
      • Optional levelThreeApplySingleUnitMax?: null | number

        Format: double

      • Optional levelThreeApplySingleUnitMin?: null | number

        Format: double

      • Optional levelThreeCaption?: string
        description

        Max length: 25;

      • Optional levelThreeExpensesFlag?: null | boolean
      • Optional levelThreeProductsFlag?: null | boolean
      • Optional levelThreeRate?: null | number

        Format: double

      • Optional levelThreeRateType?: null | "Percent" | "Amount"
      • Optional levelThreeServicesFlag?: null | boolean
      • Optional levelThreeTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelThreeTaxableMax?: null | number

        Format: double

      • Optional levelTwoAgencyXref?: string
        description

        Max length: 100;

      • Optional levelTwoApplySingleUnitFlag?: null | boolean
      • Optional levelTwoApplySingleUnitMax?: null | number

        Format: double

      • Optional levelTwoApplySingleUnitMin?: null | number

        Format: double

      • Optional levelTwoCaption?: string
        description

        Max length: 25;

      • Optional levelTwoExpensesFlag?: null | boolean
      • Optional levelTwoProductsFlag?: null | boolean
      • Optional levelTwoRate?: null | number

        Format: double

      • Optional levelTwoRateType?: null | "Percent" | "Amount"
      • Optional levelTwoServicesFlag?: null | boolean
      • Optional levelTwoTaxCodeXref?: string
        description

        Max length: 50;

      • Optional levelTwoTaxableMax?: null | number

        Format: double

      • Optional productTypeIds?: number[]
        description

        Array of product type exemptions for the tax code

      • Optional removeAllExpenseTypes?: null | boolean
      • Optional removeAllProductTypes?: null | boolean
      • Optional removeAllWorkRoles?: null | boolean
      • Optional workRoleIds?: number[]
        description

        Array of work role exemptions for the tax code

    Returns Promise<{ _info?: {}; addAllExpenseTypes?: null | boolean; addAllProductTypes?: null | boolean; addAllWorkRoles?: null | boolean; canadaCalculateGSTFlag?: null | boolean; cancelDate?: string; country?: { _info?: {}; id?: null | number; identifier?: string; name?: string }; defaultFlag?: null | boolean; description: string; displayOnInvoiceFlag?: null | boolean; effectiveDate: string; expenseTypeIds?: number[]; id?: number; identifier: string; invoiceCaption: string; levelFiveAgencyXref?: string; levelFiveApplySingleUnitFlag?: null | boolean; levelFiveApplySingleUnitMax?: null | number; levelFiveApplySingleUnitMin?: null | number; levelFiveCaption?: string; levelFiveExpensesFlag?: null | boolean; levelFiveProductsFlag?: null | boolean; levelFiveRate?: null | number; levelFiveRateType?: null | "Percent" | "Amount"; levelFiveServicesFlag?: null | boolean; levelFiveTaxCodeXref?: string; levelFiveTaxableMax?: null | number; levelFourAgencyXref?: string; levelFourApplySingleUnitFlag?: null | boolean; levelFourApplySingleUnitMax?: null | number; levelFourApplySingleUnitMin?: null | number; levelFourCaption?: string; levelFourExpensesFlag?: null | boolean; levelFourProductsFlag?: null | boolean; levelFourRate?: null | number; levelFourRateType?: null | "Percent" | "Amount"; levelFourServicesFlag?: null | boolean; levelFourTaxCodeXref?: string; levelFourTaxableMax?: null | number; levelOneAgencyXref?: string; levelOneApplySingleUnitFlag?: null | boolean; levelOneApplySingleUnitMax?: null | number; levelOneApplySingleUnitMin?: null | number; levelOneCaption?: string; levelOneExpensesFlag?: null | boolean; levelOneProductsFlag?: null | boolean; levelOneRate?: null | number; levelOneRateType?: null | "Percent" | "Amount"; levelOneServicesFlag?: null | boolean; levelOneTaxCodeXref?: string; levelOneTaxableMax?: null | number; levelSixAgencyXref?: string; levelSixApplySingleUnitFlag?: null | boolean; levelSixApplySingleUnitMax?: null | number; levelSixApplySingleUnitMin?: null | number; levelSixCaption?: string; levelSixExpensesFlag?: null | boolean; levelSixProductsFlag?: null | boolean; levelSixRate?: null | number; levelSixRateType?: null | "Percent" | "Amount"; levelSixServicesFlag?: null | boolean; levelSixTaxCodeXref?: string; levelSixTaxableMax?: null | number; levelThreeAgencyXref?: string; levelThreeApplySingleUnitFlag?: null | boolean; levelThreeApplySingleUnitMax?: null | number; levelThreeApplySingleUnitMin?: null | number; levelThreeCaption?: string; levelThreeExpensesFlag?: null | boolean; levelThreeProductsFlag?: null | boolean; levelThreeRate?: null | number; levelThreeRateType?: null | "Percent" | "Amount"; levelThreeServicesFlag?: null | boolean; levelThreeTaxCodeXref?: string; levelThreeTaxableMax?: null | number; levelTwoAgencyXref?: string; levelTwoApplySingleUnitFlag?: null | boolean; levelTwoApplySingleUnitMax?: null | number; levelTwoApplySingleUnitMin?: null | number; levelTwoCaption?: string; levelTwoExpensesFlag?: null | boolean; levelTwoProductsFlag?: null | boolean; levelTwoRate?: null | number; levelTwoRateType?: null | "Percent" | "Amount"; levelTwoServicesFlag?: null | boolean; levelTwoTaxCodeXref?: string; levelTwoTaxableMax?: null | number; productTypeIds?: number[]; removeAllExpenseTypes?: null | boolean; removeAllProductTypes?: null | boolean; removeAllWorkRoles?: null | boolean; workRoleIds?: number[] }>

putFinanceTaxCodesByParentIdExpenseTypeExemptionsById

  • putFinanceTaxCodesByParentIdExpenseTypeExemptionsById(id: number, parentId: number, expenseTypeExemption: { _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }): Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

  • Parameters

    • id: number
    • parentId: number
    • expenseTypeExemption: { _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • expenseType: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional id?: number

        Format: int32

      • Optional taxableLevels?: number[]

    Returns Promise<{ _info?: {}; expenseType: { _info?: {}; id?: null | number; name?: string }; id?: number; taxableLevels?: number[] }>

putFinanceTaxCodesByParentIdProductTypeExemptionsById

  • putFinanceTaxCodesByParentIdProductTypeExemptionsById(id: number, parentId: number, productTypeExemption: { _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }): Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    • id: number
    • parentId: number
    • productTypeExemption: { _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • productType: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableLevels?: number[]

    Returns Promise<{ _info?: {}; id?: number; productType: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

putFinanceTaxCodesByParentIdTaxCodeLevelsById

  • putFinanceTaxCodesByParentIdTaxCodeLevelsById(id: number, parentId: number, taxCodeLevel: { _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }): Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

  • Parameters

    • id: number
    • parentId: number
    • taxCodeLevel: { _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }
      • Optional _info?: {}
        • [key: string]: string
      • Optional agencyXref?: string
        description

        Max length: 100;

      • Optional caption?: string
        description

        Max length: 25;

      • Optional id?: number

        Format: int32

      • rateType: null | "Percent" | "Amount"
      • Optional singleUnitFlag?: null | boolean
      • Optional singleUnitMaximum?: null | number

        Format: double

      • Optional singleUnitMinimum?: null | number

        Format: double

      • Optional taxCodeXref?: string
        description

        Max length: 50;

      • Optional taxExpensesFlag?: null | boolean
      • Optional taxLevel?: number

        Format: int32

      • Optional taxProductsFlag?: null | boolean
      • taxRate: null | number

        Format: double

      • Optional taxServicesFlag?: null | boolean
      • Optional taxableMax?: null | number

        Format: double

    Returns Promise<{ _info?: {}; agencyXref?: string; caption?: string; id?: number; rateType: null | "Percent" | "Amount"; singleUnitFlag?: null | boolean; singleUnitMaximum?: null | number; singleUnitMinimum?: null | number; taxCodeXref?: string; taxExpensesFlag?: null | boolean; taxLevel?: number; taxProductsFlag?: null | boolean; taxRate: null | number; taxServicesFlag?: null | boolean; taxableMax?: null | number }>

putFinanceTaxCodesByParentIdTaxCodeXRefsById

  • putFinanceTaxCodesByParentIdTaxCodeXRefsById(id: number, parentId: number, taxCodeXRef: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }): Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

  • Parameters

    • id: number
    • parentId: number
    • taxCodeXRef: { _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }
      • Optional _info?: {}
        • [key: string]: string
      • Optional defaultFlag?: null | boolean
      • description: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional levelFive?: null | "NonTaxable" | "Taxable"
      • Optional levelFour?: null | "NonTaxable" | "Taxable"
      • Optional levelOne?: null | "NonTaxable" | "Taxable"
      • Optional levelSix?: null | "NonTaxable" | "Taxable"
      • Optional levelThree?: null | "NonTaxable" | "Taxable"
      • Optional levelTwo?: null | "NonTaxable" | "Taxable"
      • Optional taxCode?: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string
      • Optional taxableLevels?: number[]

    Returns Promise<{ _info?: {}; defaultFlag?: null | boolean; description: string; id?: number; levelFive?: null | "NonTaxable" | "Taxable"; levelFour?: null | "NonTaxable" | "Taxable"; levelOne?: null | "NonTaxable" | "Taxable"; levelSix?: null | "NonTaxable" | "Taxable"; levelThree?: null | "NonTaxable" | "Taxable"; levelTwo?: null | "NonTaxable" | "Taxable"; taxCode?: { _info?: {}; id?: null | number; name?: string }; taxableLevels?: number[] }>

putFinanceTaxCodesByParentIdWorkRoleExemptionsById

  • putFinanceTaxCodesByParentIdWorkRoleExemptionsById(id: number, parentId: number, workRoleExemption: { _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }): Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

  • Parameters

    • id: number
    • parentId: number
    • workRoleExemption: { _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }
      • Optional _info?: {}
        • [key: string]: string
      • Optional id?: number

        Format: int32

      • Optional taxableLevels?: number[]
      • workRole: { _info?: {}; id?: null | number; name?: string }
        • Optional _info?: {}
          • [key: string]: string
        • Optional id?: null | number

          Format: int32

        • Optional name?: string

    Returns Promise<{ _info?: {}; id?: number; taxableLevels?: number[]; workRole: { _info?: {}; id?: null | number; name?: string } }>

putFinanceTaxIntegrationsById

  • putFinanceTaxIntegrationsById(id: number, taxIntegration: { _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }): Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }>

  • Parameters

    • id: number
    • taxIntegration: { _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }
      • Optional _info?: {}
        • [key: string]: string
      • Optional accountNumber?: string
        description

        Max length: 50;

      • Optional accountingIntegrationFlag?: null | boolean
      • Optional commitTransactionsFlag?: null | boolean
      • Optional companyCode?: string
        description

        Max length: 50;

      • Optional enabledFlag?: null | boolean
      • Optional expenseTaxCode?: string
        description

        Max length: 50;

      • Optional freightTaxCode?: string
        description

        Max length: 50;

      • Optional id?: number

        Format: int32

      • Optional invoiceAmountTaxCode?: string
        description

        Max length: 50;

      • Optional licenseKey?: string
        description

        Max length: 50;

      • Optional productTaxCode?: string
        description

        Max length: 50;

      • Optional salesInvoiceFlag?: null | boolean
      • Optional serviceUrl?: string
        description

        Max length: 250;

      • Optional taxIntegrationType?: "Avalara"
      • Optional taxLineFlag?: null | boolean
      • Optional timeTaxCode?: string
        description

        Max length: 50;

    Returns Promise<{ _info?: {}; accountNumber?: string; accountingIntegrationFlag?: null | boolean; commitTransactionsFlag?: null | boolean; companyCode?: string; enabledFlag?: null | boolean; expenseTaxCode?: string; freightTaxCode?: string; id?: number; invoiceAmountTaxCode?: string; licenseKey?: string; productTaxCode?: string; salesInvoiceFlag?: null | boolean; serviceUrl?: string; taxIntegrationType?: "Avalara"; taxLineFlag?: null | boolean; timeTaxCode?: string }>

Generated using TypeDoc