CHchift
Syncs

Preview what a consumer's sync would create

Changed on

Queues an execution that writes nothing and records every object it would create (suppliers, invoices, payments…), linked to what they need, and what would fail. Each capability the consumer chose books at most limit objects changed in the last 14 days, unless dates are given. Read it with GET …/previews/{preview_id}. Refused with a 409 while another preview of the consumer is pending.

post/consumers/{consumer_id}/syncs/{syncid}/previews

Request

Path parameters

consumer_idstring uuid required
syncidstring uuid required

Request body

limitinteger

Objects each capability the consumer chose books at most. What they need (their suppliers) is previewed whatever its number.

force_from_datestring date nullable

First day the preview covers. Defaults to 14 days ago.

force_to_datestring date nullable

Last day it covers. Defaults to today.

Response

Successful Response

preview_idstring uuid required

Read the preview with it: the legacy routes know it as the preview execution.

status'pending' | 'ready' | 'failed' required

Pending while it is queued or running, then ready or failed.

Changes