Skip to content

Get all accounting categories

POST
/api/connector/v1/accountingCategories/getAll

Returns all accounting categories of the enterprise associated with the connector integration. Note this operation uses Pagination and supports Portfolio Access Tokens.

AccountingCategoryFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

Array<string>
nullable >= 1 items <= 1000 items
AccountingCategoryIds

Unique identifiers of the requested Accounting categories.

Array<string>
nullable >= 1 items <= 1000 items
UpdatedUtc
TimeFilterInterval

Last update date and time of the accounting category in UTC timezone in ISO 8601 format.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
ActivityStates

Whether to return only active, only deleted or both records.

Array<string>
nullable
Allowed values: Deleted Active
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
],
"AccountingCategoryIds": [
"0cf7aa90-736f-43e9-a7dc-787704548d86",
"0b9560fb-055d-47d3-a6d4-e579c44ca558"
],
"UpdatedUtc": {
"StartUtc": "2023-10-01T00:00:00Z",
"EndUtc": "2023-10-31T00:00:00Z"
},
"ActivityStates": [
"Active"
],
"Limitation": {
"Count": 10
}
}

OK

AccountingCategoryResult
object
AccountingCategories
required

Accounting categories of the enterprise.

Array<object>
Accounting category
object
Id
required

Unique identifier of the category.

string format: uuid
EnterpriseId
required

Unique identifier of the Enterprise.

string format: uuid
IsActive
required

Whether the accounting category is still active.

boolean
Name
required

Name of the category.

string
>= 1 characters
Code

Code of the category within Mews.

string
nullable
ExternalCode

Code of the category in external systems.

string
nullable
LedgerAccountCode

Code of the ledger account (double entry accounting).

string
nullable
PostingAccountCode

Code of the posting account (double entry accounting).

string
nullable
CostCenterCode

Code of cost center.

string
nullable
Classification

Classification of the accounting category allowing cross-enterprise reporting.

Accommodation

FoodAndBeverage

Taxes

Payments

ExternalRevenue

SundryIncome

Wellness

Sport

Technology

Facilities

Events

Tourism

string
Allowed values: Accommodation FoodAndBeverage Taxes Payments ExternalRevenue SundryIncome Wellness Sport Technology Facilities Events Tourism
CreatedUtc
required

Creation date and time of the accounting category in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the accounting category in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Cursor

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

string format: uuid
nullable
Example
{
"AccountingCategories": [
{
"Classification": "Accommodation",
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Code": "345",
"CostCenterCode": "2589",
"ExternalCode": "3010",
"Id": "0cf7aa90-736f-43e9-a7dc-787704548d86",
"IsActive": true,
"LedgerAccountCode": "311100",
"Name": "Accommodation",
"PostingAccountCode": "602020",
"CreatedUtc": "2023-10-01T11:48:57Z",
"UpdatedUtc": "2023-10-28T11:48:57Z"
},
{
"Classification": null,
"EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
"Code": "100",
"CostCenterCode": "2589",
"ExternalCode": "ABVG",
"Id": "0b9560fb-055d-47d3-a6d4-e579c44ca558",
"IsActive": true,
"LedgerAccountCode": "311100",
"Name": "Alcoholic Beverage",
"PostingAccountCode": "602020",
"CreatedUtc": "2023-10-01T11:48:57Z",
"UpdatedUtc": "2023-10-28T11:48:57Z"
}
],
"Cursor": "0b9560fb-055d-47d3-a6d4-e579c44ca558"
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable