Pennylane V2 API Documentation
Ledger Attachments
Ledger Entries
Ledger Entry Lines
Customer Invoices
- GETList customer invoices
- POSTCreate a customer invoice
- POSTImport an invoice with file attached
- GETList invoice line sections for a customer invoice
- GETList invoice lines for a customer invoice
- GETList payments for a customer invoice
- GETList matched transactions for a customer invoice
- GETList appendices of a customer invoice
- POSTUpload an appendix for a customer invoice
- GETRetrieve a customer invoice
- PUTUpdate a customer invoice
- DELDelete draft invoice
- PUTUpdate a finalized customer invoice
- PUTMark a customer invoice as paid
- POSTSend a customer invoice by email
- GETList categories of a customer invoice
- PUTCategorize a customer invoice
- PUTUpdate an Imported customer invoice
- PUTTurn the draft invoice into a finalized invoice.
- POSTLink a credit note to a customer invoice
Transactions
- POSTMatch a transaction to a customer invoice
- DELUnmatch a transaction to a customer invoice
- POSTMatch a transaction to a supplier invoice
- DELUnmatch a transaction to a supplier invoice
- GETList transactions
- GETRetrieve a transaction
- GETList categories of a bank transaction
- GETList invoices matched to a bank transaction
File Attachments
Customer Invoice Templates
Exports
Customers
Supplier Invoices
- GETList matched transactions for a supplier invoice
- GETList invoice lines for a supplier invoice
- GETList supplier invoices
- GETRetrieve a supplier invoice
- PUTUpdate a supplier invoice
- GETList categories of a supplier invoice
- PUTCategorize a supplier invoice
- GETList payments for a supplier invoice
- PUTUpdate a supplier invoice payment status
- POSTImport a supplier invoice with a file attached
Credit Notes
- GETList credit notes
- POSTCreate a credit note
- POSTImport a credit note with file attached
- GETList invoice line sections for a credit note
- GETList invoice lines for a credit note
- GETRetrieve a credit note
- POSTLink a credit note to an invoice
- PUTUpdate a finalized credit note
- PUTUpdate an imported credit note
- GETList categories of a credit note
- PUTCategorize a credit note
Draft Invoices
Categories
Category Groups
Trial balance
Fiscal years
Changelogs
Bank accounts
API Reference
List products
List products
ℹ️ This endpoint requires one of the following scopes:
products:all
,products:readonly
{
"has_more": true,
"items": [
{
"created_at": "2023-08-30T10:08:08.146343Z",
"currency": "EUR",
"description": "This is product 1",
"external_reference": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a",
"id": 1,
"label": "Product 1",
"ledger_account": {
"id": 67562603
},
"price": "commodo Lorem dolore sed",
"price_before_tax": "proident dolore consequat",
"reference": "REF-123",
"unit": "piece",
"updated_at": "2023-08-30T10:08:08.146343Z",
"vat_rate": "FR_200"
},
{
"created_at": "2023-08-30T10:08:08.146343Z",
"currency": "EUR",
"description": "This is product 1",
"external_reference": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a",
"id": 1,
"label": "Product 1",
"ledger_account": {
"id": 95554824
},
"price": "cupidatat magna",
"price_before_tax": "sed ad reprehenderit qui",
"reference": "REF-123",
"unit": "piece",
"updated_at": "2023-08-30T10:08:08.146343Z",
"vat_rate": "FR_200"
}
],
"next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2"
}
Query Parameters
Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.
"dXBkYXRlZF9hdDoxNjc0MTIzNDU2"
Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 100.
"20"
You can choose to filter items on specific fields.
Available fields : id
Available operators : lt
, lteq
, gt
, gteq
, eq
, not_eq
, in
, not_in
"[{\"field\": \"id\", \"operator\": \"ea\", \"value\": \"42\"}]"
You can choose to sort items on specific attributes
Sort field may be prefixed with -
for descending order.
Example : id
will sort by ascending order, -id
will sort by descending order.
Available fields : id
"-id"
Response
A list of Products
The response is of type object
.
{
"has_more": true,
"items": [
{
"created_at": "2023-08-30T10:08:08.146343Z",
"currency": "EUR",
"description": "This is product 1",
"external_reference": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a",
"id": 1,
"label": "Product 1",
"ledger_account": {
"id": 67562603
},
"price": "commodo Lorem dolore sed",
"price_before_tax": "proident dolore consequat",
"reference": "REF-123",
"unit": "piece",
"updated_at": "2023-08-30T10:08:08.146343Z",
"vat_rate": "FR_200"
},
{
"created_at": "2023-08-30T10:08:08.146343Z",
"currency": "EUR",
"description": "This is product 1",
"external_reference": "0e67fc3c-c632-4feb-ad34-e18ed5fbf66a",
"id": 1,
"label": "Product 1",
"ledger_account": {
"id": 95554824
},
"price": "cupidatat magna",
"price_before_tax": "sed ad reprehenderit qui",
"reference": "REF-123",
"unit": "piece",
"updated_at": "2023-08-30T10:08:08.146343Z",
"vat_rate": "FR_200"
}
],
"next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2"
}