거래처 관련 API
거래처 관련 API 기능을 제공합니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
B2bCertificate: { registeredAt, expiredAt, issuerName, ... }
B2bCertificateType: "E_TAX" | "PORTONE" | "ETC"
인증서 타입
B2bCertificateUnregisteredError: { type, message }
인증서가 등록되어 있지 않은 경우
B2bCounterparty: { id, graphqlId, isForTest, ... }
거래처
B2B 거래처 정보입니다.
B2bCounterpartyBrnInvalidError: { type, message }
사업자등록번호가 유효하지 않은 경우
B2bCounterpartyBrnModificationNotAllowedError: { type, message }
사업자등록번호 수정이 허용되지 않는 경우
거래처의 사업자등록번호는 수정할 수 없습니다.
B2bCounterpartyBusinessStatus: "UNKNOWN" | "IN_BUSINESS" | "CLOSED" | ...
거래처 휴폐업 상태
B2bCounterpartyContact: { name, phoneNumber, email, ... }
거래처 담당자 정보
B2bCounterpartyContactInput: { name, phoneNumber, email, ... }
거래처 담당자 입력 정보
B2bCounterpartyCreateOptions: { checkBusinessInfo, checkBusinessStatus, businessInfoVerificationId, ... }
거래처 생성 옵션
B2bCounterpartyFilter: { id, brn, companyName, ... }
거래처 검색 필터
B2bCounterpartyIdAlreadyExistsByPartnerError: { type, message }
파트너 연동으로 생성된 거래처 ID가 이미 사용중인 경우
파트너 연동으로 생성된 거래처 ID는 재사용할 수 없습니다.
B2bCounterpartyIdAlreadyExistsError: { type, message }
거래처 ID가 이미 사용중인 경우
B2bCounterpartyInput: { brn, name, representativeName, ... }
거래처 입력 정보
B2bCounterpartyMissingRequiredFieldsError: { type, message }
필수 입력 항목이 누락된 경우
거래처 생성/수정 시 필수 입력 항목이 누락되었습니다.
B2bCounterpartyNotFoundError: { type, message, counterpartyId }
거래처가 존재하지 않는 경우
B2bCounterpartyNtsConnectionFailedError: { type, message }
국세청 연동에 실패한 경우
B2bCounterpartyNtsNotConnectedError: { type, message, brn, ... }
국세청에 연동되어 있지 않은 경우
B2bCounterpartyOngoingTaxInvoiceExistsError: { type, message }
진행 중인 세금계산서가 존재하여 거래처를 삭제할 수 없는 경우
B2bCounterpartyPartnerNotConnectableError: { type, message }
파트너 연동 거래처는 국세청 연동이 허용되지 않는 경우
파트너와 연동된 거래처는 국세청 연동을 직접 수행할 수 없습니다.
B2bCounterpartyPartnerNotDeletableError: { type, message }
파트너 연동 거래처는 삭제할 수 없는 경우
파트너와 연동된 거래처는 직접 삭제할 수 없습니다.
B2bCounterpartyPartnerNotUpdatableError: { type, message }
파트너 연동 거래처는 수정할 수 없는 경우
파트너와 연동된 거래처는 직접 수정할 수 없습니다.
B2bCounterpartySelfOriginBrnMismatchError: { type, message }
자사 사업자등록번호와 동일한 거래처를 생성할 수 없는 경우
B2bCounterpartyTooManyAdditionalContactsError: { type, message }
추가 담당자가 너무 많은 경우
추가 담당자는 최대 5명까지 등록할 수 있습니다.
B2bCounterpartyVerification: { id, checkedAt }
거래처 검증 정보
B2bCounterpartyVerificationBrnMismatchError: { type, message }
검증 결과의 사업자등록번호가 일치하지 않는 경우
B2bCounterpartyVerificationInvalidError: { type, message }
검증 결과가 유효하지 않은 경우
B2bCounterpartyVerificationNotFoundError: { type, message }
검증 결과를 찾을 수 없는 경우
사업자 정보 검증 결과를 찾을 수 없습니다.
B2bCounterpartyVerificationTypeMismatchError: { type, message }
검증 유형이 일치하지 않는 경우
B2bExternalServiceError: { type, message }
외부 서비스에서 에러가 발생한 경우
B2bNotEnabledError: { type, message }
B2B 기능이 활성화되지 않은 경우
B2bNtsConnectionStatus: "NOT_CONNECTED" | "PENDING_CONNECT" | "CONNECTED" | ...
국세청 연동 상태
CreateB2bCounterpartyBody: { counterpartyId, counterparty, options }
거래처 생성 요청 정보
CreateB2bCounterpartyError: | | | ...
CreateB2bCounterpartyResponse: { counterparty }
거래처 생성 응답 정보
DeleteB2bCounterpartyBody: { }
거래처 삭제 요청
DeleteB2bCounterpartyError: | | | ...
DeleteB2bCounterpartyResponse: { }
거래처 삭제 응답
ForbiddenError: { type, message }
요청이 거절된 경우
GetB2bCounterpartiesBody: { page, filter }
거래처 검색 요청 정보
GetB2bCounterpartiesError: | | | ...
GetB2bCounterpartiesResponse: { page, items }
거래처 검색 성공 응답
GetB2bCounterpartyCertificateError: | | | ...
GetB2bCounterpartyCertificateRegistrationUrlError: | | | ...
GetB2bCounterpartyCertificateRegistrationUrlResponse: { url }
인증서 등록 URL 조회 응답 정보
GetB2bCounterpartyError: | | | ...
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
UpdateB2bCounterpartyBody: { counterparty, options }
거래처 정보 수정 요청
UpdateB2bCounterpartyError: | | | ...
UpdateB2bCounterpartyResponse: { counterparty }
거래처 정보 수정 응답
ValidateB2bCounterpartyCertificateError: | | | ...
ValidateB2bCounterpartyCertificateResponse: { isValid }
인증서 유효성 검증 응답 정보