Export accounting entries
The export accounting entries API can be used to export accounting entries into another system
caution
If you have not already read the Introduction to Export APIs then it's recommended to start there to understand how to use the export APIs. The Export APIs is designed to keep track of what has already been exported. If you are looking for a normal API, refer to the Core Accounting Entry API instead.
Get accounting entries that have not been exported
Endpoint: GET /v10/accounting-entries/export
You can add a date+time to the query string using the parameter not_exported_since
in accounting entry to re-export accounting entries that
have already been exported
Available properties for filtering: created_at
, updated_at
(NOTE: These filters have to be added using our Filters Syntax, however system_id
and not_export_since
should be added as a normal query string parameter)
The endpoint will fetch all accounting entries that have not been exported yet
Available query parameters
Parameter | Data type | Required | Default | Description |
---|---|---|---|---|
system_id | string | Yes | A string identifying the system the accounting entries should be exported to. This is used so accounting entries can be exported to multiple systems. | |
not_exported_since | datetime (UTC) | Current time | Add this to re-export accounting entries that have already been exported. Note the timezone should be UTC | |
filter_groups | Array<Filters> | Optional filters to add. See which filters are available above |
Data of response
Parameter | Required | Default | Description |
---|---|---|---|
accounting_entries.* | Yes | An array of object [accounting entry](/core-api/accounting entries/the-accounting entry-object) |
Mark accounting entries as exported
Endpoint: POST /v10/accounting-entries/mark-as-exported
Parameter | Data type | Required | Default | Description |
---|---|---|---|---|
accounting_entries | Array<Accounting Entries that have been exported> | Yes | Accounting Entrys that have been exported. You can at a max mark 10 accounting entries at a time |
Accounting Entrys that have been exported
Parameter | Data type | Required | Default | Description |
---|---|---|---|---|
accounting_entry_id | int | Yes | The ID of the accounting entry that has been exported | |
system_id | string | Yes | A string identifying the system the accounting entries should be exported to. This is used so accounting entries can be exported to multiple systems. | |
note | string | Any notes regarding the sync you want to add. These will be displayed in the timeline of the accounting entry |