Pennylane connection for LinkyFlow

LinkyFlow brings Pennylane ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

901

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Accounting

Analytical Ledger Exports

The analytical general ledger of a period as a file: ask for one, then read it by its id until it is ready. Its link lasts 30 minutes.

Read

Analytical Ledger Exports

The analytical general ledger of a period as a file: ask for one, then read it by its id until it is ready. Its link lasts 30 minutes.

Route: GET /analyticalLedgerExports

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	Yes	Read exactly this record. An unknown id is Pennylane’s refusal.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`file_url`	string	—	-
`status` default	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Ask for Analytical Ledger Export

Route: POST /mutation/analyticalLedgerExports

Inputs you can set

Name	Type	Required	Description
`mode`	enum	No	Values: in_line, in_column
`period_end`	date	Yes	-
`period_start`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Categories of a Ledger Entry Line

The analytical categories one line is booked on.

Read

Categories of a Ledger Entry Line

The analytical categories one line is booked on.

Route: GET /ledgerEntryLineCategories

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`ledger_entry_line_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`weight`	string	—	-
`category_group`	string	→ categoryGroups	-
`id`	id	→ categoryGroups	-
`analytical_code`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

FEC Exports

The French fiscal export of a period: ask for one, then read it by its id until it is ready. Its link lasts 30 minutes.

Read

FEC Exports

The French fiscal export of a period: ask for one, then read it by its id until it is ready. Its link lasts 30 minutes.

Route: GET /fecExports

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	Yes	Read exactly this record. An unknown id is Pennylane’s refusal.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`file_url`	string	—	-
`status` default	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Ask for FEC Export

Route: POST /mutation/fecExports

Inputs you can set

Name	Type	Required	Description
`period_end`	date	Yes	-
`period_start`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Files of a Ledger Entry

The documents attached to one journal entry.

Read

Files of a Ledger Entry

The documents attached to one journal entry.

Route: GET /ledgerEntryFiles

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`ledger_entry_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`url`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

General Ledger Exports

The general ledger of a period as a file: ask for one, then read it by its id until it is ready. Its link lasts 30 minutes.

Read

General Ledger Exports

The general ledger of a period as a file: ask for one, then read it by its id until it is ready. Its link lasts 30 minutes.

Route: GET /generalLedgerExports

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	Yes	Read exactly this record. An unknown id is Pennylane’s refusal.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`file_url`	string	—	-
`status` default	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Ask for General Ledger Export

Route: POST /mutation/generalLedgerExports

Inputs you can set

Name	Type	Required	Description
`period_end`	date	Yes	-
`period_start`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Journals

The accounting journals.

Used as filter by

Ledger Entries · journal_id

Ledger Entry Lines · journal_id

Transactions · journal_id

Read

Journals

The accounting journals.

Route: GET /journals

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`type`	string	No	Only the records whose type is this.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`code` default	string	—	-
`id` default	id	—	-
`label` default	string	—	-
`type`	string	—	-

Create

Create Journal

Route: POST /mutation/journals

Inputs you can set

Name	Type	Required	Description
`code`	string	Yes	-
`label`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Ledger Accounts

The chart of accounts.

Used as filter by

Customers · ledger_account_id

Lines of a Ledger Entry · ledger_account_id

Ledger Entry Lines · ledger_account_id

Suppliers · ledger_account_id

Read

Ledger Accounts

The chart of accounts.

Route: GET /ledgerAccounts

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`number`	string	No	Only the records whose number is this.
`number_start_with`	string	No	Only the records whose number starts with this.
`enabled`	boolean	No	Only the records whose enabled is this.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`number` default	string	—	-
`label` default	string	—	-
`vat_rate`	string	—	-
`country_alpha2`	string	—	-
`enabled`	boolean	—	-
`type`	string	—	-
`letterable`	boolean	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Create Ledger Account

Route: POST /mutation/ledgerAccounts

Inputs you can set

Name	Type	Required	Description
`country_alpha2`	string	No	-
`label`	string	Yes	-
`number`	string	Yes	-
`vat_rate`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Ledger Account

Route: PATCH /mutation/ledgerAccounts

Inputs you can set

Name	Type	Required	Description
`country_alpha2`	string	No	-
`label`	string	Yes	-
`number`	string	Yes	-
`vat_rate`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Ledger Entries

The journal entries. A create is balanced: its lines’ debits equal their credits.

Used as filter by

Lines of a Ledger Entry · ledger_entry_id

Files of a Ledger Entry · ledger_entry_id

Ledger Entry Lines · ledger_entry_id

Read

Ledger Entries

The journal entries. A create is balanced: its lines’ debits equal their credits.

Route: GET /ledgerEntries

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`date`	date	No	Only the records whose date is this.
`date_gteq`	date	No	On or after this date.
`date_lteq`	date	No	On or before this date.
`journal_id`	id	No	Only the records whose journal_id is this.
`journal_id_in`	string	No	Only the records whose journal_id is one of these, separated by commas.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`label` default	string	—	-
`piece_number`	string	—	-
`date` default	date	—	-
`due_date`	date	—	-
`invoice_number` default	string	—	-
`journal`	string	→ journals	-
`id`	id	→ journals	-
`status` default	enum	—	-
`categories`	string	—	-
`attachment`	string	—	-
`filename`	string	—	-

Create

Create Ledger Entrie

Route: POST /mutation/ledgerEntries

Inputs you can set

Name	Type	Required	Description
`currency`	string	No	-
`date`	date	Yes	-
`due_date`	date	No	-
`journal_id`	id	Yes	-
`label`	string	Yes	-
`ledger_entry_lines`	string	Yes	-
`piece_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Ledger Entrie

Route: PATCH /mutation/ledgerEntries

Inputs you can set

Name	Type	Required	Description
`currency`	string	No	-
`date`	date	Yes	-
`due_date`	date	No	-
`journal_id`	id	Yes	-
`label`	string	Yes	-
`ledger_entry_lines`	string	Yes	-
`piece_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Ledger Entry Lines

Every debit and credit line of the ledger: the general ledger’s rows.

Used as filter by

Categories of a Ledger Entry Line · ledger_entry_line_id

Lines Lettered Together · ledger_entry_line_id

Read

Ledger Entry Lines

Every debit and credit line of the ledger: the general ledger’s rows.

Route: GET /ledgerEntryLines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`journal_id`	id	No	Only the records whose journal_id is this.
`journal_id_in`	string	No	Only the records whose journal_id is one of these, separated by commas.
`ledger_account_id`	id	No	Only the records whose ledger_account_id is this.
`ledger_account_id_in`	string	No	Only the records whose ledger_account_id is one of these, separated by commas.
`ledger_entry_id`	id	No	Only the records whose ledger_entry_id is this.
`ledger_entry_id_in`	string	No	Only the records whose ledger_entry_id is one of these, separated by commas.
`date`	date	No	Only the records whose date is this.
`date_gteq`	date	No	On or after this date.
`date_lteq`	date	No	On or before this date.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id, -date, date
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`debit` default	string	—	-
`credit` default	string	—	-
`label` default	string	—	-
`categories`	string	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-
`number`	string	—	-
`journal`	string	→ journals	-
`id`	id	→ journals	-
`date` default	date	—	-
`ledger_entry`	string	→ ledgerEntries	-
`id`	id	→ ledgerEntries	-
`lettered_ledger_entry_lines`	string	—	-
`ids`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Letter Ledger Entry Lines

Letters these lines together. What an unbalanced lettering does is your choice.

Create

Letter Ledger Entry Lines

Route: POST /mutation/ledgerEntryLinesLetter

Inputs you can set

Name	Type	Required	Description
`ledger_entry_lines`	string	Yes	-
`unbalanced_lettering_strategy`	enum	Yes	Values: none, partial

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Lines Lettered Together

The lines lettered with one line.

Read

Lines Lettered Together

The lines lettered with one line.

Route: GET /ledgerEntryLineLetterings

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`ledger_entry_line_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id, -date, date
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`debit` default	string	—	-
`credit` default	string	—	-
`label` default	string	—	-
`categories`	string	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-
`number`	string	—	-
`journal`	string	→ journals	-
`id`	id	→ journals	-
`date` default	date	—	-
`ledger_entry`	string	→ ledgerEntries	-
`id`	id	→ ledgerEntries	-
`lettered_ledger_entry_lines`	string	—	-
`ids`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Lines of a Ledger Entry

The debit and credit lines of one journal entry.

Read

Lines of a Ledger Entry

The debit and credit lines of one journal entry.

Route: GET /ledgerEntryEntryLines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`ledger_entry_id`	id	Yes	The record whose rows are read.
`ledger_account_id`	id	No	Only the records whose ledger_account_id is this.
`ledger_account_id_in`	string	No	Only the records whose ledger_account_id is one of these, separated by commas.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`debit` default	string	—	-
`credit` default	string	—	-
`label` default	string	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-
`number`	string	—	-

Trial Balance

Debits and credits by ledger account over a period, as Pennylane sums them.

Read

Trial Balance

Debits and credits by ledger account over a period, as Pennylane sums them.

Route: GET /trialBalance

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`period_start`	date	Yes	Period Start of the period (2026-01-31).
`period_end`	date	Yes	Period End of the period (2026-01-31).
`is_auxiliary`	boolean	No	Include the auxiliary accounts.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`number` default	string	—	-
`formatted_number` default	string	—	-
`label` default	string	—	-
`debits` default	string	—	-
`credits` default	string	—	-

Unletter Ledger Entry Lines

Removes the lettering of these lines.

Create

Unletter Ledger Entry Lines

Route: POST /mutation/ledgerEntryLinesUnletter

Inputs you can set

Name	Type	Required	Description
`ledger_entry_lines`	string	Yes	-
`unbalanced_lettering_strategy`	enum	Yes	Values: none, partial

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Analytics

Name	Type	Required	Description
`analytical_code`	string	No	-
`category_group_id`	id	Yes	-
`direction`	enum	No	Values: cash_in, cash_out
`label`	string	Yes	-
`ledger_account_id`	id	No	-

Name	Type	Required	Description
`analytical_code`	string	No	-
`category_group_id`	id	Yes	-
`direction`	enum	No	Values: cash_in, cash_out
`label`	string	Yes	-
`ledger_account_id`	id	No	-

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`direction`	enum	—	-
`analytical_code`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

Category Groups

The analytical axes.

Used as filter by

Categories · category_group_id

Categories of a Group · category_group_id

Read

Category Groups

The analytical axes.

Route: GET /categoryGroups

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Create Category Group

Route: POST /mutation/categoryGroups

Inputs you can set

Name	Type	Required	Description
`kind`	enum	No	Values: profit_and_loss, treasury, building
`label`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Category Group

Route: PATCH /mutation/categoryGroups

Inputs you can set

Name	Type	Required	Description
`kind`	enum	No	Values: profit_and_loss, treasury, building
`label`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Banking

Bank Accounts

The company’s bank accounts.

Used as filter by

Transactions · bank_account_id

Read

Bank Accounts

The company’s bank accounts.

Route: GET /bankAccounts

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`currency`	string	—	-
`balance`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`bank_establishment`	string	→ bankEstablishments	-
`id`	id	→ bankEstablishments	-
`journal`	string	→ journals	-
`id`	id	→ journals	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

Create

Create Bank Account

Route: POST /mutation/bankAccounts

Inputs you can set

Name	Type	Required	Description
`account_type`	enum	No	Values: current, card, savings, shares, loan
`bank_establishment_id`	id	No	-
`bic`	string	No	-
`currency`	string	No	-
`iban`	string	No	-
`name`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Bank Establishments

The banks Pennylane knows.

Read

Bank Establishments

The banks Pennylane knows.

Route: GET /bankEstablishments

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only the records whose id is this.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Categories of a Transaction

The analytical categories of one transaction.

Read

Categories of a Transaction

The analytical categories of one transaction.

Route: GET /transactionCategories

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`transaction_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`weight`	string	—	-
`category_group`	string	→ categoryGroups	-
`id`	id	→ categoryGroups	-
`analytical_code`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

Invoices Matched to a Transaction

The invoices one transaction is reconciled with.

Read

Invoices Matched to a Transaction

The invoices one transaction is reconciled with.

Route: GET /transactionMatchedInvoices

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`transaction_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`type`	enum	—	-
`url`	string	—	-

Transactions

The bank movements. A transaction is no accounting payment until it is matched.

Used as filter by

Categories of a Transaction · transaction_id

Invoices Matched to a Transaction · transaction_id

Read

Transactions

The bank movements. A transaction is no accounting payment until it is matched.

Route: GET /transactions

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`bank_account_id`	id	No	Only the records whose bank_account_id is this.
`bank_account_id_in`	string	No	Only the records whose bank_account_id is one of these, separated by commas.
`journal_id`	id	No	Only the records whose journal_id is this.
`journal_id_in`	string	No	Only the records whose journal_id is one of these, separated by commas.
`date`	date	No	Only the records whose date is this.
`date_gteq`	date	No	On or after this date.
`date_lteq`	date	No	On or before this date.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`date` default	date	—	-
`currency_amount` default	string	—	-
`amount` default	string	—	-
`id` default	id	→ customers	-
`id` default	id	→ suppliers	-

Create

Create Transaction

Route: POST /mutation/transactions

Inputs you can set

Name	Type	Required	Description
`amount`	string	Yes	-
`bank_account_id`	id	Yes	-
`date`	date	Yes	-
`fee`	string	No	-
`label`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Transaction

Route: PATCH /mutation/transactions

Inputs you can set

Name	Type	Required	Description
`amount`	string	Yes	-
`bank_account_id`	id	Yes	-
`date`	date	Yes	-
`fee`	string	No	-
`label`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Changes

Customer Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Customer Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /customerChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Customer Invoice Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Customer Invoice Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /customerInvoiceChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Ledger Entry Category Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Ledger Entry Category Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /ledgerEntryCategoryChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`ledger_entry`	string	→ ledgerEntries	-
`id`	id	→ ledgerEntries	-
`type`	string	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Ledger Entry Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Ledger Entry Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /ledgerEntryChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Ledger Entry Line Category Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Ledger Entry Line Category Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /ledgerEntryLineCategoryChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`ledger_entry_line`	string	→ ledgerEntryLines	-
`id`	id	→ ledgerEntryLines	-
`ledger_entry`	string	→ ledgerEntries	-
`id`	id	→ ledgerEntries	-
`type`	string	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Ledger Entry Line Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Ledger Entry Line Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /ledgerEntryLineChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Product Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Product Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /productChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Quote Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Quote Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /quoteChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Supplier Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Supplier Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /supplierChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Supplier Invoice Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Supplier Invoice Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /supplierInvoiceChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Transaction Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Read

Transaction Changes

What was created, changed or deleted, oldest first, kept 4 weeks. Read every page before keeping the last processed_at as the next start.

Route: GET /transactionChanges

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`start_date`	string	No	The changes from this moment (RFC 3339), at most 4 weeks ago. Never beside a cursor.
`limit`	number	No	Rows per page (max 1000). Default: 1000
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`operation` default	enum	—	-
`processed_at` default	date	—	-
`updated_at`	date	—	-
`created_at`	date	—	-

Company

The company this token belongs to, its user and the scopes the token holds.

Read

Company

The company this token belongs to, its user and the scopes the token holds.

Route: GET /company

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`user`	string	—	-
`id` default	id	—	-
`first_name` default	string	—	-
`last_name` default	string	—	-
`email` default	string	—	-
`locale` default	enum	—	-
`company`	string	—	-
`id`	id	—	-
`name`	string	—	-
`reg_no`	string	—	-
`accounting_logic`	enum	—	-
`scopes`	string[]	—	-

Company Features

What this company’s Pennylane plan offers.

Read

Company Features

What this company’s Pennylane plan offers.

Route: GET /companyFeatures

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-

Data returned in Excel

Field	Type	Relations	Description
`installments` default	boolean	—	-
`custom_fields` default	boolean	—	-

Fiscal Years

The company’s fiscal years.

Read

Fiscal Years

The company’s fiscal years.

Route: GET /fiscalYears

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`start`	date	—	-
`finish`	date	—	-
`status` default	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Mandates

Associate a Customer

Associates this mandate with a customer.

Create

Associate a Customer

Route: POST /mutation/gocardlessMandateAssociate

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-
`gocardless_mandate_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Cancel Mandate

Cancels this mandate.

Create

Cancel Mandate

Route: POST /mutation/gocardlessMandateCancel

Inputs you can set

Name	Type	Required	Description
`gocardless_mandate_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

GoCardless Mandates

The GoCardless mandates of the company’s customers.

Read

GoCardless Mandates

The GoCardless mandates of the company’s customers.

Route: GET /gocardlessMandates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`external_reference`	string	No	Only the records whose external_reference is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`external_reference`	string	—	-
`customer`	string	→ customers	-
`id` default	id	→ customers	-
`status` default	enum	—	-
`external_customer_account`	string	—	-
`external_customer_label`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Pro Account Mandate Migrations

The mandates being moved to the pro account.

Read

Pro Account Mandate Migrations

The mandates being moved to the pro account.

Route: GET /proAccountMandateMigrations

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`status`	string	No	Only the records whose status is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`status` default	enum	—	-
`direct_debit_method`	enum	—	-
`signed_at`	date	—	-
`error_message`	string	—	-
`migrated_at`	date	—	-
`migration_started_at`	date	—	-
`mandate`	string	—	-
`id`	id	—	-
`type`	enum	—	-
`customer`	string	→ customers	-
`id` default	id	→ customers	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Create Pro Account Mandate Migration

Route: POST /mutation/proAccountMandateMigrations

Inputs you can set

Name	Type	Required	Description
`early_execution_date_permitted`	boolean	No	-
`mandate_id`	id	Yes	-
`mandate_type`	enum	Yes	Values: SepaMandate, Mandate

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Pro Account Mandates

The mandates of the company’s Pennylane pro account.

Read

Pro Account Mandates

The mandates of the company’s Pennylane pro account.

Route: GET /proAccountMandates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`status`	string	No	Only the records whose status is this.
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`status` default	string	—	-
`early_execution_date_permitted`	boolean	—	-
`active_billing_subscription`	boolean	—	-
`signed_at`	date	—	-
`created_at`	date	—	-
`pdf_url`	string	—	-
`customer`	string	→ customers	-
`id` default	id	→ customers	-

Request a Mandate by Email

Emails a customer the request to sign a mandate.

Create

Request a Mandate by Email

Route: POST /mutation/gocardlessMandateRequest

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-
`email`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Request a Pro Account Mandate

Emails a customer the request to sign a pro account mandate.

Create

Request a Pro Account Mandate

Route: POST /mutation/proAccountMandateRequest

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

SEPA Mandates

The SEPA direct debit mandates of the company’s customers.

Read

SEPA Mandates

The SEPA direct debit mandates of the company’s customers.

Route: GET /sepaMandates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`bank`	string	—	-
`bic`	string	—	-
`iban`	string	—	-
`sequence_type`	enum	—	-
`signed_at`	date	—	-
`identifier`	string	—	-
`customer`	string	→ customers	-
`id` default	id	→ customers	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Create SEPA Mandate

Route: POST /mutation/sepaMandates

Inputs you can set

Name	Type	Required	Description
`bank`	string	No	-
`bic`	string	Yes	-
`customer_id`	id	Yes	-
`iban`	string	Yes	-
`identifier`	string	Yes	-
`sequence_type`	enum	No	Values: FRST, OOFF, RCUR, FNAL
`signed_at`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update SEPA Mandate

Route: PATCH /mutation/sepaMandates

Inputs you can set

Name	Type	Required	Description
`bank`	string	No	-
`bic`	string	Yes	-
`customer_id`	id	Yes	-
`iban`	string	Yes	-
`identifier`	string	Yes	-
`sequence_type`	enum	No	Values: FRST, OOFF, RCUR, FNAL
`signed_at`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete SEPA Mandate

Route: DELETE /mutation/sepaMandates

Inputs you can set

Name	Type	Required	Description
`bank`	string	No	-
`bic`	string	Yes	-
`customer_id`	id	Yes	-
`iban`	string	Yes	-
`identifier`	string	Yes	-
`sequence_type`	enum	No	Values: FRST, OOFF, RCUR, FNAL
`signed_at`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Purchases

Categories of a Supplier

The analytical categories of one supplier.

Read

Categories of a Supplier

The analytical categories of one supplier.

Route: GET /supplierCategories

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`supplier_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`weight`	string	—	-
`category_group`	string	→ categoryGroups	-
`id`	id	→ categoryGroups	-
`analytical_code`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

Categories of a Supplier Invoice

The analytical categories of one supplier invoice.

Read

Categories of a Supplier Invoice

The analytical categories of one supplier invoice.

Route: GET /supplierInvoiceCategories

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`supplier_invoice_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`weight`	string	—	-
`category_group`	string	→ categoryGroups	-
`id`	id	→ categoryGroups	-
`analytical_code`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

Lines of a Supplier Invoice

The lines of one supplier invoice.

Read

Lines of a Supplier Invoice

The lines of one supplier invoice.

Route: GET /supplierInvoiceLines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`supplier_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`description`	string	—	-
`vat_rate`	string	—	-
`currency_amount_before_tax`	string	—	-
`currency_tax`	string	—	-
`tax`	string	—	-
`imputation_dates`	string	—	-
`start_date`	date	—	-
`end_date`	date	—	-
`performance_period`	string	—	-
`start_date`	date	—	-
`end_date`	date	—	-
`date_type`	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Link a Purchase Request

Links a purchase request to this invoice.

Create

Link a Purchase Request

Route: POST /mutation/supplierInvoiceLinkPurchaseRequest

Inputs you can set

Name	Type	Required	Description
`purchase_request_id`	id	Yes	-
`supplier_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Payments of a Supplier Invoice

The payments recorded on one supplier invoice.

Read

Payments of a Supplier Invoice

The payments recorded on one supplier invoice.

Route: GET /supplierInvoicePayments

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`supplier_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`currency`	string	—	-
`currency_amount` default	string	—	-
`status` default	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Purchase Requests

The company’s purchase requests.

Read

Purchase Requests

The company’s purchase requests.

Route: GET /purchaseRequests

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`reviewed_by_id`	id	No	Only the records whose reviewed_by_id is this.
`reviewed_by_id_in`	string	No	Only the records whose reviewed_by_id is one of these, separated by commas.
`user_id`	id	No	Only the records whose user_id is this.
`user_id_in`	string	No	Only the records whose user_id is one of these, separated by commas.
`supplier_id`	id	No	Only the records whose supplier_id is this.
`supplier_id_in`	string	No	Only the records whose supplier_id is one of these, separated by commas.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`purchase_order_number`	string	—	-
`supplier`	string	→ suppliers	-
`id` default	id	→ suppliers	-
`delivery_address`	string	—	-
`address`	string	—	-
`postal_code`	string	—	-
`city`	string	—	-
`country_alpha2`	string	—	-
`status` default	enum	—	-
`currency`	string	—	-
`reason`	string	—	-
`estimated_delivery_date`	date	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`currency_amount_before_tax`	string	—	-
`exchange_rate`	string	—	-
`currency_tax`	string	—	-
`tax`	string	—	-
`purchase_order`	string	—	-
`filename`	string	—	-
`linked_invoices`	string	—	-
`items`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Supplier Invoices

The invoices received.

Used as filter by

Categories of a Supplier Invoice · supplier_invoice_id

Lines of a Supplier Invoice · supplier_invoice_id

Transactions Matched to a Supplier Invoice · supplier_invoice_id

Payments of a Supplier Invoice · supplier_invoice_id

Read

Supplier Invoices

The invoices received.

Route: GET /supplierInvoices

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`supplier_id`	id	No	Only the records whose supplier_id is this.
`supplier_id_in`	string	No	Only the records whose supplier_id is one of these, separated by commas.
`invoice_number`	string	No	Only the records whose invoice_number is this.
`date`	date	No	Only the records whose date is this.
`date_gteq`	date	No	On or after this date.
`date_lteq`	date	No	On or before this date.
`category_id_in`	string	No	Only the records whose category_id is one of these, separated by commas.
`external_reference`	string	No	Only the records whose external_reference is this.
`payment_status`	string	No	Only the records whose payment_status is this.
`flow_id`	id	No	Only the records whose flow_id is this.
`flow_id_in`	string	No	Only the records whose flow_id is one of these, separated by commas.
`electronic_billing_address`	string	No	Only the records whose electronic_billing_address is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id, -date, date
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`invoice_number` default	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`date` default	date	—	-
`id` default	id	→ suppliers	-

Edit

Update Supplier Invoice

Route: PATCH /mutation/supplierInvoices

Inputs you can set

Name	Type	Required	Description
`amount`	string	No	-
`currency`	string	No	-
`currency_amount`	string	No	-
`currency_amount_before_tax`	string	No	-
`currency_tax`	string	No	-
`date`	date	No	-
`deadline`	date	No	-
`external_reference`	string	No	-
`invoice_lines`	string	No	-
`invoice_number`	string	No	-
`label`	string	No	-
`supplier_id`	id	No	-
`tax`	string	No	-
`transaction_reference.banking_provider`	enum	No	Values: stripe, gocardless, bank, budgetinsight, helloasso
`transaction_reference.provider_field_name`	enum	No	Values: payment_id, charge_id, report_id, webid, label
`transaction_reference.provider_field_value`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Suppliers

The company’s suppliers.

Used as filter by

Purchase Requests · supplier_id

Categories of a Supplier · supplier_id

Supplier Invoices · supplier_id

Read

Suppliers

The company’s suppliers.

Route: GET /suppliers

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`ledger_account_id`	id	No	Only the records whose ledger_account_id is this.
`name_start_with`	string	No	Only the records whose name starts with this.
`external_reference`	string	No	Only the records whose external_reference is this.
`emails_in`	string	No	Only the records whose emails is one of these, separated by commas.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`establishment_no`	string	—	-
`reg_no`	string	—	-
`vat_number`	string	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-
`emails`	string[]	—	-
`iban`	string	—	-
`postal_address`	string	—	-
`address`	string	—	-
`postal_code`	string	—	-
`city`	string	—	-
`country_alpha2`	string	—	-
`supplier_payment_method`	enum	—	-
`supplier_due_date_delay`	number	—	-
`supplier_due_date_rule`	enum	—	-
`external_reference`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Create Supplier

Route: POST /mutation/suppliers

Inputs you can set

Name	Type	Required	Description
`emails`	string	No	-
`establishment_no`	string	No	-
`external_reference`	string	No	-
`iban`	string	No	-
`ledger_account.number`	string	No	-
`name`	string	Yes	-
`postal_address.address`	string	No	-
`postal_address.city`	string	No	-
`postal_address.country_alpha2`	string	No	-
`postal_address.postal_code`	string	No	-
`reg_no`	string	No	-
`supplier_due_date_delay`	number	No	-
`supplier_due_date_rule`	enum	No	Values: days, days_or_end_of_month
`supplier_payment_method`	enum	No	Values: automatic_transfer, manual_transfer, automatic_debiting, bill_of_exchange, check
`vat_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Supplier

Route: PATCH /mutation/suppliers

Inputs you can set

Name	Type	Required	Description
`emails`	string	No	-
`establishment_no`	string	No	-
`external_reference`	string	No	-
`iban`	string	No	-
`ledger_account.number`	string	No	-
`name`	string	Yes	-
`postal_address.address`	string	No	-
`postal_address.city`	string	No	-
`postal_address.country_alpha2`	string	No	-
`postal_address.postal_code`	string	No	-
`reg_no`	string	No	-
`supplier_due_date_delay`	number	No	-
`supplier_due_date_rule`	enum	No	Values: days, days_or_end_of_month
`supplier_payment_method`	enum	No	Values: automatic_transfer, manual_transfer, automatic_debiting, bill_of_exchange, check
`vat_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Transactions Matched to a Supplier Invoice

The bank transactions one supplier invoice is reconciled with. A transaction is no payment: matching one reconciles, it books nothing else.

Read

Transactions Matched to a Supplier Invoice

The bank transactions one supplier invoice is reconciled with. A transaction is no payment: matching one reconciles, it books nothing else.

Route: GET /supplierInvoiceMatchedTransactions

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`supplier_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`date` default	date	—	-
`currency_amount` default	string	—	-
`amount` default	string	—	-
`id` default	id	→ suppliers	-

Create

Create Transactions Matched to a Supplier Invoice

Route: POST /mutation/supplierInvoiceMatchedTransactions

Inputs you can set

Name	Type	Required	Description
`supplier_invoice_id`	id	Yes	-
`transaction_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Transactions Matched to a Supplier Invoice

Route: DELETE /mutation/supplierInvoiceMatchedTransactions

Inputs you can set

Name	Type	Required	Description
`supplier_invoice_id`	id	Yes	-
`transaction_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Update E-Invoice Status

Sets the status of the e-invoice received.

Create

Update E-Invoice Status

Route: POST /mutation/supplierInvoiceEInvoiceStatus

Inputs you can set

Name	Type	Required	Description
`reason`	enum	No	Values: incorrect_vat_rate, contract_completed, duplicate_invoice, recipient_error, incorrect_prices
`status`	enum	Yes	Values: approved
`supplier_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Update Payment Status

Sets the invoice’s payment status. No money moves.

Create

Update Payment Status

Route: POST /mutation/supplierInvoicePaymentStatus

Inputs you can set

Name	Type	Required	Description
`payment_status`	enum	Yes	Values: paid, to_be_paid
`supplier_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Validate Accounting

Validates the invoice’s accounting.

Create

Validate Accounting

Route: POST /mutation/supplierInvoiceValidateAccounting

Inputs you can set

Name	Type	Required	Description
`supplier_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Sales

Appendices of a Commercial Document

The files appended to one commercial document.

Read

Appendices of a Commercial Document

The files appended to one commercial document.

Route: GET /commercialDocumentAppendices

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`commercial_document_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`url`	string	—	-
`filename`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Appendices of a Customer Invoice

The files appended to one customer invoice.

Read

Appendices of a Customer Invoice

The files appended to one customer invoice.

Route: GET /customerInvoiceAppendices

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_invoice_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`url`	string	—	-
`filename`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Appendices of a Quote

The files appended to one quote.

Read

Appendices of a Quote

The files appended to one quote.

Route: GET /quoteAppendices

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`quote_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`url`	string	—	-
`filename`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Billing Subscriptions

The recurring invoices.

Used as filter by

Line Sections of a Billing Subscription · billing_subscription_id

Lines of a Billing Subscription · billing_subscription_id

Customer Invoices · billing_subscription_id

Read

Billing Subscriptions

The recurring invoices.

Route: GET /billingSubscriptions

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`start`	date	No	Only the records whose start is this.
`start_gteq`	date	No	On or after this start.
`start_lteq`	date	No	On or before this start.
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`status`	string	No	Only the records whose status is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`next_occurrence`	date	—	-
`prev_occurrence`	date	—	-
`stopped_at`	date	—	-
`start`	date	—	-
`finish`	date	—	-
`status` default	enum	—	-
`mode`	enum	—	-
`activated_at`	date	—	-
`payment_conditions`	enum	—	-
`payment_method`	enum	—	-
`label` default	string	—	-
`email_settings`	string	—	-
`recipients`	string[]	—	-
`billing_email_template`	string	—	-
`recurring_rule`	string	—	-
`day_of_month`	string	—	-
`month_of_year`	string	—	-
`week_start`	number	—	-
`day`	string	—	-
`rule_type`	enum	—	-
`interval`	number	—	-
`count`	number	—	-
`until`	string	—	-
`customer`	string	→ customers	-
`id` default	id	→ customers	-
`customer_invoice_data`	string	—	-
`label`	string	—	-
`currency`	string	—	-
`amount`	string	—	-
`currency_amount`	string	—	-
`currency_amount_before_tax`	string	—	-
`exchange_rate`	string	—	-
`currency_tax`	string	—	-
`language`	enum	—	-
`customer_invoice_template`	string	—	-
`discount`	string	—	-
`pdf_invoice_free_text`	string	—	-
`pdf_invoice_subject`	string	—	-
`pdf_description`	string	—	-
`special_mention`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Create Billing Subscription

Route: POST /mutation/billingSubscriptions

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-
`customer_invoice_data`	string	Yes	-
`label`	string	No	-
`mode`	string	Yes	-
`payment_conditions`	enum	Yes	Values: upon_receipt, 7_days, 15_days, 30_days, 30_days_end_of_month
`payment_method`	enum	Yes	Values: offline, gocardless_direct_debit, pro_account_sepa_core
`recurring_rule.count`	number	No	-
`recurring_rule.day_of_month`	number	No	-
`recurring_rule.day_of_week`	enum	No	Values: monday, tuesday, wednesday, thursday, friday
`recurring_rule.interval`	number	No	-
`recurring_rule.type`	enum	Yes	Values: weekly
`start`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Billing Subscription

Route: PATCH /mutation/billingSubscriptions

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-
`customer_invoice_data`	string	Yes	-
`label`	string	No	-
`mode`	string	Yes	-
`payment_conditions`	enum	Yes	Values: upon_receipt, 7_days, 15_days, 30_days, 30_days_end_of_month
`payment_method`	enum	Yes	Values: offline, gocardless_direct_debit, pro_account_sepa_core
`recurring_rule.count`	number	No	-
`recurring_rule.day_of_month`	number	No	-
`recurring_rule.day_of_week`	enum	No	Values: monday, tuesday, wednesday, thursday, friday
`recurring_rule.interval`	number	No	-
`recurring_rule.type`	enum	Yes	Values: weekly
`start`	date	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Categories of a Customer

The analytical categories of one customer.

Read

Categories of a Customer

The analytical categories of one customer.

Route: GET /customerCategories

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`weight`	string	—	-
`category_group`	string	→ categoryGroups	-
`id`	id	→ categoryGroups	-
`analytical_code`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

Categories of a Customer Invoice

The analytical categories of one customer invoice.

Read

Categories of a Customer Invoice

The analytical categories of one customer invoice.

Route: GET /customerInvoiceCategories

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_invoice_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`weight`	string	—	-
`category_group`	string	→ categoryGroups	-
`id`	id	→ categoryGroups	-
`analytical_code`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-

Commercial Documents

Proformas, shipping orders and purchasing orders.

Used as filter by

Appendices of a Commercial Document · commercial_document_id

Line Sections of a Commercial Document · commercial_document_id

Lines of a Commercial Document · commercial_document_id

Read

Commercial Documents

Proformas, shipping orders and purchasing orders.

Route: GET /commercialDocuments

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`document_type`	string	No	Only the records whose document_type is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`date` default	date	—	-
`id` default	id	→ customers	-

Create

Create Commercial Document

Route: POST /mutation/commercialDocuments

Inputs you can set

Name	Type	Required	Description
`commercial_document_template_id`	id	No	-
`currency`	string	No	-
`customer_id`	id	Yes	-
`date`	date	Yes	-
`deadline`	date	Yes	-
`discount.type`	enum	No	Values: absolute, relative
`discount.value`	string	No	-
`document_type`	enum	Yes	Values: proforma, shipping_order, purchasing_order
`external_reference`	string	No	-
`invoice_line_sections`	string	No	-
`invoice_lines`	string	Yes	-
`language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`pdf_description`	string	No	-
`pdf_invoice_free_text`	string	No	-
`pdf_invoice_subject`	string	No	-
`special_mention`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Commercial Document

Route: PATCH /mutation/commercialDocuments

Inputs you can set

Name	Type	Required	Description
`commercial_document_template_id`	id	No	-
`currency`	string	No	-
`customer_id`	id	Yes	-
`date`	date	Yes	-
`deadline`	date	Yes	-
`discount.type`	enum	No	Values: absolute, relative
`discount.value`	string	No	-
`document_type`	enum	Yes	Values: proforma, shipping_order, purchasing_order
`external_reference`	string	No	-
`invoice_line_sections`	string	No	-
`invoice_lines`	string	Yes	-
`language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`pdf_description`	string	No	-
`pdf_invoice_free_text`	string	No	-
`pdf_invoice_subject`	string	No	-
`special_mention`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Contacts of a Customer

The people of one customer.

Read

Contacts of a Customer

The people of one customer.

Route: GET /customerContacts

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`customer_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`first_name`	string	—	-
`last_name`	string	—	-
`role`	string	—	-
`email`	string	—	-
`telephone_number`	string	—	-
`mobile_number`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Create

Create Contacts of a Customer

Route: POST /mutation/customerContacts

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-
`email`	string	Yes	-
`first_name`	string	Yes	-
`last_name`	string	Yes	-
`mobile_number`	string	No	-
`role`	string	No	-
`telephone_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Contacts of a Customer

Route: PATCH /mutation/customerContacts

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-
`email`	string	Yes	-
`first_name`	string	Yes	-
`last_name`	string	Yes	-
`mobile_number`	string	No	-
`role`	string	No	-
`telephone_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Contacts of a Customer

Route: DELETE /mutation/customerContacts

Inputs you can set

Name	Type	Required	Description
`customer_id`	id	Yes	-
`email`	string	Yes	-
`first_name`	string	Yes	-
`last_name`	string	Yes	-
`mobile_number`	string	No	-
`role`	string	No	-
`telephone_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Create Invoice from Quote

Creates an invoice from a quote.

Create

Create Invoice from Quote

Route: POST /mutation/customerInvoiceFromQuote

Inputs you can set

Name	Type	Required	Description
`customer_invoice_template_id`	id	No	-
`draft`	boolean	Yes	-
`external_reference`	string	No	-
`quote_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Customer Invoices

Invoices and credit notes issued. A draft can change or be deleted; a finalized one cannot.

Used as filter by

Appendices of a Customer Invoice · customer_invoice_id

Categories of a Customer Invoice · customer_invoice_id

Header Fields of a Customer Invoice · customer_invoice_id

Line Sections of a Customer Invoice · customer_invoice_id

Lines of a Customer Invoice · customer_invoice_id

Transactions Matched to a Customer Invoice · customer_invoice_id

Payments of a Customer Invoice · customer_invoice_id

Read

Customer Invoices

Invoices and credit notes issued. A draft can change or be deleted; a finalized one cannot.

Route: GET /customerInvoices

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`date`	date	No	Only the records whose date is this.
`date_gteq`	date	No	On or after this date.
`date_lteq`	date	No	On or before this date.
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`billing_subscription_id`	id	No	Only the records whose billing_subscription_id is this.
`billing_subscription_id_in`	string	No	Only the records whose billing_subscription_id is one of these, separated by commas.
`quote_id`	id	No	Only the records whose quote_id is this.
`quote_id_in`	string	No	Only the records whose quote_id is one of these, separated by commas.
`invoice_number`	string	No	Only the records whose invoice_number is this.
`draft`	boolean	No	Only the records whose draft is this.
`credit_note`	boolean	No	Only the records whose credit_note is this.
`external_reference`	string	No	Only the records whose external_reference is this.
`flow_id`	id	No	Only the records whose flow_id is this.
`flow_id_in`	string	No	Only the records whose flow_id is one of these, separated by commas.
`category_id_in`	string	No	Only the records whose category_id is one of these, separated by commas.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id, -date, date
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`invoice_number` default	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`date` default	date	—	-
`status` default	enum	—	-

Create

Create Customer Invoice

Route: POST /mutation/customerInvoices

Inputs you can set

Name	Type	Required	Description
`contract_reference`	string	No	-
`currency`	string	No	-
`customer_id`	id	Yes	-
`customer_invoice_template_id`	id	No	-
`date`	date	Yes	-
`deadline`	date	Yes	-
`discount.type`	enum	No	Values: absolute, relative
`discount.value`	string	No	-
`draft`	enum	No	Values: false
`external_reference`	string	No	-
`installments`	string	No	-
`invoice_line_sections`	string	No	-
`invoice_lines`	string	Yes	-
`label`	string	No	-
`language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`pdf_description`	string	No	-
`pdf_invoice_free_text`	string	No	-
`pdf_invoice_subject`	string	No	-
`purchase_order_reference`	string	No	-
`sale_type`	enum	No	Values: goods, services, goods_and_services
`special_mention`	string	No	-
`transaction_reference.banking_provider`	enum	No	Values: stripe, gocardless, bank, budgetinsight, helloasso
`transaction_reference.provider_field_name`	enum	No	Values: payment_id, charge_id, report_id, webid, label
`transaction_reference.provider_field_value`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Customer Invoice

Route: PATCH /mutation/customerInvoices

Inputs you can set

Name	Type	Required	Description
`contract_reference`	string	No	-
`currency`	string	No	-
`customer_id`	id	Yes	-
`customer_invoice_template_id`	id	No	-
`date`	date	Yes	-
`deadline`	date	Yes	-
`discount.type`	enum	No	Values: absolute, relative
`discount.value`	string	No	-
`draft`	enum	No	Values: false
`external_reference`	string	No	-
`installments`	string	No	-
`invoice_line_sections`	string	No	-
`invoice_lines`	string	Yes	-
`label`	string	No	-
`language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`pdf_description`	string	No	-
`pdf_invoice_free_text`	string	No	-
`pdf_invoice_subject`	string	No	-
`purchase_order_reference`	string	No	-
`sale_type`	enum	No	Values: goods, services, goods_and_services
`special_mention`	string	No	-
`transaction_reference.banking_provider`	enum	No	Values: stripe, gocardless, bank, budgetinsight, helloasso
`transaction_reference.provider_field_name`	enum	No	Values: payment_id, charge_id, report_id, webid, label
`transaction_reference.provider_field_value`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Customer Invoice

Route: DELETE /mutation/customerInvoices

Inputs you can set

Name	Type	Required	Description
`contract_reference`	string	No	-
`currency`	string	No	-
`customer_id`	id	Yes	-
`customer_invoice_template_id`	id	No	-
`date`	date	Yes	-
`deadline`	date	Yes	-
`discount.type`	enum	No	Values: absolute, relative
`discount.value`	string	No	-
`draft`	enum	No	Values: false
`external_reference`	string	No	-
`installments`	string	No	-
`invoice_line_sections`	string	No	-
`invoice_lines`	string	Yes	-
`label`	string	No	-
`language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`pdf_description`	string	No	-
`pdf_invoice_free_text`	string	No	-
`pdf_invoice_subject`	string	No	-
`purchase_order_reference`	string	No	-
`sale_type`	enum	No	Values: goods, services, goods_and_services
`special_mention`	string	No	-
`transaction_reference.banking_provider`	enum	No	Values: stripe, gocardless, bank, budgetinsight, helloasso
`transaction_reference.provider_field_name`	enum	No	Values: payment_id, charge_id, report_id, webid, label
`transaction_reference.provider_field_value`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Customers

The companies and individuals the company bills.

Used as filter by

Billing Subscriptions · customer_id

Commercial Documents · customer_id

Electronic Billing Addresses · customer_id

Categories of a Customer · customer_id

Contacts of a Customer · customer_id

Customer Invoices · customer_id

GoCardless Mandates · customer_id

Pro Account Mandate Migrations · customer_id

Pro Account Mandates · customer_id

Quotes · customer_id

SEPA Mandates · customer_id

Read

Customers

The companies and individuals the company bills.

Route: GET /customers

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`customer_type`	string	No	Only the records whose customer_type is this.
`ledger_account_id`	id	No	Only the records whose ledger_account_id is this.
`name`	string	No	Only the records whose name is this.
`name_start_with`	string	No	Only the records whose name starts with this.
`external_reference`	string	No	Only the records whose external_reference is this.
`external_reference_start_with`	string	No	Only the records whose external_reference starts with this.
`reg_no`	string	No	Only the records whose reg_no is this.
`emails_in`	string	No	Only the records whose emails is one of these, separated by commas.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`billing_iban`	string	—	-
`payment_conditions`	enum	—	-
`recipient`	string	—	-
`phone`	string	—	-
`reference`	string	—	-
`notes`	string	—	-
`vat_number`	string	—	-
`reg_no`	string	—	-
`electronic_billing_address`	string	—	-
`public_administration`	boolean	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-
`emails`	string[]	—	-
`billing_address`	string	—	-
`address`	string	—	-
`postal_code`	string	—	-
`city`	string	—	-
`country_alpha2`	string	—	-
`delivery_address`	string	—	-
`address`	string	—	-
`postal_code`	string	—	-
`city`	string	—	-
`country_alpha2`	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`customer_type`	enum	—	-
`external_reference`	string	—	-
`billing_language`	enum	—	-
`first_name`	string	—	-
`last_name`	string	—	-

Create

Create Customer

Route: POST /mutation/customers

Inputs you can set

Name	Type	Required	Description
`billing_address.address`	string	Yes	-
`billing_address.city`	string	Yes	-
`billing_address.country_alpha2`	string	Yes	-
`billing_address.postal_code`	string	Yes	-
`billing_iban`	string	No	-
`billing_language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`customer_type`	enum	Yes	Values: individual
`delivery_address.address`	string	No	-
`delivery_address.city`	string	No	-
`delivery_address.country_alpha2`	string	No	-
`delivery_address.postal_code`	string	No	-
`emails`	string	No	-
`external_reference`	string	No	-
`first_name`	string	No	-
`last_name`	string	No	-
`ledger_account.number`	string	No	-
`name`	string	No	-
`notes`	string	No	-
`payment_conditions`	enum	No	Values: upon_receipt, custom, 7_days, 15_days, 30_days
`phone`	string	No	-
`recipient`	string	No	-
`reference`	string	No	-
`reg_no`	string	No	-
`vat_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Customer

Route: PATCH /mutation/customers

Inputs you can set

Name	Type	Required	Description
`billing_address.address`	string	Yes	-
`billing_address.city`	string	Yes	-
`billing_address.country_alpha2`	string	Yes	-
`billing_address.postal_code`	string	Yes	-
`billing_iban`	string	No	-
`billing_language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`customer_type`	enum	Yes	Values: individual
`delivery_address.address`	string	No	-
`delivery_address.city`	string	No	-
`delivery_address.country_alpha2`	string	No	-
`delivery_address.postal_code`	string	No	-
`emails`	string	No	-
`external_reference`	string	No	-
`first_name`	string	No	-
`last_name`	string	No	-
`ledger_account.number`	string	No	-
`name`	string	No	-
`notes`	string	No	-
`payment_conditions`	enum	No	Values: upon_receipt, custom, 7_days, 15_days, 30_days
`phone`	string	No	-
`recipient`	string	No	-
`reference`	string	No	-
`reg_no`	string	No	-
`vat_number`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Electronic Billing Addresses

The electronic invoicing addresses of one customer.

Read

Electronic Billing Addresses

The electronic invoicing addresses of one customer.

Route: GET /customerBillingAddresses

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_id`	id	Yes	The record whose rows are read.
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`electronic_billing_address` default	string	—	-

Email Templates

The templates an invoice’s email can use.

Read

Email Templates

The templates an invoice’s email can use.

Route: GET /billingEmailTemplates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only the records whose id is this.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`kind`	string	No	Only the records whose kind is this.
`locale`	string	No	Only the records whose locale is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`kind` default	enum	—	-
`locale`	enum	—	-
`subject`	string	—	-
`content`	string	—	-
`default`	boolean	—	-
`cc_recipients`	string[]	—	-
`bcc_recipients`	string[]	—	-

Finalize Invoice

Finalizes a draft: Pennylane numbers it and it can no longer change.

Create

Finalize Invoice

Route: POST /mutation/customerInvoiceFinalize

Inputs you can set

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Header Fields of a Customer Invoice

The custom header fields of one customer invoice.

Read

Header Fields of a Customer Invoice

The custom header fields of one customer invoice.

Route: GET /customerInvoiceHeaderFields

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`value`	string	—	-
`rank`	number	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Invoice Templates

The templates a customer invoice can use.

Read

Invoice Templates

The templates a customer invoice can use.

Route: GET /customerInvoiceTemplates

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Line Sections of a Billing Subscription

The sections each invoice of one subscription carries.

Read

Line Sections of a Billing Subscription

The sections each invoice of one subscription carries.

Route: GET /billingSubscriptionLineSections

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`billing_subscription_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`description`	string	—	-
`rank`	number	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Line Sections of a Commercial Document

The sections of one commercial document.

Read

Line Sections of a Commercial Document

The sections of one commercial document.

Route: GET /commercialDocumentLineSections

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`commercial_document_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`description`	string	—	-
`rank`	number	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Line Sections of a Customer Invoice

The sections of one customer invoice.

Read

Line Sections of a Customer Invoice

The sections of one customer invoice.

Route: GET /customerInvoiceLineSections

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`description`	string	—	-
`rank`	number	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Line Sections of a Quote

The sections of one quote.

Read

Line Sections of a Quote

The sections of one quote.

Route: GET /quoteLineSections

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`quote_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`title` default	string	—	-
`description`	string	—	-
`rank`	number	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Lines of a Billing Subscription

The lines each invoice of one subscription carries.

Read

Lines of a Billing Subscription

The lines each invoice of one subscription carries.

Route: GET /billingSubscriptionLines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`billing_subscription_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`unit`	string	—	-
`quantity`	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`description`	string	—	-
`product`	string	→ products	-
`id`	id	→ products	-
`vat_rate`	string	—	-
`currency_amount_before_tax`	string	—	-
`currency_tax`	string	—	-
`tax`	string	—	-
`raw_currency_unit_price`	string	—	-
`discount`	string	—	-
`type`	enum	—	-
`value`	string	—	-
`section_rank`	number	—	-
`imputation_dates`	string	—	-
`start_date`	date	—	-
`end_date`	date	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Lines of a Commercial Document

The lines of one commercial document.

Read

Lines of a Commercial Document

The lines of one commercial document.

Route: GET /commercialDocumentLines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`commercial_document_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`unit`	string	—	-
`quantity`	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`description`	string	—	-
`product`	string	→ products	-
`id`	id	→ products	-
`vat_rate`	string	—	-
`currency_amount_before_tax`	string	—	-
`currency_tax`	string	—	-
`tax`	string	—	-
`raw_currency_unit_price`	string	—	-
`discount`	string	—	-
`type`	enum	—	-
`value`	string	—	-
`section_rank`	number	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Lines of a Customer Invoice

The lines of one customer invoice.

Read

Lines of a Customer Invoice

The lines of one customer invoice.

Route: GET /customerInvoiceLines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id, -rank, rank
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`unit`	string	—	-
`quantity`	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`description`	string	—	-
`product`	string	→ products	-
`id`	id	→ products	-
`vat_rate`	string	—	-
`currency_amount_before_tax`	string	—	-
`currency_tax`	string	—	-
`tax`	string	—	-
`raw_currency_unit_price`	string	—	-
`discount`	string	—	-
`type`	enum	—	-
`value`	string	—	-
`section_rank`	number	—	-
`imputation_dates`	string	—	-
`start_date`	date	—	-
`end_date`	date	—	-
`performance_period`	string	—	-
`start_date`	date	—	-
`end_date`	date	—	-
`date_type`	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`substance`	enum	—	-
`custom_fields`	string	—	-

Lines of a Quote

The lines of one quote.

Read

Lines of a Quote

The lines of one quote.

Route: GET /quoteLines

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`quote_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`unit`	string	—	-
`quantity`	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`description`	string	—	-
`product`	string	→ products	-
`id`	id	→ products	-
`vat_rate`	string	—	-
`currency_amount_before_tax`	string	—	-
`currency_tax`	string	—	-
`tax`	string	—	-
`raw_currency_unit_price`	string	—	-
`discount`	string	—	-
`type`	enum	—	-
`value`	string	—	-
`section_rank`	number	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`custom_fields`	string	—	-

Link a Credit Note

Links a credit note to this invoice.

Create

Link a Credit Note

Route: POST /mutation/customerInvoiceLinkCreditNote

Inputs you can set

Name	Type	Required	Description
`credit_note_id`	id	Yes	-
`customer_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Mark Invoice as Paid

Records the invoice as paid. No money moves.

Create

Mark Invoice as Paid

Route: POST /mutation/customerInvoiceMarkAsPaid

Inputs you can set

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

PA Registrations

The company’s registrations on the approved e-invoicing platform.

Read

PA Registrations

The company’s registrations on the approved e-invoicing platform.

Route: GET /paRegistrations

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Only the records whose id is this.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`siret`	string	No	Only the records whose siret is this.
`status`	string	No	Only the records whose status is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`siret`	string	—	-
`siren`	string	—	-
`suffix`	string	—	-
`routing_code`	string	—	-
`status` default	enum	—	-
`effective_until`	date	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Payments of a Customer Invoice

The payments recorded on one customer invoice.

Read

Payments of a Customer Invoice

The payments recorded on one customer invoice.

Route: GET /customerInvoicePayments

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`currency`	string	—	-
`currency_amount` default	string	—	-
`status` default	enum	—	-
`created_at`	date	—	-
`updated_at`	date	—	-

Products

What the company sells: a price before tax and a VAT rate.

Read

Products

What the company sells: a price before tax and a VAT rate.

Route: GET /products

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`label`	string	No	Only the records whose label is this.
`reference`	string	No	Only the records whose reference is this.
`external_reference`	string	No	Only the records whose external_reference is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`description`	string	—	-
`external_reference`	string	—	-
`price_before_tax`	string	—	-
`vat_rate`	string	—	-
`price`	string	—	-
`unit`	string	—	-
`currency`	string	—	-
`reference`	string	—	-
`substance`	enum	—	-
`ledger_account`	string	→ ledgerAccounts	-
`id`	id	→ ledgerAccounts	-
`archived_at`	date	—	-
`created_at`	date	—	-
`updated_at`	date	—	-
`custom_fields`	string	—	-

Create

Create Product

Route: POST /mutation/products

Inputs you can set

Name	Type	Required	Description
`currency`	string	No	-
`custom_fields`	string	No	-
`description`	string	No	-
`external_reference`	string	No	-
`label`	string	Yes	-
`ledger_account_id`	id	No	-
`price_before_tax`	string	Yes	-
`reference`	string	No	-
`substance`	enum	No	Values: goods, services
`unit`	string	No	-
`vat_rate`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product

Route: PATCH /mutation/products

Inputs you can set

Name	Type	Required	Description
`currency`	string	No	-
`custom_fields`	string	No	-
`description`	string	No	-
`external_reference`	string	No	-
`label`	string	Yes	-
`ledger_account_id`	id	No	-
`price_before_tax`	string	Yes	-
`reference`	string	No	-
`substance`	enum	No	Values: goods, services
`unit`	string	No	-
`vat_rate`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Quotes

The quotes issued.

Used as filter by

Customer Invoices · quote_id

Appendices of a Quote · quote_id

Line Sections of a Quote · quote_id

Lines of a Quote · quote_id

Read

Quotes

The quotes issued.

Route: GET /quotes

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. An unknown id is Pennylane’s refusal.
`id_in`	string	No	Only the records whose id is one of these, separated by commas.
`customer_id`	id	No	Only the records whose customer_id is this.
`customer_id_in`	string	No	Only the records whose customer_id is one of these, separated by commas.
`status`	string	No	Only the records whose status is this.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`amount` default	string	—	-
`currency_amount` default	string	—	-
`date` default	date	—	-
`status` default	enum	—	-
`id` default	id	→ customers	-

Create

Create Quote

Route: POST /mutation/quotes

Inputs you can set

Name	Type	Required	Description
`currency`	string	No	-
`customer_id`	id	Yes	-
`date`	date	Yes	-
`deadline`	date	Yes	-
`discount.type`	enum	No	Values: absolute, relative
`discount.value`	string	No	-
`external_reference`	string	No	-
`invoice_line_sections`	string	No	-
`invoice_lines`	string	Yes	-
`language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`pdf_description`	string	No	-
`pdf_invoice_free_text`	string	No	-
`pdf_invoice_subject`	string	No	-
`quote_template_id`	id	No	-
`special_mention`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Quote

Route: PATCH /mutation/quotes

Inputs you can set

Name	Type	Required	Description
`currency`	string	No	-
`customer_id`	id	Yes	-
`date`	date	Yes	-
`deadline`	date	Yes	-
`discount.type`	enum	No	Values: absolute, relative
`discount.value`	string	No	-
`external_reference`	string	No	-
`invoice_line_sections`	string	No	-
`invoice_lines`	string	Yes	-
`language`	enum	No	Values: fr_FR, en_GB, de_DE, es_ES
`pdf_description`	string	No	-
`pdf_invoice_free_text`	string	No	-
`pdf_invoice_subject`	string	No	-
`quote_template_id`	id	No	-
`special_mention`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Document by Email

Emails the document to the recipients named, or to the customer’s.

Create

Send Document by Email

Route: POST /mutation/commercialDocumentSendByEmail

Inputs you can set

Name	Type	Required	Description
`commercial_document_id`	id	Yes	-
`email_template_id`	id	No	-
`recipients`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Invoice by Email

Emails the invoice to the recipients named, or to the customer’s.

Create

Send Invoice by Email

Route: POST /mutation/customerInvoiceSendByEmail

Inputs you can set

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-
`email_template_id`	id	No	-
`recipients`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Invoice to the PA

Sends the invoice to the approved e-invoicing platform.

Create

Send Invoice to the PA

Route: POST /mutation/customerInvoiceSendToPa

Inputs you can set

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Quote by Email

Emails the quote to the recipients named, or to the customer’s.

Create

Send Quote by Email

Route: POST /mutation/quoteSendByEmail

Inputs you can set

Name	Type	Required	Description
`email_template_id`	id	No	-
`quote_id`	id	Yes	-
`recipients`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Transactions Matched to a Customer Invoice

The bank transactions one customer invoice is reconciled with. A transaction is no payment: matching one reconciles, it books nothing else.

Read

Transactions Matched to a Customer Invoice

The bank transactions one customer invoice is reconciled with. A transaction is no payment: matching one reconciles, it books nothing else.

Route: GET /customerInvoiceMatchedTransactions

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`customer_invoice_id`	id	Yes	The record whose rows are read.
`sort`	enum	No	The order of the rows; - is latest first. Values: -id, id
`limit`	number	No	Rows per page (max 100). Default: 100
`cursor`	string	No	The cursor the previous page answered. It is temporary: to be read at once, never kept.

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`label` default	string	—	-
`date` default	date	—	-
`currency_amount` default	string	—	-
`amount` default	string	—	-
`id` default	id	→ customers	-

Create

Create Transactions Matched to a Customer Invoice

Route: POST /mutation/customerInvoiceMatchedTransactions

Inputs you can set

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-
`transaction_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Transactions Matched to a Customer Invoice

Route: DELETE /mutation/customerInvoiceMatchedTransactions

Inputs you can set

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-
`transaction_id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Update Imported Invoice

Corrects an invoice that was imported.

Create

Update Imported Invoice

Route: POST /mutation/customerInvoiceUpdateImported

Inputs you can set

Name	Type	Required	Description
`amount`	string	No	-
`currency`	string	No	-
`currency_amount`	string	No	-
`currency_amount_before_tax`	string	No	-
`currency_tax`	string	No	-
`customer_id`	id	No	-
`customer_invoice_id`	id	Yes	-
`date`	date	No	-
`deadline`	date	No	-
`external_reference`	string	No	-
`installments`	string	No	-
`invoice_lines`	string	No	-
`invoice_number`	string	No	-
`tax`	string	No	-
`transaction_reference.banking_provider`	enum	No	Values: stripe, gocardless, bank, budgetinsight, helloasso
`transaction_reference.provider_field_name`	enum	No	Values: payment_id, charge_id, report_id, webid, label
`transaction_reference.provider_field_value`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Update Quote Status

Sets the quote’s status.

Create

Update Quote Status

Route: POST /mutation/quoteUpdateStatus

Inputs you can set

Name	Type	Required	Description
`quote_id`	id	Yes	-
`status`	enum	Yes	Values: pending, accepted, denied, invoiced, expired

Data returned in Excel

This action returns a confirmation rather than a selectable table.