@fimwise-task/fimwise-shared-list

@fimwise-task/fimwise-shared-list is a Node.js module that provides various task handlers for managing shared lists within the Fimwise platform.

Prerequisites

• Node.js (>= 20.x)
• npm (>= 10.x)

Usage

To use these task handlers, you need to define them in the process configuration file. Below are examples of how to define each task.

Get Companies

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-companies"
}

Get Company

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-company",
  "parameters": {
    "companyId": "company-123"
  }
}

Parameters:

• companyId: The ID of the company. This is required.

Get Currencies

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-currencies"
}

Get Currency

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-currency",
  "parameters": {
    "currencyId": "currency-123"
  }
}

Parameters:

• currencyId: The ID of the currency. This is required.

Get Dropdown Types

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-dropdown-types"
}

Get Dropdown Type

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-dropdown-type",
  "parameters": {
    "dropdownTypeId": "dropdownType-123"
  }
}

Parameters:

• dropdownTypeId: The ID of the dropdown type. This is required.

Get Invoice Types

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-invoice-types"
}

Get Invoice Type

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-invoice-type",
  "parameters": {
    "invoiceTypeId": "invoiceType-123"
  }
}

Parameters:

• invoiceTypeId: The ID of the invoice type. This is required.

Get Payment Contacts

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-payment-contacts"
}

Get Payment Contact

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-payment-contact",
  "parameters": {
    "paymentContactId": "paymentContact-123"
  }
}

Parameters:

• paymentContactId: The ID of the payment contact. This is required.

Get Payment Deadlines

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-payment-deadlines"
}

Get Payment Deadline

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-payment-deadline",
  "parameters": {
    "paymentDeadlineId": "paymentDeadline-123"
  }
}

Parameters:

• paymentDeadlineId: The ID of the payment deadline. This is required.

Get Payment Methods

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-payment-methods"
}

Get Payment Method

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-payment-method",
  "parameters": {
    "paymentMethodId": "paymentMethod-123"
  }
}

Parameters:

• paymentMethodId: The ID of the payment method. This is required.

Get Projects

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-projects"
}

Get Project

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-project",
  "parameters": {
    "projectId": "project-123"
  }
}

Parameters:

• projectId: The ID of the project. This is required.

Get Suppliers

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-suppliers"
}

Get Supplier

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-supplier",
  "parameters": {
    "supplierId": "supplier-123"
  }
}

Parameters:

• supplierId: The ID of the supplier. This is required.

Get Tax Types

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-tax-types"
}

Get Tax Type

{
  "name": "package:@fimwise-task/fimwise-shared-list:get-tax-type",
  "parameters": {
    "taxTypeId": "taxType-123"
  }
}

Parameters:

• taxTypeId: The ID of the tax type. This is required.

License

This project is licensed under the MIT License.