Create Invoice with Alegra API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Alegra, npm and 2,400+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

Create Invoice with the Alegra API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a npm trigger and Alegra action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Invoice action
1. Connect your Alegra account
2. Optional- Select a Status
3. Optional- Configure Number Template ID
4. Optional- Configure Number Template Prefix
5. Optional- Configure Number Template Number
6. Configure Items
7. Optional- Configure Payments
8. Optional- Configure Estimate
9. Optional- Configure Terms and Conditions
10. Optional- Configure Annotation
11. Configure Due Date
12. Configure Date
13. Optional- Configure Observations
14. Select a Client
15. Optional- Select a Seller
16. Optional- Select a Price List
17. Optional- Configure Currency
18. Optional- Configure Retentions
19. Optional- Select a Warehouse
20. Optional- Configure Remissions
21. Optional- Select a Cost Center
22. Optional- Configure Comments
23. Optional- Select a Periodicity
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

import app from "../../npm.app.mjs";

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      ts,
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation.
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Invoice on Alegra

Description:Creates a new invoice in Alegra. [See the documentation](https://developer.alegra.com/reference/post_invoices)

Version:0.0.1

Key:alegra-create-invoice

View on GitHub

Alegra Overview#

Alegra API allows for the automation and integration of accounting and financial tasks within Alegra's software platform. Through the API, developers can create, read, update, and delete information related to invoices, clients, products, services, and more. Essentially, it's a way to streamline financial operations, ensure data accuracy, and free up time from manual data entry by connecting Alegra to other business tools and services.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import alegra from "../../alegra.app.mjs";
import {
  INVOICE_STATUS_OPTIONS, PERIODICITY_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "alegra-create-invoice",
  name: "Create Invoice",
  description: "Creates a new invoice in Alegra. [See the documentation](https://developer.alegra.com/reference/post_invoices)",
  version: "0.0.1",
  type: "action",
  props: {
    alegra,
    status: {
      type: "string",
      label: "Status",
      description: "Status of the invoice. If this attribute is not sent and no associated payments are sent, the invoice is created in \"draft\". If payments are sent to the invoice, the invoice is created in \"open\".",
      options: INVOICE_STATUS_OPTIONS,
      optional: true,
    },
    numberTemplateId: {
      type: "string",
      label: "Number Template ID",
      description: "Number template ID for the invoice. You can use this to automatically numbering.",
      optional: true,
    },
    numberTemplatePrefix: {
      type: "string",
      label: "Number Template Prefix",
      description: "Number template prefix for the invoice. Send in case the numbering is manual. (Optional)",
      optional: true,
    },
    numberTemplateNumber: {
      type: "string",
      label: "Number Template Number",
      description: "Number template number for the invoice. Send in case the numbering is manual. (Required)",
      optional: true,
    },
    items: {
      type: "string[]",
      label: "Items",
      description: "Array of item objects (products/services) associated with the invoice. **Example: [{\"id\": \"123\", \"name\": \"Name\", \"price\": \"12.00\", \"quantity\": \"2\"}]**. [See the documentation](https://developer.alegra.com/reference/post_invoices) for further information.",
    },
    payments: {
      type: "string[]",
      label: "Payments",
      description: "Array of objects indicating the payments made to the invoice. **Example: [{\"date\": \"YYYY-MM-DD\", \"account\": \"123123\", \"amount\": \"10,00\"}]**. [See the documentation](https://developer.alegra.com/reference/post_invoices) for further information.",
      optional: true,
    },
    estimate: {
      type: "string",
      label: "Estimate",
      description: "Specifies the identifier of the quote you want to associate with the sales invoice, in this way, the quote is invoiced and the items specified in the items parameter are associated, not those in the quote.",
      optional: true,
    },
    termsConditions: {
      type: "string",
      label: "Terms and Conditions",
      description: "Terms and conditions of the invoice. Maximum allowed length: 500.",
      optional: true,
    },
    annotation: {
      type: "string",
      label: "Annotation",
      description: "Invoice notes, visible in the PDF or printed document. Maximum allowed length: 500.",
      optional: true,
    },
    dueDate: {
      type: "string",
      label: "Due Date",
      description: "Invoice due date. Format yyyy-MM-dd.",
    },
    date: {
      type: "string",
      label: "Date",
      description: "Invoice date. Format yyyy-MM-dd.",
    },
    observations: {
      type: "string",
      label: "Observations",
      description: "Invoice observations (not visible in the PDF or printed document). Maximum allowed length: 500.",
      optional: true,
    },
    client: {
      propDefinition: [
        alegra,
        "client",
      ],
    },
    seller: {
      propDefinition: [
        alegra,
        "seller",
      ],
      description: "Seller associated with the invoice.",
      optional: true,
    },
    pricelist: {
      propDefinition: [
        alegra,
        "priceList",
      ],
      description: "Price list associated with the invoice",
      optional: true,
    },
    currency: {
      type: "object",
      label: "Currency",
      description: "Object that includes the information of the currency and exchange rate associated with the invoice. It should only be included if the company has the multi-currency functionality active and has configured the selected currency. It must include the currency code (three letters according to ISO) and the exchange rate.",
      optional: true,
    },
    retentions: {
      type: "string[]",
      label: "Retentions",
      description: "Array of retention objects indicating the retentions of the sales invoice. **Example: [{\"id\": \"123123\", \"amount\": 10}]**. [See the documentation](https://developer.alegra.com/reference/post_invoices) for further information.",
      optional: true,
    },
    warehouse: {
      propDefinition: [
        alegra,
        "warehouse",
      ],
      optional: true,
    },
    remissions: {
      type: "string[]",
      label: "Remissions",
      description: "Array of identifiers of the remissions to be invoiced, you can associate one or more remissions by simply indicating the id of each one in an array. The client of the remissions and the sales invoice must be the same. Only open remissions can be invoiced. In this way, the items of each remission will be invoiced, and you can also specify other items with the items parameter. **Example: [{\"id\": 123, \"items\": [{\"id\": 123}], }]**.  [See the documentation](https://developer.alegra.com/reference/post_invoices) for further information.",
      optional: true,
    },
    costCenter: {
      propDefinition: [
        alegra,
        "costCenter",
      ],
      optional: true,
    },
    comments: {
      type: "string[]",
      label: "Comments",
      description: "Array of strings with each of the comments to be associated. Comments can be updated even if the sales invoice cannot be edited.",
      optional: true,
    },
    periodicity: {
      type: "string",
      label: "Periodicity",
      description: "Indicates the periodicity of the payments of the invoice installments. If you want to issue the invoice, the payment method is on credit this attribute becomes mandatory.",
      options: PERIODICITY_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const invoice = await this.alegra.generateInvoice({
        $,
        data: {
          status: this.status,
          numberTemplate: {
            id: this.numberTemplateId,
            prefix: this.numberTemplatePrefix,
            number: this.numberTemplateNumber,
          },
          items: parseObject(this.items),
          payments: parseObject(this.payments),
          estimate: this.estimate,
          termsConditions: this.termsConditions,
          annotation: this.annotation,
          dueDate: this.dueDate,
          date: this.date,
          observations: this.observations,
          client: {
            id: this.client,
          },
          seller: this.seller,
          pricelist: this.pricelist,
          currency: parseObject(this.currency),
          retentions: parseObject(this.retentions),
          warehouse: this.warehouse,
          remissions: parseObject(this.remissions),
          costCenter: this.costCenter,
          comments: parseObject(this.comments),
          periodicity: this.periodicity,
        },
      });
      $.export("$summary", `Created invoice with ID ${invoice.id}`);
      return invoice;
    } catch (e) {
      throw new ConfigurationError(e.response.data.message);
    }
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Alegra	`alegra`	`app`	This component uses the Alegra app.
Status	`status`	`string`	Select a value from the drop down menu:`draftopen`
Number Template ID	`numberTemplateId`	`string`	Number template ID for the invoice. You can use this to automatically numbering.
Number Template Prefix	`numberTemplatePrefix`	`string`	Number template prefix for the invoice. Send in case the numbering is manual. (Optional)
Number Template Number	`numberTemplateNumber`	`string`	Number template number for the invoice. Send in case the numbering is manual. (Required)
Items	`items`	`string[]`	Array of item objects (products/services) associated with the invoice. Example: [{"id": "123", "name": "Name", "price": "12.00", "quantity": "2"}]. See the documentation for further information.
Payments	`payments`	`string[]`	Array of objects indicating the payments made to the invoice. Example: [{"date": "YYYY-MM-DD", "account": "123123", "amount": "10,00"}]. See the documentation for further information.
Estimate	`estimate`	`string`	Specifies the identifier of the quote you want to associate with the sales invoice, in this way, the quote is invoiced and the items specified in the items parameter are associated, not those in the quote.
Terms and Conditions	`termsConditions`	`string`	Terms and conditions of the invoice. Maximum allowed length: 500.
Annotation	`annotation`	`string`	Invoice notes, visible in the PDF or printed document. Maximum allowed length: 500.
Due Date	`dueDate`	`string`	Invoice due date. Format yyyy-MM-dd.
Date	`date`	`string`	Invoice date. Format yyyy-MM-dd.
Observations	`observations`	`string`	Invoice observations (not visible in the PDF or printed document). Maximum allowed length: 500.
Client	`client`	`integer`	Select a value from the drop down menu.
Seller	`seller`	`string`	Select a value from the drop down menu.
Price List	`pricelist`	`string`	Select a value from the drop down menu.
Currency	`currency`	`object`	Object that includes the information of the currency and exchange rate associated with the invoice. It should only be included if the company has the multi-currency functionality active and has configured the selected currency. It must include the currency code (three letters according to ISO) and the exchange rate.
Retentions	`retentions`	`string[]`	Array of retention objects indicating the retentions of the sales invoice. Example: [{"id": "123123", "amount": 10}]. See the documentation for further information.
Warehouse	`warehouse`	`string`	Select a value from the drop down menu.
Remissions	`remissions`	`string[]`	Array of identifiers of the remissions to be invoiced, you can associate one or more remissions by simply indicating the id of each one in an array. The client of the remissions and the sales invoice must be the same. Only open remissions can be invoiced. In this way, the items of each remission will be invoiced, and you can also specify other items with the items parameter. Example: [{"id": 123, "items": [{"id": 123}], }]. See the documentation for further information.
Cost Center	`costCenter`	`string`	Select a value from the drop down menu.
Comments	`comments`	`string[]`	Array of strings with each of the comments to be associated. Comments can be updated even if the sales invoice cannot be edited.
Periodicity	`periodicity`	`string`	Select a value from the drop down menu:`BIWEEKLYMONTHLYBIMONTHLYQUARTERLYSEMIANNUALLYMANUAL`