Delete journal entry
Changed onUse with caution
Because journal entries underpin every transaction in an accounting software, deleting a journal entry can affect every transaction for a given company.
Before you proceed, make sure you understand the implications of deleting journal entries from an accounting perspective.
The Delete journal entry endpoint allows you to delete a specified journal entry from an accounting software.
Journal entries are made in a company's general ledger, or accounts, when transactions are approved.
Process
-
Pass the {journalEntryId} to the Delete journal entry endpoint and store the pushOperationKey returned.
-
Check the status of the delete by checking the status of push operation either via
- Push operation webhook (advised),
- Push operation status endpoint.
A Success status indicates that the journal entry object was deleted from the accounting software.
-
(Optional) Check that the journal entry was deleted from the accounting software.
Effect on related objects
Be aware that deleting a journal entry from an accounting software might cause related objects to be modified. For example, if you delete the journal entry for a paid invoice in QuickBooks Online, the invoice is deleted but the payment against that invoice is not. The payment is converted to a payment on account.
Integration specifics
Integrations that support soft delete do not permanently delete the object in the accounting software.
| Integration | Soft Deleted |
|---|---|
| QuickBooks Online | Yes |
Request
- Base URLhttps://api.codat.io
- URLhttps://api.codat.io/companies/{companyId}/connections/{connectionId}/push/journalEntries/{journalEntryId}
- AuthAPI key in header Authorization
Query parameters
Time limit for the push operation to complete before it is timed out.
Allow a sync upon push completion.
Response
OK
Changes
- info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status
- info