{
  "platform_id": "1234567890123456789",
  "account_id": "1234567890123456789",
  "currency_id": "3770712000000000099",
  "amount": 1234,
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": null
    }
  },
  "currency_rate": 1,
  "document_number": "AO-123",
  "journal_entry_type": "both",
  "description": "Journal Entries For Proper Accounting",
  "posted_date": "2023-06-12T00:00:00.000Z",
  "journal_lines": {
    "data": [
      {
        "platform_id": "3770712000001725038",
        "journal_entry_id": "3770712000001725026",
        "account_id": "3770712000000035001",
        "contact_id": "3770712000000080780",
        "tax_id": null,
        "tracking_category_ids": ["3770712000000000335_3770712000001122010"],
        "type": "DEBIT",
        "description": "Test Description for Journal",
        "net_amount": 5,
        "tax_amount": null,
        "updated_at": null
      },
      {
        "platform_id": "3770712000001725036",
        "journal_entry_id": "3770712000001725026",
        "account_id": "3770712000000035001",
        "contact_id": "3770712000000080780",
        "tax_id": null,
        "tracking_category_ids": ["3770712000000000335_3770712000001122010"],
        "type": "CREDIT",
        "description": "Test Description for Journal",
        "net_amount": 5,
        "tax_amount": null,
        "updated_at": null
      }
    ]
  },
  "account": {},
  "updated_at": "2023-11-05T00:00:00.000Z"
}
The Journal Entries Data Model simplifies the management and retrieval of journal entry information across various accounting platforms.
  • Unified journal entry properties: The model unifies essential journal entry details, such as account ID, amount, currency, description, and posted date, making it easier to work with journal entry data from different platforms.
  • Journal entry lines: The journal_lines property includes an array of related journal lines, providing a comprehensive view of the journal entry’s constituent transactions.

Attributes

platform_id
string
required
The accounting Platform’s ID for this journal entry
account_id
string
required
The accounting platform’s unique ID for the account associated with the journal entry
currency_id
string
The Accounting Platform’s unique ID for the currency
amount
float
required
The total amount of the journal entry
currency
string
required
The currency data associated with the Journal Entries.
currency_rate
float
required
Rate between the currency of the payment and the base currency
document_number
string
Reference number for the journal entry
journal_entry_type
string
Type of the journal entry
description
string
Description of the journal entry
posted_date
date
required
Date of the journal entry
journal_lines
Journal Lines
An array of Journal Lines
account
Account
The account associated with the journal entry
updated_at
date
required
The date at which the information was updated on the accounting platform

Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for this journal entry
account_idstringThe accounting platform’s unique ID for the account associated with the journal entry
amountfloatThe total amount of the journal entry
currencystringThe ISO-4217 currency code
currency_ratefloatRate between the currency of the payment and the base currency
document_numberstringReference number for the journal entry
journal_entry_typestringType of the journal entry
descriptionstringDescription of the journal entry
posted_datedateDate of the journal entry
journal_linesJournal LinesAn array of Journal Lines
accountAccountThe account associated with the journal entry
updated_atdateThe date at which the information was updated on the accounting platform

Journal Lines

The Journal Lines Data Model complements the Journal Entries Data Model, focusing on individual transactions within a journal entry.
  • Unified journal line properties: The model unifies essential journal line details, such as type, description, net amount, and tax amount, making it easier to work with journal line data from different platforms.
  • Hierarchical relationship with journal entries: Journal lines are associated with specific journal entries through the journal_entry_id property, enabling a clear understanding of their context within the broader financial record.
  • Relationship with other data models: Journal lines are connected to accounts, customers, and taxes using their respective platform_id properties, ensuring data consistency and accuracy across different accounting platforms.

Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for this journal entry
journal_entry_idstringThe platform ID for the journal entry associated with this journal line
account_idstringThe platform ID for the account associated with this journal line
customer_idstringThe platform ID for the customer associated with this journal line
tax_idstringThe platform ID for the tax associated with this journal line
typeenumType of the journal line item. Values are: DEBIT, CREDIT
descriptionstringDescription of the journal line
net_amountfloatThe total amount of this journal line
tax_amountfloatThe total tax amount of this journal line
{
  "platform_id": "1234567890123456789",
  "account_id": "1234567890123456789",
  "currency_id": "3770712000000000099",
  "amount": 1234,
  "currency": {
    "data": {
      "platform_id": "3770712000000000099",
      "name": "Indian Rupee",
      "code": "INR",
      "symbol": "₹",
      "is_base_currency": true,
      "exchange_rate": 0,
      "updated_at": null
    }
  },
  "currency_rate": 1,
  "document_number": "AO-123",
  "journal_entry_type": "both",
  "description": "Journal Entries For Proper Accounting",
  "posted_date": "2023-06-12T00:00:00.000Z",
  "journal_lines": {
    "data": [
      {
        "platform_id": "3770712000001725038",
        "journal_entry_id": "3770712000001725026",
        "account_id": "3770712000000035001",
        "contact_id": "3770712000000080780",
        "tax_id": null,
        "tracking_category_ids": ["3770712000000000335_3770712000001122010"],
        "type": "DEBIT",
        "description": "Test Description for Journal",
        "net_amount": 5,
        "tax_amount": null,
        "updated_at": null
      },
      {
        "platform_id": "3770712000001725036",
        "journal_entry_id": "3770712000001725026",
        "account_id": "3770712000000035001",
        "contact_id": "3770712000000080780",
        "tax_id": null,
        "tracking_category_ids": ["3770712000000000335_3770712000001122010"],
        "type": "CREDIT",
        "description": "Test Description for Journal",
        "net_amount": 5,
        "tax_amount": null,
        "updated_at": null
      }
    ]
  },
  "account": {},
  "updated_at": "2023-11-05T00:00:00.000Z"
}