Organization
Organization is a basic unit that contains all objects that are required to fully use Rossum platform.
Organization
ID of the organization.
Name of the organization (not visible in UI).
URL of the organization.
List of workspaces objects in the organization.
List of users in the organization.
URL to organization group the organization belongs to.
Organization-wide frontend UI settings (e.g. locales). Rossum internal.
Default:{}Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Property indicates whether this license is a trial license.
Timestamp for when the organization was created.
Timestamp for when the trial period ended (ISO 8601).
(Deprecated) OpenID Connect provider name.
INTERNAL Rossum internal information on organization.
URL of the first user of the organization (set during organization creation).
User that last modified the object.
Timestamp of last modification.
Specifies if the organization is a sandbox.
Default:falseList organizations
GET api / v1 / organizations
Retrieve all organization objects.
curl -X GET "https://example.rossum.app/api/v1/organizations?id=406&name=East+West+Trading+Co&include_membership_organizations=true"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 406,
"name": "East West Trading Co",
"url": "https://example.rossum.app/api/v1/organizations/406",
"workspaces": [
"https://example.rossum.app/api/v1/workspaces/7540"
],
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"organization_group": "string",
"ui_settings": {},
"metadata": {
"some_key": "some_value"
},
"is_trial": true,
"created_at": "2019-09-02T14:28:11.000000Z",
"trial_expires_at": "2020-09-02T14:28:11.000000Z",
"oidc_provider": null,
"internal_info": {
"cs_account_classification": null,
"customer_type": null,
"market_category": null,
"overdue_payment_date": null,
"sso_active": false
},
"creator": "https://example.rossum.app/api/v1/users/10775",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"sandbox": false
}
]
}{
"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 / organizations / {organizationID}
Get an organization object.
curl -X GET "https://example.rossum.app/api/v1/organizations/406"{
"id": 406,
"name": "East West Trading Co",
"url": "https://example.rossum.app/api/v1/organizations/406",
"workspaces": [
"https://example.rossum.app/api/v1/workspaces/7540"
],
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"organization_group": "string",
"ui_settings": {},
"metadata": {
"some_key": "some_value"
},
"is_trial": true,
"created_at": "2019-09-02T14:28:11.000000Z",
"trial_expires_at": "2020-09-02T14:28:11.000000Z",
"oidc_provider": null,
"internal_info": {
"cs_account_classification": null,
"customer_type": null,
"market_category": null,
"overdue_payment_date": null,
"sso_active": false
},
"creator": "https://example.rossum.app/api/v1/users/10775",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"sandbox": false
}{
"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.
Name of the organization (not visible in UI).
URL of the organization.
List of workspaces objects in the organization.
List of users in the organization.
URL to organization group the organization belongs to.
Organization-wide frontend UI settings (e.g. locales). Rossum internal.
Default:{}Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Property indicates whether this license is a trial license.
Timestamp for when the organization was created.
Timestamp for when the trial period ended (ISO 8601).
(Deprecated) OpenID Connect provider name.
INTERNAL Rossum internal information on organization.
URL of the first user of the organization (set during organization creation).
User that last modified the object.
Timestamp of last modification.
Specifies if the organization is a sandbox.
Default:falseInvalid 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
Partial update organization
PATCH api / v1 / organizations / {organizationID}
Update part of organization object. Writable fields are ui_settings, metadata, and settings; all other fields are read-only.
curl -X PATCH "https://example.rossum.app/api/v1/organizations/406" \ -H "Content-Type: application/json" \ -d '{}'{
"id": 406,
"name": "East West Trading Co",
"url": "https://example.rossum.app/api/v1/organizations/406",
"workspaces": [
"https://example.rossum.app/api/v1/workspaces/7540"
],
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"organization_group": "string",
"ui_settings": {},
"metadata": {
"some_key": "some_value"
},
"is_trial": true,
"created_at": "2019-09-02T14:28:11.000000Z",
"trial_expires_at": "2020-09-02T14:28:11.000000Z",
"oidc_provider": null,
"internal_info": {
"cs_account_classification": null,
"customer_type": null,
"market_category": null,
"overdue_payment_date": null,
"sso_active": false
},
"creator": "https://example.rossum.app/api/v1/users/10775",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"sandbox": false
}{
"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
Name of the organization (not visible in UI).
URL to organization group the organization belongs to.
Organization-wide frontend UI settings (e.g. locales). Rossum internal.
Default:{}Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Specifies if the organization is a sandbox.
Default:falseResponse
OK
ID of the organization.
Name of the organization (not visible in UI).
URL of the organization.
List of workspaces objects in the organization.
List of users in the organization.
URL to organization group the organization belongs to.
Organization-wide frontend UI settings (e.g. locales). Rossum internal.
Default:{}Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Property indicates whether this license is a trial license.
Timestamp for when the organization was created.
Timestamp for when the trial period ended (ISO 8601).
(Deprecated) OpenID Connect provider name.
INTERNAL Rossum internal information on organization.
URL of the first user of the organization (set during organization creation).
User that last modified the object.
Timestamp of last modification.
Specifies if the organization is a sandbox.
Default:falseInvalid 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
Update organization
PUT api / v1 / organizations / {organizationID}
Update organization object. Writable fields are ui_settings, metadata, and settings; all other fields are read-only.
curl -X PUT "https://example.rossum.app/api/v1/organizations/406" \ -H "Content-Type: application/json" \ -d '{}'{
"id": 406,
"name": "East West Trading Co",
"url": "https://example.rossum.app/api/v1/organizations/406",
"workspaces": [
"https://example.rossum.app/api/v1/workspaces/7540"
],
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"organization_group": "string",
"ui_settings": {},
"metadata": {
"some_key": "some_value"
},
"is_trial": true,
"created_at": "2019-09-02T14:28:11.000000Z",
"trial_expires_at": "2020-09-02T14:28:11.000000Z",
"oidc_provider": null,
"internal_info": {
"cs_account_classification": null,
"customer_type": null,
"market_category": null,
"overdue_payment_date": null,
"sso_active": false
},
"creator": "https://example.rossum.app/api/v1/users/10775",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"sandbox": false
}{
"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
Name of the organization (not visible in UI).
URL to organization group the organization belongs to.
Organization-wide frontend UI settings (e.g. locales). Rossum internal.
Default:{}Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Specifies if the organization is a sandbox.
Default:falseResponse
OK
ID of the organization.
Name of the organization (not visible in UI).
URL of the organization.
List of workspaces objects in the organization.
List of users in the organization.
URL to organization group the organization belongs to.
Organization-wide frontend UI settings (e.g. locales). Rossum internal.
Default:{}Client data. May be used to store e.g. external system object IDs. See Metadata for more details.
Default:{}Property indicates whether this license is a trial license.
Timestamp for when the organization was created.
Timestamp for when the trial period ended (ISO 8601).
(Deprecated) OpenID Connect provider name.
INTERNAL Rossum internal information on organization.
URL of the first user of the organization (set during organization creation).
User that last modified the object.
Timestamp of last modification.
Specifies if the organization is a sandbox.
Default:falseInvalid 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
Create organization
POST api / v1 / organizations / create
Create new organization and related objects (workspace, queue, user, schema, inbox, domain).
You need a create_key in order to create an organization. Please contact support@rossum.ai to obtain one.
Selected template_name affects default schema and extracted fields. Please note that the demo templates may be updated as new features are introduced.
List of available templates:
| Template name | Description | Is demo |
|---|---|---|
| Empty Organization Template | Empty organization, suitable for further customization | no |
| CZ Demo Template | Czech standard invoices | yes |
| Tax Invoice EU Demo Template | VAT Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the EU | yes |
| Tax Invoice US Demo Template | Tax Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the US | yes |
| Tax Invoice UK Demo Template | VAT Invoices, Credit Notes, Debit Notes, Purchase/Sales Orders, Receipts, and Pro Formas coming from the UK, India, Canada, or Australia | yes |
| Delivery Note Demo Template | Delivery Notes | yes |
| Tax Invoice CN Demo Template | governmental Tax Invoices from Mainland China (fapiaos) | yes |
| Certificates of Analysis Demo Template | Certificates of Analysis that are quality control documents common in the food and beverage industry | yes |
curl -X POST "https://example.rossum.app/api/v1/organizations/create" \ -H "Content-Type: application/json" \ -d '{ "template_name": "Tax Invoice UK Demo Template", "organization_name": "East West Trading Co", "user_fullname": "John Doe", "user_email": "john@east-west-trading.com", "create_key": "13156106d6f185df24648ac7ff20f64f1c5c06c144927be217189e26f8262c4a" }'{
"organization": {
"id": 406,
"name": "East West Trading Co",
"url": "https://example.rossum.app/api/v1/organizations/406",
"workspaces": [
"https://example.rossum.app/api/v1/workspaces/7540"
],
"users": [
"https://example.rossum.app/api/v1/users/10775"
],
"organization_group": "string",
"ui_settings": {},
"metadata": {
"some_key": "some_value"
},
"is_trial": true,
"created_at": "2019-09-02T14:28:11.000000Z",
"trial_expires_at": "2020-09-02T14:28:11.000000Z",
"oidc_provider": null,
"internal_info": {
"cs_account_classification": null,
"customer_type": null,
"market_category": null,
"overdue_payment_date": null,
"sso_active": false
},
"creator": "https://example.rossum.app/api/v1/users/10775",
"modified_by": "https://example.rossum.app/api/v1/users/10775",
"modified_at": "2021-04-26T10:08:03.856648Z",
"settings": {},
"sandbox": false
},
"key": "e7c4ddd996d8e92bdf780b9f0dfe8e4cd17f0c6e",
"domain": "example.rossum.app",
"code": "abc123def456"
}{
"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
Template to use for new organization.
Name of the organization. Will be also used as a base for inbox e-mail address.
Full user name.
Valid email of the user (also used as Rossum login).
Initial user password. If not provided, password will be generated.
Initial UI settings.
Default:{"locale":"en"}A key that allows to create an organization.
Response
Created
Authentication token for the newly created user.
Domain of the newly created organization.
One-time login token for the newly created user.
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
Export organization billing history
GET api / v1 / organizations / {organizationID} / 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/organizations/406/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\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 - CSV file download
responsestringCSV file containing billing history data.
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 billing stats
POST api / v1 / organizations / {organizationID} / 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/organizations/406/billing_stats/export" \ -H "Content-Type: application/json" \ -d '{ "filters": { "queues": [ "https://example.rossum.app/api/v1/queues/12345" ], "begin_date": "2021-10-01", "end_date": "2022-09-30" }, "group_by": [ "month" ] }'"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\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.
Response
OK - CSV file download
responsestringCSV file containing billing stats data.
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
Generate organization token
POST api / v1 / auth / membership_token
Generate token for access to membership and primary organizations. If the user is a group administrator, token can be generated for any organization in his organization group.
curl -X POST "https://example.rossum.app/api/v1/auth/membership_token" \ -H "Content-Type: application/json" \ -d '{ "organization": "https://example.rossum.app/api/v1/organizations/406" }'{
"key": "b6dde6e6280c697bc4afac7f920c5cee8c9c9t7d",
"organization": "https://example.rossum.app/api/v1/organizations/406"
}{
"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
URL to the organization to which the token will have access.
Response
OK
Authorization token belonging to requested organization.
Organization URL.
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
POST api / v1 / organizations / {organizationID} / billing
In order to obtain an overview of the billed items, you can get basic billing statistics.
This endpoint is deprecated in favor of billing stats for organization and may return inaccurate results.
Please note that data are accurate starting on June 1st 2021.
curl -X POST "https://example.rossum.app/api/v1/organizations/406/billing" \ -H "Content-Type: application/json" \ -d '{}'{
"series": [
{
"begin_date": "2019-02-01",
"end_date": "2019-02-01",
"queue": "https://example.rossum.app/api/v1/queues/8198",
"values": {
"header_fields_per_page": 2,
"header_fields_per_document": 5,
"header_fields_and_line_items_per_page": 9,
"header_fields_and_line_items_per_document": 20
}
}
],
"totals": {
"header_fields_per_page": 8,
"header_fields_per_document": 16,
"header_fields_and_line_items_per_page": 20,
"header_fields_and_line_items_per_document": 43
}
}{
"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 series is to be grouped.
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
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 organization billing history
GET api / v1 / organizations / {organizationID} / 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/organizations/406/billing_history"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"begin_date": "2021-01-01",
"end_date": "2022-12-31",
"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
POST api / v1 / organizations / {organizationID} / billing_stats
In order to obtain an overview of the billed items, you can get basic billing statistics.
The billing unit (pages or documents) is defined in the contract.
curl -X POST "https://example.rossum.app/api/v1/organizations/406/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",
"queue": "https://example.rossum.app/api/v1/queues/8198",
"values": {
"billable_documents": 13,
"billable_pages": 7,
"non_billable_documents": 0,
"non_billable_pages": 0
}
}
],
"totals": {
"billable_documents": 21288,
"billable_pages": 30204,
"non_billable_documents": 81,
"non_billable_pages": 5649
},
"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.
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