cityworks
    Preparing search index...

    Class CaseFinancial

    Index

    Case Deposits

    addDefaultDeposits addDeposit deleteDeposit deleteDepositsByCaseId getDeposits searchDeposits

    Case Fees

    addDefaultFees addFee deleteFee deleteFeesByCaseId getAllFeeTemplates getFees searchFees searchFeeTemplates updateFee

    Case Instrument Releases

    addCaseInstrumentRelease deleteCaseInstrumentRelease searchCaseInstrumentReleases

    Case Instruments

    addInstrument deleteInstrument deleteInstrumentsByCaseId getInstruments searchCaseInstruments

    Case Payment Refunds

    addRefund deleteRefund searchRefunds

    Case Payments

    addDepositPayment addPayment deletePayment deletePaymentsByCaseId getPayments makePayment searchPayments

    Case Refund Payment

    voidRefund

    Fees

    fees searchAvailableFees

    Instruments

    getInstrumentList

    Tender Types

    addTenderType getTenderTypes updateTenderType

    Case Deposits

    • Adds Default Case Deposits. Adds deposits to the case specified by the CaObectId and BusCaseId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to add the default deposits

      • busCaseId: number

        The business case ID whose default deposits should be added to the case

      Returns Promise<unknown>

      Returns Promise that represents a collection of Deposit Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase

    • Adds a deposit to the case specified by the CaObectId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to add the fee

      • depositId: number

        The deposit setup id for the deposit to add to the case.

      • Optionalamount: number

        The amount of the deposit (optional)

      • Optionalcomment: string

        Comment text to add to the deposit (optional)

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added deposit. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaDepositItemBase

    • Delete the fee specified by the caFeeId.

      Parameters

      • caDepositId: number

        The Case Deposit ID which should be deleted

      Returns Promise<unknown>

      Returns Promise that represents a collection of Case Deposits.

    • Delete Case Fees by Case ObjectId. Delete from the system all Fees linked to a specific Case as specified by the Case Id parameter (CaObjectId).

      Parameters

      • caObjectId: number

        The Case Object ID whose fees should be deleted

      Returns Promise<unknown>

      Returns Promise that represents a number (?)

    • Get Case Deposit by Case ObjectId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to get the deposits

      Returns Promise<unknown>

      Returns Promise that represents a collection of Case Deposits.

    • Search for Case Deposits. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The parameters to search by.

      Returns Promise<unknown>

      Returns Promise that represents an Array of case fee IDs

    Case Fees

    • Adds Default Case Fees. Adds fees to the case specified by the CaObectId and BusCaseId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to add the default fees

      • busCaseId: number

        The business case ID whose default fees should be added to the case

      Returns Promise<unknown>

      Returns Promise that represents a collection of Fee Items. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase

    • Adds a fee to the case specified by the CaObectId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to add the fee

      • feeSetupId: number

        The fee setup id for the fee to add to the case.

      • Optionaloptions: Object

        See /{subdirectory}/apidocs/#/service-info/Pll/CaseFees for more options. (Checkboxes -- Autorecalculate -- are Y/N strings)

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase

    • Delete the fee specified by the caFeeId.

      Parameters

      • caFeeId: number

        The Case Fee ID which should be deleted

      Returns Promise<unknown>

      Returns Promise that represents a Case Fee object.

    • Delete Case Fees by Case ObjectId. Delete from the system all Fees linked to a specific Case as specified by the Case Id parameter (CaObjectId).

      Parameters

      • caObjectId: number

        The Case Object ID whose fees should be deleted

      Returns Promise<unknown>

      Returns Promise that represents a number (?)

    • Get All Fee Templates

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase

    • Gets the fees from the case specified by the CaObectId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to get the fees

      Returns Promise<unknown>

      Returns Promise that represents a collection of Case Fees.

    • Search for Case Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The parameter(s) to search by

      Returns Promise<unknown>

      Returns Promise that represents an Array of case fee IDs

    • Search for Fees. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The parameters to search by

      Returns Promise<unknown>

      Returns Promise that represents an Array of case fee IDs

    • Updates a fee specified by the CaFeeId.

      Parameters

      • caFeeId: number

        The Fee ID for the specific instance of the fee you wish to update

      • Optionaloptions: Object

        See /{subdirectory}/apidocs/#/service-info/Pll/CaseFees for more options. (Checkboxes -- Autorecalculate -- are Y/N strings)

      Returns Promise<unknown>

      Returns Promise that represents an object describing the updated fee. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaFeesItemBase

    Case Instrument Releases

    • Adds a release to a case instrument specified by the caInstrumentId. Must provide either amountReleased OR percentReleased

      Parameters

      • caInstrumentId: number

        The Case Instrument ID to which to add the instrument release

      • releasedBy: number

        UserID to attach to the release.

      • dateReleased: Date

        The date of the release

      • OptionalamountReleased: number

        The amount to be released

      • OptionalpercentReleased: number

        OR the percent to be released

      • Optionalcomment: string

        Comment to attach to the release

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase

    • Deletes a release specified by the caInstReleasesId.

      Parameters

      • caInstReleasesId: number

        The Case Instrument Release ID to delete

      Returns Promise<unknown>

      Returns Promise that represents an object describing the deleted instrument release. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaInstReleasesItemBase

    • Search for Case Instrument Releases. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.

      Parameters

      • filters: Object

        Specify at least one of the following: AmountReleased, CaInstReleasesId, CaInstrumentId, CommentText, PercentReleased, ReleasedBy

      Returns Promise<unknown>

      Returns Promise that represents an Array of Case Instruments resulting from the search

    Case Instruments

    • Adds an instrument to the case specified by the CaObectId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to add the instrument

      • instTypeId: number

        The instrument type id for the instrument being added to the case.

      • amount: number

        The amount of the instrument

      • dateExpire: Date

        The datetime for the instrument to expire.

      • Optionaloptions: Object

        See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument for more options.

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added instrument. See /{subdirectory}/apidocs/#/service-info/Pll/CaseInstrument

    • Delete the instrument specified by the caInstrumentId.

      Parameters

      • caInstrumentId: number

        The Case Instrument ID which should be deleted

      Returns Promise<unknown>

      Returns Promise that represents a Case Instrument.

    • Delete Case Instruments by Case ObjectId. Delete from the system all Instruments linked to a specific Case as specified by the Case Id parameter (CaObjectId).

      Parameters

      • caObjectId: number

        The Case Object ID whose instruments should be deleted

      Returns Promise<unknown>

      Returns Promise that represents a number (?)

    • Gets the instruments from the case specified by the CaObectId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to get the fees

      Returns Promise<unknown>

      Returns Promise that represents a collection of Case Instruments.

    • Search for Case Instruments. Include at least one of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The parameters to search by (AddressLine1, Amount, CaInstrumentId, CityName, CommentText, Company, ContactEmail, ContactName, ContactPhone, CountryCode, InstTypeId, SerialNumber, StateCode, ZipCode)

      Returns Promise<unknown>

      Returns Promise that represents an Array of case instrument IDs

    Case Payment Refunds

    • Add Case Payment Refund. Refunds a payment on the case payment specified by caPaymentId.

      Parameters

      • caPaymentId: number

        The Case Payment ID for the case payment which to refund

      • refundAmount: number

        The amount to refund

      • comment: string

        A comment to append to the refund

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase

    • Delete Case Payment Refund. Removes a refund on a payment.

      Parameters

      • caPaymentRefundId: number

        The Case Payment ID for the case payment which to refund

      Returns Promise<unknown>

      Returns Promise that represents an object describing the deleted payment refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase

    • Search for Case Payment Refunds. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The filters to search for matched Case Payments.

      Returns Promise<unknown>

      Returns Promise that represents an Array of case payment refund IDs

    Case Payments

    • Add Case Deposit Payment. Adds a payment to the case deposit specified by CaDepositId.

      Parameters

      • caDepositId: number

        The Case Deposit ID for the case deposit to which to add the fee

      • options: Object

        See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase

    • Add Case Fee Payment. Adds a payment to the case fee specified by caObjectId.

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to add the fee

      • options: Object

        See /{subdirectory}/apidocs/#/service-info/Pll/CasePayment for more options, including required fields.

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added payment. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentItemBase

    • Delete a Case Payment by Id. Delete a specific case payment by CaPaymentId.

      Parameters

      • caFeeId: number

      Returns Promise<unknown>

      Returns Promise that represents a Case Payment object.

    • Delete Case Payments by Case ObjectId. Delete from the system all payments associated to a specific case as specified by the case id (CaObjectId)

      Parameters

      • caObjectId: number

        The Case Object ID whose payments should be deleted

      Returns Promise<unknown>

      Returns Promise that represents a number (?)

    • Get Case Payments by Case ObjectId

      Parameters

      • caObjectId: number

        The Case Object ID for the case to which to get the payments

      Returns Promise<unknown>

      Returns Promise that represents a collection of Case Payments.

    • Make a Payment. Adds a payment to the case fee(s) specified.

      Parameters

      • payments: string[][]

        The Case Object ID for the case to which to add the fee

      • caseFees: number[]

        Fees this payment should be applied to. Array of CaFeeIds values.

      • OptionalpayerInfo: {
            AddressLine1?: string;
            AddressLine2?: string;
            AddressLine3?: string;
            CityName?: string;
            CommentText?: string;
            CountryCode?: string;
            Email?: string;
            FaxNumber?: string;
            PhoneHome?: string;
            PhoneMobile?: string;
            PhoneWork?: string;
            PhoneWorkExt?: string;
            StateCode?: string;
            stringName: string;
            WebSiteUrl?: string;
            ZipCode?: string;
        }

        Payer info for the payment being made.

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added payment.

    • Search for Case Payments. Include one or more of the search fields. A logical 'and' operation is applied for multiple search fields.

      Parameters

      • filters: Object

        The filters to search for matched Case Payments

      Returns Promise<unknown>

      Returns Promise that represents an Array of case payment IDs

    Case Refund Payment

    • Void a refund.

      Parameters

      • caPaymentRefundId: number

        The Refund ID for the specific refund to void

      • voided: string

        A string. No clue.

      Returns Promise<unknown>

      Returns Promise that represents an object describing the voided refund. See /{subdirectory}/apidocs/#/data-type-info;dataType=CaPaymentRefundItemBase

    Fees

    • Get All Fees

      Returns Promise<unknown>

      Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase

    • Search for Fees. Include one or more of the search fields. A logical 'and' operation is applied for muliple search fields.

      Parameters

      • filters: {
            AccountCode?: string;
            FeeCode?: string;
            FeeDesc?: string;
            FeeSetupId?: number;
            FeeTypeId?: number;
        }

        Specify at least one.

      Returns Promise<unknown>

      Returns Promise that represents a collection of FeeSetups. See /{subdirectory}/apidocs/#/data-type-info;dataType=FeeSetupItemBase

    Instruments

    • Get the Defined Instruments

      Parameters

      • options: Object

        the options to filter the instruments returned by

      Returns Promise<unknown>

      Returns Promise that represents an Array of CaInstrumentItem

    Tender Types

    • Adds a tender type configuration

      Parameters

      • options: Object

        See /{subdirectory}/apidocs/#/service-info/Pll/TenderType

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem

    • Get all tender types configured

      Returns Promise<unknown>

      Returns Promise that represents a collection of tender type objects. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem

    • Update a tender type configuration

      Parameters

      • tenderTypeId: number

        ID of the tender type to update

      • options: Object

        See /{subdirectory}/apidocs/#/service-info/Pll/TenderType

      Returns Promise<unknown>

      Returns Promise that represents an object describing the newly-added tender type. See /{subdirectory}/apidocs/#/data-type-info;dataType=TenderTypeItem

    Settings

    Member Visibility

    On This Page

    Case Deposits
    Case Fees
    Case Instrument Releases
    Case Instruments
    Case Payment Refunds
    Case Payments
    Case Refund Payment
    Fees
    Instruments
    Tender Types