openapi: 3.0.4
info:
title: BookingEngineApi Account notes Bills API
version: v1
servers:
- url: https://api.mews.com
tags:
- name: Bills
paths:
/api/connector/v1/bills/update:
post:
tags:
- Bills
summary: Update bills
description: Updates one or more existing bills in the system. Closed bills cannot be updated. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
operationId: bills_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleBillsUpdateParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
BillsUpdates:
- BillId: ea087d64-3901-4eee-b0b7-9fce4c58a005
AccountId:
Value: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
AssociatedAccountIds:
Value:
- fadd5bb6-b428-45d5-94f8-fd0d89fece6d
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BillsUpdateResult'
example:
Bills:
- Id: ea087d64-3901-4eee-b0b7-9fce4c58a005
Name: Accommodation Charges
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
AccountId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
AccountType: Company
CustomerId: null
CompanyId: null
AssociatedAccountIds:
- fadd5bb6-b428-45d5-94f8-fd0d89fece6d
CounterId: null
State: Closed
Type: Invoice
Number: '29'
VariableSymbol: null
CreatedUtc: '2017-01-31T10:48:06Z'
IssuedUtc: '2017-01-31T10:58:06Z'
TaxedUtc: null
PaidUtc: null
DueUtc: null
LastReminderDateUtc: null
UpdatedUtc: '2017-01-31T10:58:06Z'
PurchaseOrderNumber: XX-123
Notes: ''
Options:
DisplayCustomer: true
DisplayTaxation: true
TrackReceivable: true
DisplayCid: false
Rebated: false
Revenue: []
Payments: []
OrderItems: []
PaymentItems: []
AssigneeData: null
OwnerData:
Discriminator: BillCompanyData
Value:
Id: 26afba60-06c3-455b-92db-0e3983be0b1d
Address:
Line1: I.P. Pavlova 5
Line2: null
City: Prague
PostalCode: '12000'
SubdivisionCode: CZ-PR
CountryCode: CZ
LegalIdentifiers:
TaxIdentifier: CZ24227781
CityOfRegistration: Prague
BillingCode: Billing code value
Name: Acme, Inc.
FiscalIdentifier: Fiscal identifier
AdditionalTaxIdentifier: Additional tax identifier
DUNS: '150483782'
Telephone: '+420123456789'
TaxIdentifier: CZ24227781
InvoicingEmail: billing@acme.example
Department: Billing
CompanyDetails: null
AssociatedAccountData:
- Discriminator: BillCompanyData
BillCustomerData: null
BillCompanyData:
Id: 26afba60-06c3-455b-92db-0e3983be0b1d
Address:
Line1: I.P. Pavlova 5
Line2: null
City: Prague
PostalCode: '12000'
SubdivisionCode: CZ-PR
CountryCode: CZ
LegalIdentifiers:
TaxIdentifier: CZ24227781
CityOfRegistration: Prague
BillingCode: Billing code value
Name: Acme, Inc.
FiscalIdentifier: Fiscal identifier
AdditionalTaxIdentifier: Additional tax identifier
DUNS: '150483782'
Telephone: '+420123456789'
TaxIdentifier: CZ24227781
InvoicingEmail: billing@acme.example
Department: Billing
EnterpriseData:
AdditionalTaxIdentifier: XY00112233445
CompanyName: The Sample Hotel Group AS
BankAccount: CZ3808000000000012345678
BankName: CESKA SPORITELNA A.S.
Iban: CZ6508000000192000145399
Bic: GIBACZPX
CorrectionState: Bill
CorrectionType: null
CorrectedBillId: 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'
x-restricted: true
/api/connector/v1/bills/getAll:
post:
tags:
- Bills
summary: Get all bills
description: Returns all bills, optionally filtered by customers, identifiers and other filters. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/).
operationId: bills_getAll
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BillFilterParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
Extent:
Items: false
ClosedUtc:
StartUtc: '2020-02-05T00:00:00Z'
EndUtc: '2020-02-10T00:00:00Z'
CreatedUtc:
StartUtc: '2020-02-05T00:00:00Z'
EndUtc: '2020-02-10T00:00:00Z'
UpdatedUtc:
StartUtc: '2020-02-05T00:00:00Z'
EndUtc: '2020-02-10T00:00:00Z'
BillIds:
- e654f217-d1b5-46be-a820-e93ba568dfac
CustomerIds:
- fe795f96-0b64-445b-89ed-c032563f2bac
State: Closed
EnterpriseIds:
- 3fa85f64-5717-4562-b3fc-2c963f66afa6
- 4d0201db-36f5-428b-8d11-4f0a65e960cc
Limitation:
Count: 100
Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BillsResult'
example:
Bills:
- Id: ea087d64-3901-4eee-b0b7-9fce4c58a005
Name: Accommodation Charges
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
AccountId: c6f5c82d-621a-4c8a-903b-1b0a9a23b71f
AccountType: Company
CustomerId: null
CompanyId: null
AssociatedAccountIds:
- fadd5bb6-b428-45d5-94f8-fd0d89fece6d
CounterId: null
State: Closed
Type: Invoice
Number: '29'
VariableSymbol: null
CreatedUtc: '2017-01-31T10:48:06Z'
IssuedUtc: '2017-01-31T10:58:06Z'
TaxedUtc: null
PaidUtc: null
DueUtc: null
LastReminderDateUtc: null
UpdatedUtc: '2017-01-31T10:58:06Z'
PurchaseOrderNumber: XX-123
Notes: ''
Options:
DisplayCustomer: true
DisplayTaxation: true
TrackReceivable: true
DisplayCid: false
Rebated: false
Revenue: []
Payments: []
OrderItems: []
PaymentItems: []
AssigneeData: null
OwnerData:
Discriminator: BillCompanyData
Value:
Id: 26afba60-06c3-455b-92db-0e3983be0b1d
Address:
Line1: I.P. Pavlova 5
Line2: null
City: Prague
PostalCode: '12000'
SubdivisionCode: CZ-PR
CountryCode: CZ
LegalIdentifiers:
TaxIdentifier: CZ24227781
CityOfRegistration: Prague
BillingCode: Billing code value
Name: Acme, Inc.
FiscalIdentifier: Fiscal identifier
AdditionalTaxIdentifier: Additional tax identifier
DUNS: '150483782'
Telephone: '+420123456789'
TaxIdentifier: CZ24227781
InvoicingEmail: billing@acme.example
Department: Billing
CompanyDetails: null
AssociatedAccountData:
- Discriminator: BillCompanyData
BillCustomerData: null
BillCompanyData:
Id: 26afba60-06c3-455b-92db-0e3983be0b1d
Address:
Line1: I.P. Pavlova 5
Line2: null
City: Prague
PostalCode: '12000'
SubdivisionCode: CZ-PR
CountryCode: CZ
LegalIdentifiers:
TaxIdentifier: CZ24227781
CityOfRegistration: Prague
BillingCode: Billing code value
Name: Acme, Inc.
FiscalIdentifier: Fiscal identifier
AdditionalTaxIdentifier: Additional tax identifier
DUNS: '150483782'
Telephone: '+420123456789'
TaxIdentifier: CZ24227781
InvoicingEmail: billing@acme.example
Department: Billing
EnterpriseData:
AdditionalTaxIdentifier: XY00112233445
CompanyName: The Sample Hotel Group AS
BankAccount: CZ3808000000000012345678
BankName: CESKA SPORITELNA A.S.
Iban: CZ6508000000192000145399
Bic: GIBACZPX
CorrectionState: Bill
CorrectionType: null
CorrectedBillId: null
Cursor: ea087d64-3901-4eee-b0b7-9fce4c58a005
'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/bills/getPdf:
post:
tags:
- Bills
summary: Get bill PDF
description: Creates a PDF version of the specified bill. In case it's not possible to return PDF immediately, you must retry the call later while providing the unique event identifier that is returned from the first invocation.
operationId: bills_getPdf
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BillPdfParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
BillId: 44eba542-193e-47c7-8077-abd7008eb206
PdfTemplate: Detailed
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BillPdfResult'
example:
BillId: 44eba542-193e-47c7-8077-abd7008eb206
Result:
Discriminator: BillPdfFile
Value:
Base64Data: JVBERi0xLj...
'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/bills/add:
post:
tags:
- Bills
summary: Add bill
description: Creates new empty bill assigned to specified account. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
operationId: bills_add
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleBillAddParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
Bills:
- AccountId: a5786a7b-a388-43cc-a838-abd7007b5ff7
Name: Bill of Joe Doe
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BillsAddResult'
example:
BillId: 44eba542-193e-47c7-8077-abd7008eb206
Result:
Discriminator: BillPdfFile
Value:
Base64Data: JVBER.....
'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/bills/delete:
post:
tags:
- Bills
summary: Delete bill
description: Removes selected bills. Bill must be empty, otherwise it's not possible to delete it. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
operationId: bills_delete
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BillDeleteParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
BillIds:
- 177966b7-f3d9-42b7-ba49-abd80057329b
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
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'
/api/connector/v1/bills/close:
post:
tags:
- Bills
summary: Close bill
description: Closes a bill so no further modification to it is possible. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property).
operationId: bills_close
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BillCloseParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
BillId: 44eba542-193e-47c7-8077-abd7008eb206
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
Type: Receipt
BillCounterId: 84b25778-c1dd-48dc-8c00-ab3a00b6df14
FiscalMachineId: null
Options:
DisplayCustomer:
Value: false
DisplayTaxation: null
TaxedDate:
Value: '2020-07-07'
DueDate:
Value: '2020-07-14'
VariableSymbol:
Value: '5343'
AccountTaxIdentifier:
Value: '446768'
AccountAddress:
Line1: Astronautů 2
Line2: ''
City: Havířov
PostalCode: 736 01
CountryCode: CZ
CountrySubdivisionCode: null
PurchaseOrderNumber:
Value: XX-123
Notes:
Value: Bill closing note
AssociatedAccountData:
- Id: 84b25778-c1dd-48dc-8c00-ab3a00b6df14
TaxIdentifier:
Value: '123459'
Address:
Line1: Astronautů 2
Line2: ''
City: Havířov
PostalCode: 736 01
CountryCode: CZ
CountrySubdivisionCode: null
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BillsCloseResult'
example:
BillId: 44eba542-193e-47c7-8077-abd7008eb206
Result:
Discriminator: BillPdfFile
Value:
Base64Data: JVBER.....
'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)
# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mews-com/refs/heads/main/openapi/mews-com-bills-api-openapi.yml