Sync invoices for a period

post

https://api.cardda.com/v1/sii/keys/{sii_key_id}/sync_invoices

Triggers a synchronous sync of the company's electronic documents (DTEs) from
the SII for the tax periods in [from, to] (both YYYY-MM, inclusive). The
call authenticates with this key, walks each month in the range, and upserts
the resulting fiscal invoices.

The range is validated server-side: from and to must both match YYYY-MM,
from must be ≤ to, and the span must not exceed 24 months — otherwise
the request fails with 422 (sii/invalid-range).

Because CxP payables ingestion relies on the company's own certificate, this
is how you backfill or refresh a company's SII inbox/outbox on demand. The call
is synchronous and can take a while for wide ranges.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sii_key_id

uuid

required

UUID of the SII key (digital-certificate credential).

Body Params

Inclusive tax-period range to sync.

from

string

required

^[0-9]{4}-(0[1-9]|1[0-2])$

First tax period to sync, in YYYY-MM format. Anything that does not match
YYYY-MM is rejected with 422 (sii/invalid-range).

string

required

^[0-9]{4}-(0[1-9]|1[0-2])$

Last tax period to sync (inclusive), in YYYY-MM format. Must be greater
than or equal to from, and the span must not exceed 24 months —
otherwise 422 (sii/invalid-range).

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Fiscal-invoice endpoints
authorize the caller against this company (and read/write its data). SII-key
endpoints never filter their results by this header. On the SII-key list,
however, belonging to the header company is one of the ways a caller is authorized
to make the call (alongside being Cardda staff or passing their own user_id), so
the header is not merely ignored there. On the other SII-key endpoints the header
plays no part in authorization. See The company-id header
for details on how to obtain a value for this header and the error responses to
expect when it is missing or invalid.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The sync completed successfully.

404SII key not found. Body: { "message": "Resource not found" }.

409A sync is already in progress for this key upstream. Body: { "error": { "code": "sii/sync-in-progress" } }.

422Invalid range — from/to not in YYYY-MM, from after to, or the span exceeds 24 months. Body: { "error": { "code": "sii/invalid-range" } }.

429The SII WAF is throttling Cardda's crawler; the sync can't complete right now. Body: { "error": { "code": "sii/rate-limited" } }.

500An unmapped internal error occurred while syncing. Body: { "error": { "code": "sii/unknown" } }.

504The upstream SII call timed out. Body: { "error": { "code": "sii/upstream-timeout" } }.