Headers

  • X-Application-Name string

Path parameters

  • documentNumber string Required

    Offset document number

Query parameters

  • client_id string Required

    Client identifier

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • data object
      Hide data attributes Show data attributes object
      • partner string Required
      • documentNumber string Required
      • createdAt string
      • dueDate string
      • currency string Required
      • diffPrice number Required
      • variableSymbol integer Required
      • supplier object Required
        Hide supplier attributes Show supplier 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
      • 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
      • invoices array[object] Required
        Hide invoices attributes Show invoices attributes array[object]
        • id integer Required
        • created string
        • dueDate string
        • sumPrice number Required
        • offsetPrice number Required
        • remainPrice number Required
        • currency string Required
        • purchNoC string Required
        • note string Required
        • invoiceNumber string Required
      • orders array[object] Required
        Hide orders attributes Show orders attributes array[object]
        • id integer Required
        • created string
        • dueDate string
        • sumPrice number Required
        • offsetPrice number Required
        • remainPrice number Required
        • currency string Required
      • attachment object Required
        Hide attachment attributes Show attachment attributes object
        • filename string Required
        • mime string Required
    • result object
      Hide result attributes Show result attributes object
      • code integer(int)
      • status string
GET /offsets/{documentNumber}
curl \
 -X GET https://mpapi.proxy.omnicado.com/v1/offsets/0000003003-28032019?client_id=yourClientId&client_id=api_token_value \
 -H "X-Application-Name: myApplicationName"
Response examples (200)
{
  "data": {
    "partner": 3000,
    "documentNumber": "0000003003-06112018",
    "createdAt": "2018-06-06",
    "dueDate": "2018-06-20",
    "currency": "CZK",
    "diffPrice": 200,
    "variableSymbol": 300006062018,
    "supplier": {
      "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"
      }
    },
    "invoices": [
      {
        "id": 3011000002,
        "created": "2018-06-01",
        "dueDate": "2018-06-01",
        "sumPrice": 934,
        "offsetPrice": 934,
        "remainPrice": 0,
        "currency": "CZK",
        "purchNoC": 30030000002113,
        "note": "Example note",
        "invoiceNumber": "string"
      }
    ],
    "orders": [
      {
        "id": 10151988,
        "created": "2018-06-02",
        "dueDate": "2018-06-02",
        "sumPrice": 1234,
        "offsetPrice": 1034,
        "remainPrice": 0,
        "currency": "CZK"
      }
    ],
    "attachment": {
      "filename": "MP_0000003000-20082021.pdf",
      "mime": "application/pdf"
    }
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}
Response examples (200)
{
  "data": {
    "partner": 3000,
    "documentNumber": "0000003003-06112018",
    "createdAt": "2018-06-06",
    "dueDate": "2018-06-20",
    "currency": "CZK",
    "diffPrice": 200,
    "variableSymbol": 300006062018,
    "supplier": {
      "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"
      }
    },
    "invoices": [
      {
        "id": 3011000002,
        "created": "2018-06-01",
        "dueDate": "2018-06-01",
        "sumPrice": 934,
        "offsetPrice": 934,
        "remainPrice": 0,
        "currency": "CZK",
        "purchNoC": 30030000002113,
        "note": "Example note",
        "invoiceNumber": "string"
      }
    ],
    "orders": [
      {
        "id": 10151988,
        "created": "2018-06-02",
        "dueDate": "2018-06-02",
        "sumPrice": 1234,
        "offsetPrice": 1034,
        "remainPrice": 0,
        "currency": "CZK"
      }
    ],
    "attachment": {
      "filename": "MP_0000003000-20082021.pdf",
      "mime": "application/pdf"
    }
  },
  "result": {
    "code": 200,
    "status": "OK"
  }
}