Connexion Pennylane pour LinkyFlow

LinkyFlow connecte Excel a Pennylane pour consulter, modifier et publier les donnees e-commerce utiles depuis un tableur.

Ressources

Requetes de lecture

Actions ecriture

Champs documentes

901

Workflows a ramener dans Excel

Chaque ressource ci-dessous correspond a un workflow tableur concret. Les lectures ramenent des colonnes utiles dans Excel; les creations et modifications indiquent ce qui peut etre relu en lignes avant envoi.

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.

Lecture

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

Entrees configurables

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

Donnees retournees dans Excel

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

Creation

Ask for Analytical Ledger Export

Route: POST /mutation/analyticalLedgerExports

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Categories of a Ledger Entry Line

The analytical categories one line is booked on.

Lecture

Categories of a Ledger Entry Line

The analytical categories one line is booked on.

Route: GET /ledgerEntryLineCategories

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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

Donnees retournees dans Excel

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

Creation

Ask for FEC Export

Route: POST /mutation/fecExports

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Files of a Ledger Entry

The documents attached to one journal entry.

Lecture

Files of a Ledger Entry

The documents attached to one journal entry.

Route: GET /ledgerEntryFiles

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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

Donnees retournees dans Excel

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

Creation

Ask for General Ledger Export

Route: POST /mutation/generalLedgerExports

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Journals

The accounting journals.

Utilise comme filtre par

Ledger Entries · journal_id

Ledger Entry Lines · journal_id

Transactions · journal_id

Lecture

Journals

The accounting journals.

Route: GET /journals

Entrees configurables

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.

Donnees retournees dans Excel

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

Creation

Create Journal

Route: POST /mutation/journals

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Ledger Accounts

The chart of accounts.

Utilise comme filtre par

Customers · ledger_account_id

Lines of a Ledger Entry · ledger_account_id

Ledger Entry Lines · ledger_account_id

Suppliers · ledger_account_id

Lecture

Ledger Accounts

The chart of accounts.

Route: GET /ledgerAccounts

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Ledger Account

Route: POST /mutation/ledgerAccounts

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Ledger Account

Route: PATCH /mutation/ledgerAccounts

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Ledger Entries

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

Utilise comme filtre par

Lines of a Ledger Entry · ledger_entry_id

Files of a Ledger Entry · ledger_entry_id

Ledger Entry Lines · ledger_entry_id

Lecture

Ledger Entries

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

Route: GET /ledgerEntries

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Ledger Entrie

Route: POST /mutation/ledgerEntries

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Ledger Entrie

Route: PATCH /mutation/ledgerEntries

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Ledger Entry Lines

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

Utilise comme filtre par

Categories of a Ledger Entry Line · ledger_entry_line_id

Lines Lettered Together · ledger_entry_line_id

Lecture

Ledger Entry Lines

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

Route: GET /ledgerEntryLines

Entrees configurables

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.

Donnees retournees dans 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.

Creation

Letter Ledger Entry Lines

Route: POST /mutation/ledgerEntryLinesLetter

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Lines Lettered Together

The lines lettered with one line.

Lecture

Lines Lettered Together

The lines lettered with one line.

Route: GET /ledgerEntryLineLetterings

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Lines of a Ledger Entry

The debit and credit lines of one journal entry.

Route: GET /ledgerEntryEntryLines

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Trial Balance

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

Route: GET /trialBalance

Entrees configurables

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.

Donnees retournees dans 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.

Creation

Unletter Ledger Entry Lines

Route: POST /mutation/ledgerEntryLinesUnletter

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

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	-

Donnees retournees dans 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.

Utilise comme filtre par

Categories · category_group_id

Categories of a Group · category_group_id

Lecture

Category Groups

The analytical axes.

Route: GET /categoryGroups

Entrees configurables

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.

Donnees retournees dans Excel

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

Creation

Create Category Group

Route: POST /mutation/categoryGroups

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Category Group

Route: PATCH /mutation/categoryGroups

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Banking

Bank Accounts

The company’s bank accounts.

Utilise comme filtre par

Transactions · bank_account_id

Lecture

Bank Accounts

The company’s bank accounts.

Route: GET /bankAccounts

Entrees configurables

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.

Donnees retournees dans 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	-

Creation

Create Bank Account

Route: POST /mutation/bankAccounts

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Bank Establishments

The banks Pennylane knows.

Lecture

Bank Establishments

The banks Pennylane knows.

Route: GET /bankEstablishments

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Categories of a Transaction

The analytical categories of one transaction.

Route: GET /transactionCategories

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Invoices Matched to a Transaction

The invoices one transaction is reconciled with.

Route: GET /transactionMatchedInvoices

Entrees configurables

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.

Donnees retournees dans 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.

Utilise comme filtre par

Categories of a Transaction · transaction_id

Invoices Matched to a Transaction · transaction_id

Lecture

Transactions

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

Route: GET /transactions

Entrees configurables

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.

Donnees retournees dans 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	-

Creation

Create Transaction

Route: POST /mutation/transactions

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Transaction

Route: PATCH /mutation/transactions

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Company

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

Route: GET /company

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-

Donnees retournees dans 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.

Lecture

Company Features

What this company’s Pennylane plan offers.

Route: GET /companyFeatures

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-

Donnees retournees dans Excel

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

Fiscal Years

The company’s fiscal years.

Lecture

Fiscal Years

The company’s fiscal years.

Route: GET /fiscalYears

Entrees configurables

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.

Donnees retournees dans 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.

Creation

Associate a Customer

Route: POST /mutation/gocardlessMandateAssociate

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Cancel Mandate

Cancels this mandate.

Creation

Cancel Mandate

Route: POST /mutation/gocardlessMandateCancel

Entrees configurables

Name	Type	Required	Description
`gocardless_mandate_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

GoCardless Mandates

The GoCardless mandates of the company’s customers.

Lecture

GoCardless Mandates

The GoCardless mandates of the company’s customers.

Route: GET /gocardlessMandates

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Pro Account Mandate Migrations

The mandates being moved to the pro account.

Route: GET /proAccountMandateMigrations

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Pro Account Mandate Migration

Route: POST /mutation/proAccountMandateMigrations

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Pro Account Mandates

The mandates of the company’s Pennylane pro account.

Lecture

Pro Account Mandates

The mandates of the company’s Pennylane pro account.

Route: GET /proAccountMandates

Entrees configurables

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.

Donnees retournees dans 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.

Creation

Request a Mandate by Email

Route: POST /mutation/gocardlessMandateRequest

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Request a Pro Account Mandate

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

Creation

Request a Pro Account Mandate

Route: POST /mutation/proAccountMandateRequest

Entrees configurables

Name	Type	Required	Description
`customer_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

SEPA Mandates

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

Lecture

SEPA Mandates

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

Route: GET /sepaMandates

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create SEPA Mandate

Route: POST /mutation/sepaMandates

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update SEPA Mandate

Route: PATCH /mutation/sepaMandates

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete SEPA Mandate

Route: DELETE /mutation/sepaMandates

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Purchases

Categories of a Supplier

The analytical categories of one supplier.

Lecture

Categories of a Supplier

The analytical categories of one supplier.

Route: GET /supplierCategories

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Categories of a Supplier Invoice

The analytical categories of one supplier invoice.

Route: GET /supplierInvoiceCategories

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Lines of a Supplier Invoice

The lines of one supplier invoice.

Route: GET /supplierInvoiceLines

Entrees configurables

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.

Donnees retournees dans 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.

Creation

Link a Purchase Request

Route: POST /mutation/supplierInvoiceLinkPurchaseRequest

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Payments of a Supplier Invoice

The payments recorded on one supplier invoice.

Lecture

Payments of a Supplier Invoice

The payments recorded on one supplier invoice.

Route: GET /supplierInvoicePayments

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Purchase Requests

The company’s purchase requests.

Route: GET /purchaseRequests

Entrees configurables

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.

Donnees retournees dans 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.

Utilise comme filtre par

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

Lecture

Supplier Invoices

The invoices received.

Route: GET /supplierInvoices

Entrees configurables

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.

Donnees retournees dans 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	-

Modification

Update Supplier Invoice

Route: PATCH /mutation/supplierInvoices

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Suppliers

The company’s suppliers.

Utilise comme filtre par

Purchase Requests · supplier_id

Categories of a Supplier · supplier_id

Supplier Invoices · supplier_id

Lecture

Suppliers

The company’s suppliers.

Route: GET /suppliers

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Supplier

Route: POST /mutation/suppliers

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Supplier

Route: PATCH /mutation/suppliers

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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	-

Creation

Create Transactions Matched to a Supplier Invoice

Route: POST /mutation/supplierInvoiceMatchedTransactions

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Transactions Matched to a Supplier Invoice

Route: DELETE /mutation/supplierInvoiceMatchedTransactions

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Update E-Invoice Status

Sets the status of the e-invoice received.

Creation

Update E-Invoice Status

Route: POST /mutation/supplierInvoiceEInvoiceStatus

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Update Payment Status

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

Creation

Update Payment Status

Route: POST /mutation/supplierInvoicePaymentStatus

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Validate Accounting

Validates the invoice’s accounting.

Creation

Validate Accounting

Route: POST /mutation/supplierInvoiceValidateAccounting

Entrees configurables

Name	Type	Required	Description
`supplier_invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Sales

Appendices of a Commercial Document

The files appended to one commercial document.

Lecture

Appendices of a Commercial Document

The files appended to one commercial document.

Route: GET /commercialDocumentAppendices

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Appendices of a Customer Invoice

The files appended to one customer invoice.

Route: GET /customerInvoiceAppendices

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Appendices of a Quote

The files appended to one quote.

Route: GET /quoteAppendices

Entrees configurables

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.

Donnees retournees dans Excel

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

Billing Subscriptions

The recurring invoices.

Utilise comme filtre par

Line Sections of a Billing Subscription · billing_subscription_id

Lines of a Billing Subscription · billing_subscription_id

Customer Invoices · billing_subscription_id

Lecture

Billing Subscriptions

The recurring invoices.

Route: GET /billingSubscriptions

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Billing Subscription

Route: POST /mutation/billingSubscriptions

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Billing Subscription

Route: PATCH /mutation/billingSubscriptions

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Categories of a Customer

The analytical categories of one customer.

Lecture

Categories of a Customer

The analytical categories of one customer.

Route: GET /customerCategories

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Categories of a Customer Invoice

The analytical categories of one customer invoice.

Route: GET /customerInvoiceCategories

Entrees configurables

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.

Donnees retournees dans 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.

Utilise comme filtre par

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

Lecture

Commercial Documents

Proformas, shipping orders and purchasing orders.

Route: GET /commercialDocuments

Entrees configurables

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.

Donnees retournees dans 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	-

Creation

Create Commercial Document

Route: POST /mutation/commercialDocuments

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Commercial Document

Route: PATCH /mutation/commercialDocuments

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Contacts of a Customer

The people of one customer.

Lecture

Contacts of a Customer

The people of one customer.

Route: GET /customerContacts

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Contacts of a Customer

Route: POST /mutation/customerContacts

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Contacts of a Customer

Route: PATCH /mutation/customerContacts

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Contacts of a Customer

Route: DELETE /mutation/customerContacts

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Create Invoice from Quote

Creates an invoice from a quote.

Creation

Create Invoice from Quote

Route: POST /mutation/customerInvoiceFromQuote

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Customer Invoices

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

Utilise comme filtre par

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

Lecture

Customer Invoices

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

Route: GET /customerInvoices

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Customer Invoice

Route: POST /mutation/customerInvoices

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Customer Invoice

Route: PATCH /mutation/customerInvoices

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Customer Invoice

Route: DELETE /mutation/customerInvoices

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Customers

The companies and individuals the company bills.

Utilise comme filtre par

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

Lecture

Customers

The companies and individuals the company bills.

Route: GET /customers

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Customer

Route: POST /mutation/customers

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Customer

Route: PATCH /mutation/customers

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Electronic Billing Addresses

The electronic invoicing addresses of one customer.

Lecture

Electronic Billing Addresses

The electronic invoicing addresses of one customer.

Route: GET /customerBillingAddresses

Entrees configurables

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.

Donnees retournees dans Excel

Field	Type	Relations	Description
`electronic_billing_address` default	string	—	-

Email Templates

The templates an invoice’s email can use.

Lecture

Email Templates

The templates an invoice’s email can use.

Route: GET /billingEmailTemplates

Entrees configurables

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.

Donnees retournees dans 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.

Creation

Finalize Invoice

Route: POST /mutation/customerInvoiceFinalize

Entrees configurables

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Header Fields of a Customer Invoice

The custom header fields of one customer invoice.

Lecture

Header Fields of a Customer Invoice

The custom header fields of one customer invoice.

Route: GET /customerInvoiceHeaderFields

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Invoice Templates

The templates a customer invoice can use.

Route: GET /customerInvoiceTemplates

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Line Sections of a Billing Subscription

The sections each invoice of one subscription carries.

Route: GET /billingSubscriptionLineSections

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Line Sections of a Commercial Document

The sections of one commercial document.

Route: GET /commercialDocumentLineSections

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Line Sections of a Customer Invoice

The sections of one customer invoice.

Route: GET /customerInvoiceLineSections

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Line Sections of a Quote

The sections of one quote.

Route: GET /quoteLineSections

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Lines of a Billing Subscription

The lines each invoice of one subscription carries.

Route: GET /billingSubscriptionLines

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Lines of a Commercial Document

The lines of one commercial document.

Route: GET /commercialDocumentLines

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Lines of a Customer Invoice

The lines of one customer invoice.

Route: GET /customerInvoiceLines

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Lines of a Quote

The lines of one quote.

Route: GET /quoteLines

Entrees configurables

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.

Donnees retournees dans 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.

Creation

Link a Credit Note

Route: POST /mutation/customerInvoiceLinkCreditNote

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Mark Invoice as Paid

Records the invoice as paid. No money moves.

Creation

Mark Invoice as Paid

Route: POST /mutation/customerInvoiceMarkAsPaid

Entrees configurables

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

PA Registrations

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

Lecture

PA Registrations

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

Route: GET /paRegistrations

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Payments of a Customer Invoice

The payments recorded on one customer invoice.

Route: GET /customerInvoicePayments

Entrees configurables

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.

Donnees retournees dans 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.

Lecture

Products

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

Route: GET /products

Entrees configurables

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.

Donnees retournees dans 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	—	-

Creation

Create Product

Route: POST /mutation/products

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Product

Route: PATCH /mutation/products

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Quotes

The quotes issued.

Utilise comme filtre par

Customer Invoices · quote_id

Appendices of a Quote · quote_id

Line Sections of a Quote · quote_id

Lines of a Quote · quote_id

Lecture

Quotes

The quotes issued.

Route: GET /quotes

Entrees configurables

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.

Donnees retournees dans 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	-

Creation

Create Quote

Route: POST /mutation/quotes

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Quote

Route: PATCH /mutation/quotes

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Send Document by Email

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

Creation

Send Document by Email

Route: POST /mutation/commercialDocumentSendByEmail

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Send Invoice by Email

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

Creation

Send Invoice by Email

Route: POST /mutation/customerInvoiceSendByEmail

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Send Invoice to the PA

Sends the invoice to the approved e-invoicing platform.

Creation

Send Invoice to the PA

Route: POST /mutation/customerInvoiceSendToPa

Entrees configurables

Name	Type	Required	Description
`customer_invoice_id`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Send Quote by Email

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

Creation

Send Quote by Email

Route: POST /mutation/quoteSendByEmail

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

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.

Lecture

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

Entrees configurables

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.

Donnees retournees dans 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	-

Creation

Create Transactions Matched to a Customer Invoice

Route: POST /mutation/customerInvoiceMatchedTransactions

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Transactions Matched to a Customer Invoice

Route: DELETE /mutation/customerInvoiceMatchedTransactions

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Update Imported Invoice

Corrects an invoice that was imported.

Creation

Update Imported Invoice

Route: POST /mutation/customerInvoiceUpdateImported

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Update Quote Status

Sets the quote’s status.

Creation

Update Quote Status

Route: POST /mutation/quoteUpdateStatus

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.