Sign in

v1

latestOpenAPI 3.0.12026-07-141671231.8 MB
Ledger Entries

Retrieve a Ledger entry

Retrieve a ledger entry

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

get/api/external/v2/ledger_entries/{id}

Path parameters

idinteger required

The unique identifier of the ledger entry

Response

Ledger entry details

idinteger required

ID of the ledger entry

labelstring required

Label that describes the ledger entry

piece_numberstring nullable required
datestring date required

Date of the ledger entry (ISO 8601)

due_datestring date nullable required

The date the invoice is due

invoice_numberstring nullable required

Invoice number of the document linked to the ledger entry

created_atstring date-time required

Created at

updated_atstring date-time required

Last update

status'accounting_needed' | 'archived' | 'complete' | 'draft' | 'entry' | 'validation_needed' | 'waiting_details' nullable required

The accounting state of the entry.

  • archived: The entry has been archived.
  • draft: The customer invoice is still in draft and has not been finalized.
  • entry: The invoice is incomplete, some information is missing and needs to be completed.
  • waiting_details: The entry is awaiting additional accounting details.
  • validation_needed: The entry is sent to the accountant and needs validation.
  • accounting_needed: The entry needs to be processed by the accountant.
  • complete: The entry has been validated by the accountant.
  • null : The entry is neither a transaction nor an invoice that needs to be processed on Pennylane

Example response

{
  "id": 1,
  "label": "Payment for Services",
  "piece_number": "TENSNYLUGV",
  "date": "2023-08-30",
  "due_date": "2023-08-30",
  "invoice_number": "FAC-2024-001",
  "created_at": "2023-06-14T12:12:56.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z",
  "journal": {
    "id": 123,
    "url": "https://app.pennylane.com/api/external/v2/journals/123"
  },
  "categories": [
    {
      "id": 421,
      "label": "HR - Salaries",
      "weight": "0.25",
      "category_group": {
        "id": 229
      },
      "analytical_code": "CODE123",
      "created_at": "2023-08-30T10:08:08.146343Z",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    }
  ],
  "attachment": {
    "filename": "filename.pdf",
    "url": "http://www.pennylane.com/rails/active_storage/blobs/redirect/eyJfc..==--26d6e7391dd728fae2cde59bd3fbe4dd11e20a95/filename.pdf"
  },
  "ledger_entry_lines": [
    {
      "id": 42,
      "debit": "100.00",
      "credit": "0.00",
      "ledger_account": {
        "id": 987,
        "number": "411000",
        "url": "https://app.pennylane.com/api/external/v2/ledger_accounts/42"
      },
      "label": "Transaction label"
    }
  ]
}