Invoices

Invoices object

Get invoices

get

https://api.mews.com/poshttps://api.mews-demo.com/pos

/v1/invoices

This operation returns a list of invoices.

Note: This operation needs Authentication and supports the following JSON:API features:

• Relationships - invoiceItems, user, register, originalInvoice, order, promoCode, revenueCenter using include query parameter.

• Filters - createdAtGt, createdAtGteq, createdAtLt, createdAtLteq, registerIdEq

• Sparse fieldsets - supports all fields of invoices and related resources with fields query parameter.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Query parameters

page[size]integer · int32 · min: 1 · max: 1000Optional

The number of resources to return in a single response.

page[before]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$

page[after]string · min: 1 · max: 36Optional

Unique identifier.

Pattern: ^[a-zA-Z0-9-]+$

filter[createdAtGt]any ofOptional

Filters the objects that were created after a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z

or

string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16

filter[createdAtGteq]any ofOptional

Filters the objects that were created after or on a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-16T14:30:00Z

or

string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-16

filter[createdAtLt]any ofOptional

Filters the objects that were created before a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-17T14:30:00Z

or

string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-17

filter[createdAtLteq]any ofOptional

Filters the objects that were created before or on a specified datetime.

string · date-time · max: 25Optional

Timestamp in RFC 3339 format.

Example: 2023-10-17T14:30:00Z

or

string · date · max: 10Optional

Date in RFC 3339 format.

Example: 2023-10-17

filter[registerIdEq]string · uuid · min: 36 · max: 36Optional

Universally unique ID UUID4.

Example: 5efa8b3c-b930-4b31-918d-95ab0e212e64

Responses

200

Successful response with invoices data in JSON:API format.

application/vnd.api+json

400

Bad request.

application/vnd.api+json

401

Unauthorized.

application/vnd.api+json

429

Too many requests.

application/vnd.api+json

500

Internal Server Error.

application/vnd.api+json

503

Service is unavailable.

application/vnd.api+json

get

/v1/invoices

HTTPcURLJavaScriptPython

GET /pos/v1/invoices HTTP/1.1
Host: api.mews.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "5a43b8fa-8029-4093-895b-bddd8c74ebe1",
      "type": "invoices",
      "attributes": {
        "discount": "0.00",
        "tax": "1.67",
        "total": "10.00",
        "subtotal": "8.33",
        "cancelled": false,
        "cancelReason": null,
        "discountAmount": "0.00",
        "description": null,
        "itemDiscountAmount": "0.00",
        "createdAt": "2024-10-24T08:44:45.409Z",
        "updatedAt": "2024-10-24T08:44:45.547Z",
        "tipAmount": "0.00"
      },
      "relationships": {
        "user": {
          "data": {
            "id": "817f7fc3-3dcb-4cb8-9991-af488a497968",
            "type": "users"
          }
        },
        "order": {
          "data": {
            "id": "f51fd61c-c618-4b05-acad-5ee96961acf9",
            "type": "orders"
          }
        },
        "originalInvoices": {
          "data": null
        },
        "register": {
          "data": {
            "id": "eef23c03-49b9-432b-b1a3-955ea1501557",
            "type": "registers"
          }
        },
        "invoiceItems": {
          "data": [
            {
              "id": "22426614-316e-4654-b567-60d781f9ae37",
              "type": "invoiceItems"
            }
          ]
        },
        "promoCode": {
          "data": {
            "id": "167beb82-e6a7-453b-8048-cfa25d3ce467",
            "type": "promoCodes"
          }
        },
        "revenueCenter": {
          "data": {
            "id": "5efa8b3c-b930-4b31-918d-95ab0e212e64",
            "type": "revenueCenters"
          }
        }
      }
    }
  ],
  "links": {
    "prev": "https://api.mews-demo.com/pos/v1/invoices?page%5Bbefore%5D=NA&page%5Bsize%5D=1",
    "next": "https://api.mews-demo.com/pos/v1/invoices?page%5Bafter%5D=NA&page%5Bsize%5D=1"
  }
}