---
title: "Get create journal entry model"
method: GET
path: "/companies/{companyId}/connections/{connectionId}/options/journalEntries"
tags: ["Journal entries"]
---

# Get create journal entry model

`GET /companies/{companyId}/connections/{connectionId}/options/journalEntries`

## Request

- Base URL: `https://api.codat.io`
- URL: `https://api.codat.io/companies/{companyId}/connections/{connectionId}/options/journalEntries`
- Auth: API key in header `Authorization`

The *Get create journal entry model* endpoint returns the expected data for the request payload when creating a [journal entry](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) for a given company and integration.

[Journal entries](https://docs.codat.io/sync-for-payroll-api#/schemas/JournalEntry) are  made in a company's general ledger, or accounts, when transactions are approved.

**Integration-specific behaviour**

See the *response examples* for integration-specific indicative models.

## Response `200`

OK

- PushOption
  - `type` PushOptionType, required (unresolved $ref)
  - `displayName` DisplayName, required (unresolved $ref)
  - `description` Description (unresolved $ref)
  - `required` Required, required (unresolved $ref)
  - `properties` object, nullable
  - `options` PushOptionChoice[], nullable (unresolved $ref)
  - `validation` PushValidationInfo (unresolved $ref)

## Other responses

- `401`: Your API request was not properly authorized.
- `402`: An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403`: You are using an outdated API key or a key not associated with that resource.
- `404`: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429`: Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500`: There is a problem with our server. Please try again later.
- `503`: The Codat API is temporarily offline for maintenance. Please try again later.

## Changes

- **2024-02-13** `fc70787de2f3`: 7 info
  - added the optional property `validation` to the response with the `401` status
  - added the optional property `validation` to the response with the `402` status
  - added the optional property `validation` to the response with the `403` status
  - added the optional property `validation` to the response with the `404` status
  - …3 more

[Operation history](https://skmtc.dev/codatio/apis/sync-for-payroll/changes/companies/:companyId/connections/:connectionId/options/journalEntries/get.md)

---

[API](https://skmtc.dev/codatio/apis/sync-for-payroll.md) - [All operations](https://skmtc.dev/codatio/apis/sync-for-payroll/llms.txt) - [OpenAPI document](https://skmtc.dev/codatio/apis/sync-for-payroll/revisions/aa198f328aac?raw)