Exclude Numeral Sync Record
POST/api/numeral/records/:record/exclude
Stops sending this document to Numeral until it is included again. If Numeral accepted (or may hold) it, it is sent once more with every line zeroed, then held (reason_code manually_excluded); otherwise it is held right away. Later edits never re-queue it.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Body fields:
- reason (string, optional, max 500): shown as the record's reason.
Authentication: Requires a Bearer token. Requires the integrations.sync permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.