curl --request POST \
--url http://localhost:3500/v1/agreements/{id}/price-imports/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"files": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"worksheets": null,
"instructions": null,
"default_currency": null
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
files: [
{
document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
worksheets: null,
instructions: null,
default_currency: null
}
]
})
};
fetch('http://localhost:3500/v1/agreements/{id}/price-imports/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/agreements/{id}/price-imports/batch"
payload = { "files": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"worksheets": None,
"instructions": None,
"default_currency": None
}
] }
headers = {
"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": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"admission": "created",
"price_import": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "workflow",
"worksheets": [
"<string>"
],
"instructions": "<string>",
"default_currency": "<string>",
"mode": "add",
"status": "queued",
"counts": {
"created": 1,
"duplicate": 1,
"invalid": 1,
"replaced": 1
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"admission": "created",
"price_import": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "workflow",
"worksheets": [
"<string>"
],
"instructions": "<string>",
"default_currency": "<string>",
"mode": "add",
"status": "queued",
"counts": {
"created": 1,
"duplicate": 1,
"invalid": 1,
"replaced": 1
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"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": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "A Document source is missing or changed during admission.",
"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": "No new file was confirmed as started. Location identifies the admitted run for checking before retrying.",
"request_id": "req_example"
}
}Import prices from several Documents
Admits up to 200 distinct linked Documents as items of one agreement price-import run. Each file has its own worksheets, instructions and default currency; one mode applies across the selection. Files settle independently, so a failed file does not undo successful siblings. replace_all removes existing prices once, when the first file with valid prices commits. An add of identical bytes and settings may reuse an active or completed import instead of starting new work. Poll the returned run and per-file imports for outcomes.
curl --request POST \
--url http://localhost:3500/v1/agreements/{id}/price-imports/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"files": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"worksheets": null,
"instructions": null,
"default_currency": null
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
files: [
{
document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
worksheets: null,
instructions: null,
default_currency: null
}
]
})
};
fetch('http://localhost:3500/v1/agreements/{id}/price-imports/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/agreements/{id}/price-imports/batch"
payload = { "files": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"worksheets": None,
"instructions": None,
"default_currency": None
}
] }
headers = {
"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": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"admission": "created",
"price_import": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "workflow",
"worksheets": [
"<string>"
],
"instructions": "<string>",
"default_currency": "<string>",
"mode": "add",
"status": "queued",
"counts": {
"created": 1,
"duplicate": 1,
"invalid": 1,
"replaced": 1
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entries": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"admission": "created",
"price_import": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agreement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"origin": "workflow",
"worksheets": [
"<string>"
],
"instructions": "<string>",
"default_currency": "<string>",
"mode": "add",
"status": "queued",
"counts": {
"created": 1,
"duplicate": 1,
"invalid": 1,
"replaced": 1
},
"failure": {
"code": "<string>",
"message": "<string>"
},
"workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_run_item_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
]
}{
"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": "not_found",
"message": "The resource does not exist in the current organization.",
"request_id": "req_example"
}
}{
"error": {
"code": "conflict",
"message": "A Document source is missing or changed during admission.",
"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": "No new file was confirmed as started. Location identifies the admitted run for checking before retrying.",
"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.