GET /invoices

Filtering

Show

You can filter the results by any field from the results set.

Eg. /invoices?currency=CZK will return only invoices with currency set to CZK Eg. /invoices?createdAt=ge:2019-01-01 will return invoices since 1. 1. 2019

You may specify a modifier to filters

Modifier Meaning
gt greater than
ge greater or equal
lt less than
le less or equal

Usage of filter modifiers

E.g. /invoices?currency=in:CZK,EUR will return only results with currency equal to CZK or EUR

Sorting

Show

You can sort results using sort parameter

E.g. /invoices?_sort=createdAt

You may specify sorting modifiers (default is asc) | Modifier | Meaning | |--------------|---------------------| | asc | ascending (default) | | desc | descending | E.g. /invoices?_sort=createdAt:desc,dueDate:asc

Headers

  • X-Application-Name string

Query parameters

  • client_id string Required

    Client identifier

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • data array[object]
      Hide data attributes Show data attributes array[object]
      • partner string Required

        Partner Id

      • invoiceNumber integer Required

        Invoice number

      • originDocumentId string

        Id of origin document

      • createdAt string

        Creation date

      • deliveryAt string

        Date of delivery to the customer

      • dueDate string

        The due date of the invoice

      • currency string Required

        Currency of the invoice

      • total number Required
      • supplier object Required
        Hide supplier attributes Show supplier attributes object
        • bank object
          Hide bank attributes Show bank attributes object
          • bankAccount string Required
          • bankName string Required
          • iban string Required
          • swift string Required
        • name string Required
        • registrationNumber string Required
        • taxIdentification string Required
        • vatNumber string
        • note string
        • address object Required
          Hide address attributes Show address attributes object
          • city string Required
          • street string Required
          • zip string Required
          • country string Required
      • customer object Required
        Hide customer attributes Show customer attributes object
        • name string Required
        • registrationNumber string Required
        • taxIdentification string Required
        • vatNumber string
        • note string
        • address object Required
          Hide address attributes Show address attributes object
          • city string Required
          • street string Required
          • zip string Required
          • country string Required
      • items array[object] Required
        Hide items attributes Show items attributes array[object]
        • articleId integer
        • id string Required
        • orderId integer Required
        • title string Required
        • priceWithoutVat number Required
        • quantity integer Required
        • totalPrice number Required
        • unit string Required
        • unitPrice number Required
        • vatRate integer Required
      • taxRecap object Required
        Hide taxRecap attributes Show taxRecap attributes object
        • total number Required
        • taxes object Required
          Hide taxes attributes Show taxes attributes object
          • 15 object Required

            At least one tax must be specified

            Hide 15 attributes Show 15 attributes object
            • base number Required
            • price number Required
            • total number Required
          • 21 object Required

            At least one tax must be specified

            Hide 21 attributes Show 21 attributes object
            • base number Required
            • price number Required
            • total number Required
          • osvobozeno object Required

            At least one tax must be specified

            Hide osvobozeno attributes Show osvobozeno attributes object
            • base number Required
            • price number Required
            • total number Required
      • note string Required
      • filePath string Required
      • purchNoC string Required
      • invoiceType string Required
      • invoiceIndicator string Required
      • documentType string Required
      • invoiceTypeTag string Required
    • result object
      Hide result attributes Show result attributes object
      • code integer(int)
      • status string
    • paging object
      Hide paging attributes Show paging attributes object
      • pages integer
      • size integer
      • page integer
GET /invoices
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/invoices?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"
Response examples (200)
{
  "data": [
    {
      "partner": 3000,
      "invoiceNumber": 3003000022,
      "originDocumentId": "string",
      "createdAt": "2018-11-23",
      "deliveryAt": "2018-11-26",
      "dueDate": "2018-11-26",
      "currency": "CZK",
      "total": 1000,
      "supplier": {
        "bank": {
          "bankAccount": "1000084488/0800",
          "bankName": "Česká spořitelna",
          "iban": "CZ8100161984000098459001",
          "swift": "GXCAMCZX"
        },
        "name": "Novak s.r.o",
        "registrationNumber": "123456789",
        "taxIdentification": "CZ123456789",
        "vatNumber": "3210480832",
        "note": "Example note",
        "address": {
          "city": "Praha",
          "street": "U Garáží 1",
          "zip": "17001",
          "country": "CZ"
        }
      },
      "customer": {
        "name": "Internet Mall s.r.o",
        "registrationNumber": "26204967",
        "taxIdentification": "CZ26204967",
        "vatNumber": "3210480832",
        "note": "Example note",
        "address": {
          "city": "Praha",
          "street": "U Garáží 1",
          "zip": "17001",
          "country": "CZ"
        }
      },
      "items": [
        {
          "articleId": 1100051914,
          "id": "IDP29826",
          "orderId": 206054198198,
          "title": "Produckt 1",
          "priceWithoutVat": 200.2,
          "quantity": 1,
          "totalPrice": 200,
          "unit": "KS",
          "unitPrice": 200,
          "vatRate": 21
        }
      ],
      "taxRecap": {
        "total": 200,
        "taxes": {
          "15": {
            "base": 190,
            "price": 19,
            "total": 200
          },
          "21": {
            "base": 190,
            "price": 19,
            "total": 200
          },
          "osvobozeno": {
            "base": 190,
            "price": 19,
            "total": 200
          }
        }
      },
      "note": "Example note",
      "filePath": "3003/invoice_3003900055.pdf",
      "purchNoC": 30030000002113,
      "invoiceType": "SB",
      "invoiceIndicator": "I",
      "documentType": "invoice",
      "invoiceTypeTag": "SB"
    }
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}
Response examples (200)
{
  "data": [
    {
      "partner": 3000,
      "invoiceNumber": 3003000022,
      "originDocumentId": "string",
      "createdAt": "2018-11-23",
      "deliveryAt": "2018-11-26",
      "dueDate": "2018-11-26",
      "currency": "CZK",
      "total": 1000,
      "supplier": {
        "bank": {
          "bankAccount": "1000084488/0800",
          "bankName": "Česká spořitelna",
          "iban": "CZ8100161984000098459001",
          "swift": "GXCAMCZX"
        },
        "name": "Novak s.r.o",
        "registrationNumber": "123456789",
        "taxIdentification": "CZ123456789",
        "vatNumber": "3210480832",
        "note": "Example note",
        "address": {
          "city": "Praha",
          "street": "U Garáží 1",
          "zip": "17001",
          "country": "CZ"
        }
      },
      "customer": {
        "name": "Internet Mall s.r.o",
        "registrationNumber": "26204967",
        "taxIdentification": "CZ26204967",
        "vatNumber": "3210480832",
        "note": "Example note",
        "address": {
          "city": "Praha",
          "street": "U Garáží 1",
          "zip": "17001",
          "country": "CZ"
        }
      },
      "items": [
        {
          "articleId": 1100051914,
          "id": "IDP29826",
          "orderId": 206054198198,
          "title": "Produckt 1",
          "priceWithoutVat": 200.2,
          "quantity": 1,
          "totalPrice": 200,
          "unit": "KS",
          "unitPrice": 200,
          "vatRate": 21
        }
      ],
      "taxRecap": {
        "total": 200,
        "taxes": {
          "15": {
            "base": 190,
            "price": 19,
            "total": 200
          },
          "21": {
            "base": 190,
            "price": 19,
            "total": 200
          },
          "osvobozeno": {
            "base": 190,
            "price": 19,
            "total": 200
          }
        }
      },
      "note": "Example note",
      "filePath": "3003/invoice_3003900055.pdf",
      "purchNoC": 30030000002113,
      "invoiceType": "SB",
      "invoiceIndicator": "I",
      "documentType": "invoice",
      "invoiceTypeTag": "SB"
    }
  ],
  "result": {
    "code": 200,
    "status": "OK"
  },
  "paging": {
    "pages": 1,
    "size": 1,
    "page": 1
  }
}