Workspace

Add Invoices To A Workspace

HTTP Request

PUT /api/v1/workspace/{id}/invoices/add

Interactive Demo

📋 Description: Adds one or more Approved invoices to the specified workspace. Returns a result object describing which invoices were added and which were skipped (e.g. already linked).

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Workspace ID
body	body	array[integer]	true	Request body containing the invoice details, including line items, amounts, and associated metadata, necessary for adding an invoice to the specified workspace.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	Invoices processed; see result body for per-invoice outcome	AddingInvoicesToWorkspaceResult
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "workspaceId": 0,
  "workspaceDisplayId": "string",
  "workspaceName": "string",
  "results": [
    {
      "entity": {
        "id": 0,
        "displayId": "string",
        "name": "string",
        "invoiceType": "VENDOR_INV",
        "state": "INV_DRAFT",
        "externalDocumentNumber": "string",
        "purchaseOrderReference": "string",
        "invoiceDate": "2019-08-24",
        "dueDate": "2019-08-24",
        "notes": "string",
        "billingPeriodFromDate": "2019-08-24",
        "billingPeriodToDate": "2019-08-24",
        "currency": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "decimalPoints": 0
        },
        "vendor": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "erpSystemDisplayId": "string"
        },
        "company": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string",
          "countryId": 0,
          "countryDisplayId": "string",
          "name": "string",
          "postingPeriodVariantId": 0,
          "fiscalVariantId": 0
        },
        "netAmount": 0,
        "taxAmount": 0,
        "totalAmount": 0,
        "netAmountBalance": 0,
        "taxAmountBalance": 0,
        "paymentTerm": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        },
        "paymentMethod": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "type": "string"
        },
        "paymentBlock": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string"
        },
        "defaultCostCenter": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "erpSystemId": 0
        },
        "defaultProfitCenter": {
          "id": 0,
          "displayId": "string",
          "status": "CREATED",
          "name": "string",
          "validTo": "2019-08-24",
          "erpSystemId": 0,
          "erpSystemDisplayId": "string"
        },
        "invoiceLineItems": [
          {
            "id": 0,
            "displayId": "string",
            "expenseCategory": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "expenseCategoryType": "PAYMENT"
            },
            "description": "string",
            "unitOfMeasure": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "quantity": 0,
            "unitPrice": 0,
            "taxJurisdiction": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0,
              "schema": "string",
              "countryDisplayId": "string"
            },
            "taxCode": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "taxExpenseAccount": {
              "id": 0,
              "displayId": "string",
              "generalLedgerAccountName": "string",
              "generalLedgerAccountCode": "string",
              "openItemManagement": true,
              "accountCategory": "BALANCESHEET",
              "shortName": "string",
              "longName": "string"
            },
            "taxLineItems": [
              {
                "id": 0,
                "taxRate": 0.1,
                "taxAmount": 0,
                "taxType": "string",
                "invoiceLineItemId": 0
              }
            ],
            "workBreakdownStructure": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "costCenter": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "profitCenter": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "validTo": "2019-08-24",
              "erpSystemId": 0,
              "erpSystemDisplayId": "string"
            },
            "functionalArea": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "businessArea": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "segment": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "network": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "internalOrderType": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0
            },
            "internalOrder": {
              "id": 0,
              "displayId": "string",
              "status": "CREATED",
              "name": "string",
              "erpSystemId": 0,
              "internalOrderTypeId": 0
            },
            "additionalCurrencies": [
              {
                "id": 0,
                "amount": 0,
                "currency": {
                  "id": 0,
                  "displayId": "string",
                  "status": "CREATED",
                  "name": "string",
                  "decimalPoints": 0
                },
                "conversionRate": 0,
                "conversionDate": "2019-08-24",
                "translationDateType": "DOCUMENT_DATE",
                "amountType": "NET_AMOUNT",
                "currencyDefinitionType": "CONTRACT_CURRENCY",
                "invoiceEntryId": 0,
                "invoiceEntryDisplayId": "string"
              }
            ],
            "scheduledPaymentMatches": [
              {
                "id": 0,
                "fromId": 0,
                "toId": 0,
                "amount": 0
              }
            ],
            "goodsReceiptLineItemLinks": [
              {
                "id": 0,
                "fromId": 0,
                "toId": 0,
                "linkedQuantity": 0
              }
            ],
            "invoiceId": 0,
            "invoiceDisplayId": "string",
            "invoiceState": "INV_DRAFT",
            "vendorPaymentId": 0,
            "purchaseOrderLineItemId": 0,
            "netAmount": 0,
            "allowsSystemGenerateNewId": true,
            "numberRangeIdentifierValue": "string",
            "numberRangeIdentifierType": {
              "name": "string"
            },
            "numberRangeType": {
              "name": "string"
            }
          }
        ],
        "workspaceId": 0,
        "workspaceDisplayId": "string",
        "workspaceName": "string",
        "workspaceState": "INV_DRAFT",
        "remainingNetAmount": 0,
        "remainingTaxAmount": 0,
        "remainingTotalAmount": 0,
        "pendingPaymentCount": 0,
        "allPaymentsPosted": true,
        "approvalInfo": {
          "approverUsername": "string",
          "approvedAt": "2019-08-24T14:15:22Z"
        },
        "rejectionReason": "string",
        "allowsSystemGenerateNewId": true,
        "numberRangeIdentifierValue": "string",
        "numberRangeIdentifierType": {
          "name": "string"
        },
        "numberRangeType": {
          "name": "string"
        }
      },
      "entityId": 0,
      "status": "SUCCESS",
      "errorMessage": "string"
    }
  ],
  "totalProcessed": 0,
  "successCount": 0,
  "failedCount": 0,
  "alreadyLinkedCount": 0
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get A Resource By ID

HTTP Request

GET /api/v1/workspace/{id}

Interactive Demo

📋 Description: Returns the single resource with the given ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Resource ID

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update A Resource

HTTP Request

PUT /api/v1/workspace/{id}

Interactive Demo

📋 Description: Fully replaces the resource with the given ID. All fields in the request body are applied.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Resource ID
body	body	WorkspaceDto	true	Request body containing the updated workspace details, including name, description, and configuration settings, to facilitate effective workspace management.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "state": "INV_DRAFT",
  "postingDate": "2019-08-24",
  "userDocumentDate": "2019-08-24",
  "owner": {
    "id": 0,
    "accountId": 0,
    "fullName": "string",
    "firstName": "string",
    "lastName": "string",
    "username": "string",
    "email": "string",
    "accountName": "string",
    "profile": "string"
  },
  "allowsSystemGenerateNewId": true,
  "numberRangeIdentifierValue": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete A Single Resource

HTTP Request

DELETE /api/v1/workspace/{id}

Interactive Demo

📋 Description: Permanently deletes the resource with the given ID.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Partially Update A Resource (Json Patch)

HTTP Request

PATCH /api/v1/workspace/{id}

Interactive Demo

📋 Description: Applies a JSON Patch (RFC 6902) document to the resource with the given ID. Only the fields specified in the patch are modified; all other fields remain unchanged.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	JsonPatch	true	Request body containing the updated workspace information, including attributes such as name, description, and configuration settings.

Body Parameters

{}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Not Supported — Use Put /{ID} To Update A Workspace

HTTP Request

PUT /api/v1/workspace/createOrUpdate

Interactive Demo

📋 Description: Not supported — use PUT /{id} to update a workspace

Parameters

Name	In	Type	Required	Description
body	body	WorkspaceDto	true	Request body containing the workspace details, including configuration settings and user permissions, for creating or updating a workspace.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "state": "INV_DRAFT",
  "postingDate": "2019-08-24",
  "userDocumentDate": "2019-08-24",
  "owner": {
    "id": 0,
    "accountId": 0,
    "fullName": "string",
    "firstName": "string",
    "lastName": "string",
    "username": "string",
    "email": "string",
    "accountName": "string",
    "profile": "string"
  },
  "allowsSystemGenerateNewId": true,
  "numberRangeIdentifierValue": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
405	Method Not Allowed	Method Not Allowed	ResponseWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk-Update Resources

HTTP Request

PUT /api/v1/workspace/bulk

Interactive Demo

📋 Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response errors list. The response body always contains the successfully updated items alongside any per-item errors.

Parameters

Name	In	Type	Required	Description
body	body	WorkspaceDto	true	Request body containing an array of workspace configurations for bulk updates, including details such as workspace identifiers, settings, and associated metadata.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "displayId": "string",
      "name": "string",
      "state": "INV_DRAFT",
      "postingDate": "2019-08-24",
      "userDocumentDate": "2019-08-24",
      "owner": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Not Supported — Bulk Workspace Creation Is Disabled

HTTP Request

POST /api/v1/workspace/bulk

Interactive Demo

📋 Description: Not supported — bulk workspace creation is disabled

Parameters

Name	In	Type	Required	Description
body	body	WorkspaceDto	true	Request body containing an array of workspace configurations for bulk creation, including essential attributes such as workspace name, description, and associated user roles.

Body Parameters

[
  {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
]

Responses

Status	Meaning	Description	Schema
405	Method Not Allowed	Method Not Allowed	ResponseListWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "displayId": "string",
      "name": "string",
      "state": "INV_DRAFT",
      "postingDate": "2019-08-24",
      "userDocumentDate": "2019-08-24",
      "owner": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk-Delete Resources

HTTP Request

DELETE /api/v1/workspace/bulk

Interactive Demo

📋 Description: Deletes multiple resources by ID in a single request. Partial success: each deletion is attempted independently. If one or more deletions fail (e.g. due to state constraints), the successfully deleted items are NOT rolled back. A ValidationException containing per-item errors is thrown after all items have been attempted, so the caller must inspect the error list to determine which IDs were not deleted.

Parameters

Name	In	Type	Required	Description
body	body	array[integer]	true	Request body containing an array of workspace identifiers to be deleted in bulk, ensuring efficient management of workspace resources.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseVoid
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {}
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Search Workspaces

HTTP Request

POST /api/v1/workspace/search

Interactive Demo

📋 Description: Returns a paginated list of workspaces matching the given filter criteria, routed through the advanced-search adapter for consistent field mapping.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	WorkspaceDtoFilter	false	Request body containing search criteria parameters to retrieve relevant workspace information based on user-defined filters.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["CREATED_AT,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "displayIdIn": [
    "string"
  ],
  "displayIdLike": "string",
  "nameLike": "string",
  "stateEqual": "INV_DRAFT",
  "stateIn": [
    "INV_DRAFT"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "displayId": "string",
      "name": "string",
      "state": "INV_DRAFT",
      "postingDate": "2019-08-24",
      "userDocumentDate": "2019-08-24",
      "owner": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Advanced Workspace Search

HTTP Request

POST /api/v1/workspace/advanced-search

Interactive Demo

📋 Description: Full-text / multi-field search with faceting support. Prefer this over the basic search for programmatic queries. Returns a SearchResponseDto that includes total hits and facet buckets.

Parameters

Name	In	Type	Required	Description
page	query	integer	false	Zero-based page index (0..N)
size	query	integer	false	The size of the page to be returned
sort	query	array[string]	false	Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
body	body	WorkspaceSearchRequestDto	true	Request body containing advanced search criteria and filters to refine workspace data retrieval based on user-defined parameters.

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["CREATED_AT,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "facets": [
    "ID"
  ],
  "facetSelections": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "aggregations": {
    "property1": {
      "type": "TERMS",
      "field": "ID",
      "size": 0,
      "missing": "string"
    },
    "property2": {
      "type": "TERMS",
      "field": "ID",
      "size": 0,
      "missing": "string"
    }
  },
  "filter": {
    "operator": "AND",
    "children": [
      {}
    ],
    "field": "ID",
    "comparison": "EQUAL",
    "value": "string",
    "values": [
      "string"
    ],
    "from": "string",
    "to": "string"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	SearchResponseDtoWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "results": [
    {
      "id": 0,
      "displayId": "string",
      "name": "string",
      "state": "INV_DRAFT",
      "postingDate": "2019-08-24",
      "userDocumentDate": "2019-08-24",
      "owner": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "facets": {
    "property1": {},
    "property2": {}
  },
  "aggregations": {
    "property1": {},
    "property2": {}
  },
  "pagination": {
    "number": 0,
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 0
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

List All Resources

HTTP Request

GET /api/v1/workspace

Interactive Demo

📋 Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the results should be returned in a paginated format, facilitating efficient data retrieval for large datasets.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "pageNumber": 0,
    "unpaged": true,
    "paged": true,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "displayId": "string",
      "name": "string",
      "state": "INV_DRAFT",
      "postingDate": "2019-08-24",
      "userDocumentDate": "2019-08-24",
      "owner": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Not Supported — Workspace Creation Via This Endpoint Is Disabled

HTTP Request

POST /api/v1/workspace

Interactive Demo

📋 Description: Use PUT /{id}/invoices/add to add invoices; a workspace is auto-created if needed.

Parameters

Name	In	Type	Required	Description
body	body	WorkspaceDto	true	Request body containing the workspace configuration details, including name, description, and access permissions for effective collaboration.

Body Parameters

{
  "id": 0,
  "displayId": "string",
  "name": "string",
  "state": "INV_DRAFT",
  "postingDate": "2019-08-24",
  "userDocumentDate": "2019-08-24",
  "owner": {
    "id": 0,
    "accountId": 0,
    "fullName": "string",
    "firstName": "string",
    "lastName": "string",
    "username": "string",
    "email": "string",
    "accountName": "string",
    "profile": "string"
  },
  "allowsSystemGenerateNewId": true,
  "numberRangeIdentifierValue": "string",
  "numberRangeIdentifierType": {
    "name": "string"
  },
  "numberRangeType": {
    "name": "string"
  }
}

Responses

Status	Meaning	Description	Schema
405	Method Not Allowed	Method Not Allowed	ResponseWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Clear All Invoices From A Workspace

HTTP Request

PATCH /api/v1/workspace/{workspaceId}/clear

Interactive Demo

📋 Description: Removes all invoices from the workspace, leaving it empty and Open. The workspace itself is NOT deleted — use the standard DELETE endpoint for that.

Parameters

Name	In	Type	Required	Description
workspaceId	path	integer(int64)	true	Workspace ID

Responses

Status	Meaning	Description	Schema
200	OK	Workspace cleared; returns the updated workspace	ResponseWorkspaceDto
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "source": {},
        "errorMessage": "string",
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "displayId": "string",
    "name": "string",
    "state": "INV_DRAFT",
    "postingDate": "2019-08-24",
    "userDocumentDate": "2019-08-24",
    "owner": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "allowsSystemGenerateNewId": true,
    "numberRangeIdentifierValue": "string",
    "numberRangeIdentifierType": {
      "name": "string"
    },
    "numberRangeType": {
      "name": "string"
    }
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Workflow State History For A Workspace

HTTP Request

GET /api/v1/workspace/{workspaceId}/state-history

Interactive Demo

📋 Description: Returns the ordered list of state transitions the workspace has gone through, each with timestamp and actor information.

Parameters

Name	In	Type	Required	Description
workspaceId	path	integer(int64)	true	Unique identifier for the workspace

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

[
  {
    "id": 0,
    "success": true,
    "failedMessage": "string",
    "warningMessage": "string",
    "fromState": "string",
    "event": "string",
    "comment": "string",
    "workspaceId": 0
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[WorkspaceStateHistoryDto]	false	none	[Data transfer object representing the historical state of a workspace, capturing key changes and metadata to facilitate effective workspace management and analysis.]
» id	integer(int64)	false	none	Unique identifier for the resource
» success	boolean	false	none	Indicates whether the operation was successful, providing insight into the outcome of the workspace state change.
» failedMessage	string	false	none	Message detailing the reason for the failure of a workspace state transition, providing insights for troubleshooting and resolution.
» warningMessage	string	false	none	Message indicating any warnings related to the state history of the workspace, providing insights for effective workspace management.
» fromState	string	false	none	Represents the initial state of the workspace in the history of state transitions, providing insight into the workspace’s operational changes over time.
» event	string	false	none	Represents the specific event that occurred within the workspace, providing context for changes in the workspace state history.
» comment	string	false	none	Textual feedback or notes associated with changes in the workspace state history, providing context for decision-making and collaboration.
» workspaceId	integer(int64)	false	none	Unique identifier for the workspace

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Remove A Single Invoice From A Workspace

HTTP Request

DELETE /api/v1/workspace/{workspaceId}/invoices/{invoiceId}

Interactive Demo

📋 Description: Detaches the specified invoice from the workspace. The invoice reverts to Approved state and becomes eligible for other workspaces.

Parameters

Name	In	Type	Required	Description
workspaceId	path	integer(int64)	true	Workspace ID
invoiceId	path	integer(int64)	true	Invoice ID to remove

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "errorCode": "string",
  "balances": [
    {
      "id": 0,
      "displayId": "string",
      "invoiceId": 0,
      "invoiceDisplayId": "string",
      "invoiceLineItemId": 0,
      "invoiceLineItemDisplayId": "string",
      "invoiceLineItemDescription": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "name": "string"
      },
      "totalNetAmount": 0,
      "totalTaxAmount": 0,
      "reservedNetAmount": 0,
      "reservedTaxAmount": 0,
      "remainingTotalAmount": 0,
      "remainingNetAmount": 0,
      "remainingTaxAmount": 0,
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Bulk-Remove Invoices From A Workspace

HTTP Request

DELETE /api/v1/workspace/{workspaceId}/invoices

Interactive Demo

📋 Description: Detaches multiple invoices from the workspace in one call. Each removed invoice reverts to Approved state.

Parameters

Name	In	Type	Required	Description
workspaceId	path	integer(int64)	true	Workspace ID
body	body	array[integer]	true	Request body containing the identifiers of invoices to be deleted from the specified workspace, ensuring accurate invoice management and compliance.

Body Parameters

[
  0
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "errorCode": "string",
  "balances": [
    {
      "id": 0,
      "displayId": "string",
      "invoiceId": 0,
      "invoiceDisplayId": "string",
      "invoiceLineItemId": 0,
      "invoiceLineItemDisplayId": "string",
      "invoiceLineItemDescription": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "name": "string"
      },
      "totalNetAmount": 0,
      "totalTaxAmount": 0,
      "reservedNetAmount": 0,
      "reservedTaxAmount": 0,
      "remainingTotalAmount": 0,
      "remainingNetAmount": 0,
      "remainingTaxAmount": 0,
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---