Organization Group
Organization group object represents coupling among organizations.
Organization group
ID of the organization group.
Name of the organization group.
Property indicates whether this license is a trial license.
Property indicates whether this licence is a production licence.
Deployment location identifier.
Use the /features endpoint instead. Enabled features (for internal use only).
Enabled priced features (for internal use only).
User that last modified the object.
Timestamp of last modification.
List organization groups
GET api / v1 / organization_groups
Retrieve all organization group objects. Typically, there would only be one result.
curl -X GET "https://example.rossum.app/api/v1/organization_groups"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 42,
"name": "Rossum group",
"is_trial": false,
"is_production": true,
"deployment_location": "prod-eu",
"features": null,
"usage": {},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z"
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve organization group
GET api / v1 / organization_groups / {organizationGroupID}
Get an organization group object.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0"{
"id": 42,
"name": "Rossum group",
"is_trial": false,
"is_production": true,
"deployment_location": "prod-eu",
"features": null,
"usage": {},
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the organization group.
Name of the organization group.
Property indicates whether this license is a trial license.
Property indicates whether this licence is a production licence.
Deployment location identifier.
Use the /features endpoint instead. Enabled features (for internal use only).
Enabled priced features (for internal use only).
User that last modified the object.
Timestamp of last modification.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Export organization group billing history
GET api / v1 / organization_groups / {organizationGroupID} / billing_history / export
Download the data provided by the billing history response resource in a CSV output.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/billing_history/export""begin_date,end_date,purchased_pages,billable_pages,non_billable_pages,purchased_documents,billable_documents,non_billable_documents,extracted_pages_with_learning,extracted_pages_without_learning,split_pages_with_learning,split_pages_without_learning,extracted_documents_with_learning,extracted_documents_without_learning,split_documents_with_learning,split_documents_without_learning,ocr_only_pages,ocr_only_documents,purchased_extracted_pages_with_learning,purchased_extracted_pages_without_learning,purchased_split_pages_with_learning,purchased_split_pages_without_learning,purchased_extracted_documents_with_learning,purchased_extracted_documents_without_learning,purchased_split_documents_with_learning,purchased_split_documents_without_learning,purchased_ocr_only_pages,purchased_ocr_only_documents\n2021-01-01,2022-12-31,555,34735,100,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0\n2020-01-01,2021-12-31,0,0,0,111,10209,123,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0\n"{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
responsestringInvalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Export organization group billing stats
POST api / v1 / organization_groups / {organizationGroupID} / billing_stats / export
Download the data provided by the billing stats response resource in a CSV output.
curl -X POST "https://example.rossum.app/api/v1/organization_groups/0/billing_stats/export" \ -H "Content-Type: application/json" \ -d '{}'"begin_date,end_date,billable_pages,non_billable_pages,billable_documents,non_billable_documents\n2021-10-01,2021-10-31,27,0,32,0\n2021-11-01,2021-11-30,159,0,147,9\n2021-12-01,2021-12-31,41,0,20,0\n"{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
List of attributes by which the results are to be grouped. Only a single value is supported. Note that 'organization' is only available for organization groups.
List of attributes by which the results are to be ordered.
Response
OK
responsestringInvalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
List organization group organizations
GET api / v1 / organization_groups / {organizationGroupID} / organizations
Get organizations for an organization group object. Returned objects contain subset of organization attributes.
The endpoint provides read-only view for users with the organization_group_admin role for managing memberships.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/organizations"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 321,
"url": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321",
"name": "East West Trading Co"
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
List organization group queues
GET api / v1 / organization_groups / {organizationGroupID} / queues
Get queues for an organization group object. Returned objects contain subset of queue attributes.
The endpoint provides read-only view for users with the organization_group_admin role for managing memberships.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/queues"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 654,
"url": "https://example.rossum.app/api/v1/organization_groups/42/queues/654",
"name": "Received invoices",
"organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321",
"workspace": "https://example.rossum.app/api/v1/organization_groups/42/workspaces/12"
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
List organization group users
GET api / v1 / organization_groups / {organizationGroupID} / users
Get users for an organization group object. Returned objects contain subset of user attributes.
The endpoint provides read-only view for users with the organization_group_admin role for managing memberships.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/users"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 123456,
"url": "https://example.rossum.app/api/v1/organization_groups/42/users/123456",
"email": "john-doe@east-west-trading.com",
"username": "JohnDoe",
"organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321"
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
List organization group workspaces
GET api / v1 / organization_groups / {organizationGroupID} / workspaces
Get workspaces for an organization group object. Returned objects contain subset of workspace attributes.
The endpoint provides read-only view for users with the organization_group_admin role for managing memberships.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/workspaces"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 345,
"url": "https://example.rossum.app/api/v1/organization_groups/42/workspaces/345",
"name": "East West Trading Co",
"organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/123",
"queues": [
"https://example.rossum.app/api/v1/organization_groups/42/queues/1",
"https://example.rossum.app/api/v1/organization_groups/42/queues/2"
]
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve organization
GET api / v1 / organization_groups / {organizationGroupID} / organizations / {organizationID}
Get organization for an organization group object. Returned object contains subset of organization attributes.
The endpoint provides read-only view for users with the organization_group_admin role for managing memberships.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/organizations/406"{
"id": 321,
"url": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321",
"name": "East West Trading Co"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the organization.
Membership URL of the organization.
Name of the organization (not visible in UI).
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve organization billing history group
GET api / v1 / organization_groups / {organizationGroupID} / billing_history
Retrieve billing history with entries corresponding to individual contracted periods. The value purchased_documents or purchased_pages define the period billing unit.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/billing_history"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"begin_date": "2021-01-01",
"end_date": "2022-12-31",
"organization_group": "string",
"values": {
"billable_documents": 32,
"billable_pages": 27,
"non_billable_documents": 0,
"non_billable_pages": 0,
"purchased_documents": 0,
"purchased_pages": 555,
"extracted_pages_with_learning": 0,
"extracted_pages_without_learning": 0,
"split_pages_with_learning": 0,
"split_pages_without_learning": 0,
"extracted_documents_with_learning": 0,
"extracted_documents_without_learning": 0,
"split_documents_with_learning": 0,
"split_documents_without_learning": 0,
"ocr_only_pages": 0,
"ocr_only_documents": 0,
"purchased_extracted_pages_with_learning": 0,
"purchased_extracted_pages_without_learning": 0,
"purchased_split_pages_with_learning": 0,
"purchased_split_pages_without_learning": 0,
"purchased_extracted_documents_with_learning": 0,
"purchased_extracted_documents_without_learning": 0,
"purchased_split_documents_with_learning": 0,
"purchased_split_documents_without_learning": 0,
"purchased_ocr_only_pages": 0,
"purchased_ocr_only_documents": 0,
"is_current": true
}
}
],
"totals": {
"billable_documents": 32,
"billable_pages": 27,
"non_billable_documents": 0,
"non_billable_pages": 0,
"purchased_documents": 0,
"purchased_pages": 555,
"extracted_pages_with_learning": 0,
"extracted_pages_without_learning": 0,
"split_pages_with_learning": 0,
"split_pages_without_learning": 0,
"extracted_documents_with_learning": 0,
"extracted_documents_without_learning": 0,
"split_documents_with_learning": 0,
"split_documents_without_learning": 0,
"ocr_only_pages": 0,
"ocr_only_documents": 0,
"purchased_extracted_pages_with_learning": 0,
"purchased_extracted_pages_without_learning": 0,
"purchased_split_pages_with_learning": 0,
"purchased_split_pages_without_learning": 0,
"purchased_extracted_documents_with_learning": 0,
"purchased_extracted_documents_without_learning": 0,
"purchased_split_documents_with_learning": 0,
"purchased_split_documents_without_learning": 0,
"purchased_ocr_only_pages": 0,
"purchased_ocr_only_documents": 0
},
"updated_at": "2022-09-01"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Date when the billing history was last updated.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve organization billing stats group
POST api / v1 / organization_groups / {organizationGroupID} / billing_stats
Download billing stats report for an organization group.
Limitations:
filter.queuescan only be used whenfilter.organizationscontains a single organizationfilter.queuescannot be used forgroup_by=organization
curl -X POST "https://example.rossum.app/api/v1/organization_groups/0/billing_stats" \ -H "Content-Type: application/json" \ -d '{}'{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"begin_date": "2021-01-01",
"end_date": "2022-12-31",
"organization": "https://example.rossum.app/api/v1/organizations/406",
"organization_group": "string",
"queue": "https://example.rossum.app/api/v1/queues/8199",
"values": {
"billable_documents": 32,
"billable_pages": 27,
"non_billable_documents": 0,
"non_billable_pages": 0,
"purchased_documents": 0,
"purchased_pages": 555,
"extracted_pages_with_learning": 0,
"extracted_pages_without_learning": 0,
"split_pages_with_learning": 0,
"split_pages_without_learning": 0,
"extracted_documents_with_learning": 0,
"extracted_documents_without_learning": 0,
"split_documents_with_learning": 0,
"split_documents_without_learning": 0,
"ocr_only_pages": 0,
"ocr_only_documents": 0,
"purchased_extracted_pages_with_learning": 0,
"purchased_extracted_pages_without_learning": 0,
"purchased_split_pages_with_learning": 0,
"purchased_split_pages_without_learning": 0,
"purchased_extracted_documents_with_learning": 0,
"purchased_extracted_documents_without_learning": 0,
"purchased_split_documents_with_learning": 0,
"purchased_split_documents_without_learning": 0,
"purchased_ocr_only_pages": 0,
"purchased_ocr_only_documents": 0,
"is_current": true
}
}
],
"totals": {
"billable_documents": 32,
"billable_pages": 27,
"non_billable_documents": 0,
"non_billable_pages": 0,
"purchased_documents": 0,
"purchased_pages": 555,
"extracted_pages_with_learning": 0,
"extracted_pages_without_learning": 0,
"split_pages_with_learning": 0,
"split_pages_without_learning": 0,
"extracted_documents_with_learning": 0,
"extracted_documents_without_learning": 0,
"split_documents_with_learning": 0,
"split_documents_without_learning": 0,
"ocr_only_pages": 0,
"ocr_only_documents": 0,
"purchased_extracted_pages_with_learning": 0,
"purchased_extracted_pages_without_learning": 0,
"purchased_split_pages_with_learning": 0,
"purchased_split_pages_without_learning": 0,
"purchased_extracted_documents_with_learning": 0,
"purchased_extracted_documents_without_learning": 0,
"purchased_split_documents_with_learning": 0,
"purchased_split_documents_without_learning": 0,
"purchased_ocr_only_pages": 0,
"purchased_ocr_only_documents": 0
},
"updated_at": "2022-09-01"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
List of attributes by which the results are to be grouped. Only a single value is supported. Note that 'organization' is only available for organization groups.
List of attributes by which the results are to be ordered.
Response
OK
Date when the billing stats were last updated.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve queue
GET api / v1 / organization_groups / {organizationGroupID} / queues / {queueID}
Get queue for an organization group object. Returned object contains subset of queue attributes.
The endpoint provides read-only view for users with the organization_group_admin role for managing memberships.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/queues/0"{
"id": 654,
"url": "https://example.rossum.app/api/v1/organization_groups/42/queues/654",
"name": "Received invoices",
"organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321",
"workspace": "https://example.rossum.app/api/v1/organization_groups/42/workspaces/12"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the queue.
Membership URL of the queue.
Name of the queue.
Membership URL of the organization.
Membership URL of the workspace.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve user
GET api / v1 / organization_groups / {organizationGroupID} / users / {userID}
Get user for an organization group object. Returned object contains subset of user attributes.
The endpoint provides read-only view for users with the organization_group_admin role for managing memberships.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/users/10775"{
"id": 123456,
"url": "https://example.rossum.app/api/v1/organization_groups/42/users/123456",
"email": "john-doe@east-west-trading.com",
"username": "JohnDoe",
"organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321"
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the user.
Membership URL of the user.
Email of the user.
Username of a user.
Related organization.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve workspace
GET api / v1 / organization_groups / {organizationGroupID} / workspaces / {workspaceID}
Get workspace for an organization group object. Returned object contains subset of workspace attributes.
Please note that direct access to the API requires you to login using Rossum credentials. User must have organization_group_admin role.
curl -X GET "https://example.rossum.app/api/v1/organization_groups/0/workspaces/0"{
"id": 345,
"url": "https://example.rossum.app/api/v1/organization_groups/42/workspaces/345",
"name": "East West Trading Co",
"organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/123",
"queues": [
"https://example.rossum.app/api/v1/organization_groups/42/queues/1",
"https://example.rossum.app/api/v1/organization_groups/42/queues/2"
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the workspace.
Membership URL of the workspace.
Name of the workspace.
Membership URL of the organization.
Membership URLs of the queues.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error