Deel Invoices List

Deel Invoices List

Certified

List Invoices

List workforce invoices. Requires the accounting: read scope. Supports offset- and cursor-based pagination.

yaml
type: io.kestra.plugin.deel.invoices.List

List paid invoices

yaml
id: list_invoices
namespace: company.team
tasks:
  - id: list_invoices
    type: io.kestra.plugin.deel.invoices.List
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    limit: 25
    fetchType: FETCH

List all invoices issued in a date range

yaml
id: list_all_invoices
namespace: company.team
tasks:
  - id: list_invoices
    type: io.kestra.plugin.deel.invoices.List
    apiToken: "{{ secret('DEEL_API_TOKEN') }}"
    status: "all"
    issuedFrom: "2024-01-01"
    issuedTo: "2024-12-31"
    limit: 50
    fetchType: STORE
Installation

Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command: 

kestractl plugins get io.kestra.plugin:plugin-deel --compatible-for $KESTRA_VERSION

For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.

For Kestra CLI, replace LATEST with a specific version or version range to pin the plugin version.

Properties

Deel API token

API token for authentication. Can be an organization token, personal token, or worker token.

Default2026-01-01

API version

API version header value. Defaults to 2026-01-01.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Defaulthttps://api.letsdeel.com/rest

Deel API base URL

Base URL for the Deel API. Use https://api-sandbox.demo.deel.com/rest for sandbox environment.

Filter by contract ID

Filter invoices by related contract ID.

Cursor for pagination

Return the next page of results after the given cursor.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

Result handling mode

Controls how hits are exposed in outputs. FETCH returns all hits in the response. FETCH_ONE returns only the first hit. STORE writes hits to Kestra storage and returns a URI. NONE leaves outputs empty.

Filter by issued-from date

Filter invoices issued on or after the specified date.

Filter by issued-to date

Filter invoices issued before the specified date.

Default25

Maximum number of invoices per page

Number of invoices to return per page. Default is 25.

Default0

Offset for pagination

Index of the first record to return. Default is 0.

Filter by status

By default only paid invoices are returned. Use 'all' to return invoices in all statuses.

Next page cursor

Cursor for the next page of results. Returned when more pages are available.

First invoice

Available only when fetchType=FETCH_ONE; contains the first invoice.

SubTypeobject

Fetched invoices

Available only when fetchType=FETCH; contains invoices for the current response page.

Number of invoices returned in this response

Number of invoices included in outputs for the selected fetch type.

Total number of invoices

Total invoices reported by the API, regardless of pagination.

Formaturi

Stored invoices URI

Available only when fetchType=STORE; Kestra internal storage path to the Ion file.

More Plugins in this Category

Dataform
Dataform

Tasks that run Dataform data transformations through the Dataform CLI.

Data

1 tasks

6 blueprints

Google Workspace
Google Workspace

Tasks that work with Google Workspace services (Chat, Drive, Calendar, Mail, Sheets).

BusinessData

25 tasks

13 blueprints