> ## Documentation Index > Fetch the complete documentation index at: https://docs.nmbr.co/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a journal entry ## OpenAPI ````yaml /spec/openapi.json get /journal_entries/{journal_entry} openapi: 3.0.0 info: title: Nmbr API description: API to interact with Nmbr Payroll version: 1.0.0 servers: - url: https://sandbox.nmbr.co/services/payroll security: - CompanyToken: [] tags: - name: Accounting Codes - name: Accounting Code Rules - name: Adjustments - name: Allowances - name: Allowance Line Items - name: Allowance Types - name: Async Tasks - name: Bank Accounts - name: Business Entities - name: Business Entity Verifications - name: Business Entity ROE Authorizations - name: Business Presets - name: Calculations - name: Companies - name: Contractors - name: Deductions - name: Deduction Line Items - name: Deduction Types - name: Earnings - name: Earning Line Items - name: Earning Types - name: Effective Tax Properties - name: Employees - name: Employee Benefits - name: Employee Benefit Line Items - name: Employee Benefit Types - name: Employer Benefits - name: Employer Benefit Line Items - name: Employer Benefit Types - name: Employer Statutory Withholding Line Items - name: Employer Statutory Withholding Types - name: Forms - name: Form Batches - name: Form Types - name: Holidays - name: Integrations - name: Journal Entries - name: Overtime Rates - name: Partners - name: Pay Rates - name: Pay Schedules - name: Pay Splits - name: Pay Stubs - name: Payments - name: Payrolls - name: Reimbursements - name: Reimbursement Line Items - name: Reimbursement Types - name: Remittance Accounts - name: Remittance Account Enrollments - name: Reports - name: Statutory Withholding Line Items - name: Statutory Withholding Types - name: Tags - name: Tag Groups - name: Tax Properties - name: Tax Property Templates - name: Tokens - name: Usage Records - name: Usage Summaries - name: Vacation Pay - name: Vacation Pay Settings - name: Webhooks - name: Work Assignments paths: /journal_entries/{journal_entry}: get: tags: - Journal Entries summary: Retrieve a journal entry operationId: journal-entries-show parameters: - name: journal_entry in: path schema: type: string required: true - name: expand in: query schema: type: array items: type: string enum: - journal_entry_rows - pay_stub - payroll required: false responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"journal_entry"`). readOnly: true data: type: object allOf: - $ref: '#/components/schemas/JournalEntry' anyOf: - type: object title: Default - type: object title: With payroll expanded properties: payroll: type: object properties: data: $ref: '#/components/schemas/Payroll' - type: object title: With pay_stub expanded properties: pay_stub: type: object properties: data: $ref: '#/components/schemas/PayStub' - type: object title: With journal_entry_rows expanded properties: journal_entry_rows: type: object nullable: true properties: object: type: string description: The type of the object in Nmbr (`"list"`). readOnly: true data: type: array items: type: object properties: id: type: string description: >- The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr. readOnly: true data: $ref: '#/components/schemas/JournalEntryRow' example: id: object: journal_entry data: type: payroll_recording title: Payroll Accrual Entry title_translations: en: Payroll Accrual Entry fr: Écriture de provision de la paie title_translated: Payroll Accrual Entry payroll: id: object: payroll links: self: /payrolls/ pay_stub: null is_balanced: true total: 0 is_missing_line_item_accounting_codes: true is_missing_default_account_payable: true is_missing_default_bank_account: false posted_on: '2026-01-30T00:00:00.000000Z' invalid_expense_types: - type: employer_statutory_withholding subtype: ei - type: employer_statutory_withholding subtype: cpp - type: employer_statutory_withholding subtype: cpp_2 invalid_liability_types: - type: statutory_withholding subtype: cpp - type: statutory_withholding subtype: cpp_2 - type: statutory_withholding subtype: ei - type: statutory_withholding subtype: federal_income_tax - type: statutory_withholding subtype: provincial_income_tax - type: employer_statutory_withholding subtype: ei - type: employer_statutory_withholding subtype: cpp - type: employer_statutory_withholding subtype: cpp_2 integrations: quickbooks: reference: null xero: reference: null created_at: '2026-01-01T00:00:00.000000Z' updated_at: '2026-01-01T00:00:00.000000Z' links: self: /journal_entries/ components: schemas: JournalEntry: type: object title: Journal Entry properties: type: type: string description: The type of journal entry (e.g. payroll recording, payroll payment). enum: - pay_stub_recording - payroll_payment - payroll_recording title: type: string nullable: true maxLength: 255 title_translations: type: object description: Optional translations for the `title` property. allOf: - $ref: '#/components/schemas/Translations' nullable: true title_translated: type: string description: >- The translation of the `title` property for the request locale. Computed using the values in `title` and `title_translations` and the value of the request's `Accept-Language` header. readOnly: true payroll: type: object description: The Payroll this journal entry belongs to. properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"payroll"`). readOnly: true pay_stub: description: >- The Pay Stub this journal entry belongs to. Present only for Pay Stub-level journal entries. is_balanced: type: boolean description: >- Whether the journal entry is balanced (total debits equal total credits). total: type: number description: The total amount for this journal entry. nullable: true format: decimal is_missing_line_item_accounting_codes: type: integer description: >- Whether any rows in this journal entry are missing an Accounting Code assignment. maxLength: 1 is_missing_default_account_payable: type: integer description: Whether the accounts payable row is missing an Accounting Code. maxLength: 1 is_missing_default_bank_account: type: integer description: Whether the bank row is missing an Accounting Code. maxLength: 1 posted_on: type: string description: The date this journal entry was posted to the accounting system. nullable: true format: date invalid_expense_types: type: object description: >- Line Item type/subtype pairs that are missing an expense Accounting Code. Each entry contains `type` and `subtype`. nullable: true invalid_liability_types: type: object description: >- Line Item type/subtype pairs that are missing a liability Accounting Code. Each entry contains `type` and `subtype`. nullable: true integrations: type: object description: >- External integration references. Contains `xero` and `quickbooks` objects, each with a `reference` field holding the external ID if synced. nullable: true properties: quickbooks: type: object nullable: true properties: reference: {} xero: type: object nullable: true properties: reference: {} created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime Payroll: type: object title: Payroll properties: business_entity: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"business_entity"`). readOnly: true pay_schedule: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"pay_schedule"`). readOnly: true type: type: string description: >- The type of payroll. `regular` payrolls are generated automatically on the Pay Schedule. `off_cycle` Payrolls are created manually against a source regular payroll. `historical` and `correction` payrolls are used to record or correct prior periods. enum: - correction - historical - off_cycle - regular period_number: type: integer description: >- The sequential number of this pay period within the calendar year of its `pay_date`, counting only regular payrolls. `null` for off-cycle, historical, and correction payrolls. nullable: true period_label: type: string description: A human-readable label for this pay period. nullable: true period_start: type: string description: The start date of the pay period. format: date period_end: type: string description: The end date of the pay period. format: date pay_date: type: string description: The date on which Employees and Contractors are paid. format: date original_pay_date: type: string description: >- For payrolls on a custom-frequency Pay Schedule, the originally scheduled pay date before any movement for weekends or bank holidays. Used for year-to-date calculations and tax year assignment. nullable: true format: date debit_date: type: string description: >- The expected date the company's account will be debited the `cash_requirement` amount. nullable: true approval_due_at: type: string description: >- The date and time, in UTC, by which the payroll must be approved to be processed on time. readOnly: true nullable: true format: dateTime regular_periods_count: type: integer description: >- The total number of regular pay periods in this Pay Schedule whose `pay_date` falls in the same calendar year as this payroll's `pay_date`. Used for year-to-date calculations. nullable: true is_impacted_by_weekend_or_holiday: type: boolean description: >- Whether `pay_date` or `approval_due_at` has been moved to avoid falling on a weekend or bank holiday. is_blocked_by_draft: type: boolean description: >- Whether this payroll is blocked from being approved because an earlier payroll on the same Pay Schedule is still in draft status. note: type: string description: An optional note on the payroll, visible to the partner. nullable: true employee_summary: type: object description: A summary of pay across all Employees in this payroll. nullable: true properties: gross: description: The sum of all earnings and allowances. subtractions: description: The total of all deductions, taxes, and benefit contributions. reimbursements: description: The total of non-taxable reimbursements. net: description: The Employee net pay; when negative, a warning is included. contractor_summary: type: object description: A summary of pay across all Contractors in this payroll. nullable: true properties: gross: description: The sum of all earnings. reimbursements: description: The total of non-taxable reimbursements. net: description: The Contractor net pay. company_summary: type: object description: A summary of the company's obligations in this payroll. nullable: true properties: taxes_and_contributions: description: The employer share of statutory remittances (CPP and EI). benefits: description: The total of employer benefit contributions. total: description: The company's total obligations. liability: type: number description: >- The total amount owed by the company for this payroll, including Employee and Contractor net pay, employer tax contributions, and employer benefit contributions. nullable: true format: decimal cash_requirement: type: number description: >- The total amount that will be debited from the company's account when this payroll is approved. nullable: true format: decimal status: type: string description: The current status of the payroll. enum: - approved - draft - failed - paid - partially_paid - processing approved_at: type: string description: The date on which the payroll was approved. nullable: true format: date is_stale: type: boolean description: >- Whether the payroll's tax calculations are out of date. When `true`, `stale_since` indicates when the payroll became stale. stale_since: type: string description: >- The timestamp at which the payroll's tax calculations became stale and need to be recalculated. `null` if the payroll is up to date. readOnly: true nullable: true format: dateTime source_payroll: {} warnings: type: object description: >- A collection of data validation warnings for this payroll. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing. nullable: true properties: object: type: string nullable: true data: type: object nullable: true external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime PayStub: type: object title: Pay Stub properties: payroll: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"payroll"`). readOnly: true work_assignment: type: object properties: id: type: string description: The unique identifier of the object in Nmbr. readOnly: true object: type: string description: The type of the object in Nmbr (`"work_assignment"`). readOnly: true payment_method: type: string description: The payment method for this pay stub. enum: - direct_deposit - manual - pad - wire has_taxes_calculated: type: boolean description: >- Whether tax amounts have been calculated for this pay stub. When `false`, amounts in the `employee_summary` and `company_summary` may be incomplete. is_pending_tax_rates: type: boolean description: This attribute is deprecated and will be removed. deprecated: true employee_summary: type: object description: >- A summary of pay for the Employee associated with this pay stub. Both `employee_summary` and `contractor_summary` are always present. The summary that does not apply is empty rather than omitted, and its amounts may be `null` before summaries are calculated. For calculated summaries, the side with a non-null `net` is the populated summary. `*_ytd` fields contain year-to-date totals inclusive of this pay period. nullable: true properties: gross: type: number description: The sum of all earnings and allowances. nullable: true format: decimal subtractions: type: number description: The total of all deductions, taxes, and benefit contributions. nullable: true format: decimal reimbursements: type: number description: The total of non-taxable reimbursements. nullable: true format: decimal net: type: number description: The Employee net pay; when negative, a warning is included. nullable: true format: decimal gross_ytd: type: number nullable: true format: decimal subtractions_ytd: type: number nullable: true format: decimal reimbursements_ytd: type: number nullable: true format: decimal net_ytd: type: number nullable: true format: decimal contractor_summary: type: object description: >- A summary of pay for the Contractor associated with this pay stub. Always present. For calculated summaries, a non-null `contractor_summary.net` means the contractor summary is populated. `*_ytd` fields contain year-to-date totals inclusive of this pay period. nullable: true properties: gross: description: The sum of all earnings. reimbursements: description: The total of non-taxable reimbursements. net: description: The Contractor net pay. gross_ytd: type: number nullable: true format: decimal reimbursements_ytd: type: number nullable: true format: decimal net_ytd: type: number nullable: true format: decimal company_summary: type: object description: >- A summary of the company's obligations for this pay stub. `*_ytd` fields contain year-to-date totals inclusive of this pay period. nullable: true properties: taxes_and_contributions: type: number description: The employer share of statutory remittances (CPP and EI). nullable: true format: decimal benefits: type: number description: The total of employer benefit contributions. nullable: true format: decimal total: type: number description: The company's total obligations. nullable: true format: decimal taxes_and_contributions_ytd: type: number nullable: true format: decimal benefits_ytd: type: number nullable: true format: decimal total_ytd: type: number nullable: true format: decimal vacation_pay_balance: type: number description: >- The Employee's Vacation Pay balance as of the end of this pay period. `null` for Contractor pay stubs. nullable: true format: decimal liability: type: number description: >- The total amount owed by the company for this pay stub, including Employee or Contractor net pay, employer tax contributions, and employer benefit contributions. nullable: true format: decimal cash_requirement: type: number description: >- The total amount that will be debited from the company's account for this pay stub when the Payroll is approved. nullable: true format: decimal note: type: string description: An optional note on the pay stub, visible to the partner. nullable: true line_item_summary: type: object description: >- Totals grouped by line item category for this pay stub. Each category includes a `period` total for the current pay period and a `ytd` total for the calendar year to date. Categories: `earnings`, `statutory_withholdings`, `reimbursements`, `allowances`, `employee_benefits`, `employer_benefits`, `deductions`. nullable: true properties: earnings: type: object nullable: true properties: period: type: number nullable: true format: decimal period_managed: type: number nullable: true format: decimal period_unmanaged: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal statutory_withholdings: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal reimbursements: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal allowances: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal benefits: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal employee_benefits: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal employer_benefits: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal deductions: type: object nullable: true properties: period: type: number nullable: true format: decimal ytd: type: number nullable: true format: decimal is_stale: type: boolean description: >- Whether the pay stub's tax calculations are out of date. When `true`, `stale_since` indicates when the pay stub became stale. stale_since: type: string description: >- The timestamp at which the pay stub's tax calculations became stale and need to be recalculated. `null` if the pay stub is up to date. readOnly: true nullable: true format: dateTime warnings: type: object description: >- A collection of data validation warnings for this pay stub. Warnings indicate incomplete or potentially incorrect data and could prevent payroll processing. nullable: true properties: object: type: string nullable: true data: type: object nullable: true external_ref: type: string description: >- A reference to the object in an external system, e.g. the primary key of the object in your application's database. Nmbr doesn't use, validate, parse, or require this value to be unique - it simply stores it for your reference. nullable: true maxLength: 255 apply_standard_tax_reductions: type: boolean description: >- When `true`, the standard tax reductions are applied to this pay stub's withholdings even in cases where they would otherwise be skipped to avoid applying them twice across related runs in the same period. In Canada these reductions are the employee's federal and provincial personal tax credits (their TD1 claim amounts) and the CPP/QPP basic exemption. Defaults to `false`, and has no effect where those reductions already apply. created_at: type: string description: The date and time the object was created in Nmbr. readOnly: true format: dateTime updated_at: type: string description: The date and time the object was last updated in Nmbr. readOnly: true format: dateTime JournalEntryRow: type: object properties: type: type: string enum: - credit - debit amount: type: number format: decimal code: type: string description: type: string Translations: type: object nullable: true properties: en: type: string maxLength: 255 fr: type: string maxLength: 255 securitySchemes: CompanyToken: type: http scheme: bearer ````