POST Api/Invoices/Search
Pobiera odfiltrowaną listę obiektów Invoice
Request Information
URI Parameters
None.
Body Parameters
ustawienia filtrowania i sortowania wyników
InvoiceFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| TextFilter |
Filtrowanie w zależności od tekstu. Jeśli null to brak filtrowania. |
string |
None. |
| SortOrder |
Określa sposób sortowania wyników |
InvoiceSortEnum |
Required |
| MainInvoiceId |
Filtruje listę wyników według identyfikatora obiektu MainInvoice. Jeśli null to filtr jest pomijany. |
integer |
None. |
| CustomInvoiceId |
Filtruje listę wyników według identyfikatora obiektu CustomInvoice. Jeśli null to filtr jest pomijany. |
string |
None. |
| PayTypeId |
Filtruje listę wyników według identyfikatora obiektu PayType. Jeśli null to filtr jest pomijany. |
integer |
None. |
| InvoiceTypeId |
Filtruje listę wyników według identyfikatora obiektu InvoiceType. Jeśli null to filtr jest pomijany. |
integer |
None. |
| CustomerId |
Filtruje listę wyników według identyfikatora obiektu Customer. Jeśli null to filtr jest pomijany. |
integer |
None. |
| ProviderId |
Filtruje listę wyników według identyfikatora obiektu Provider. Jeśli null to filtr jest pomijany. |
integer |
None. |
| ProfileId |
Filtruje listę wyników według identyfikatora obiektu Profile. Jeśli null to filtr jest pomijany. |
integer |
None. |
| ItemsPerPage |
Ilość obiektów na stronę |
integer |
None. |
| CurrentPage |
Obecna strona |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"textFilter": "sample string 1",
"sortOrder": 0,
"mainInvoiceId": 1,
"customInvoiceId": "sample string 2",
"payTypeId": 1,
"invoiceTypeId": 1,
"customerId": 1,
"providerId": 1,
"profileId": 1,
"itemsPerPage": 3,
"currentPage": 4
}
multipart/form-data
Sample:
{"textFilter":"sample string 1","sortOrder":0,"mainInvoiceId":1,"customInvoiceId":"sample string 2","payTypeId":1,"invoiceTypeId":1,"customerId":1,"providerId":1,"profileId":1,"itemsPerPage":3,"currentPage":4}
application/xml, text/xml
Sample:
<InvoiceFilter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ItemsPerPage>3</ItemsPerPage> <CurrentPage>4</CurrentPage> <TextFilter>sample string 1</TextFilter> <SortOrder>InvoiceIdAsc</SortOrder> <MainInvoiceId>1</MainInvoiceId> <CustomInvoiceId>sample string 2</CustomInvoiceId> <PayTypeId>1</PayTypeId> <InvoiceTypeId>1</InvoiceTypeId> <CustomerId>1</CustomerId> <ProviderId>1</ProviderId> <ProfileId>1</ProfileId> </InvoiceFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
lista obiektów Invoice zgodna z ustawieniem filtrowania oraz całkowita liczba wszystkich elementów w bazie spełniających kryteria (całkowita liczba obiektów jest obliczana tylo dla pierwszej strony CurrentPage == 0)
Collection of InvoiceDto| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceId | integer |
Required |
|
| MainInvoiceId | integer |
None. |
|
| YearNumber | integer |
Required |
|
| MonthNumber | integer |
Required |
|
| InvoiceNumber | integer |
Required |
|
| CustomInvoiceId | string |
Required |
|
| SellDate | date |
Required |
|
| IssueDate | date |
Required |
|
| PayTime | integer |
Required |
|
| IsPayed | boolean |
None. |
|
| PayTypeId | integer |
Required |
|
| InvoiceTypeId | integer |
Required |
|
| CustomerId | integer |
Required |
|
| ProviderId | integer |
None. |
|
| ProfileId | string |
None. |
|
| PriceBrutto | decimal number |
None. |
|
| PriceNetto | decimal number |
None. |
|
| IsDigital | boolean |
None. |
|
| Description | string |
None. |
|
| InvoiceRows | Collection of InvoiceRowDto |
None. |
|
| CustomerName | string |
None. |
|
| ProviderName | string |
None. |
|
| ProfileName | string |
None. |
|
| PaymentDate | date |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"invoiceId": 1,
"mainInvoiceId": 1,
"yearNumber": 2,
"monthNumber": 3,
"invoiceNumber": 4,
"customInvoiceId": "sample string 5",
"sellDate": "2024-05-17T04:17:13.3840119+00:00",
"issueDate": "2024-05-17T04:17:13.3840119+00:00",
"payTime": 8,
"isPayed": true,
"payTypeId": 10,
"invoiceTypeId": 11,
"customerId": 12,
"providerId": 13,
"profileId": "sample string 14",
"priceBrutto": 1.0,
"priceNetto": 1.0,
"isDigital": true,
"description": "sample string 16",
"invoiceRows": [
{
"invoiceRowId": 1,
"invoiceId": 2,
"name": "sample string 3",
"netto": 4.1,
"unitId": 5,
"quantity": 6.1,
"vatId": 7
},
{
"invoiceRowId": 1,
"invoiceId": 2,
"name": "sample string 3",
"netto": 4.1,
"unitId": 5,
"quantity": 6.1,
"vatId": 7
}
],
"customerName": "sample string 17",
"providerName": "sample string 18",
"profileName": "sample string 19",
"paymentDate": "2024-05-17T04:17:13.3840119+00:00"
},
{
"invoiceId": 1,
"mainInvoiceId": 1,
"yearNumber": 2,
"monthNumber": 3,
"invoiceNumber": 4,
"customInvoiceId": "sample string 5",
"sellDate": "2024-05-17T04:17:13.3840119+00:00",
"issueDate": "2024-05-17T04:17:13.3840119+00:00",
"payTime": 8,
"isPayed": true,
"payTypeId": 10,
"invoiceTypeId": 11,
"customerId": 12,
"providerId": 13,
"profileId": "sample string 14",
"priceBrutto": 1.0,
"priceNetto": 1.0,
"isDigital": true,
"description": "sample string 16",
"invoiceRows": [
{
"invoiceRowId": 1,
"invoiceId": 2,
"name": "sample string 3",
"netto": 4.1,
"unitId": 5,
"quantity": 6.1,
"vatId": 7
},
{
"invoiceRowId": 1,
"invoiceId": 2,
"name": "sample string 3",
"netto": 4.1,
"unitId": 5,
"quantity": 6.1,
"vatId": 7
}
],
"customerName": "sample string 17",
"providerName": "sample string 18",
"profileName": "sample string 19",
"paymentDate": "2024-05-17T04:17:13.3840119+00:00"
}
]
multipart/form-data
Sample:
[{"invoiceId":1,"mainInvoiceId":1,"yearNumber":2,"monthNumber":3,"invoiceNumber":4,"customInvoiceId":"sample string 5","sellDate":"2024-05-17T04:17:13.3840119+00:00","issueDate":"2024-05-17T04:17:13.3840119+00:00","payTime":8,"isPayed":true,"payTypeId":10,"invoiceTypeId":11,"customerId":12,"providerId":13,"profileId":"sample string 14","priceBrutto":1.0,"priceNetto":1.0,"isDigital":true,"description":"sample string 16","invoiceRows":[{"invoiceRowId":1,"invoiceId":2,"name":"sample string 3","netto":4.1,"unitId":5,"quantity":6.1,"vatId":7},{"invoiceRowId":1,"invoiceId":2,"name":"sample string 3","netto":4.1,"unitId":5,"quantity":6.1,"vatId":7}],"customerName":"sample string 17","providerName":"sample string 18","profileName":"sample string 19","paymentDate":"2024-05-17T04:17:13.3840119+00:00"},{"invoiceId":1,"mainInvoiceId":1,"yearNumber":2,"monthNumber":3,"invoiceNumber":4,"customInvoiceId":"sample string 5","sellDate":"2024-05-17T04:17:13.3840119+00:00","issueDate":"2024-05-17T04:17:13.3840119+00:00","payTime":8,"isPayed":true,"payTypeId":10,"invoiceTypeId":11,"customerId":12,"providerId":13,"profileId":"sample string 14","priceBrutto":1.0,"priceNetto":1.0,"isDigital":true,"description":"sample string 16","invoiceRows":[{"invoiceRowId":1,"invoiceId":2,"name":"sample string 3","netto":4.1,"unitId":5,"quantity":6.1,"vatId":7},{"invoiceRowId":1,"invoiceId":2,"name":"sample string 3","netto":4.1,"unitId":5,"quantity":6.1,"vatId":7}],"customerName":"sample string 17","providerName":"sample string 18","profileName":"sample string 19","paymentDate":"2024-05-17T04:17:13.3840119+00:00"}]
application/xml, text/xml
Sample:
<ArrayOfInvoiceDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<InvoiceDto>
<InvoiceId>1</InvoiceId>
<MainInvoiceId>1</MainInvoiceId>
<YearNumber>2</YearNumber>
<MonthNumber>3</MonthNumber>
<InvoiceNumber>4</InvoiceNumber>
<CustomInvoiceId>sample string 5</CustomInvoiceId>
<SellDate />
<IssueDate />
<PayTime>8</PayTime>
<IsPayed>true</IsPayed>
<PayTypeId>10</PayTypeId>
<InvoiceTypeId>11</InvoiceTypeId>
<CustomerId>12</CustomerId>
<ProviderId>13</ProviderId>
<ProfileId>sample string 14</ProfileId>
<PriceBrutto>1</PriceBrutto>
<PriceNetto>1</PriceNetto>
<IsDigital>true</IsDigital>
<Description>sample string 16</Description>
<InvoiceRows>
<InvoiceRowDto>
<InvoiceRowId>1</InvoiceRowId>
<InvoiceId>2</InvoiceId>
<Name>sample string 3</Name>
<Netto>4.1</Netto>
<UnitId>5</UnitId>
<Quantity>6.1</Quantity>
<VatId>7</VatId>
</InvoiceRowDto>
<InvoiceRowDto>
<InvoiceRowId>1</InvoiceRowId>
<InvoiceId>2</InvoiceId>
<Name>sample string 3</Name>
<Netto>4.1</Netto>
<UnitId>5</UnitId>
<Quantity>6.1</Quantity>
<VatId>7</VatId>
</InvoiceRowDto>
</InvoiceRows>
<CustomerName>sample string 17</CustomerName>
<ProviderName>sample string 18</ProviderName>
<ProfileName>sample string 19</ProfileName>
<PaymentDate />
</InvoiceDto>
<InvoiceDto>
<InvoiceId>1</InvoiceId>
<MainInvoiceId>1</MainInvoiceId>
<YearNumber>2</YearNumber>
<MonthNumber>3</MonthNumber>
<InvoiceNumber>4</InvoiceNumber>
<CustomInvoiceId>sample string 5</CustomInvoiceId>
<SellDate />
<IssueDate />
<PayTime>8</PayTime>
<IsPayed>true</IsPayed>
<PayTypeId>10</PayTypeId>
<InvoiceTypeId>11</InvoiceTypeId>
<CustomerId>12</CustomerId>
<ProviderId>13</ProviderId>
<ProfileId>sample string 14</ProfileId>
<PriceBrutto>1</PriceBrutto>
<PriceNetto>1</PriceNetto>
<IsDigital>true</IsDigital>
<Description>sample string 16</Description>
<InvoiceRows>
<InvoiceRowDto>
<InvoiceRowId>1</InvoiceRowId>
<InvoiceId>2</InvoiceId>
<Name>sample string 3</Name>
<Netto>4.1</Netto>
<UnitId>5</UnitId>
<Quantity>6.1</Quantity>
<VatId>7</VatId>
</InvoiceRowDto>
<InvoiceRowDto>
<InvoiceRowId>1</InvoiceRowId>
<InvoiceId>2</InvoiceId>
<Name>sample string 3</Name>
<Netto>4.1</Netto>
<UnitId>5</UnitId>
<Quantity>6.1</Quantity>
<VatId>7</VatId>
</InvoiceRowDto>
</InvoiceRows>
<CustomerName>sample string 17</CustomerName>
<ProviderName>sample string 18</ProviderName>
<ProfileName>sample string 19</ProfileName>
<PaymentDate />
</InvoiceDto>
</ArrayOfInvoiceDto>