Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Add outlet bills
  • Request
  • Response

Was this helpful?

  1. API Operations

Outlet bills

Add outlet bills

Adds new outlet bills with their items.

Request

[PlatformAddress]/api/connector/v1/outletBills/add

{  
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "Bills": [  
        {  
            "OutletId": "7700469f-7667-4ebd-a1c0-10380afc9bd0",
            "Number": "1257",
            "ClosedUtc": "2017-01-01T00:00:00Z",
            "Items": [  
                {  
                    "Type": "Payment",
                    "Name": "Cash payment",
                    "UnitCount": 1,
                    "UnitAmount": {
      		            "Currency": "GBP",
       		            "GrossValue": -25,
        	            "TaxCodes": [
                            "UK-S"
                        ]
                    },
                    "ConsumedUtc": "2017-01-01T00:00:00Z",
                    "ExternalIdentifier": "PaymentReference123"
                },
                {  
                    "Type": "Revenue",
                    "Name": "Beer",
                    "UnitCount": 10,
                    "UnitAmount": {
      		            "Currency": "GBP",
       		            "GrossValue": 2.50,
        	            "TaxCodes": [
                            "UK-S"
                        ]
                    },
                    "ConsumedUtc": "2017-01-01T00:00:00Z",
                    "AccountingCategoryId": null
                }
            ]
        }
    ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

Bills

required

The new outlet bills.

Outlet bill parameters

Property
Type
Contract
Description

OutletId

string

required

Number

string

required

Number of the bill.

Notes

string

optional

Additional notes on the bill.

ClosedUtc

string

required

Date and time of the bill closure in UTC timezone in ISO 8601 format.

Items

required

The items on the bill.

Outlet item parameters

Property
Type
Contract
Description

Type

required

Type of the item.

Name

string

required

Name of the item.

UnitCount

number

required

Unit count of the item.

UnitAmount

required

Unit amount of the item.

ConsumedUtc

string

required

Date and time of the item consumption in UTC timezone in ISO 8601 format.

ExternalIdentifier

string

optional

An identifier of this item from another system.

Notes

string

optional

Additional notes of the item.

AccountingCategoryId

string

optional

Response

{
    "OutletBillIds": [
        "f2ee1bd2-dd55-4cd3-bab1-ab6800bf0301"
    ]
}
Property
Type
Contract
Description

OutletBillIds

array of string

required

Array of unique identifiers of the added Outlet bills.

PreviousOrdersNextOutlet items

Last updated 5 months ago

Was this helpful?

array of

Unique identifier of the where the bill was issued.

array of

string

Unique identifier of an to be assigned to the item.

Outlet bill parameters
Outlet item parameters
Accounting category
Outlet
Outlet item type
Amount parameters