v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Core Accounting

List Intercompany Journal Entries

    Retrieves a paginated list of intercompany journal entries for the authenticated user's customer.

    This endpoint returns:
    - Summary information for each intercompany journal entry
    - Basic transaction details (simplified view for list performance)
    - Entity and exchange rate information
    - Pagination metadata (count, next, previous)
    - Reversal relationships and attachment counts

    The response includes:
    - Intercompany journal entry metadata
    - Associated transaction summaries
    - Exchange rate information for currency conversions
    - Links to related reversals
    - Attachment information

    Results can be sorted using the 'sort' query parameter with field names like 'date', 'id', etc.
    Prefix with '-' for descending order (e.g., '-date').
    
get/coa/api/intercompany-journal-entry

Query parameters

include_deletedboolean

When set to 'true', returns ONLY deleted records instead of active records. Deleted records contain minimal data: 'id', 'is_deleted=true', 'deleted_at' timestamp, and 'last_modified_at'. When 'false' or omitted, returns ONLY active records. This provides clean separation between active and deleted data.

last_modified_at__gtestring

Filter for records modified on or after this timestamp. Format: ISO 8601 (e.g., '2024-01-01T00:00:00Z' or '2024-01-01'). Works with both active records and deleted records (filters by deletion time for deleted records).

last_modified_at__ltestring

Filter for records modified on or before this timestamp. Format: ISO 8601 (e.g., '2024-12-31T23:59:59Z' or '2024-12-31'). Works with both active records and deleted records (filters by deletion time for deleted records).

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}