Free 회계 API를 사용하여 은행 계좌의 입금 정보와 연합

Free의 회계 API를 유연하게 활용하면 은행의 수금 정보를 시스템과 쉽게 연결할 수 있다

서비스를 제공할 때 소액이면 신용카드로 결제하는 것이 편리하지만 조금 크면 은행으로 송금하는 것이 안심

한편, 은행 시스템과 합작하려면 도입원가(비용과 개발원가)가 큰 인상을 남겼다

실제로 Free의 회계 API를 유연하게 운용하면 의외로 은행 계좌의 입금 정보를 시스템과 쉽게 연결할 수 있다.

이번에는 Free의 회계 API를 사용하여 은행 계좌에 대한 입금 정보를 시스템과 연합할 때 전체 절차와 각 단계에서 사용하는 API를 설명한다.
처리된 세부 내용을 모두 적으면 길어지기 때문에 사용하는 API와 주의사항만 적는다.
전체 프로세스

단계별 세부 사항
전제 조건

시스템 측의 은행 계좌의 거래 상세한 내용은 Free와 동기화하도록 미리 설정해야 한다.

설정 동기화를 통해 은행 계좌의 거래 내역 정보가 Free측과 동기화

Free 회계시스템 화면에 API에 액세스하기 위한 리셋 토큰과 액세스 토큰이 설정되어 있습니다(설정 단계는 몇 가지 기사가 있으니 중단하십시오)

일반 API는 접속영패를 사용하도록 요청하지만 Free규범으로 접속영패의 유효기간은 24시간이기 때문에 만기가 되면 갱신영패를 사용하여 접속영패를 다시 보내야 한다

주의점: 리셋 영패를 사용하여 접속 영패를 보내면 리셋 영패 자체도 바뀌기 때문에 두 가지 모두 시스템에서 발표된 값을 유지해야 한다

Free API의 경우 거의 모든 API에 매개변수company_id가 필요합니다.

이 매개 변수는 Free 시스템의 "사무소"

입니다.

실제 사용 상황에서 모든 서비스는 하나의 사무소가 되어야 하기 때문에 시스템에서 설정값으로 유지해야 한다

1. 고객 생성 처리

처리 내용

고객의 성명, 은행 계좌의 번호 등 정보를'거래자'로freee측에 로그인

API 사용

POST /api/1/partners

필요한 데이터

이름만 필수 항목이므로 최소한 이름으로만 등록

고려 사항

제작 후 반응에'고객 ID'가 있기 때문에 이를 고객의 손에 보관해야 한다.2단계에서 이 ID 사용

고객 고정 시 Free 화면에 등록하고 시스템에서 ID만 유지하면 문제 없음

API를 사용하여 등록할 때 문서에 특별히 쓰여 있지 않지만'고객 이름'항목은 독특한 제한이 있다.중복을 허용하지 않기 때문에 가장'이름 고객 ID'처럼 독특한 ID

를 추가합니다.

[2010/07/17 추기] 공동주소 정보의 경우 프리 측에 県/市区町村・番地/建物名・部屋番号など 3항만 있기 때문에県/都市/市区郡村市区町村・番地/建物名・部屋番号 4개 프로젝트의 시스템을 유지하는 상황에서 도시의 값을 시내 군촌·문패 헤드에 놓고 협력해야 한다

2. 거래 제작 처리 요청

처리 내용

비즈니스별 시스템 거래 생성

시스템에서 발생한 거래 내용을 Free 측에 등록

Free 측의 거래 ID를 시스템의 거래와 연결시킨다

API 사용

POST /api/1/deals

필요한 데이터

발생일

수지분류: income(수입) #평론: 본 편의 경우 입금 정보를 동기화하기 위해'수입'

으로 변경

명세행(최소항목은 세류, 회계과목, 금액)

고려 사항

결산과목 ID는 Free시스템의'결산과목'설정에 기록된 ID의 값을 사용해야 하는데 화면에서 이 ID의 값을 확인하는 수단이 없는 것 같아서 GET /api/1/account_items API를 호출하여 취득해야 한다

시스템의 거래는 어떤 결제 과목을 사용해야 하는지는 업무 상황에 따라 결정되기 때문에 본 보도에서 잠시 언급하지 않겠다

3. 입금 처리(시스템 외)

이 단계는 시스템 이외의 내용으로 전체 절차를 설명하기 위해 쓴다

처리 내용

고객이 시스템에서 지정한 Free와 합작한 은행 계좌로 송금

은행 측의 거래가 성립된 후 Free에 이 거래 정보를 연합한다(구체적인 합작 빈도 불분명)

Free 시스템에서 은행에서 협업한 거래가 자동으로 등록되어 시스템에서 거래를 취소할 수 있다.

이 일대는 회계 지식이 필요하기 때문에 본 기사에서는 생략하지만, 여기서는'은행 연합의 입금 거래와 절차 2에 등록된 소득 거래를 연계할 수 있다'는 의미로만 이해하면 된다

이 관련 처리에서 2단계에 등록된 거래에'수금일, 금액'등 수금 정보를 등록

4. 수금 정보 획득(정기적으로 집행하는 처리)

처리 내용

정기 처리를 통해 시스템상의 미수금 거래에 대해 프리측의 거래 정보를 취득하고 수금 정보가 있는지 확인한다.아래와 같이 매번 거래에서payments라는 프로젝트의 입금 정보를 얻을 수 있다(배열하면 여러 번 입금에 대응할 수 있다)

"payments": [
  {
    "id": 202,
    "date": "2013-01-28",
    "from_walletable_type": "bank_account",
    "from_walletable_id": 103,
    "amount": 5250
  }
],

입금 정보를 받고'입금일'을 취득하면 시스템상의 거래의 입금일로 설정하고 상태를 이미 입금된 것으로 업데이트

API 사용

GET /api/1/deals/:id

필요한 데이터

Free 측의 거래 ID(2단계에서 설정)

총결산
몇 가지 주의점과 과제가 있는데 프리의 회계 API를 이용하면 은행과의 협력도 쉽게 대응할 수 있어 감사하다.
참고 자료

공식 API 문서: https://developer.freee.co.jp/docs