Skip to content
Mews Open API

Add outlet bills

POST
/api/connector/v1/outletBills/add

Adds new outlet bills with their items.

Request Body

Section titled “Request Body ”
AddOutletBillsParameters
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
Bills
required

The new outlet bills.

Array<object>
>= 1 items <= 1000 items
OutletBillParameters
object
OutletId
required
string format: uuid
Number
required
string
>= 1 characters
ClosedUtc
required
string
>= 1 characters
Items
required
Array<object>
OutletItemParameters
object
Name
required
string
>= 1 characters
UnitCount
required
integer format: int32
UnitAmount
required
Amount parameters

Price of the product that overrides the price defined in Mews.

object
Currency
required
string format: currency
>= 1 characters
TaxCodes
required
Array<string>
NetValue
number format: double
nullable
GrossValue
number format: double
nullable
ConsumedUtc
required
string format: date-time
>= 1 characters
Type
string
nullable
ExternalIdentifier
string
nullable <= 255 characters
Notes
string
nullable
AccountingCategoryId
string format: uuid
nullable
AccountingCategory
AccountingCategoryParameters
object
Code
string
nullable
Name
string
nullable
UnitCost
CostParameters
object
Amount
required
number format: double
Currency
required
string format: currency
>= 1 characters
Tax
required
number format: double
AccountId
string format: uuid
nullable
Notes
string
nullable
Example
{
  "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.5,
            "TaxCodes": [
              "UK-S"
            ]
          },
          "ConsumedUtc": "2017-01-01T00:00:00Z",
          "AccountingCategoryId": null
        }
      ]
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

AddOutletBillsResult
object
OutletBillIds

Array of unique identifiers of the added Outlet bills.

Array<string>
nullable
Example
{
  "OutletBillIds": [
    "f2ee1bd2-dd55-4cd3-bab1-ab6800bf0301"
  ]
}

204

Section titled “204 ”

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

400

Section titled “400 ”

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

401

Section titled “401 ”

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

403

Section titled “403 ”

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

408

Section titled “408 ”

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

429

Section titled “429 ”

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

500

Section titled “500 ”

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