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
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
}
}