Sign in
Journal entries

Get journal entry

The Get journal entry endpoint returns a single journal entry for a given journalEntryId.

Journal entries are made in a company's general ledger, or accounts, when transactions are approved.

Before using this endpoint, you must have retrieved data for the company.

get/companies/{companyId}/data/journalEntries/{journalEntryId}

Response

Success

idstring

Unique identifier of the journal entry for the company in the accounting software.

descriptionstring nullable

Optional description of the journal entry.

postedOnstring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

createdOnstring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

updatedOnstring

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:

2020-10-08T22:40:50Z
2021-01-01T00:00:00

When syncing data that contains DateTime fields from Codat, make sure you support the following cases when reading time information:

  • Coordinated Universal Time (UTC): 2021-11-15T06:00:00Z
  • Unqualified local time: 2021-11-15T01:00:00
  • UTC time offsets: 2021-11-15T01:00:00-05:00

Time zones

Not all dates from Codat will contain information about time zones.
Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.

journalRefJournalRef — unresolved $ref
journalLinesJournalLine[] nullable— unresolved $ref

An array of journal lines.

recordRefJournalEntryRecordRef — unresolved $ref
modifiedDatestring

The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache.

Use it to identify and retrieve records that have changed since your last fetch. For example, filtering modifiedDate to today will provide new records updated in Codat today.

This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports (read more).

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

sourceModifiedDatestring

The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice.

It is not populated (read more) when:

  • Pulling attachments
  • The accounting software does not provide modification dates for a data type
  • A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred
  • A record has been voided. For certain platforms that soft delete records, isDeleted metadata is used to identify void records

In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

Changes

Changed in 4 of the 51 revisions of this API.1411

  • 84e2867c192f2See the full diff
    • ○

      added the optional property allOf[subschema #1]/journalLines/items/transactionAmount to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[subschema #1]/journalLines/items/transactionCurrency to the response with the 200 status

      response-optional-property-added

  • ac0cc1f525071See the full diff
    • ○

      added the optional property allOf[subschema #1]/journalLines/items/contactRef to the response with the 200 status

      response-optional-property-added

  • 4bfab0afa6ca8See the full diff
    • ○

      added the optional property validation to the response with the 401 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 402 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 403 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 404 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 409 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 429 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 500 status

      response-optional-property-added

    • ○

      added the optional property validation to the response with the 503 status

      response-optional-property-added

  • 0fcc5f736d8614See the full diff
    • ●

      added the new bankTransactions enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new billCreditNotes enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new billPayments enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new bills enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new creditNotes enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new customers enum value to the allOf[subschema #1]/journalLines/items/tracking/recordRefs/items/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new directCosts enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new directIncomes enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new invoices enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new journalEntries enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new payments enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new suppliers enum value to the allOf[subschema #1]/journalLines/items/tracking/recordRefs/items/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new trackingCategories enum value to the allOf[subschema #1]/journalLines/items/tracking/recordRefs/items/dataType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new transfers enum value to the allOf[subschema #1]/recordRef/dataType response property for the response status 200

      response-property-enum-value-added