Skip to main content
GET
/
api
/
v1
/
invoices
청구서 목록 조회
curl --request GET \
  --url https://api.steppay.kr/api/v1/invoices \
  --header 'Secret-Token: <api-key>'
{
  "invoiceList": {
    "content": [
      {
        "id": 123,
        "orderCode": "<string>",
        "orderType": "RECURRING",
        "price": 123,
        "vendorUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "productCountryCode": "<string>",
        "productCurrencyCode": "<string>",
        "region": {
          "name": "<string>",
          "currencies": [
            "<string>"
          ],
          "country": "<string>",
          "countryCode": "<string>",
          "language": "<string>",
          "state": "<string>"
        },
        "currency": "<string>",
        "baseCurrency": "<string>",
        "exchangeRate": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "customerName": "<string>",
        "productName": "<string>",
        "status": "TEMPORARY",
        "paymentDate": "2023-11-07T05:31:56Z",
        "purchaseDeadline": "2023-11-07T05:31:56Z",
        "parentVendorUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "reservationAt": "2023-11-07T05:31:56Z",
        "invoicePayMethods": [
          "CARD"
        ]
      }
    ],
    "empty": true,
    "first": true,
    "last": true,
    "number": 123,
    "numberOfElements": 123,
    "pageable": {
      "offset": 123,
      "pageNumber": 123,
      "pageSize": 123,
      "paged": true,
      "sort": {
        "empty": true,
        "sorted": true,
        "unsorted": true
      },
      "unpaged": true
    },
    "size": 123,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "totalElements": 123,
    "totalPages": 123
  }
}

Authorizations

Secret-Token
string
header
required

Query Parameters

startDate
string<date-time>

조회 시작 시점

endDate
string<date-time>

조회 끝 시점

page
integer<int32>

페이지 번호(기본값: 0)

size
integer<int32>

페이지 크기(기본값: 20)

sortDir
string

정렬 방향(오름차순: ASC, 내림차순: DESC(기본값))

sort
string

정렬 기준값 - 기본값: 생성 시점

status
enum<string>

지정한 상태만 목록을 반환하게 합니다.

Available options:
TEMPORARY,
RESERVATION,
SENT,
PAID,
OVER_DUE,
SEND_FAIL

Response

정상적으로 조회됨

invoiceList
청구서 목록 Pagination 정보 · object
required

청구서 목록