APIリファレンスConnect 会員事業の請求書作成依頼

Connect 会員事業の請求書作成依頼

会員自身の発注について、請求書作成依頼を下書きする

GET/v1/connect/accounts/{accountId}/partner-invoice-requests

会員事業の請求書作成依頼を一覧する

パスの値

  • accountIdstring必須

    100文字まで

クエリ

  • cursorstring

    100文字まで

  • limitinteger

    1〜100

  • partnerOrderIdstring

    100文字まで

  • partnerIdstring

    100文字まで

  • externalRefstring

    200文字まで

  • statusenum
    draftsentviewededitingsubmittedneeds_revisionapprovedscheduled_for_paymentpaidcanceled

返る項目data の中身 · 200

  • idstring
  • statusenum
    draftsentviewededitingsubmittedneeds_revisionapprovedscheduled_for_paymentpaidcanceled
  • externalRefstring | null
  • partnerIdstring
  • partnerOrderIdstring
  • requestedAmountinteger
  • currencystring
  • isIncludingTaxboolean
  • taxRoundingMethodenum
    floorceilround
  • billingDatestring (date-time) | null
  • paymentDeadlinestring (date-time) | null
  • expiresAtstring (date-time) | null
  • sentAtstring (date-time) | null
  • submittedAtstring (date-time) | null
  • approvedAtstring (date-time) | null
  • paidAtstring (date-time) | null
  • canceledAtstring (date-time) | null
  • createdAtstring (date-time)
  • updatedAtstring (date-time)

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

GET/v1/…/accounts/{accountId}/partner-invoice-requests
curl https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests \
  -H "Authorization: Bearer $TOOON_API_KEY"
レスポンス
{
  "data": [
    {
      "id": "clx8k2m0a0001",
      "status": "draft",
      "externalRef": "staff-0001",
      "partnerId": "clx8k2m0a0001",
      "partnerOrderId": "clx8k2m0a0001",
      "requestedAmount": 100000,
      "currency": "JPY",
      "isIncludingTax": false,
      "taxRoundingMethod": "floor",
      "billingDate": "2026-11-01T09:00:00.000Z",
      "paymentDeadline": "2026-11-01T09:00:00.000Z",
      "expiresAt": "2026-11-01T09:00:00.000Z",
      "sentAt": "2026-11-01T09:00:00.000Z",
      "submittedAt": "2026-11-01T09:00:00.000Z",
      "approvedAt": "2026-11-01T09:00:00.000Z",
      "paidAt": "2026-11-01T09:00:00.000Z",
      "canceledAt": "2026-11-01T09:00:00.000Z",
      "createdAt": "2026-11-01T09:00:00.000Z",
      "updatedAt": "2026-11-01T09:00:00.000Z"
    }
  ],
  "nextCursor": null
}
POST/v1/connect/accounts/{accountId}/partner-invoice-requests

会員事業の請求書作成依頼を下書きする

同じ事業の発注に下書きを作ります。明細から請求額を計算します。externalRefは事業内で一意で、現在の下書きと同じ内容だけ再利用できます。送付・提出・承認・支払い・公開リンクの発行は行いません。

パスの値

  • accountIdstring必須

    100文字まで

送る項目JSON · 17項目

  • buyerMessagestring | null

    4,000文字まで

  • billingDatestring (date) | null
  • paymentDeadlinestring (date) | null
  • expiresAtstring (date-time) | null
  • invoiceNumberstring | null

    200文字まで

  • isIncludingTaxboolean
  • taxRoundingMethodenum
    floorceilround
  • linesobject[]必須

    1〜100件

    中の項目 7
    • namestring必須

      200文字まで

    • quantitynumber必須

      0〜1,000,000

    • unitstring | null

      20文字まで

    • unitPriceinteger必須

      1〜2,147,483,647

    • taxRateinteger必須

      0〜100

    • isWithholdingTaxboolean
    • sortOrderinteger

      0〜1,000

  • partnerOrderIdstring必須

    100文字まで

  • externalRefstring

    200文字まで

返る項目data の中身 · 200

  • idstring
  • statusenum
    draftsentviewededitingsubmittedneeds_revisionapprovedscheduled_for_paymentpaidcanceled
  • externalRefstring | null
  • partnerIdstring
  • partnerOrderIdstring
  • requestedAmountinteger
  • currencystring
  • isIncludingTaxboolean
  • taxRoundingMethodenum
    floorceilround
  • buyerMessagestring | null
  • billingDatestring (date-time) | null
  • paymentDeadlinestring (date-time) | null
  • expiresAtstring (date-time) | null
  • invoiceNumberstring | null
  • sentAtstring (date-time) | null
  • submittedAtstring (date-time) | null
  • approvedAtstring (date-time) | null
  • paidAtstring (date-time) | null
  • canceledAtstring (date-time) | null
  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • linesobject[]
    中の項目 7
    • namestring
    • quantitynumber
    • unitstring | null
    • unitPriceinteger
    • taxRateinteger
    • isWithholdingTaxboolean
    • sortOrderinteger

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

POST/v1/…/accounts/{accountId}/partner-invoice-requests
curl -X POST https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "lines": [
    {
      "name": "山田 太郎",
      "quantity": 1,
      "unitPrice": 100000,
      "taxRate": 10
    }
  ],
  "partnerOrderId": "clx8k2m0a0001",
  "externalRef": "staff-0001"
}'
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "status": "draft",
    "externalRef": "staff-0001",
    "partnerId": "clx8k2m0a0001",
    "partnerOrderId": "clx8k2m0a0001",
    "requestedAmount": 100000,
    "currency": "JPY",
    "isIncludingTax": false,
    "taxRoundingMethod": "floor",
    "buyerMessage": "内容をご確認ください",
    "billingDate": "2026-11-01T09:00:00.000Z",
    "paymentDeadline": "2026-11-01T09:00:00.000Z",
    "expiresAt": "2026-11-01T09:00:00.000Z",
    "invoiceNumber": "…",
    "sentAt": "2026-11-01T09:00:00.000Z",
    "submittedAt": "2026-11-01T09:00:00.000Z",
    "approvedAt": "2026-11-01T09:00:00.000Z",
    "paidAt": "2026-11-01T09:00:00.000Z",
    "canceledAt": "2026-11-01T09:00:00.000Z",
    "createdAt": "2026-11-01T09:00:00.000Z",
    "updatedAt": "2026-11-01T09:00:00.000Z",
    "lines": [
      {
        "name": "山田 太郎",
        "quantity": 1,
        "unit": "式",
        "unitPrice": 100000,
        "taxRate": 10,
        "isWithholdingTax": false,
        "sortOrder": 0
      }
    ]
  }
}
GET/v1/connect/accounts/{accountId}/partner-invoice-requests/{id}

会員事業の請求書作成依頼を取得する

パスの値

  • accountIdstring必須

    100文字まで

  • idstring必須

    100文字まで

返る項目data の中身 · 200

  • idstring
  • statusenum
    draftsentviewededitingsubmittedneeds_revisionapprovedscheduled_for_paymentpaidcanceled
  • externalRefstring | null
  • partnerIdstring
  • partnerOrderIdstring
  • requestedAmountinteger
  • currencystring
  • isIncludingTaxboolean
  • taxRoundingMethodenum
    floorceilround
  • buyerMessagestring | null
  • billingDatestring (date-time) | null
  • paymentDeadlinestring (date-time) | null
  • expiresAtstring (date-time) | null
  • invoiceNumberstring | null
  • sentAtstring (date-time) | null
  • submittedAtstring (date-time) | null
  • approvedAtstring (date-time) | null
  • paidAtstring (date-time) | null
  • canceledAtstring (date-time) | null
  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • linesobject[]
    中の項目 7
    • namestring
    • quantitynumber
    • unitstring | null
    • unitPriceinteger
    • taxRateinteger
    • isWithholdingTaxboolean
    • sortOrderinteger

起こりうるエラー共通のエラー

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

GET/v1/…/accounts/{accountId}/partner-invoice-requests/{id}
curl https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests/clx8k2m0a0001 \
  -H "Authorization: Bearer $TOOON_API_KEY"
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "status": "draft",
    "externalRef": "staff-0001",
    "partnerId": "clx8k2m0a0001",
    "partnerOrderId": "clx8k2m0a0001",
    "requestedAmount": 100000,
    "currency": "JPY",
    "isIncludingTax": false,
    "taxRoundingMethod": "floor",
    "buyerMessage": "内容をご確認ください",
    "billingDate": "2026-11-01T09:00:00.000Z",
    "paymentDeadline": "2026-11-01T09:00:00.000Z",
    "expiresAt": "2026-11-01T09:00:00.000Z",
    "invoiceNumber": "…",
    "sentAt": "2026-11-01T09:00:00.000Z",
    "submittedAt": "2026-11-01T09:00:00.000Z",
    "approvedAt": "2026-11-01T09:00:00.000Z",
    "paidAt": "2026-11-01T09:00:00.000Z",
    "canceledAt": "2026-11-01T09:00:00.000Z",
    "createdAt": "2026-11-01T09:00:00.000Z",
    "updatedAt": "2026-11-01T09:00:00.000Z",
    "lines": [
      {
        "name": "山田 太郎",
        "quantity": 1,
        "unit": "式",
        "unitPrice": 100000,
        "taxRate": 10,
        "isWithholdingTax": false,
        "sortOrder": 0
      }
    ]
  }
}
PATCH/v1/connect/accounts/{accountId}/partner-invoice-requests/{id}

会員事業の請求書作成依頼の下書きを編集する

DRAFTのみ編集できます。expectedUpdatedAtに直前のGETの値を指定します。省略した項目は保持し、任意項目はnullで消せます。linesを送ると全明細を置き換えます。送付・提出・承認・支払い・取消は行いません。

パスの値

  • accountIdstring必須

    100文字まで

  • idstring必須

    100文字まで

送る項目JSON · 16項目

  • buyerMessagestring | null

    4,000文字まで

  • billingDatestring (date) | null
  • paymentDeadlinestring (date) | null
  • expiresAtstring (date-time) | null
  • invoiceNumberstring | null

    200文字まで

  • isIncludingTaxboolean
  • taxRoundingMethodenum
    floorceilround
  • linesobject[]

    1〜100件

    中の項目 7
    • namestring必須

      200文字まで

    • quantitynumber必須

      0〜1,000,000

    • unitstring | null

      20文字まで

    • unitPriceinteger必須

      1〜2,147,483,647

    • taxRateinteger必須

      0〜100

    • isWithholdingTaxboolean
    • sortOrderinteger

      0〜1,000

  • expectedUpdatedAtstring (date-time)必須

返る項目data の中身 · 200

  • idstring
  • statusenum
    draftsentviewededitingsubmittedneeds_revisionapprovedscheduled_for_paymentpaidcanceled
  • externalRefstring | null
  • partnerIdstring
  • partnerOrderIdstring
  • requestedAmountinteger
  • currencystring
  • isIncludingTaxboolean
  • taxRoundingMethodenum
    floorceilround
  • buyerMessagestring | null
  • billingDatestring (date-time) | null
  • paymentDeadlinestring (date-time) | null
  • expiresAtstring (date-time) | null
  • invoiceNumberstring | null
  • sentAtstring (date-time) | null
  • submittedAtstring (date-time) | null
  • approvedAtstring (date-time) | null
  • paidAtstring (date-time) | null
  • canceledAtstring (date-time) | null
  • createdAtstring (date-time)
  • updatedAtstring (date-time)
  • linesobject[]
    中の項目 7
    • namestring
    • quantitynumber
    • unitstring | null
    • unitPriceinteger
    • taxRateinteger
    • isWithholdingTaxboolean
    • sortOrderinteger

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

PATCH/v1/…/accounts/{accountId}/partner-invoice-requests/{id}
curl -X PATCH https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests/clx8k2m0a0001 \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "buyerMessage": "内容をご確認ください",
  "expectedUpdatedAt": "2026-11-01T09:00:00.000Z"
}'
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "status": "draft",
    "externalRef": "staff-0001",
    "partnerId": "clx8k2m0a0001",
    "partnerOrderId": "clx8k2m0a0001",
    "requestedAmount": 100000,
    "currency": "JPY",
    "isIncludingTax": false,
    "taxRoundingMethod": "floor",
    "buyerMessage": "内容をご確認ください",
    "billingDate": "2026-11-01T09:00:00.000Z",
    "paymentDeadline": "2026-11-01T09:00:00.000Z",
    "expiresAt": "2026-11-01T09:00:00.000Z",
    "invoiceNumber": "…",
    "sentAt": "2026-11-01T09:00:00.000Z",
    "submittedAt": "2026-11-01T09:00:00.000Z",
    "approvedAt": "2026-11-01T09:00:00.000Z",
    "paidAt": "2026-11-01T09:00:00.000Z",
    "canceledAt": "2026-11-01T09:00:00.000Z",
    "createdAt": "2026-11-01T09:00:00.000Z",
    "updatedAt": "2026-11-01T09:00:00.000Z",
    "lines": [
      {
        "name": "山田 太郎",
        "quantity": 1,
        "unit": "式",
        "unitPrice": 100000,
        "taxRate": 10,
        "isWithholdingTax": false,
        "sortOrder": 0
      }
    ]
  }
}
POST/v1/connect/accounts/{accountId}/partner-invoice-requests/{id}/presentation-preview

相手への提示前に請求書作成依頼を確認する

15分有効な確認IDと依頼条件・明細・名義・相手・期限を返します。連携先はログインした依頼元本人にreviewの全内容と副作用を表示し、確認操作の証拠を保持してください。明細の計算と依頼額が一致する必要があります。

パスの値

  • accountIdstring必須

    200文字まで

  • idstring必須

    200文字まで

送る項目JSON · 1項目

  • expectedUpdatedAtstring (date-time)必須

返る項目data の中身 · 200

  • confirmationIdstring
  • expectedActorIdstring
  • reviewHashstring
  • expiresAtstring (date-time)
  • reviewobject
    中の項目 7
    • requestobject
      中の項目 14
      • idstring
      • statusenum
        draftsentviewededitingsubmittedneeds_revisionapprovedscheduled_for_paymentpaidcanceled
      • partnerIdstring
      • partnerOrderIdstring
      • requestedAmountinteger
      • currencystring
      • isIncludingTaxboolean
      • taxRoundingMethodenum
        floorceilround
      • buyerMessagestring | null
      • billingDatestring (date-time) | null
      • paymentDeadlinestring (date-time) | null
      • expiresAtstring (date-time) | null
      • invoiceNumberstring | null
      • linesobject[]
        中の項目 7
        • namestring
        • quantitynumber
        • unitstring | null
        • unitPriceinteger
        • taxRateinteger
        • isWithholdingTaxboolean
        • sortOrderinteger
    • buyerobject
      中の項目 7
      • namestring
      • companystring | null
      • postalCodestring | null
      • addressstring | null
      • buildingNamestring | null
      • phoneNumberstring | null
      • registrationNumberstring | null
    • supplierobject
      中の項目 6
      • namestring
      • companyNamestring | null
      • contactNamestring | null
      • emailstring | null
      • taxRegistrationNumberstring | null
      • addressstring | null
    • orderobject
      中の項目 10
      • titlestring
      • rolestring | null
      • scopestring | null
      • amountinteger
      • currencystring
      • isIncludingTaxboolean
      • taxRoundingMethodstring
      • contractTermsstring | null
      • startDatestring | null
      • endDatestring | null
    • recipientDetailsobject | null
      中の項目 7
      • recipientNamestring | null
      • recipientHonorificTitlestring | null
      • recipientDepartmentstring | null
      • recipientPostalCodestring | null
      • recipientAddressstring | null
      • recipientBuildingNamestring | null
      • recipientPhoneNumberstring | null
    • senderDetailsobject | null
      中の項目 7
      • senderNamestring | null
      • senderCompanystring | null
      • senderRegistrationNumberstring | null
      • senderAddressstring | null
      • senderPhoneNumberstring | null
      • transferBankAccountstring | null
      • remarksstring | null
    • effectsobject
      中の項目 7
      • status"sent"
      • presentation"provider"
      • delivery"none"
      • invalidatesPublicLinktrue
      • submitsInvoicefalse
      • createsSettlementfalse
      • approvesPaymentfalse

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

POST/v1/…/accounts/{accountId}/partner-invoice-requests/{id}/presentation-preview
curl -X POST https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests/clx8k2m0a0001/presentation-preview \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedUpdatedAt": "2026-11-01T09:00:00.000Z"
}'
レスポンス
{
  "data": {
    "confirmationId": "clx8k2m0a0001",
    "expectedActorId": "clx8k2m0a0001",
    "reviewHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "expiresAt": "2026-11-01T09:00:00.000Z",
    "review": {
      "request": {
        "id": "clx8k2m0a0001",
        "status": "draft",
        "partnerId": "clx8k2m0a0001",
        "partnerOrderId": "clx8k2m0a0001",
        "requestedAmount": 100000,
        "currency": "JPY",
        "isIncludingTax": false,
        "taxRoundingMethod": "floor",
        "buyerMessage": "内容をご確認ください",
        "billingDate": "2026-11-01T09:00:00.000Z",
        "paymentDeadline": "2026-11-01T09:00:00.000Z",
        "expiresAt": "2026-11-01T09:00:00.000Z",
        "invoiceNumber": "…",
        "lines": [
          {
            "name": "山田 太郎",
            "quantity": 1,
            "unit": "式",
            "unitPrice": 100000,
            "taxRate": 10,
            "isWithholdingTax": false,
            "sortOrder": 0
          }
        ]
      },
      "buyer": {
        "name": "山田 太郎",
        "company": "…",
        "postalCode": "…",
        "address": "東京都渋谷区神南1-2-3",
        "buildingName": "…",
        "phoneNumber": "090-1234-5678",
        "registrationNumber": "T1234567890123"
      },
      "supplier": {
        "name": "山田 太郎",
        "companyName": "山田デザイン事務所",
        "contactName": "山田 太郎",
        "email": "…",
        "taxRegistrationNumber": "T1234567890123",
        "address": "東京都渋谷区神南1-2-3"
      },
      "order": {
        "title": "Webサイト制作の業務委託",
        "role": "…",
        "scope": "…",
        "amount": 100000,
        "currency": "JPY",
        "isIncludingTax": false,
        "taxRoundingMethod": "…",
        "contractTerms": "…",
        "startDate": "2026-11-30",
        "endDate": "2026-11-30"
      },
      "recipientDetails": {
        "recipientName": "…",
        "recipientHonorificTitle": "…",
        "recipientDepartment": "…",
        "recipientPostalCode": "…",
        "recipientAddress": "…",
        "recipientBuildingName": "…",
        "recipientPhoneNumber": "…"
      },
      "senderDetails": {
        "senderName": "…",
        "senderCompany": "…",
        "senderRegistrationNumber": "…",
        "senderAddress": "…",
        "senderPhoneNumber": "…",
        "transferBankAccount": "…",
        "remarks": "…"
      },
      "effects": {
        "status": "sent",
        "presentation": "provider",
        "delivery": "none",
        "invalidatesPublicLink": true,
        "submitsInvoice": false,
        "createsSettlement": false,
        "approvesPayment": false
      }
    }
  }
}
POST/v1/connect/accounts/{accountId}/partner-invoice-requests/{id}/present

本人が確認した請求書作成依頼を提示用に確定する

連携先で本人が確認した版をSENTへ進め、保存したreviewを提示内容として確定します。delivery:none。連携先は確認済みreviewを相手に表示します。既存の公開リンクは失効し、新しいリンクは返しません。到達・閲覧・提出・請求書発行・承認・支払いは行いません。変更・期限切れ・別本人を拒否し、同じ確認記録の再送は同じ確定結果を返します。

パスの値

  • accountIdstring必須

    200文字まで

  • idstring必須

    200文字まで

送る項目JSON · 5項目

  • confirmationIdstring必須

    200文字まで

  • reviewHashstring必須
  • confirmedBystring必須

    200文字まで

  • confirmedAtstring (date-time)必須
  • confirmationReferencestring必須

    200文字まで

返る項目data の中身 · 200

  • requestIdstring
  • confirmationIdstring
  • reviewHashstring
  • presentedAtstring (date-time)
  • delivery"none"

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

POST/v1/…/accounts/{accountId}/partner-invoice-requests/{id}/present
curl -X POST https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests/clx8k2m0a0001/present \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "confirmationId": "clx8k2m0a0001",
  "reviewHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "confirmedBy": "member-0001",
  "confirmedAt": "2026-11-01T09:00:00.000Z",
  "confirmationReference": "confirmation-0001"
}'
レスポンス
{
  "data": {
    "requestId": "clx8k2m0a0001",
    "confirmationId": "clx8k2m0a0001",
    "reviewHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "presentedAt": "2026-11-01T09:00:00.000Z",
    "delivery": "none"
  }
}
POST/v1/connect/accounts/{accountId}/partner-invoice-requests/{id}/cancel-preview

提出前の請求書作成依頼を取り消す前に確認する

15分有効な確認IDと対象依頼・現在の相手/発注・理由・副作用を返します。連携先は依頼元本人へreviewの全内容を表示し、確認証拠を保持してください。提出以降や精算に接続した依頼は対象外です。

パスの値

  • accountIdstring必須

    200文字まで

  • idstring必須

    200文字まで

送る項目JSON · 2項目

  • expectedUpdatedAtstring (date-time)必須
  • commentstring | null

    2,000文字まで

返る項目data の中身 · 200

  • confirmationIdstring
  • expectedActorIdstring
  • reviewHashstring
  • expiresAtstring (date-time)
  • reviewobject
    中の項目 5
    • requestobject
      中の項目 22
      • idstring
      • statusenum
        draftsentviewededitingsubmittedneeds_revisionapprovedscheduled_for_paymentpaidcanceled
      • externalRefstring | null
      • partnerIdstring
      • partnerOrderIdstring
      • requestedAmountinteger
      • currencystring
      • isIncludingTaxboolean
      • taxRoundingMethodenum
        floorceilround
      • buyerMessagestring | null
      • billingDatestring (date-time) | null
      • paymentDeadlinestring (date-time) | null
      • expiresAtstring (date-time) | null
      • invoiceNumberstring | null
      • sentAtstring (date-time) | null
      • submittedAtstring (date-time) | null
      • approvedAtstring (date-time) | null
      • paidAtstring (date-time) | null
      • canceledAtstring (date-time) | null
      • createdAtstring (date-time)
      • updatedAtstring (date-time)
      • linesobject[]
        中の項目 7
        • namestring
        • quantitynumber
        • unitstring | null
        • unitPriceinteger
        • taxRateinteger
        • isWithholdingTaxboolean
        • sortOrderinteger
    • partnerobject
      中の項目 2
      • namestring
      • companyNamestring | null
    • orderobject
      中の項目 2
      • titlestring
      • statusstring
    • commentstring | null
    • effectsobject
      中の項目 7
      • status"canceled"
      • delivery"none"
      • invalidatesPublicLinktrue
      • changesPartnerOrderfalse
      • changesAgreementfalse
      • changesSettlementfalse
      • changesPaymentfalse

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

POST/v1/…/accounts/{accountId}/partner-invoice-requests/{id}/cancel-preview
curl -X POST https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests/clx8k2m0a0001/cancel-preview \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedUpdatedAt": "2026-11-01T09:00:00.000Z"
}'
レスポンス
{
  "data": {
    "confirmationId": "clx8k2m0a0001",
    "expectedActorId": "clx8k2m0a0001",
    "reviewHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "expiresAt": "2026-11-01T09:00:00.000Z",
    "review": {
      "request": {
        "id": "clx8k2m0a0001",
        "status": "draft",
        "externalRef": "staff-0001",
        "partnerId": "clx8k2m0a0001",
        "partnerOrderId": "clx8k2m0a0001",
        "requestedAmount": 100000,
        "currency": "JPY",
        "isIncludingTax": false,
        "taxRoundingMethod": "floor",
        "buyerMessage": "内容をご確認ください",
        "billingDate": "2026-11-01T09:00:00.000Z",
        "paymentDeadline": "2026-11-01T09:00:00.000Z",
        "expiresAt": "2026-11-01T09:00:00.000Z",
        "invoiceNumber": "…",
        "sentAt": "2026-11-01T09:00:00.000Z",
        "submittedAt": "2026-11-01T09:00:00.000Z",
        "approvedAt": "2026-11-01T09:00:00.000Z",
        "paidAt": "2026-11-01T09:00:00.000Z",
        "canceledAt": "2026-11-01T09:00:00.000Z",
        "createdAt": "2026-11-01T09:00:00.000Z",
        "updatedAt": "2026-11-01T09:00:00.000Z",
        "lines": [
          {
            "name": "山田 太郎",
            "quantity": 1,
            "unit": "式",
            "unitPrice": 100000,
            "taxRate": 10,
            "isWithholdingTax": false,
            "sortOrder": 0
          }
        ]
      },
      "partner": {
        "name": "山田 太郎",
        "companyName": "山田デザイン事務所"
      },
      "order": {
        "title": "Webサイト制作の業務委託",
        "status": "…"
      },
      "comment": "…",
      "effects": {
        "status": "canceled",
        "delivery": "none",
        "invalidatesPublicLink": true,
        "changesPartnerOrder": false,
        "changesAgreement": false,
        "changesSettlement": false,
        "changesPayment": false
      }
    }
  }
}
POST/v1/connect/accounts/{accountId}/partner-invoice-requests/{id}/cancel-confirmed

本人が確認した提出前の請求書作成依頼を取り消す

確認した提出前の依頼をCANCELEDにし、旧公開リンクを無効にします。delivery:none。発注・契約・精算・支払・請求書を変更せず、メールも送りません。内容・版・本人・期限を検証し、同じ確認の再送は同じ結果を返します。

パスの値

  • accountIdstring必須

    200文字まで

  • idstring必須

    200文字まで

送る項目JSON · 5項目

  • confirmationIdstring必須

    200文字まで

  • reviewHashstring必須
  • confirmedBystring必須

    200文字まで

  • confirmedAtstring (date-time)必須
  • confirmationReferencestring必須

    200文字まで

返る項目data の中身 · 200

  • requestIdstring
  • confirmationIdstring
  • reviewHashstring
  • canceledAtstring (date-time)
  • delivery"none"

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限(scope)が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

POST/v1/…/accounts/{accountId}/partner-invoice-requests/{id}/cancel-confirmed
curl -X POST https://tooon.app/api/v1/connect/accounts/clx8k2m0a0001/partner-invoice-requests/clx8k2m0a0001/cancel-confirmed \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "confirmationId": "clx8k2m0a0001",
  "reviewHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "confirmedBy": "member-0001",
  "confirmedAt": "2026-11-01T09:00:00.000Z",
  "confirmationReference": "confirmation-0001"
}'
レスポンス
{
  "data": {
    "requestId": "clx8k2m0a0001",
    "confirmationId": "clx8k2m0a0001",
    "reviewHash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "canceledAt": "2026-11-01T09:00:00.000Z",
    "delivery": "none"
  }
}