CashReceipt API

현금영수증 발행 결과를 Toss POS에 등록하는 API예요. Toss POS에서 현금 결제 시 자동으로 처리되지만, 플러그인에서 별도로 현금영수증을 발행한 경우 결과를 등록할 때 사용해요.

Types

CashReceipt

현금영수증 발행 결과를 나타내는 객체예요.

{
    orderId: string;     // 현금영수증이 발행된 주문 ID
    amount: number;      // 현금영수증 발행 금액
    issueDate: string;   // 현금영수증 발행 날짜 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
    issueNumber: string; // 현금영수증 발행 번호
    cardNumber: string;  // 현금영수증 발행 카드/휴대폰 번호
}

필드	타입	필수	설명	예시
orderId	string	필수	현금영수증이 발행된 주문 ID	'order-id'
amount	number	필수	현금영수증 발행 금액	10000
issueDate	string	필수	현금영수증 발행 날짜 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z' 형식)	'2025-01-01T12:00:00.000Z'
issueNumber	string	필수	현금영수증 발행 번호	'issue-number'
cardNumber	string	필수	현금영수증 발행 카드 또는 휴대폰 번호	'1234123412341234'

Methods

add

현금영수증 발행 결과를 Toss POS에 등록해요.

주의사항

이 API는 현금영수증을 발행하는 기능이 아니에요. 외부 시스템에서 발행한 현금영수증의 결과를 Toss POS에 등록하는 API예요.

import { posPluginSdk } from '@tossplace/pos-plugin-sdk';

// 현금영수증 발행 결과 등록
await posPluginSdk.cashReceipt.add({
    orderId: 'order-id',
    amount: 10000,
    issueDate: '2025-01-01T12:00:00.000Z',
    issueNumber: 'issue-number',
    cardNumber: 'card-number',
});

Parameters

CashReceipt 객체 하나를 넘겨요.

파라미터	타입	필수	설명
orderId	string	O	현금영수증이 발행된 주문 ID
amount	number	O	현금영수증 발행 금액
issueDate	string	O	현금영수증 발행 날짜 (yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
issueNumber	string	O	현금영수증 발행 번호
cardNumber	string	O	현금영수증 발행 카드 또는 휴대폰 번호

Response

반환값이 없어요.

사용 예시

테이블 주문에서 현금영수증 발행 후 등록

import { posPluginSdk } from '@tossplace/pos-plugin-sdk';

/**
 * 테이블 주문에 대한 현금영수증 발행 및 등록
 * @param orderId 주문 ID
 * @param amount 발행 금액
 */
async function registerCashReceipt(orderId: string, amount: number) {
    // 1. 외부 시스템을 통한 현금영수증 발행
    const cashReceipt = await issueCashReceipt(orderId, amount);

    // 2. 발행 결과를 Toss POS에 등록
    await posPluginSdk.cashReceipt.add({
        orderId: orderId,
        amount: amount,
        issueDate: cashReceipt.issueDate,
        issueNumber: cashReceipt.issueNumber,
        cardNumber: cashReceipt.cardNumber,
    });
}