Developer docs

← All endpoints

GET/v1/tenants/{tenantId}/core/transactions/invoices

Synchronize invoices Experimental

Live entity representations and retained deletions, ordered by modification/deletion timestamp and ID. Use an overlap window when polling from a completed sync_through checkpoint. Requires transactions:read or core:read. Save sync_through after the final page succeeds, then subtract a configurable overlap window for the next poll.

Parameters

tenantIdpathstringnon-nullrequired
sincequerystringnon-nulloptional

Inclusive ISO 8601 timestamp with offset. Omit to synchronize everything. Cannot be combined with cursor.

cursorquerystringnon-nulloptional

Opaque next_cursor from the previous page. Pass it back unchanged to continue the same collection.

limitqueryintegernon-nulloptional

Combined entities and deletions per page: default 100, maximum 500. May change between pages.

  • Format: int32

Responses

200Response
application/jsonobjectnon-null
itemsarray of objectnon-nullrequired
Show item fields

Exactly one of these shapes is allowed.

deleted objectnon-null
typestringnon-nullrequired
Allowed values"deleted"
idstringnon-nullrequired
changed_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
deleted_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
entity objectnon-null
typestringnon-nullrequired
Allowed values"entity"
dataobjectnon-nullrequired
Show child fields
idstringnon-nullrequired
bankstringnullableoptional
ibanstringnullableoptional
linesarray of objectnon-nullrequired
Show item fields
idstringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

final_net_unit_sales_pricestringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
gross_line_amountstringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
invoice_line_typeanynon-nullrequired

Further nesting is omitted. See the schema for the full definition.

View schema definition

invoice_quantitystringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
item_namestringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

item_numberstringnullableoptional

Further nesting is omitted. See the schema for the full definition.

line_discount_percentagestringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
net_line_amountstringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
net_unit_order_discount_amountstringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
net_unit_pricestringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
source_referencesanynon-nullrequired

Further nesting is omitted. See the schema for the full definition.

View schema definition

unit_coststringnullableoptional

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
unit_cost_currency_iso_codestringnullableoptional

Further nesting is omitted. See the schema for the full definition.

unit_of_measurestringnullableoptional

Further nesting is omitted. See the schema for the full definition.

vat_amountstringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
vat_ratestringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

  • Format: BigDecimal
Example"100.0"
paidbooleannon-nullrequired
referencestringnullableoptional
swiftstringnullableoptional
versionintegernon-nullrequired
  • Format: int64
bank_accountstringnullableoptional
company_idstringnon-nullrequired
created_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
creditor_referencestringnullableoptional
creditor_reference_algorithmstringnullableoptional
creditor_reference_numberstringnullableoptional
currency_iso_codestringnon-nullrequired
customer_idstringnon-nullrequired
customer_typestringnon-nullrequired
Allowed values"B2B""B2C""COMPANY""RETAIL_STORE""ECOM_STORE"
document_statusstringnon-nullrequired
due_datestringnon-nullrequired
  • Format: date
Example"2026-01-14"
exchange_ratestringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
external_notesstringnullableoptional
invoice_addressobjectnon-nullrequired
Show child fields
citystringnon-nullrequired
namestringnon-nullrequired
streetstringnon-nullrequired
country_iso_codestringnon-nullrequired
post_codestringnon-nullrequired
invoice_datestringnon-nullrequired
  • Format: date
Example"2026-01-14"
invoice_email_addressstringnullableoptional
invoice_numberstringnon-nullrequired
invoiced_by_user_idstringnon-nullrequired
modified_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
organisational_unit_idstringnon-nullrequired
source_typestringnon-nullrequired
terms_of_payment_idstringnon-nullrequired
total_gross_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
total_net_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
total_vat_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
changed_atstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"

View schema definition

next_cursorstringnullablerequired
sync_throughstringnon-nullrequired
  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"

View schema definition

400Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

401Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

403Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition