curl --request POST \
--url http://localhost:3500/v1/invoices/imports/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"entries": [
{
"primary_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachment_document_ids": []
}
]
}
'const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entries: [
{
primary_document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
attachment_document_ids: []
}
]
})
};
fetch('http://localhost:3500/v1/invoices/imports/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/invoices/imports/batch"
payload = { "entries": [
{
"primary_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachment_document_ids": []
}
] }
headers = {
"idempotency-key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries": [
{
"index": 1,
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "accepted",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"failure": {
"code": "<string>",
"message": "<string>"
},
"dispatch": "accepted"
}
]
}{
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries": [
{
"index": 1,
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "accepted",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"failure": {
"code": "<string>",
"message": "<string>"
},
"dispatch": "accepted"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Idempotency conflict.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Submit an invoice import batch
Submits one finite selection, at most 100 total source files and the API request body limit. Validates ownership before admission. The transaction records accepted work, source failures, duplicate skips and capacity skips in one closed workflow run. One finite provider batch is dispatched after commit; unconfirmed dispatch is retained for recovery. Idempotency-Key is required; replay returns original admission references without dispatching again. Poll workflow-run items for current status. No batch session is created.
curl --request POST \
--url http://localhost:3500/v1/invoices/imports/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'idempotency-key: <idempotency-key>' \
--data '
{
"entries": [
{
"primary_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachment_document_ids": []
}
]
}
'const options = {
method: 'POST',
headers: {
'idempotency-key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entries: [
{
primary_document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
attachment_document_ids: []
}
]
})
};
fetch('http://localhost:3500/v1/invoices/imports/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/invoices/imports/batch"
payload = { "entries": [
{
"primary_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachment_document_ids": []
}
] }
headers = {
"idempotency-key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries": [
{
"index": 1,
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "accepted",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"failure": {
"code": "<string>",
"message": "<string>"
},
"dispatch": "accepted"
}
]
}{
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries": [
{
"index": 1,
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_document_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"import_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "accepted",
"invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"failure": {
"code": "<string>",
"message": "<string>"
},
"dispatch": "accepted"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "Idempotency conflict.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.
Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.
1 - 200^[\x21-\x7e]+$Body
1 - 100 elementsShow child attributes
Show child attributes