Package dev.vality.anapi.v2.api

Interface InvoicesApi

All Known Implementing Classes:

InvoicesApiController

@Generated(value="org.openapitools.codegen.languages.SpringCodegen",
           date="2023-07-07T08:12:11.951968249Z[Etc/UTC]")
@Validated
public interface InvoicesApi

Method Summary

Modifier and Type	Method	Description
default InvoicesApiDelegate	getDelegate()
default org.springframework.http.ResponseEntity<InlineResponse2008>	searchInvoices(String xRequestID, @NotNull @Size(min=1,max=40) @Valid String partyID, @NotNull @Valid OffsetDateTime fromTime, @NotNull @Valid OffsetDateTime toTime, @NotNull @Min(1L) @Max(1000L) @Valid Integer limit, String xRequestDeadline, @Size(min=1,max=40) @Valid String shopID, @Valid List<String> shopIDs, @Valid String paymentInstitutionRealm, @Size(min=1,max=40) @Valid String invoiceID, @Valid List<String> invoiceIDs, @Valid String invoiceStatus, @Min(1L) @Valid Long invoiceAmountFrom, @Min(1L) @Valid Long invoiceAmountTo, @Size(min=1,max=40) @Valid String externalID, @Valid String continuationToken)	GET /invoices : Поиск инвойсов Поиск инвойсов

Method Details

getDelegate

default InvoicesApiDelegate getDelegate()

searchInvoices

@RequestMapping(method=GET,
                value="/invoices",
                produces="application/json; charset=utf-8")
default org.springframework.http.ResponseEntity<InlineResponse2008> searchInvoices(@RequestHeader(value="X-Request-ID",required=true)
String xRequestID,
@NotNull @Size(min=1,max=40) @Valid @RequestParam(value="partyID",required=true)
@NotNull @Size(min=1,max=40) @Valid String partyID,
@NotNull @Valid @RequestParam(value="fromTime",required=true) @DateTimeFormat(iso=DATE_TIME)
@NotNull @Valid OffsetDateTime fromTime,
@NotNull @Valid @RequestParam(value="toTime",required=true) @DateTimeFormat(iso=DATE_TIME)
@NotNull @Valid OffsetDateTime toTime,
@NotNull @Min(1L) @Max(1000L) @Valid @RequestParam(value="limit",required=true)
@NotNull @Min(1L) @Max(1000L) @Valid Integer limit,
@RequestHeader(value="X-Request-Deadline",required=false)
String xRequestDeadline,
@Size(min=1,max=40) @Valid @RequestParam(value="shopID",required=false)
@Size(min=1,max=40) @Valid String shopID,
@Valid @RequestParam(value="shopIDs",required=false)
@Valid List<String> shopIDs,
@Valid @RequestParam(value="paymentInstitutionRealm",required=false)
@Valid String paymentInstitutionRealm,
@Size(min=1,max=40) @Valid @RequestParam(value="invoiceID",required=false)
@Size(min=1,max=40) @Valid String invoiceID,
@Valid @RequestParam(value="invoiceIDs",required=false)
@Valid List<String> invoiceIDs,
@Valid @RequestParam(value="invoiceStatus",required=false)
@Valid String invoiceStatus,
@Min(1L) @Valid @RequestParam(value="invoiceAmountFrom",required=false)
@Min(1L) @Valid Long invoiceAmountFrom,
@Min(1L) @Valid @RequestParam(value="invoiceAmountTo",required=false)
@Min(1L) @Valid Long invoiceAmountTo,
@Size(min=1,max=40) @Valid @RequestParam(value="externalID",required=false)
@Size(min=1,max=40) @Valid String externalID,
@Valid @RequestParam(value="continuationToken",required=false)
@Valid String continuationToken)

GET /invoices : Поиск инвойсов Поиск инвойсов

Parameters:

xRequestID - Уникальный идентификатор запроса к системе (required)

partyID - Уникальный идентификатор участника в рамках платформы (required)

fromTime - Начало временного отрезка (required)

toTime - Конец временного отрезка (required)

limit - Лимит выборки (required)

xRequestDeadline - Максимальное время обработки запроса (optional)

shopID - Идентификатор магазина (optional)

shopIDs - Идентификаторы магазинов (optional)

paymentInstitutionRealm - Тип магазина, тестовый или «боевой» (optional)

invoiceID - Идентификатор инвойса (optional)

invoiceIDs - Список инвойсов (optional)

invoiceStatus - Статус инвойса для поиска (optional)

invoiceAmountFrom - Минимальная сумма инвойса (optional)

invoiceAmountTo - Максимальная сумма инвойса (optional)

externalID - Внешний идентификатор (optional)

continuationToken - (optional)

Returns:

Найденные инвойсы (status code 200) or Неверные данные (status code 400) or Ошибка авторизации (status code 401)