마감내역 요청
마감된 거래와 관련된 API 기능을 제공합니다.
발생한 매출에 대해 마감된 정보를 조회할 수 있습니다.
마감의 종류로는 수동마감과 자동마감 이 존재합니다.
- 수동마감
- 자판기 또는 단말기에서 직접 마감을 진행하는 경우
- 특정 시간에 마감을 진행하는 경우(예: 17:45:00) - (단말기 펌웨어를 통해 제어)
- 자동마감
- 시스템에서 자동으로 마감을 진행하는 경우(23:59:59 고정)
기본 호출 구문
const API = axios.create({ baseURL: `http://api.ubcn.co.kr/api`, headers: { "Access-Control-Allow-Origin": "*", "company": "{company}", "token": "{token}", },});
// get, post 모두 지원합니다.// 조회일자를 기준으로 마감 정보가 없을 경우, 데이터가 출력되지 않습니다.
// {date}만 작성하는 경우, 해당 날짜의 전체 마감내역을 조회합니다.// 예시) /20240809 입력 시// 20240809 일자에 발생한 전체 마감내역을 조회합니다.const res = await API.get("/closing/{closingType}/{date}");
// {date}와 {time}을 작성하는 경우,// 해당 날짜의 전일자 {time} 부터 해당 날짜 {time} 까지의 마감내역을 조회합니다.// 예시) /20240809/180000 입력 시// 20240808 18시부터 20240809 18시까지의 마감내역을 조회합니다.const res = await API.get("/closing/{closingType}/{date}/{time}");
// 결과 출력console.log(res.data);
// 프로세스가 제대로 완료되지 않은 경우 에러 코드가 존재합니다.if (res.code != null) { return alert(res.decription);}Schema
결과 값에 들어 있는 필드는 다음과 같습니다.
| 필드명 | 상세필드명 | 필수 | 타입 | 설명 | 비고 |
|---|---|---|---|---|---|
| decription | - | Y | String | API 상세설명 | - |
| message | - | Y | String | 응답 메시지 | - |
| type | - | Y | String | API 유형 | - |
| closingDate | - | Y | String | 요청일자 | YYYYMMDD |
| salesList | closingDate | Y | String | 마감일자 | YYYYMMDD |
| terminalId | Y | String | 단말기 ID | UBCn 단말기 ID | |
| terminalCode | Y | String | 단말기 코드 | 가맹점 관리 단말기 코드 | |
| placeCode | Y | String | 위치코드(점포코드) | 점포코드 | |
| placeNo | Y | String | 위치순번(POS번호) | POS번호 | |
| cabNo | Y | String | 자판기 캐비넷 번호 | 컬럼별 마감 시 | |
| colNo | Y | String | 자판기 컬럼 | 컬럼별 마감 시 | |
| productCode | Y | String | 상품코드 | 상품별 마감 시 | |
| productName | Y | String | 상품명 | 상품별 마감 시 | |
| totCnt | Y | String | 전체 매출수량 | - | |
| totAmt | Y | String | 전체 매출금액 | - | |
| cashCnt | Y | String | 현금(영수증) 매출수량 | - | |
| cashAmt | Y | String | 현금(영수증) 매출금액 | - | |
| cardCnt | Y | String | 신용카드 매출수량 | - | |
| cardAmt | Y | String | 신용카드 매출금액 | - | |
| tmnCnt | Y | String | 티머니 매출수량 | - | |
| tmnAmt | Y | String | 티머니 매출금액 | - | |
| csbCnt | Y | String | 캐시비 매출수량 | - | |
| csbAmt | Y | String | 캐시비 매출금액 | - | |
| mybCnt | Y | String | 마이비 매출수량 | - | |
| mybAmt | Y | String | 마이비 매출금액 | - | |
| krpCnt | Y | String | 레일플러스 매출수량 | - | |
| krpAmt | Y | String | 레일플러스 매출금액 | - | |
| npcCnt | Y | String | 페이코 매출수량 | - | |
| npcAmt | Y | String | 페이코 매출금액 | - | |
| kkpCnt | Y | String | 카카오페이 매출수량 | - | |
| kkpAmt | Y | String | 카카오페이 매출금액 | - |