Retrieve a supplier invoice

get https://app.pennylane.com/api/external/v2/supplier_invoices/{id}

This endpoint returns a supplier invoice.

⚠️ ALPHA STATUS NOTICE

This endpoint is currently in alpha. It is part of an early testing phase, and its functionality may change or be removed in future updates.
We welcome your feedback to help us improve. Please use this endpoint with caution, especially in production environments, as backward compatibility is not guaranteed and functionality may change frequently.
This feature is best suited for developers interested in testing and providing input on upcoming capabilities.

ℹ️
This endpoint requires one of the following scopes: supplier_invoices:all, supplier_invoices:readonly

Responses

Response body

object

integer

required

The ID of the supplier invoice

label

string | null

required

invoice_number

string

required

currency

string

required

Defaults to EUR

EUR USD GBP AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BYR BZD CAD CDF CHF CLF CLP CNY COP CRC CUC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB FJD FKP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LTL LVL LYD MAD MDL MGA MKD MMK MNT MOP MRO MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD STD SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX UYU UZS VEF VND VUV WST XAF XCD XDR XOF XPF YER ZAR ZMK ZMW ZWL

amount

string

required

Invoice amount (total value of the invoice in euros). If the currency is euro, currency_amount and amount are identical.

currency_amount

string

required

Invoice currency amount (total value of the invoice in the currency of the invoice)

currency_amount_before_tax

string

required

Invoice currency amount before tax (total value before tax of the invoice in the currency of the invoice)

exchange_rate

string

required

Invoice exchange rate (used to convert the invoice to euros. If the invoice currency is euro it will be 1.0)

date

string | null

required

Invoice issue date (ISO 8601)

deadline

string | null

required

Invoice payment deadline (ISO 8601)

currency_tax

string

required

Invoice taxable amount (in euros). If the currency is euro, currency_tax and tax are identical.

tax

string

required

Invoice taxable amount (in invoice currency)

reconciled

boolean

required

Whether the invoice has been reconciled or not

filename

string | null

required

Name of the file attached to the invoice

public_file_url

string | null

required

Public URL of the invoice file. The URL will expire after 30 minutes.

remaining_amount_with_tax

string | null

required

The remaining amount with VAT to pay for the invoice to be considered paid

remaining_amount_without_tax

string | null

required

The remaining amount without VAT to pay for the invoice to be considered paid

ledger_entry

object

required

integer

required

Ledger entry identifier

supplier

object | null

required

integer

required

url

string

required

URL to get the supplier.

invoice_lines

object

required

url

string

required

URL to get the invoice lines of the invoice.

categories

object

required

url

string

required

URL to get the categories of the invoice.

transaction_reference

object | null

required

This reconciles the invoice with a transaction. See documentation about automatic payment matching.

banking_provider

string

required

The banking provider for the transaction

provider_field_name

string

required

Name of the field that you want to match

provider_field_value

string

required

Value that you want to match

payment_status

string

required

to_be_processed to_be_paid partially_paid payment_error payment_scheduled payment_in_progress payment_emitted payment_found paid_offline fully_paid

payments

object

required

url

string

required

URL to get the payments of the invoice.

matched_transactions

object

required

url

string

required

URL to get the transactions of the invoice.

external_reference

string

required

The unique external reference that was assigned during creation either by you or Pennylane

archived_at

date-time | null

required

The time the invoice has been archived

created_at

date-time

required

The time the invoice has been created

updated_at

date-time

required

The last time the invoice has been updated

Language

Credentials

OAuth2


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.pennylane.com/api/external/v2/supplier_invoices/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
48
}
1
{
2
  "id": 123,
3
  "label": "Demo label",
4
  "invoice_number": "F20230001",
5
  "currency": "EUR",
6
  "amount": "230.32",
7
  "currency_amount": "230.32",
8
  "currency_amount_before_tax": "196.32",
9
  "exchange_rate": "1.0",
10
  "date": "2023-08-30",
11
  "deadline": "2023-09-30",
12
  "currency_tax": "34.0",
13
  "tax": "34.0",
14
  "reconciled": false,
15
  "filename": "my_file.pdf",
16
  "public_file_url": "https://app.pennylane.com/public/invoice/pdf?encrypted_id=bzjoVJe...3D%3D",
17
  "remaining_amount_with_tax": "20.0",
18
  "remaining_amount_without_tax": "16.0",
19
  "ledger_entry": {
20
    "id": 42003
21
  },
22
  "supplier": {
23
    "id": 456,
24
    "url": "https://app.pennylane.com/api/external/v2/suppliers/42"
25
  },

200Returns a supplier invoice

400Bad request

401Access token is missing or invalid

403Access to this resource forbidden

404The resource was not found