Mews Accounts API
The Accounts API from Mews — 3 operation(s) for accounts.
OpenAPI Specification
openapi: 3.0.4
info:
title: Connector Account notes Accounts API
description: General-purpose API that enables partners of Mews to access data and services in Mews Operations
termsOfService: https://www.mews.com/en/terms-conditions/partners
contact:
name: Partner success
email: partnersuccess@mews.com
version: v1
servers:
- url: https://api.mews.com
tags:
- name: Accounts
paths:
/api/connector/v1/accounts/update:
post:
tags:
- Accounts
summary: Update accounts
description: Updates one or more existing accounts in the system. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
operationId: accounts_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleAccountUpdateParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
AccountUpdates:
- Id: 3ff104e6-3ba8-4dfc-8d35-b0ec00c5fd4c
Discriminator: Company
Customer: null
Company:
Email:
Value: example@example.com
TaxIdentifier:
Value: CZ8810310963
BillingCode:
Value: null
AccountingCode:
Value: null
Notes:
Value: Example notes
Name:
Value: Example company
MotherCompanyId:
Value: 839e9d92-aa8b-48bf-8384-b0ec0081bb34
WebsiteUrl:
Value: https://www.example.com
InvoiceDueInterval:
Value: null
CreditRatingBasic:
Value: CreditOk
Department:
Value: Accounting
DunsNumber:
Value: '987654321'
ReferenceId:
Value: null
ExternalIdentifier:
Value: COM-123
AdditionalTaxIdentifier:
Value: XY00112233445
Contact:
Value: Sample contact
ContactPerson:
Value: Sample person
FiscalIdentifier:
Value: FiscalIdentifier
Iata:
Value: PAO
Telephone:
Value: 111-222-333
SourceId:
Value: F42098A0-8507-4963-ACC9-B0EC00821949
Classifications:
Corporate:
Value: true
Internal:
Value: true
Private:
Value: true
OnlineTravelAgency:
Value: true
GlobalDistributionSystem:
Value: true
Marketing:
Value: true
Inactive:
Value: true
Options:
Invoiceable:
Value: 'true'
AddFeesToInvoices:
Value: 'true'
- Id: 71db411f-c1d6-4e1c-9cd7-44e8bf45f936
Discriminator: Customer
Company: null
Customer:
Email:
Value: example@example.com
TaxIdentifier:
Value: CZ8810310963
BillingCode:
Value: null
AccountingCode:
Value: null
Notes:
Value: Example notes
LastName:
Value: Sample
FirstName:
Value: Sample
SecondLastName:
Value: null
BirthPlace:
Value: Sample place
Telephone:
Value: 111-222-333
Occupation:
Value: null
CarRegistrationNumber:
Value: null
LoyaltyCode:
Value: null
NationalityCode:
Value: US
CompanyId:
Value: 839e9d92-aa8b-48bf-8384-b0ec0081bb34
BirthDate:
Value: '2000-01-01'
Sex:
Value: Male
Title:
Value: Mister
PreferredLanguageCode:
Value: null
Options:
SendMarketingEmails:
Value: true
Invoiceable:
Value: true
BillAddressObjection:
Value: true
Classifications:
PaymasterAccount:
Value: true
Blacklist:
Value: true
Media:
Value: true
LoyaltyProgram:
Value: true
PreviousComplaint:
Value: true
Returning:
Value: true
Staff:
Value: true
FriendOrFamily:
Value: true
TopManagement:
Value: true
Important:
Value: true
VeryImportant:
Value: true
Problematic:
Value: true
Cashlist:
Value: true
DisabledPerson:
Value: true
Military:
Value: true
Airline:
Value: true
HealthCompliant:
Value: true
InRoom:
Value: true
WaitingForRoom:
Value: true
Student:
Value: true
LegalEntityIdentifiers:
ItDestinationCode:
Value: null
ItFiscalCode:
Value: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AccountResult'
example:
Accounts:
- Id: 3ff104e6-3ba8-4dfc-8d35-b0ec00c5fd4c
Discriminator: Company
Customer: null
Company:
ChainId: 79fa3c17-bec6-454f-b3be-b0ec00818acd
CreatedUtc: '2024-01-03T07:52:20Z'
UpdatedUtc: '2024-01-18T10:20:31Z'
UpdaterProfileId: 93f03906-ed13-4a26-b8dc-b0ec0082194f
Email: example@example.com
TaxIdentifier: CZ8810310963
BillingCode: null
AccountingCode: null
Notes: Example notes
Name: Example company
MotherCompanyId: 839e9d92-aa8b-48bf-8384-b0ec0081bb34
WebsiteUrl: https://www.example.com
InvoiceDueInterval: null
CreditRatingBasic: CreditOk
Department: Accounting
DunsNumber: '987654321'
ReferenceId: null
ExternalIdentifier: COM-123
AdditionalTaxIdentifier: XY00112233445
Contact: Sample contact
ContactPerson: Sample person
FiscalIdentifier: FiscalIdentifier
Iata: PAO
Telephone: 111-222-333
SourceId: F42098A0-8507-4963-ACC9-B0EC00821949
Classifications:
Corporate: true
Internal: true
Private: true
OnlineTravelAgency: true
GlobalDistributionSystem: true
Marketing: true
Inactive: true
Options:
Invoiceable: true
AddFeesToInvoices: true
- Id: 71db411f-c1d6-4e1c-9cd7-44e8bf45f936
Discriminator: Customer
Customer:
ChainId: 79fa3c17-bec6-454f-b3be-b0ec00818acd
CreatedUtc: '2024-01-03T07:52:19Z'
UpdatedUtc: '2024-01-18T10:25:41Z'
UpdaterProfileId: 93f03906-ed13-4a26-b8dc-b0ec0082194f
Email: example@example.com
TaxIdentifier: CZ8810310963
BillingCode: null
AccountingCode: null
Notes: Example notes
LastName: Sample
FirstName: Sample
SecondLastName: null
BirthPlace: Sample place
Telephone: 111-222-333
Occupation: null
CarRegistrationNumber: null
LoyaltyCode: null
NationalityCode: US
CompanyId: 839e9d92-aa8b-48bf-8384-b0ec0081bb34
BirthDate: '2000-01-01T00:00:00Z'
Sex: Male
Title: Mister
PreferredLanguageCode: null
Options:
SendMarketingEmails: true
Invoiceable: true
BillAddressObjection: true
Classifications:
PaymasterAccount: true
Blacklist: true
Media: true
LoyaltyProgram: true
PreviousComplaint: true
Returning: true
Staff: true
FriendOrFamily: true
TopManagement: true
Important: true
VeryImportant: true
Problematic: true
Cashlist: true
DisabledPerson: true
Military: true
Airline: true
HealthCompliant: true
InRoom: true
WaitingForRoom: true
Student: true
LegalEntityIdentifiers:
ItDestinationCode: null
ItFiscalCode: null
Company: null
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
/api/connector/v1/accounts/addFile:
post:
tags:
- Accounts
summary: Upload and link file to account
description: "Attaches the specified file to the account. \r\n\r\nAllowed MIME types: `application/pdf`, `image/bmp`, `image/gif`, `image/jpeg`, `image/png`, `image/tiff`.\r\n\r\nNote this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/guidelines/multi-property)."
operationId: accounts_addFile
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountFileParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
AccountId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
Name: document.pdf
Type: application/pdf
ChainId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AddAccountFileResult'
example:
FileId: f039f5b4-ff18-4510-9086-92b14a68ed78
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
/api/connector/v1/accounts/merge:
post:
tags:
- Accounts
summary: Merge accounts
description: Merges two or more accounts of the same account type together. The given source accounts will be merged into the given target account and the merged account will keep the target account ID.
operationId: accounts_merge
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleAccountMergeParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
AccountMergeParameters:
- AccountType: Company
SourceAccountIds:
- b0c10ced-34eb-44b4-92e8-af5b008f3fb4
- 5176d000-bf17-40be-b140-9041d2b70eee
TargetAccountId: 51262225-8130-4320-8210-af5b008f64e5
- AccountType: Customer
SourceAccountIds:
- 7799f19a-c9c9-42bf-968f-a759e3ea1ea6
- bb926ffe-5310-48bc-8202-6165fa3bdcad
TargetAccountId: 49b2abd4-df58-4f1d-bead-0fa6342f8a78
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Unit'
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
components:
schemas:
CustomerOptionUpdateParameters:
title: Customer update options
type: object
properties:
SendMarketingEmails:
title: Boolean update value
allOf:
- $ref: '#/components/schemas/BooleanUpdateValue'
description: Send marketing email (or `null` if the value should not be updated).
nullable: true
Invoiceable:
title: Boolean update value
allOf:
- $ref: '#/components/schemas/BooleanUpdateValue'
description: Invoiceable (or `null` if the value should not be updated).
nullable: true
BillAddressObjection:
title: Boolean update value
allOf:
- $ref: '#/components/schemas/BooleanUpdateValue'
description: Bill address objection (or `null` if the value should not be updated).
nullable: true
additionalProperties: false
x-schema-id: CustomerOptionUpdateParameters
CustomerAccountClassifications:
title: Customer classifications
type: object
properties:
PaymasterAccount:
type: boolean
description: Paymaster account.
Blacklist:
type: boolean
description: Synonym of Blocklist, left for backward compatibility.
deprecated: true
x-deprecatedMessage: Use Blocklist instead.
Blocklist:
type: boolean
description: Blocklist.
Media:
type: boolean
description: Media.
LoyaltyProgram:
type: boolean
description: Loyalty program.
PreviousComplaint:
type: boolean
description: Previous complaint.
Returning:
type: boolean
description: Returning.
Staff:
type: boolean
description: Staff.
FriendOrFamily:
type: boolean
description: Friend or family.
TopManagement:
type: boolean
description: Top management.
Important:
type: boolean
description: Important.
VeryImportant:
type: boolean
description: Very important.
Problematic:
type: boolean
description: Problematic.
Cashlist:
type: boolean
description: Cash list.
DisabledPerson:
type: boolean
description: Disabled person.
Military:
type: boolean
description: Military.
Airline:
type: boolean
description: Airline.
HealthCompliant:
type: boolean
description: Health compliant.
InRoom:
type: boolean
description: In room.
WaitingForRoom:
type: boolean
description: Waiting for room.
Student:
type: boolean
description: Student.
additionalProperties: false
x-schema-id: CustomerAccountClassifications
LegalEntityIdentifierUpdateParameters:
title: Customer update legal entity identifiers
type: object
properties:
ItDestinationCode:
title: String update value
allOf:
- $ref: '#/components/schemas/StringUpdateValue'
description: Italian destination code (or `null` if the Italian destination code should not be updated).
nullable: true
ItFiscalCode:
title: String update value
allOf:
- $ref: '#/components/schemas/StringUpdateValue'
description: Italian fiscal code (or `null` if the Italian fiscal code should not be updated).
nullable: true
ItLotteryCode:
title: String update value
maxLength: 15
minLength: 2
allOf:
- $ref: '#/components/schemas/StringUpdateValue'
description: Italian lottery code (or `null` if the Italian lottery code should not be updated).
nullable: true
additionalProperties: false
x-schema-id: LegalEntityIdentifierUpdateParameters
Unit:
type: object
additionalProperties: false
AccountTypeEnum:
title: Account type
enum:
- Company
- Customer
type: string
description: 'A discriminator specifying the account type, e.g. `Customer` or `Company`
Company
Customer'
x-enumNames:
- Company
- Customer
x-enumDescriptions:
- ''
- ''
CustomerAccountOptions:
title: Customer options
type: object
properties:
SendMarketingEmails:
type: boolean
description: Send marketing emails.
Invoiceable:
type: boolean
description: Invoiceable.
BillAddressObjection:
type: boolean
description: Bill address objection.
additionalProperties: false
x-schema-id: CustomerAccountOptions
CreditRatingBasic:
title: Credit rating basic
enum:
- CreditOk
- PaymentRequiredUpfront
- LocalDecisionRequired
type: string
x-enumDescriptions:
- Company can book services.
- Company must pay upfront.
- Requires local approval.
AccountFileParameters:
title: AccountFileParameters
required:
- AccessToken
- AccountId
- Client
- ClientToken
- Data
- Name
- Type
type: object
properties:
ClientToken:
minLength: 1
type: string
description: Token identifying the client application.
AccessToken:
minLength: 1
type: string
description: Access token of the client application.
Client:
minLength: 1
type: string
description: Name and version of the client application.
ChainId:
type: string
description: Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise.
format: uuid
nullable: true
AccountId:
type: string
description: Unique identifier of the account to which the file will be uploaded to.
format: uuid
Name:
maxLength: 1000
minLength: 1
type: string
description: Uploaded file name.
Type:
maxLength: 1000
minLength: 1
type: string
description: Content type of the uploaded file following defined by its MIME type.
Data:
minLength: 1
type: string
description: Uploaded file data serialized in base64 format.
additionalProperties: false
x-schema-id: AccountFileParameters
CompanyAccountOptions:
title: Company options
type: object
properties:
Invoiceable:
type: boolean
description: Whether the company is invoiceable or not.
AddFeesToInvoices:
type: boolean
description: Whether the company has an additional fee applied for invoicing or not.
AddTaxDeductedPaymentToInvoices:
type: boolean
description: Whether tax-deducted payments should be automatically added to invoices.
additionalProperties: false
x-schema-id: CompanyAccountOptions
LegalEntityIdentifiers:
title: Customer legal identifiers
type: object
properties:
ItDestinationCode:
type: string
description: Italian destination code.
nullable: true
ItFiscalCode:
type: string
description: Italian fiscal code.
nullable: true
ItLotteryCode:
maxLength: 15
minLength: 2
type: string
description: Italian lottery code.
nullable: true
additionalProperties: false
x-schema-id: LegalEntityIdentifiers
GuidNullableUpdateValue:
title: Guid update value
type: object
properties:
Value:
type: string
description: Value which is to be updated.
format: uuid
nullable: true
additionalProperties: false
x-schema-id: GuidNullableUpdateValue
CompanyOptionUpdateParameters:
title: Company update options
type: object
properties:
Invoiceable:
title: Boolean update value
allOf:
- $ref: '#/components/schemas/BooleanUpdateValue'
description: Whether the company is invoiceable or not (or `null` if the `Invoiceable` field should not be updated).
nullable: true
AddFeesToInvoices:
title: Boolean update value
allOf:
- $ref: '#/components/schemas/BooleanUpdateValue'
description: Whether the company has an additional fee applied for invoicing or not (or `null` if the `AddFeesToInvoices` field should not be updated).
nullable: true
AddTaxDeductedPaymentToInvoices:
title: Boolean update value
allOf:
- $ref: '#/components/schemas/BooleanUpdateValue'
description: Whether tax-deducted payments should be automatically added to invoices (or `null` if the `AddTaxDeductedPaymentToInvoices` field should not be updated).
nullable: true
additionalProperties: false
description: Options of the company.
x-schema-id: CompanyOptionUpdateParameters
CreditRatingBasicEnum:
title: Credit rating basic
enum:
- CreditOk
- PaymentRequiredUpfront
- LocalDecisionRequired
type: string
description: '
CreditOk (Company can book services.)
PaymentRequiredUpfront (Company must pay upfront.)
LocalDecisionRequired (Requires local approval.)'
x-enumNames:
- CreditOk
- PaymentRequiredUpfront
- LocalDecisionRequired
x-enumDescriptions:
- Company can book services.
- Company must pay upfront.
- Requires local approval.
MultipleAccountMergeParameters:
title: MultipleAccountMergeParameters
required:
- AccessToken
- AccountMergeParameters
- Client
- ClientToken
type: object
properties:
ClientToken:
minLength: 1
type: string
description: Token identifying the client application.
AccessToken:
minLength: 1
type: string
descripti
# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mews/refs/heads/main/openapi/mews-accounts-api-openapi.yml