Export credit notes
The export credit notes API can be used to export credit notes 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 Credit note API instead.
Get credit notes that have not been exported
Endpoint: GET /v10/credit-notes/export
You can add a date+time to the query string using the parameter not_exported_since in credit note to re-export credit notes 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)
Available nested resources for including: lines
The endpoint will fetch all credit notes 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 credit notes should be exported to. This is used so credit notes can be exported to multiple systems. | |
not_exported_since | datetime (UTC) | Current time | Add this to re-export credit notes that have already been exported. Note the timezone should be UTC | |
include_non_booked | integer | 0 | Export draft credit notes that have not been booked yet. 0 = only export booked credit notes. 1 = include draft credit notes in export | |
filter_groups | Array<Filters> | Optional filters to add. See which filters are available above |
Data of response
| Parameter | Required | Default | Description |
|---|---|---|---|
credit_notes.* | Yes | An array of object [credit note](/core-api/credit notes/the-credit note-object) |
Mark credit notes as exported
Endpoint: POST /v10/credit notes/mark-as-exported
| Parameter | Data type | Required | Default | Description |
|---|---|---|---|---|
credit_notes | Array<[Credit notes that have been exported](#credit notes-that-have-been-exported)> | Yes | [Credit notes that have been exported](#credit notes-that-have-been-exported). You can at a max mark 10 credit notes at a time |
Credit notes that have been exported
| Parameter | Data type | Required | Default | Description |
|---|---|---|---|---|
credit note_id | int | Yes | The ID of the credit note that has been exported | |
system_id | string | Yes | A string identifying the system the credit notes should be exported to. This is used so credit notes 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 credit note |