Pennylane Get

Pennylane Get

Certified

Get a Pennylane customer invoice

Retrieves a single customer invoice by its ID.

yaml
type: io.kestra.plugin.pennylane.customerinvoices.Get

Get a customer invoice by ID

yaml
id: get_pennylane_customer_invoice
namespace: company.finance

tasks:
  - id: get_invoice
    type: io.kestra.plugin.pennylane.customerinvoices.Get
    apiToken: "{{ secret('PENNYLANE_API_TOKEN') }}"
    invoiceId: 42
Properties

Pennylane API token

Company or firm API token used to authenticate against the Pennylane API. Store it securely as a Kestra secret.

Customer invoice ID

Unique identifier of the customer invoice to retrieve.

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://app.pennylane.com/api/external/v2

Pennylane API base URL

Base endpoint URL for Pennylane API calls. Defaults to https://app.pennylane.com/api/external/v2.

HTTP client options

Optional HTTP client configuration (timeouts, proxy, SSL) applied to every request.

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*object
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*object
tokenstring

The token for bearer token authentication.

type*object
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

The retrieved customer invoice

Definitions
additionalPropertiesobject
Default{}
amountobject

Total invoice amount including tax in euros

created_atstring

Creation timestamp in Pennylane

credit_noteboolean

Whether this document is a credit note

currencystring

Currency code (e.g. 'EUR', 'USD')

currency_amountobject

Total invoice amount in document currency

currency_taxobject

Tax / VAT amount in document currency

customerobject

Customer reference summary

datestring

Invoice issue date (YYYY-MM-DD)

deadlinestring

Invoice payment deadline (YYYY-MM-DD)

draftboolean

Whether the invoice is in draft state

idinteger

Customer invoice unique identifier

invoice_numberstring

Customer invoice number

labelstring

Customer invoice label

paidboolean

Whether the invoice has been fully paid

public_file_urlstring

Public temporary download URL for the invoice PDF

taxobject

Tax / VAT amount in euros

updated_atstring

Last update timestamp in Pennylane